status

kix status lists live Kix-managed resources with whether each is ready. The default view is one flat table. With --operator it reads the cluster’s Active Activation record and groups resources by package.

This page is hand-maintained. Check cli/kix-cli/src/cli.rs and cli/kix-cli/src/commands/status.rs when in doubt.

Synopsis

kix status <CLUSTER> [--operator] [-o text|json|yaml]
           [--flake <FLAKE>] [--context <CONTEXT>] [--no-cache]

Argument or flag	Meaning
<CLUSTER>	Cluster name. The flat view evaluates it from the flake first; --operator uses existing Activation records when any carry <CLUSTER>, and otherwise evaluates the cluster name from the flake.
--operator	Package-grouped view built from the Active Activation record.
-o, --output	text (default), json, or yaml. markdown prints text.
--flake, --override-input	Select and evaluate the cluster in the flat view, or resolve <CLUSTER> with --operator when no Activation record in the context carries <CLUSTER>.
--no-cache	Bypass the eval cache in the flat view. Ignored with --operator.
--context	Select the kubeconfig context in either view.

Flat view

A table with NAME, NAMESPACE, KIND, READY, STATUS, and AGE, sorted by namespace, kind, and name. It includes the resources of <CLUSTER>: those whose kix.run/activations annotation names one of its Activation records, including resources it shares with another Kix cluster. Resources of other Kix clusters on the same Kubernetes cluster are left out, and a line on stderr says how many per cluster.

STATUS is kind-specific:

Kind	STATUS
Deployment, StatefulSet	Ready replicas over desired replicas
DaemonSet	Ready pods over desired scheduled pods
Job	Complete, Running, or Pending
PersistentVolumeClaim	status.phase
Other	Ready or Available when that condition is True, otherwise Active

READY uses the same readiness rules as kix deploy.

--operator view

Prints the Active record’s name, phase, identity hash, and age, then one line per package with its resource count and healthy or N degraded. Packages with a resource that is not ready are expanded. A resource the build declares but the cluster lacks shows as NotFound.

The live resources are the same set the flat view shows.

Package grouping needs the Active record’s build in Kix’s local store. Without it every resource is listed under “Unowned resources”. When an Activation record in the context already carries <CLUSTER> as its kix.run/cluster label, the operator view does not evaluate the flake; otherwise it uses --flake and --override-input to evaluate the cluster name. --no-cache has no effect with --operator.

Examples

❱ kix status demo

❱ kix status demo --operator -o json

Exit status

0 when the report is printed, whatever the readiness of the resources. 1 on an evaluation or cluster error. Use kix health when a script needs a failing status.

Use it in a task

See Check resource status for reading the output.