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¶
nereus reef apply release
One command applies the release reef, with its four kindsnereus nereid apply reference-release
The reference-release Nereid answers every kind with no tool, through the reference Mandatenereus nereid apply flux
The flux Nereid installs Flux and becomes the default through its Mandatenereus release repository create codecentric
A repository says where the charts come fromnereus release repository create codecentric
Apply takes a file, and applying what already holds changes nothingnereus release repository list
The list shows every repository and whether it is readynereus release repository get codecentric
One repository, by its namenereus release repository delete codecentric
A repository goes once no source names itnereus release source create keycloak
A source is one chart of a repository, at one versionnereus release source create keycloak
A new version is one file awaynereus release source list
The list shows every source with its chart and versionnereus release source get keycloak
One source, by its namenereus release repository create ghcr
Publishing goes through the platform, with its credential, never yoursnereus release source delete keycloak
A source in use is refused, with what to delete firstnereus release target create dev-identity
A target is a namespace, of an environment or of the cluster Nereus runs innereus release target create dev-identity
Applying the same target again changes nothingnereus release target list
The list shows every target with its environment and namespacenereus release target get dev-identity
One target, by its namenereus release target delete dev-identity
A target goes once no release names itnereus release create keycloak-reference
A release runs a source in a target, through the reef's default Mandatenereus release create keycloak
Values and a Mandate of your choice, with Flux installing the chartnereus release create keycloak
A release asks for its secrets by name, and its values never pass through Nereusnereus release create keycloak-reference
One folder holds the whole release, and the second apply changes nothingnereus release list
The list shows every release, its version and the Nereid behind itnereus release get keycloak-reference
One release, by its namenereus release delete keycloak-reference
Deleting a release uninstalls its chartkubectl apply
The Gateway API CRDs come first, applied by hand for nownereus release repository create istio
Istio's charts come from its own Helm repositorynereus release source create istio-base
Three charts at one pinned version: base and istiod firstnereus release source create istio-gateway
Three charts at one pinned version: then the gateway, into istio-systemnereus release create istio-base
Each chart starts once the previous one is Ready: base firstnereus release create istiod
Then istiod, the control planenereus release create istio-gateway
Last, the ingress gateway, with no values of its ownkubectl apply
A Gateway opens Envoy's listener, and with no route it answers 404
Examples¶
apply-reef¶
Apply the release reef.
nereus reef apply release
✓ 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
✓ 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
✓ 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
✓ 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
release/repositories/codecentric unchanged
Next steps:
nereus release repository list
repository-list¶
Every repository.
nereus release repository list
NAME TYPE URL READY
codecentric http https://codecentric.github.io/helm-charts True
repository-get¶
One repository.
nereus release repository get codecentric
NAME TYPE URL READY
codecentric http https://codecentric.github.io/helm-charts True
repository-delete¶
Delete the repository.
nereus release repository delete codecentric
✓ 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
✓ 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
✓ release/sources/keycloak configured
Next steps:
nereus release source list
source-list¶
Every source.
nereus release source list
NAME REPOSITORY CHART VERSION DIGEST READY
keycloak codecentric keycloakx 7.0.2 - True
source-get¶
One source.
nereus release source get keycloak
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
✓ 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
✗ 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
✓ 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
release/targets/dev-identity unchanged
Next steps:
nereus release target list
target-list¶
Every target.
nereus release target list
NAME ENVIRONMENT NAMESPACE READY
dev-identity dev identity True
target-get¶
One target.
nereus release target get dev-identity
NAME ENVIRONMENT NAMESPACE READY
dev-identity dev identity True
target-delete¶
Delete the target.
nereus release target delete dev-identity
✓ 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
✓ 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
✓ 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
✓ 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/
✓ 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
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
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
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
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
✓ 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
✓ 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
✓ 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
✓ 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
✓ 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
✓ 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
gateway.gateway.networking.k8s.io/ingress created