README.md

CloudSecret

Map GCP Secret Manager secrets to Kubernetes Secrets.

Implemented as a simple CRD. You define CloudSecrets:

apiVersion: secrets.masonwr.dev/v1
kind: CloudSecret
metadata:
  name: cloudsecret-sample
spec:
  data:
    SECRET_DATA: projects/<PROJECT_ID>/secrets/test/versions/latest

CloudSecrets map a key to a Secret Manager Path, and produces a matching Kubernetes secret with the resolved secret data.

For example, if we apply the above CloudSecret, this would result in the creation of the following Kubernetes secret:

apiVersion: v1
data:
  SECRET_DATA: a2VlcCB0...
kind: Secret

Install

NB: The service account running the deployment must have the "Secret Manager Secret Accessor" role. And the Secret Manager API must be enabled.

Deploy (public image)

Dependencies

• kustomize
• kubectl

$ git clone https://github.com/masonwr/CloudSecret && cd CloudSecret
$ make install  # install CRD 
$ make deploy   # deploy using the public image built from this repo (gcr.io/public-263420/cloudsecret-controller)

Build (build from source)

Dependencies

• kubebuilder

$ git clone https://github.com/masonwr/CloudSecret && cd CloudSecret
$ export IMG=your/image/repo:tag
$ make install 
$ make docker-build docker-push
$ make deploy

Tutorial

Dependencies

• kubectl
• gcloud

Create the GCP Secret, and get its path

$ cd $(mktemp -d)
$ export PROJECT_ID=some_project_id
$ echo "keep this secret, keep this safe" > secret.data.txt
$ gcloud beta secrets  create loc-of-ring \
   --data-file=secret.data.txt \
   --project=$PROJECT_ID \
   --replication-policy=automatic
$ gcloud beta secrets describe loc-of-ring --project=$PROJECT_ID
createTime: '2019-12-23T21:11:34.245558Z'
name: projects/<PROJECT_ID>/secrets/loc-of-ring
replication:
  automatic: {}

Note the fully qualified secret name.

Define a CloudSecret

$ cat << EOF > cloudSecretExample.yaml
apiVersion: secrets.masonwr.dev/v1                                                                                                   
kind: CloudSecret
metadata:
  name: example
spec:
  data:
    SECRET_DATA: <Fully qulified secret path>/versions/latest
EOF

$ kubectl apply -f cloudSecretExample.yaml 

Verify

$ kubectl get secrets example -o json | jq -r .data.SECRET_DATA | base64 -d
keep this secret, keep this safe

TODO:

• Implement controls for handling when secret lookup fails

NOTE

Built with the awesome kubebuilder.