ConfigMap

3 min read

This declares one ConfigMap to be managed by Orkestra.

ConfigMap data values are static — template expressions are not evaluated in ConfigMap data entries. For dynamic configuration, use a custom Go hook.

Example:

onCreate:
  configMaps:
    - name: "{{ .metadata.name }}-config"
      data:
        LOG_LEVEL: info
        MAX_CONNECTIONS: "100"

Lifecycle

Declare this resource under onCreate for an idempotent, one-time create: Orkestra creates it on the first reconcile and leaves it untouched afterward. Set reconcile: true on the same entry to also apply it as drift correction on every subsequent reconcile. This is a shorthand for declaring the identical entry under onReconcile as well — there’s no need to do both.

Declare a resource under onDelete to run explicit cleanup before the CR’s finalizer is removed. Most resources need no onDelete entry — they are garbage-collected automatically through owner references when the CR itself is deleted.


Fields

name

Type: string

Name — ConfigMap name. Default when omitted: “{{ .metadata.name }}-config”


namespace

Type: string

Namespace — target namespace. Default when omitted: “{{ .metadata.namespace }}”


toNamespaces

Type: list

ToNamespaces - a list of target namespaces Default when omitted: “{{ .metadata.namespace }}”


data

Type: map

Data — static key-value configuration entries. Values are plain strings — template expressions are not supported here.


labels

Type: map

Labels — applied to ConfigMap metadata. Values support template expressions.


fromConfigMap

Type: string

FromConfigMap — name of an existing ConfigMap to copy data from. Orkestra reads this at reconcile time — copies stay in sync with the source.


fromNamespace

Type: string

FromNamespace — namespace where FromConfigMap lives. Default: same namespace as the CR.


reconcile

Type: boolean

Reconcile: true — also apply this declaration as drift correction on every reconcile. Equivalent to declaring the same entry under both onCreate and onReconcile. When false (default), only runs on onCreate (idempotent create).


when

Type: list

Conditions declares the set of runtime predicates that must all evaluate to true for this resource template to be applied during reconciliation.

Each condition inspects a field on the live Custom Resource using dot-notation (e.g. “spec.enabled”, “metadata.labels.tier”) and compares it against a value using the chosen operator. All conditions in the list are AND‑ed together.

If any condition fails, the resource is skipped for that reconcile cycle. This is not an error — it simply means “do not create/update this resource right now”. This enables expressive, data‑driven orchestration such as:

when:
  - field: spec.exposePublicly
    equals: "true"
  - field: spec.environment
    prefix: "prod"

Conditions allow templates to be selectively activated based on the CR’s state, enabling dynamic topologies, feature flags, environment‑specific behavior, and conditional provisioning without writing Go code.


forEach

Type: object

ForEach declares dynamic expansion over a list field. When set, one source declaration becomes N declarations — one per list element. .item and .<as> are available in template expressions within this declaration.


anyOf

Type: list

AnyOf holds OR conditions — at least one must pass for this resource to be created. Works alongside the existing Conditions (when:) field which uses AND semantics.


sleep

Type: string

Sleep injects an artificial delay into the reconcile of this resource. Useful for autoscale testing, latency simulation, and chaos engineering. Accepts extended duration units (s, m, h, d, w, mo, y).


Quick reference

YAML keyType
namestring
namespacestring
toNamespaceslist
datamap
labelsmap
fromConfigMapstring
fromNamespacestring
reconcileboolean
whenlist
forEachobject
anyOflist
sleepstring