README.md

ClusterSecret

clustersecret.com

Kubernetes Cluster wide secrets

The clusterSecret operator makes sure all the matching namespaces have the secret available and up to date.

• New namespaces, if they match the pattern, will also have the secret.
• Any change on the ClusterSecret will update all related secrets. Including changing the match pattern.
• Deleting the ClusterSecret deletes "child" secrets (all cloned secrets) too.

Full documentation is available at https://clustersecret.com

---

Here is how it looks like:

kind: ClusterSecret
apiVersion: clustersecret.io/v1
metadata:
  namespace: clustersecret
  name: default-wildcard-certifiate
matchNamespace:
  - prefix_ns-*
  - anothernamespace
avoidNamespaces:
  - supersecret-ns
data:
  tls.crt: BASE64
  tls.key: BASE64

Use it for certificates, registry pulling credentials and so on.

when you need a secret in more than one namespace. you have to:

1- Get the secret from the origin namespace. 2- Edit the the secret with the new namespace. 3- Re-create the new secret in the new namespace.

This could be done with one command:

kubectl get secret <secret-name> -n <source-namespace> -o yaml \
| sed s/"namespace: <source-namespace>"/"namespace: <destination-namespace>"/\
| kubectl apply -n <destination-namespace> -f -

Clustersecrets automates this. It keep track of any modification in your secret and it will also react to new namespaces.

If this is helpful, consider supporting the project :)

installation

Requirements

Current version 0.0.11 is tested for Kubernetes >= 1.19 up to 1.27.3 For older Kubernetes (<1.19) use the image tag 0.0.6 in your helm values file.

architectures available (0.0.11):

SHA256 ed12e8f3e630 | linux | 386 SHA256 91b0285f5398 | linux | amd64 SHA256 cad79c68cb8c | linux | s390x SHA256 637f3be7850a | linux | arm64

Install

Using the official helm chart

helm repo add clustersecret https://charts.clustersecret.com/
helm install clustersecret clustersecret/cluster-secret --version 0.4.3 -n clustersecret --create-namespace

with just kubectl

clone the repo and apply

cd ClusterSecret
kubectl apply -f ./yaml

quick start:

create a ClusterSecret object yaml like the one above, or in the example in yaml/Object_example/obj.yaml and apply it in your cluster kubectl apply -f yaml/Object_example/obj.yaml

The ClusterSecret operator will pick it up and will create the secret in every matching namespace: match matchNamespace but not matching avoidNamespaces RegExp's.

You can specify multiple matching or non-matching RegExp. By default, it will match all, the same as defining matchNamespace = *

Get the clustersecrets

$> kubectl get csec -n clustersecret
NAME            TYPE
global-secret

Minimal example

apiVersion: clustersecret.io/v1
kind: ClusterSecret
metadata:
  name: global-secret
  namespace: my-fav-namespce
data:
  username: MTIzNDU2Cg==
  password: Nzg5MTAxMTIxMgo=

images

Images are built and pushed on tag ('git tag') with GitHub Actions. You can find them here:

https://quay.io/repository/clustersecret/clustersecret

Known bugs:

• check this on the issues tab

Roadmap:

TO-DO: enable super linter -> DISABLE_ERRORS

Support

If you need help, you can start with the troubleshooting guide: Run it in debug mode. You can open issues and we will try to address them.

That said, if you have questions, or just want to establish contact, reach out one way or another. https://flag5.com || nico at flag5.com

Global inter-namespace cluster secrets - Secrets that work across namespaces - Cluster wide secrets