Job
This declares one Job to be run by Orkestra.
Most commonly used under onDelete for cleanup tasks that must complete before Orkestra removes finalizers from the CR:
- Draining queues or buffers
- Archiving state to external storage
- Notifying external systems of deletion
- Running database migrations before removing a CRD instance
Can also be used under onCreate for one-time provisioning tasks.
Example (cleanup on delete):
onDelete:
jobs:
- name: "{{ .metadata.name }}-cleanup"
image: busybox
command: ["sh", "-c", "echo cleaning up {{ .metadata.name }}"]
backoffLimit: 3
Lifecycle
Declare this resource under onCreate for an idempotent, one-time create: Orkestra creates it on the first reconcile and leaves it untouched afterward. Job entries are always a one-time create — reconcile: true and onReconcile have no effect. Job is also commonly declared under onDelete, for cleanup work that must complete before the CR’s finalizer is removed.
Fields
name
Type: string
Name — Job name. Default when omitted: “{{ .metadata.name }}-job”
image
Type: string
Image — container image. Required.
imagePullSecrets
Type: list
ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images used by this PodSpec. If specified, these secrets will be passed to individual puller implementations for them to use.
command
Type: list
Command — container entrypoint command. Each element is resolved independently — template expressions are supported per element. e.g. [“sh”, “-c”, “echo cleaning up {{ .metadata.name }}”]
args
Type: list
Args — arguments passed to the container command. Each element supports template expressions independently.
backoffLimit
Type: number
BackoffLimit — number of Pod restart attempts before the Job is marked Failed. Default: 3.
namespace
Type: string
Namespace — target namespace. Default when omitted: “{{ .metadata.namespace }}”
labels
Type: map
Labels — applied to Job metadata. Values support template expressions.
nodeSelector
Type: map
NodeSelector is a selector which must be true for the pod to fit on a node. Selector which must match a node’s labels for the pod to be scheduled on that node. More info: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/ +optional +mapType=atomic
serviceAccountName
Type: string
ServiceAccountName is the name of the ServiceAccount to use to run this pod. More info: https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/ +optional
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.
reconcile
Type: boolean
Reconcile has no effect on a Job entry. Jobs are always a one-time, idempotent create — Orkestra never re-applies or updates a Job after it runs, since Jobs are meant to run once to completion. This field exists for schema consistency with other resource types only.
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
workingDirectory
Type: string
WorkingDirectory sets the container’s working directory (container.WorkingDir). Useful for Git-backed pipelines where build/test commands must run inside a checked-out repository path.
resources
Type: object
Resources — CPU and memory requests/limits for the container. Set resources.profile for a named preset, or resources.requests/limits for explicit values. Profile and explicit values are mutually exclusive.
resources:
profile: burst
securityContext
Type: object
SecurityContext — container-level security settings. Set securityContext.profile for a named preset (baseline, restricted, hardened) or declare individual fields. Profile and explicit fields are mutually exclusive.
securityContext:
profile: restricted
podSecurity
Type: object
PodSecurity — pod-level security settings applied to the pod spec. Set podSecurity.profile for a named preset or declare individual fields.
podSecurity:
profile: baseline
volumes
Type: list
Volumes — pod volumes available for mounting into the container.
volumes:
- name: config
configMap:
name: myapp-config
volumeMounts
Type: list
VolumeMounts — mounts for the primary container.
volumeMounts:
- name: config
mountPath: /etc/myapp
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 key | Type |
|---|---|
name | string |
image | string |
imagePullSecrets | list |
command | list |
args | list |
backoffLimit | number |
namespace | string |
labels | map |
nodeSelector | map |
serviceAccountName | string |
when | list |
reconcile | boolean |
forEach | object |
anyOf | list |
workingDirectory | string |
resources | object |
securityContext | object |
podSecurity | object |
volumes | list |
volumeMounts | list |
sleep | string |