feat(secret-sync): Hashicorp Vault App Connection & Secret Sync

[x032205]

Description 📣

This PR adds Secret Sync and App support for Hashicorp Vault. Doc changes included.

Type ✨

• [ ] Bug fix
• [x] New feature
• [ ] Improvement
• [ ] Breaking change
• [x] Documentation

---

• [x] I have read the contributing guide, agreed and acknowledged the code of conduct. 📝

Summary by CodeRabbit

• New Features

  • Added full support for integrating Hashicorp Vault as an app connection and secret sync destination.
  • Users can now connect to Hashicorp Vault using Access Token or AppRole authentication methods.
  • Secret syncs to Hashicorp Vault can be configured, reviewed, and managed through the UI and API.
  • New UI components and forms for Vault connection and sync configuration, including mount and path selection.
  • Hashicorp Vault options are available in relevant dropdowns, tables, and detail views.

• Documentation

  • Comprehensive user and API documentation added for Hashicorp Vault app connection and secret sync setup.
  • Navigation updated to include Hashicorp Vault under integrations and API reference sections.
  • Deprecated legacy Hashicorp Vault integration documentation.

• Chores

  • Internal types, enums, and schemas extended to support Hashicorp Vault across backend and frontend.

[coderabbitai[bot]]

## Walkthrough

This change introduces comprehensive support for HashiCorp Vault (HCVault) as both an App Connection and a Secret Sync destination throughout the backend, frontend, and documentation. On the backend, new enums, types, schemas, and service modules are added to represent and validate HCVault connections and secret syncs, supporting both Access Token and AppRole authentication methods. CRUD API endpoints and routers are implemented for managing HCVault connections and secret syncs, including a specialized endpoint for listing Vault mounts. Secret synchronization logic for Vault is encapsulated in new modules, handling batch sync, removal, and retrieval of secrets via Vault's KV version 2 API.

Frontend changes include new React components and form schemas for configuring and reviewing HCVault syncs, as well as table and detail section components for displaying Vault sync data. TypeScript types and enums are extended to support the new connection and sync types. The documentation is updated with new integration guides, API reference entries, and navigation updates for HCVault, while legacy Vault integration documentation is deprecated.

## Possibly related PRs

- Infisical/infisical#3373: Adds support for a new app connection and secret sync integration for Camunda, with analogous backend and frontend schema, service, and router extensions similar in structure to the Hashicorp Vault integration.

## Suggested reviewers

- maidul98

---

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[maidul98]

:tada: Snyk checks have passed. No issues have been found so far.

:white_check_mark: security/snyk check is complete. No issues have been found. (View Details)

[carlosmonastyrski]

It looks like the Cloud version of HashiCorp has a different layout. Based on the screenshots in the app connection documentation, the steps to set up a connection there seem to follow a different path than what we see on self-hosted instances 🤔