Credential Management in Concourse

Encrypting your Concourse deployment is a good first step to securing your CI/CD tools. For even greater security, Pivotal recommends that you use a credential manager as well.

Explicit credential management provides temporary credentials to your Concourse builds. These credentials are not stored anywhere. Credential management also allows for credentials to be rotated and managed from outside the pipeline or team, and prevents them from being revealed by get-pipeline.

Credential management works by replacing the credentials with ((parameters)) in your pipeline or task config files. When the ATC is about to run the step or check that is configured with the parameters, it will resolve them by fetching the values from the credential manager. This ensures that credentials are not transmitted over insecure channels, or stored in build history.

Concourse uses Vault as a credential manager.

What credentials can I store?

You can use a credential manager to control the following resources:

Where these values are looked up and how the credential manager is configured depends on the backend. Consult the relevant section below for whichever backend you want to use.

Using Vault

Configuration

The ATC is statically configured with a Vault server URL (plus any TLS config), and either a client token or an auth backend.

To configure Vault, provide the vault properties to your ATC. More details on this process are described in the BOSH documentation. Additional details can be found on the Concourse documentation regarding Using Vault

Credential Lookup Rules

When resolving a parameter such as ((YOUR_PARAM)), the ATC looks in the following paths:

  • /concourse/TEAM_NAME/PIPELINE_NAME/YOUR_PARAM
  • /concourse/TEAM_NAME/YOUR_PARAM

If you need to, change the leading /concourse by specifying --vault-path-prefix.

If the action runs in the context of a pipeline, the ATC looks in the pipeline path first. If the action is not found there, the ATC looks in the team path. This allows credentials to be scoped widely if they are common across many pipelines.

If an action is run in a one-off build, the ATC only looks in the team path.

Create a pull request or raise an issue on the source for this page in GitHub