- Notifications
You must be signed in to change notification settings - Fork165
added page for hashicorp-vault#249
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Merged
Uh oh!
There was an error while loading.Please reload this page.
Merged
Changes fromall commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Jump to
Jump to file
Failed to load files.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,55 @@ | ||
| --- | ||
| title: "Hashicorp Vault" | ||
| description: "How to use secrets from Vault in your Codefresh pipelines" | ||
Member There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. This is a new feature. We need an entry in the what's new page. | ||
| group: integrations | ||
| toc: true | ||
| --- | ||
| Codefresh can use secrets from your Hashicorp Vault installation. This way you have full control over secret storage and rotation. | ||
| >Note: This feature is for Enterprise accounts only. | ||
| ### Prerequisites | ||
| You need to have a vault instance up and running. Codefresh supports Vault instances that run on the cloud, as well as behind the firewall (albeit with some differences in the authentication methods). | ||
| You also need to decide what [authentication method](https://www.vaultproject.io/docs/auth) Codefresh will use. The following methods are supported: | ||
| ---|--- | ||
| [Username/Password](https://www.vaultproject.io/docs/auth/userpass)|Available in SaaS and Hybrid customers | ||
| [Access Token](https://www.vaultproject.io/docs/auth/token)|Available in SaaS and Hybrid customers | ||
| [Kubernetes](https://www.vaultproject.io/docs/auth/kubernetes)|Only available in [Hybrid installation]({{site.baseurl}}/docs/docs/administration/behind-the-firewall/) | ||
| [Google Cloud Engine](https://www.vaultproject.io/docs/auth/gcp)|Only available in [Hybrid installation]({{site.baseurl}}/docs/docs/administration/behind-the-firewall/) | ||
| [App Role]()|Available in SaaS and Hybrid customers | ||
| ### Using the Codefresh UI | ||
| On the left-hand panel, navigate to **Account Settings** > **Integrations** > **Secret Store** and select **Configure**. | ||
| Click on **Add Provider** and select **Hashicorp vault**. Toggle the “allow access to all users” button to the off position as you normally want only Codefresh admins to change vault configuration. | ||
| {% include image.html | ||
| lightbox="true" | ||
| file="/images/integrations/hashicorp-vault/hashicorp-vault.png" | ||
| url="/images/integrations/hashicorp-vault/hashicorp-vault.png" | ||
| alt="Hashicorp-vault Secret" | ||
| caption="Hashicorp-vault Secret" | ||
| max-width="80%" | ||
| %} | ||
| Enter a name for your integration (you can have multiple vault integrations) unique to this configuration. Then choose if your vault instance is behind a firewall or not. | ||
| The rest of the options are specific to your [Vault authentication](https://www.vaultproject.io/docs/auth) method and you should consult the Vault documentation on how to obtain them. | ||
| ### Using the Codefresh CLI | ||
| You can also create Vault integrations with the [CLI](https://codefresh-io.github.io/cli/) and more specifically with the [create context command](https://codefresh-io.github.io/cli/contexts/create-context/create-secret-store-context/hashicorp-vault/). | ||
| The available options are the same ones as found in the UI. For example, to create an integration with user/pass authentication the respective command is: | ||
| `codefresh create context secret-store hashicorp-vault my-integration --sharing-policy AccountAdmins -app-url http://vault.example.com --username my-user --password my-password` | ||
| ### Using the Secrets | ||
| To use the vault secrets in pipelines see our [secrets guide]({{site.baseurl}}/docs/docs/configure-ci-cd-pipeline/secrets-store/). Note that because in Vault, a secret can contain multiple key-value pairs you will need to put in the key name as well. So the syntax will be `{secrets.vault-store-name.path/to/secret@key}` | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong.Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.