Skip to content

The release reef

Every command of the release reef: where a chart comes from, what it is, where it goes and the release itself.

Commands

Examples

apply-reef

Apply the release reef.

nereus reef apply release
output
✓ core/reefs/release 0.1.0 created (release.getnereus.dev/v1alpha1: releases, repositories, sources, targets)

Next steps:

  nereus release --help
  nereus nereid apply <nereid> --reef release

apply-reference

Apply the reference Nereid to the release reef.

nereus nereid apply reference-release \
  --reef release \
  --image localhost:5111/reference-release-controller:0.1.0
output
✓ core/nereids/reference-release created, Ready, pinned to sha256:b3c32d74194e: see 'nereus release --help'

Next steps:

  nereus nereid list

apply-flux

Apply the flux Nereid to the release reef.

nereus nereid apply flux \
  --reef release
output
✓ core/nereids/flux created, Ready, pinned to sha256:e8731e3fb833: see 'nereus release --help'
  flux/v2.9.6 created (source-controller, helm-controller in namespace flux-system)

Next steps:

  nereus mandate create flux --reef release --nereid flux --default

repository-create

A Helm repository over http.

nereus release repository create codecentric \
  --url https://codecentric.github.io/helm-charts \
  --type http
output
✓ release/repositories/codecentric created
NAME         TYPE  URL                                        READY
codecentric  http  https://codecentric.github.io/helm-charts  True

Next steps:

  nereus release source create <name> --repository codecentric --chart <chart> --version <version>

repository-apply

Apply the file.

nereus release repository apply \
  --from-file codecentric.yaml
output
release/repositories/codecentric unchanged

Next steps:

  nereus release repository list

repository-list

Every repository.

nereus release repository list
output
NAME         TYPE  URL                                        READY
codecentric  http  https://codecentric.github.io/helm-charts  True

repository-get

One repository.

nereus release repository get codecentric
output
NAME         TYPE  URL                                        READY
codecentric  http  https://codecentric.github.io/helm-charts  True

repository-delete

Delete the repository.

nereus release repository delete codecentric
output
✓ release/repositories/codecentric deleted

Next steps:

  nereus release repository list

source-create

The keycloakx chart at 7.0.1.

nereus release source create keycloak \
  --repository codecentric \
  --chart keycloakx \
  --version 7.0.1
output
✓ release/sources/keycloak created
NAME      REPOSITORY   CHART      VERSION  DIGEST  READY
keycloak  codecentric  keycloakx  7.0.1    -       True

Next steps:

  nereus release target create <name> --namespace <namespace>

source-apply

Apply the file.

nereus release source apply \
  --from-file keycloak.yaml
output
✓ release/sources/keycloak configured

Next steps:

  nereus release source list

source-list

Every source.

nereus release source list
output
NAME      REPOSITORY   CHART      VERSION  DIGEST  READY
keycloak  codecentric  keycloakx  7.0.2    -       True

source-get

One source.

nereus release source get keycloak
output
NAME      REPOSITORY   CHART      VERSION  DIGEST  READY
keycloak  codecentric  keycloakx  7.0.2    -       True

source-publish

An OCI repository whose push credential is a secret of the platform.

nereus release repository create ghcr \
  --type oci \
  --url oci://ghcr.io/getnereus/charts \
  --secret ghcr-push
output
✓ release/repositories/ghcr created
NAME  TYPE  URL                              READY
ghcr  oci   oci://ghcr.io/getnereus/charts   True

Next steps:

  nereus release source create <name> --repository ghcr --chart <chart> --version <version>

source-delete

A release still uses it.

nereus release source delete keycloak
output
✗ source keycloak is used by release keycloak-reference.
  Delete it first: nereus release delete keycloak-reference

target-create

The identity namespace of the dev environment.

nereus release target create dev-identity \
  --environment dev \
  --namespace identity
output
✓ release/targets/dev-identity created
NAME          ENVIRONMENT  NAMESPACE  READY
dev-identity  dev          identity   True

Next steps:

  nereus release create <name> --source <source> --target dev-identity

target-apply

Apply the file.

nereus release target apply \
  --from-file dev-identity.yaml
output
release/targets/dev-identity unchanged

Next steps:

  nereus release target list

target-list

Every target.

nereus release target list
output
NAME          ENVIRONMENT  NAMESPACE  READY
dev-identity  dev          identity   True

target-get

One target.

nereus release target get dev-identity
output
NAME          ENVIRONMENT  NAMESPACE  READY
dev-identity  dev          identity   True

target-delete

Delete the target.

nereus release target delete dev-identity
output
✓ release/targets/dev-identity deleted

Next steps:

  nereus release target list

release-create

Run keycloak in dev-identity.

nereus release create keycloak-reference \
  --source keycloak \
  --target dev-identity
output
✓ release/releases/keycloak-reference created (nereid: reference-release)

Next steps:

  nereus release get keycloak-reference --watch

release-create-values

Keycloak with its values, through the flux Mandate.

nereus release create keycloak \
  --source keycloak \
  --target dev-identity \
  --values-file keycloak-values.yaml \
  --mandate flux
output
✓ release/releases/keycloak created (nereid: flux)

Next steps:

  nereus release get keycloak --watch

release-create-secrets

Keycloak with a Secret in its namespace and one key in its values.

