The secrets reef¶
Every command of the secrets reef: vaults, and the secrets in them, encrypted before they leave the machine.
Commands¶
nereus init
The profile brings the secrets reef ready to use, with its key and the vault defaultnereus secrets create google-oauth
A secret is encrypted on your machine, before it leaves itnereus secrets create google-oauth
Creating it again is refused, with how to change itnereus secrets create github-app
A key can come from a file, such as a private keynereus secrets create google-oauth
Apply takes a folder of secrets, and the second apply changes nothingnereus secrets list
The list shows every secret with its keys, never a valuenereus secrets get default/google-oauth
One secret, by its vault and namenereus secrets get google-oauth
As YAML, the object shows the names of its keys instead of the envelopesnereus secrets vault list
The list shows every vault, its Nereid and how many secrets it holdsnereus secrets vault create team-a
A vault for a team, with the namespaces allowed to bind its secretsnereus secrets vault delete default
A vault that holds secrets is refused, with what to delete firstnereus secrets delete default/google-oauth
A secret goes by its full name, or by its name in the vault defaultnereus secrets vault delete team-a
An empty vault goesnereus secrets binding create keycloak-google
A binding makes a Kubernetes Secret from a secret, in a namespace the vault allowsnereus secrets binding create payments
A namespace the vault does not allow, or a key the secret does not have, is refused before anything is writtencat test/charts/binding-demo/templates/secretbinding.yaml
A chart asks for its secret with a SecretBinding among its templatesnereus secrets binding list
Every binding, with who asked for itnereus secrets get default/google-oauth
A secret says where it is used, and is not deleted while it isnereus secrets binding delete keycloak-google
A binding goes, and its Kubernetes Secret with it
Examples¶
init¶
Install core and the internal developer platform profile.
nereus init \
--profile internal-developer-platform
✓ reef secrets 0.0s core/reefs/secrets 0.1.0 created (secrets.getnereus.dev/v1alpha1: secrets, secretbindings, vaults)
✓ nereid openbao 21.5s core/nereids/openbao created, Ready
✓ mandate default 0.0s core/mandates/default created (reef: secrets, nereid: openbao, default)
✓ public key 5.0s rsa-4096, SHA256:yJi61pETATOGjDo6b6B2y5+V8jiPPDruqOUYp2CtPFs, version 1
✓ vault default 0.1s secrets/vaults/default created (mandate: default)
create¶
Two keys, each from an environment variable.
nereus secrets create google-oauth \
--from-env GOOGLE_CLIENT_ID \
--from-env GOOGLE_CLIENT_SECRET
✓ secrets/vaults/default/secrets/google-oauth created (key SHA256:GQ8TrJ9h6ZrNYHItBycWK+tXkURjowfJWcjEyabRIKI)
Stored encrypted; a Kubernetes Secret is made only when a binding asks for it (#532).
Next steps:
nereus secrets get default/google-oauth
create-exists¶
Create it again.
nereus secrets create google-oauth \
--from-env GOOGLE_CLIENT_ID
✗ secrets/vaults/default/secrets/google-oauth already exists. To change it, write it as a file, then apply the file:
nereus secrets create google-oauth --from-env GOOGLE_CLIENT_ID --dry-run --output yaml > google-oauth.yaml
nereus secrets apply --from-file google-oauth.yaml
create-file¶
A private key from a file, and an id from the environment.
nereus secrets create github-app \
--vault default \
--from-file private-key=key.pem \
--from-env APP_ID
✓ secrets/vaults/default/secrets/github-app created (key SHA256:GQ8TrJ9h6ZrNYHItBycWK+tXkURjowfJWcjEyabRIKI)
Stored encrypted; a Kubernetes Secret is made only when a binding asks for it (#532).
Next steps:
nereus secrets get default/github-app
apply¶
Apply the folder.
nereus secrets apply \
--from-file secrets
✓ secrets/vaults/default/secrets/github-app configured
✓ secrets/vaults/default/secrets/google-oauth configured
Next steps:
nereus secrets list
list¶
Every secret.
nereus secrets list
VAULT NAME KEYS STATUS AGE
default github-app APP_ID, +1 Ready 4s
default google-oauth GOOGLE_CLIENT_ID, +1 Ready 5s
get¶
One secret.
nereus secrets get default/google-oauth
Vault default
Name google-oauth
Keys GOOGLE_CLIENT_ID
GOOGLE_CLIENT_SECRET
Version 2
Location openbao: secret/nereus/default/google-oauth
Bindings -
Status Ready
Age 10s
get-yaml¶
The object, without its values.
nereus secrets get google-oauth \
--output yaml
apiVersion: secrets.getnereus.dev/v1alpha1
kind: Secret
metadata:
name: default.google-oauth
namespace: nereus-system
spec:
vault: default
keys:
- GOOGLE_CLIENT_ID
- GOOGLE_CLIENT_SECRET
status:
location: 'openbao: secret/nereus/default/google-oauth'
mandate: default
nereid: openbao
phase: Ready
version: '2'
vault-list¶
Every vault.
nereus secrets vault list
NAME NEREID NAMESPACES SECRETS STATUS AGE
default openbao nereus-system 2 Ready 4m
vault-create¶
A vault the identity and tools namespaces may bind.
nereus secrets vault create team-a \
--allow-namespace identity \
--allow-namespace tools
✓ secrets/vaults/team-a created
Next steps:
nereus secrets create <secret> --vault team-a --from-env <VAR>
vault-delete-held¶
The vault default still holds two secrets.
nereus secrets vault delete default
✗ secrets/vaults/default holds secrets github-app, google-oauth. Delete them first:
nereus secrets delete default/github-app
nereus secrets delete default/google-oauth
delete¶
By vault and name.
nereus secrets delete default/google-oauth
✓ secrets/vaults/default/secrets/google-oauth deleted
Next steps:
nereus secrets list
vault-delete¶
Delete the vault team-a.
nereus secrets vault delete team-a
✓ secrets/vaults/team-a deleted
Next steps:
nereus secrets vault list
binding-create¶
Keycloak, in the namespace identity, reads the Google client under its own key names.
nereus secrets binding create keycloak-google \
--secret default/google-oauth \
--namespace identity \
--key client-id=GOOGLE_CLIENT_ID \
--key client-secret=GOOGLE_CLIENT_SECRET
✓ secrets/vaults/default/secrets/google-oauth/secretbindings/identity/keycloak-google created
Secret keycloak-google ready in namespace identity.
Next steps:
nereus secrets binding get keycloak-google --namespace identity
binding-refused¶
The vault default does not allow the namespace payments.
nereus secrets binding create payments \
--secret default/google-oauth \
--namespace payments
✗ secrets/vaults/default does not allow namespace payments (it allows: nereus-system, identity, tools).
Allow it: write the vault as a file, add payments to spec.allowedNamespaces, then apply the file:
nereus secrets vault get default --output yaml > default.yaml
nereus secrets vault apply --from-file default.yaml
binding-chart¶
The template of test/charts/binding-demo.
cat test/charts/binding-demo/templates/secretbinding.yaml
apiVersion: {{ .Values.apiGroup }}/v1alpha1
kind: SecretBinding
metadata:
name: {{ .Release.Name }}
namespace: {{ .Release.Namespace }}
labels:
{{- include "binding-demo.labels" . | nindent 4 }}
spec:
secret: {{ required "secret is <vault>/<secret>" .Values.secret | quote }}
binding-list¶
In every namespace.
nereus secrets binding list
NAME SECRET NAMESPACE FOR STATUS AGE
keycloak-google default/google-oauth identity system:admin Ready 12s
binding-demo default/google-oauth tools chart binding-demo Ready 4s
binding-used¶
The secret lists its bindings.
nereus secrets get default/google-oauth
Vault default
Name google-oauth
Keys GOOGLE_CLIENT_ID
GOOGLE_CLIENT_SECRET
Version 2
Location openbao: secret/nereus/default/google-oauth
Bindings identity/keycloak-google by system:admin Ready
tools/binding-demo by chart binding-demo Ready
Status Ready
Age 30s
binding-delete¶
The binding keycloak-google.
nereus secrets binding delete keycloak-google \
--namespace identity
✓ secrets/vaults/default/secrets/google-oauth/secretbindings/identity/keycloak-google deleted
Next steps:
nereus secrets binding list --namespace identity