The environment reef¶
Every command of the environment reef: an environment per agent, made by a Nereid, gone at its expiry.
Commands¶
nereus reef apply environment
The environment reef, the vcluster Nereid and its default Mandatenereus environment create a
An environment of its own, for an hournereus mandate create heavy
A bigger environment, for Nereus itselfnereus environment list
Two agents, two environments, and the time each one has leftnereus environment kubeconfig a > a.kubeconfig
Its kubeconfig, read with your own credentialsnereus environment delete a
Deleting it removes the vcluster, then its namespacenereus environment create c
At its expiry, its Nereid removes it by itselfnereus environment create naxos
The kept cluster is the environment naxos, made through its own Mandate
Examples¶
setup¶
The vcluster Nereid requires the release reef: it asks it for the vcluster chart.
nereus reef apply environment
output
✓ core/reefs/environment 0.1.0 created (environment.getnereus.dev/v1alpha1: environments)
Next steps:
nereus environment --help
nereus nereid apply <nereid> --reef environment
create¶
Who it is for, and for how long.
nereus environment create a \
--owner project/nereus \
--expires 1h
output
✓ environment/environments/a created (mandate: vcluster, nereid: vcluster)
Next steps:
nereus environment get a --watch
nereus environment kubeconfig a
size¶
A Mandate whose Environments are of size platform.
nereus mandate create heavy \
--reef environment \
--nereid vcluster \
--param size=platform
output
✓ core/mandates/heavy created (reef: environment, nereid: vcluster)
Next steps:
nereus mandate list
list¶
Its Nereid, its state, and when it goes.
nereus environment list
output
ENVIRONMENT OWNER NEREID STATUS SIZE EXPIRES
a Project/nereus vcluster Ready small 58m
b Project/nereus vcluster Ready small 58m
kubeconfig¶
kubectl get namespaces \
--kubeconfig a.kubeconfig
output
NAME STATUS AGE
default Active 42s
kube-node-lease Active 42s
kube-public Active 42s
kube-system Active 42s
delete¶
Waits until its Nereid removed what it made.
nereus environment delete a
output
2026-10-30T19:40:35Z … release Deleting release/releases/env-a: Flux uninstalls the vcluster chart.
2026-10-30T19:40:36Z · namespace Deleting the namespace env-vcluster-a.
2026-10-30T19:40:56Z ✓ release release/releases/env-a deleted.
2026-10-30T19:40:56Z … namespace Deleting the namespace env-vcluster-a.
✓ environment/environments/a deleted
Next steps:
nereus environment list
expires¶
An environment for one minute.
nereus environment create c \
--owner project/nereus \
--expires 1m
output
✓ environment/environments/c created (mandate: vcluster, nereid: vcluster)
Next steps:
nereus environment get c --watch
nereus environment kubeconfig c
naxos¶
The CLI's first setup registers the kept k3d cluster; vcluster stays the default.
nereus environment create naxos \
--owner project/nereus \
--mandate local
output
✓ environment/environments/naxos created (mandate: local, nereid: k3d)
Next steps:
nereus environment get naxos --watch