Skip to content
kix /docs
Install the CLI

Reference Annotations and CRDs

kix.run/expects

Lists objects that must exist before Kix applies the annotated resource.

Kix generates kix.run/expects when a resource contains an untracked reference that names the expected object’s kind:

secretName = kix.untrackedRef {
  apiVersion = "v1";
  kind = "Secret";
  name = "admission-cert";
  by = self.certJob;
};

The annotation contains comma-separated apiVersion|kind|name entries:

kix.run/expects: v1|Secret|admission-cert

Before applying the annotated resource, kix deploy waits up to 180 seconds for every listed object to exist. Namespaced kinds are looked up in the referring resource’s namespace. Cluster-scoped kinds are looked up at cluster scope. This is an existence check, not a readiness check for the expected object.

The kind attribute creates the expectation. The optional by attribute also adds the creator resource to deploy ordering, so Kix waits for that resource to become ready before checking for the object it creates. Without by, Kix can still wait for an object supplied independently of this deploy.

The string form, kix.untrackedRef "name", generates no expectation. A reference with by = "self" also generates none because the referring resource must start before it can create the object.

Prefer kix.untrackedRef over writing this annotation directly. Malformed annotation entries are ignored by the deploy client.

See facts and untrackedRef for all supported forms and their ordering behavior.