nereus release create keycloak \
  --source keycloak \
  --target dev-identity \
  --values-file keycloak-values.yaml \
  --mandate flux \
  --secret google-oauth \
  --secret-value nereus.googleClientId=google-oauth/GOOGLE_CLIENT_ID
output
✓ release/releases/keycloak created (nereid: flux)
  binding secrets/vaults/default/secrets/google-oauth/secretbindings/identity/keycloak
  binding secrets/vaults/default/secrets/google-oauth/secretbindings/nereus-system/keycloak-values-google-oauth

Next steps:

  nereus release get keycloak --watch

release-apply

Apply the folder: every kind of the reef, in order.

nereus release apply \
  --from-file release/
output
✓ release/releases/keycloak-reference created
NAME                SOURCE    TARGET        VERSION  NEREID             STATUS
keycloak-reference  keycloak  dev-identity  -        reference-release  Pending
keycloak-reference  keycloak  dev-identity  7.0.1    reference-release  Ready

Next steps:

  nereus release list

release-list

Every release.

nereus release list
output
NAME                SOURCE    TARGET        VERSION  NEREID             STATUS
keycloak-reference  keycloak  dev-identity  7.0.2    reference-release  Ready

release-get

One release.

nereus release get keycloak-reference
output
NAME                SOURCE    TARGET        VERSION  NEREID             STATUS
keycloak-reference  keycloak  dev-identity  7.0.2    reference-release  Ready

release-delete

See what would go.

nereus release delete keycloak-reference \
  --dry-run
output
release/releases/keycloak-reference would be deleted.
Nothing changed (--dry-run).

ingress-crds

The Gateway API CRDs v1.7.0, standard channel.

kubectl apply \
  --server-side \
  --filename https://github.com/kubernetes-sigs/gateway-api/releases/download/v1.7.0/standard-install.yaml
output
customresourcedefinition.apiextensions.k8s.io/backendtlspolicies.gateway.networking.k8s.io serverside-applied
customresourcedefinition.apiextensions.k8s.io/gatewayclasses.gateway.networking.k8s.io serverside-applied
customresourcedefinition.apiextensions.k8s.io/gateways.gateway.networking.k8s.io serverside-applied
customresourcedefinition.apiextensions.k8s.io/grpcroutes.gateway.networking.k8s.io serverside-applied
customresourcedefinition.apiextensions.k8s.io/httproutes.gateway.networking.k8s.io serverside-applied
customresourcedefinition.apiextensions.k8s.io/listenersets.gateway.networking.k8s.io serverside-applied
customresourcedefinition.apiextensions.k8s.io/referencegrants.gateway.networking.k8s.io serverside-applied
customresourcedefinition.apiextensions.k8s.io/tcproutes.gateway.networking.k8s.io serverside-applied
customresourcedefinition.apiextensions.k8s.io/tlsroutes.gateway.networking.k8s.io serverside-applied
customresourcedefinition.apiextensions.k8s.io/udproutes.gateway.networking.k8s.io serverside-applied
validatingadmissionpolicy.admissionregistration.k8s.io/safe-upgrades.gateway.networking.k8s.io serverside-applied
validatingadmissionpolicybinding.admissionregistration.k8s.io/safe-upgrades.gateway.networking.k8s.io serverside-applied

ingress-repository

Istio's Helm repository.

nereus release repository create istio \
  --url https://blob.istio.io/istio-release/charts \
  --type http
output
✓ release/repositories/istio created
NAME   TYPE  URL                                                  READY
istio  http  https://blob.istio.io/istio-release/charts  False

Next steps:

  nereus release source create <name> --repository istio --chart <chart> --version <version>

ingress-sources

The CRDs of Istio.

nereus release source create istio-base \
  --repository istio \
  --chart base \
  --version 1.30.4
output
✓ release/sources/istio-base created
NAME        REPOSITORY  CHART  VERSION  DIGEST  READY
istio-base  istio       base   1.30.4   -       True

Next steps:

  nereus release target create <name> --namespace <namespace>

ingress-sources-gateway

The ingress gateway.

nereus release source create istio-gateway \
  --repository istio \
  --chart gateway \
  --version 1.30.4
output
✓ release/sources/istio-gateway created
NAME           REPOSITORY  CHART    VERSION  DIGEST  READY
istio-gateway  istio       gateway  1.30.4   -       True

Next steps:

  nereus release target create <name> --namespace <namespace>

ingress-istio-base

Istio's CRDs, through the flux Mandate.

nereus release create istio-base \
  --source istio-base \
  --target istio-system \
  --mandate flux
output
✓ release/releases/istio-base created (nereid: flux)

Next steps:

  nereus release get istio-base --watch

ingress-istiod

The control plane, once istio-base is Ready.

nereus release create istiod \
  --source istiod \
  --target istio-system \
  --mandate flux
output
✓ release/releases/istiod created (nereid: flux)

Next steps:

  nereus release get istiod --watch

ingress-istio-gateway

The ingress gateway, once istiod is Ready.

nereus release create istio-gateway \
  --source istio-gateway \
  --target istio-system \
  --mandate flux
output
✓ release/releases/istio-gateway created (nereid: flux)

Next steps:

  nereus release get istio-gateway --watch

ingress-curl

The Gateway ingress: class istio, the gateway's Service, HTTP on port 80.

kubectl apply \
  --filename gateway.yaml
output
gateway.gateway.networking.k8s.io/ingress created