Skip to content

The delivery reef

Every command that takes a Workload to an Environment, and says what runs.

Commands

Examples

reef-apply

The delivery reef's contract.

nereus reef apply delivery \
  --from-file ./reefs/delivery/
output
✓ core/reefs/delivery created (delivery.getnereus.dev/v1alpha1)

workload-deploy

A Workload of the catalog, in the dev Environment.

nereus workload deploy hello@dev \
  --image registry.example.com/hello:a1b2c3d
output
✓ delivery/deliveries/hello-dev created

Next steps:

  nereus delivery get hello-dev

deploy-refuses

A bare name could change target in silence when a second Environment appears.

nereus workload deploy hello \
  --image registry.example.com/hello:a1b2c3d
output
✗ deploy needs the target. To deploy hello, run:
  # to the dev Environment
  nereus workload deploy hello@dev --image registry.example.com/hello:a1b2c3d

deploy-build

The image of a Build that succeeded, never a tag that may move.

nereus workload deploy hello@dev \
  --build hello-a1b2c3d
output
✓ delivery/deliveries/hello-dev created

Next steps:

  nereus delivery get hello-dev

deploy-update

The same tag, pushed again: the unique name works too.

nereus workload deploy hello-dev \
  --image registry.example.com/hello:a1b2c3d
output
✓ delivery/deliveries/hello-dev configured

Next steps:

  nereus delivery get hello-dev

deploy-dry-run

Changes nothing; the digest comes from the Nereid, after the deploy.

nereus workload deploy hello@dev \
  --image registry.example.com/hello:a1b2c3d \
  --dry-run
output
delivery/deliveries/hello-dev would be created
  workload: hello
  environment: dev
  image: registry.example.com/hello:a1b2c3d

deploy-wait

A tag that does not exist fails after the Delivery is written.

nereus workload deploy hello@dev \
  --image registry.example.com/hello:does-not-exist \
  --wait
output
✓ delivery/deliveries/hello-dev configured
✗ delivery/deliveries/hello-dev not ready: The registry does not have the tag does-not-exist of the repository registry.example.com/hello. To fix it, run:
  # deploy a tag that exists
  nereus workload deploy hello@dev --image registry.example.com/hello:<tag>

workload-list

One row per Workload; DELIVERIES counts them, 0 means not deployed.

nereus workload list
output
WORKLOAD  OWNER          TYPE     AUDIENCE  DELIVERIES  STATUS
billing   Project/shop   service  programs  0           Ready
hello     Project/hello  service  people    2           Ready

Next steps:

  nereus delivery list

delivery-list

One row per Workload and Environment pair.

nereus delivery list
output
NAME         WORKLOAD  ENVIRONMENT  DIGEST         READY
hello-dev    hello     dev          sha256:9f2c1e  True
hello-stage  hello     stage        sha256:77ab40  True

delivery-get

The digest running, the namespace, and the previous digest.

nereus delivery get hello-dev
output
NAME       WORKLOAD  ENVIRONMENT  DIGEST         NAMESPACE  READY
hello-dev  hello     dev          sha256:9f2c1e  hello-dev  True

Previous digest: sha256:77ab40

Next steps:

  nereus workload logs hello-dev

workload-logs

Follow what the app prints.

nereus workload logs hello-dev \
  --follow
output
[::ffff:127.0.0.1]:53792: response:200

delivery-apply

Write it as a file, then apply the file.

nereus workload deploy hello@dev \
  --image registry.example.com/hello:a1b2c3d \
  --dry-run \
  --output yaml
output
apiVersion: delivery.getnereus.dev/v1alpha1
kind: Delivery
metadata:
  name: hello-dev

delivery-delete

The Workload stays in the catalog.

nereus delivery delete hello-dev
output
✓ delivery/deliveries/hello-dev deleted

Next steps:

  nereus workload list

template-render

The files of a new Workload, with Copier.

nereus template render python-service \
  --path ./hello \
  --param name=hello
output
✓ catalog/templates/python-service rendered at ./hello

Next steps:

  nereus catalog apply --from-file ./hello/catalog/