Service

This declares one Service to be managed by Orkestra.

Example:

onCreate:
  services:
    - name: "{{ .metadata.name }}-svc"
      type: ClusterIP
      port: "80"
      targetPort: "8080"
      namespace: "{{ .metadata.namespace }}"
      labels:
        app: "{{ .metadata.name }}"
      selector:
        app: "{{ .metadata.name }}"

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 — Service name. Default when omitted: “{{ .metadata.name }}-svc”

type

Type: string

Type — Kubernetes Service type. Accepted values: ClusterIP, NodePort, LoadBalancer. Default: ClusterIP.

headless

Type: boolean

Headless — when true, the Service is created without a clusterIP (clusterIP: None). Used primarily for StatefulSets to enable stable network identities and per‑pod DNS:

<podname>.<service>.<namespace>.svc.cluster.local

Set this to true when the Service is meant to back a StatefulSet or provide direct pod‑to‑pod addressing rather than load‑balanced traffic.

protocol

Type: string

Protocol defines network protocols supported for things like container ports. “TCP”, “UDP”, “SCTP”

port

Type: string

Port — Service port as a string. Static: “80” or Dynamic: “{{ .spec.servicePort }}”

targetPort

Type: string

TargetPort — container port the Service routes traffic to. Static: “8080” or Dynamic: “{{ .spec.containerPort }}”

namespace

Type: string

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

labels

Type: map

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

selector

Type: map

Selector filters which pods this service will route traffic to. Useful in forEach situations where the labels would likely be the same.

selector:
  app: "{{ .metadata.name }}"

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.

forEach:
  field: spec.regions
  as: region

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.

anyOf:
  - field: spec.tier
    equals: pro
  - field: spec.tier
    equals: enterprise

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