Secrets in S3

This document describes how to set up Spinnaker secrets in an encrypted S3 bucket.

This document describes how to set up Spinnaker secrets in an encrypted S3 bucket. This example uses a bucket (mybucket) in the us-west-2 region to store GitHub credentials and a kubeconfig file. You reference the bucket by its URL mybucket.us-west-2.amazonaws.com.

Authorization

Since you’re storing sensitive information, you protect the bucket by restricting access and enabling encryption .

Remember to run Halyard’s daemon and Spinnaker services with IAM roles that allow them to read that content.

Storing secrets

Storing credentials

Store your GitHub credentials in mybucket/spinnaker-secrets.yml:

  1. github:
  2.   password: <PASSWORD>
  3.   token: <TOKEN>

Note: You could choose to store the password under different keys than github.password and github.token. You’d just need to change how to reference the secret further down.

Storing sensitive files

Some Spinnaker configuration uses information stored as files. For example, upload the kubeconfig file of your Kubernetes account directly to mybucket/mykubeconfig:

  1. aws s3 cp /path/to/mykubeconfig s3://mybucket/mykubeconfig

Referencing secrets

Now that secrets are safely stored in the bucket, you reference them from your config files using the following format. The S3 specific parameters (r:<region>, b:<bucket>, k:<optional yaml key>) can be in any order: To reference secret literal values:

  1. encrypted:s3!r:<region>!b:<bucket>!f:<path to file>!k:<optional yaml key>

To reference secret files:

  1. encryptedFile:s3!b:<bucket>!f:<path to file>

The k:<key> parameter is only necessary when storing secret values in a yaml file, like in our example. To reference github.password from the file above, use:

  1. encrypted:s3!b:mybucket!f:spinnaker-secrets.yml!r:us-west-2!k:github.password

But to reference your kubeconfig file, you can leave off the k parameter and use encryptedFile prefix:

  1. encrypted:s3!r:us-west-2!b:mybucket!f:mykubeconfig
  2. encryptedFile:s3!r:us-west-2!b:mybucket!f:mykubeconfig

Last modified October 16, 2020: rest of commits (b97d8a1)