Skip to content

The secrets reef

Every command of the secrets reef: vaults, and the secrets in them, encrypted before they leave the machine.

Commands

Examples

init

Install core and the internal developer platform profile.

nereus init \
  --profile internal-developer-platform
output
✓ 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
output
✓ 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
output
✗ 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
output
✓ 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
output
✓ 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
output
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
output
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
output
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
output
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
output
✓ 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
output
✗ 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
output
✓ 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
output
✓ 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
output
✓ 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
output
✗ 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
output
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
output
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
output
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
output
✓ secrets/vaults/default/secrets/google-oauth/secretbindings/identity/keycloak-google deleted

Next steps:

  nereus secrets binding list --namespace identity