children

Overview ¶

pkg/children/builtins.go

Single authoritative registry for every Kubernetes built-in resource kind Orkestra knows about. Adding one entry here is the only change required to:

• Resolve GVR for children and GVR lookups
• Generate RBAC rules (ClusterRole) for any katalog that uses the resource
• Detect usage in onReconcile / onCreate / onDelete template blocks
• Expand kind shorthands (e.g. "hpa" → "horizontalpodautoscaler")
• Derive the canonical PascalCase Kind name
• Drive readiness and deletion-protection logic

Keys are lowercase singular Kind names (e.g. "deployment", "namespace"). Accessor functions live in builtins_accessors.go.

NOTE: If a new kind supports context enrichment, also add an entry to enrichmentMeta (in this same file) — it is intentionally a parallel map so enrichment concerns stay separate from Kubernetes API identity.

pkg/children/builtins_accessors.go

Accessor functions over the builtInRegistry defined in builtins.go. These are the public API for querying built-in kind metadata. To add a new built-in kind, edit builtins.go — not this file.

Package children reads and enriches child Kubernetes resources that are declared in a Katalog's operatorBox. It is the bridge between the template resolver (which holds the owner CR's fields) and the Kubernetes API (which holds the live state of every child resource).

The single entry point is ReadChildren. It:

1. Merges onCreate and onReconcile template declarations.
2. For each declared resource type, reads the live objects from Kubernetes.
3. Applies enrichment layers (pods, endpoints, warnings, PV).
4. Returns a structured map injected into the template resolver under "children".

File layout ¶

• children.go — this file; package doc and ReadChildren entry point
• read.go — readResourceGroup, firstValue, mergeTemplates
• names.go — name resolution (resolvedChildName, *Names helpers)
• foreach.go — forEach expansion for all built-in resource types
• foreach_customresources.go — forEach expansion for custom resources
• enrich_pods.go — _pods enrichment and pod summary building
• enrich_endpoints.go — _endpoints enrichment
• enrich_warnings.go — _warnings enrichment (workload + pod events)
• enrich_pvc.go — _pv enrichment for PersistentVolumeClaims
• enrich_pv.go — _pvc enrichment for PersistentVolumes
• enrich_replicasets.go — _owner for ReplicaSets; _replicaSets for Deployments
• enrich_cronjobs.go — _activeJobs, _lastJob, _lastSuccessfulJob for CronJobs
• enrich_statefulsets.go — _pvcs for StatefulSets
• enrich_storageclass.go — _storageClass for PersistentVolumeClaims
• enrich_service_pods.go — _backingPods for Services
• enrich_ingress.go — _loadBalancerIPs, _tlsSecrets for Ingresses
• enrich_node.go — _node for Pods
• enrich_hpa.go — _currentMetrics, _scaleTarget for HPAs

See docs/ for a progressive walkthrough of each layer.

pkg/children/foreach.go

forEach expansion — expands template sources with a forEach declaration into N resolved sources, one per element in the list field.

forEach works on every resource type. The expansion happens before the resource-specific run_*.go function is called — each run_*.go function receives an already-expanded slice and is unaware of forEach.

Expansion sequence in runTemplateReconcile:

deployments := ExpandForEachDeployments(resolver, t.Deployments)
runDeployments(ctx, kube, resolver, obj, deployments, update)

YAML:

onReconcile:
  deployments:
    - name: "{{ .metadata.name }}-{{ .item }}"
      image: "{{ .spec.image }}"
      forEach:
        field: spec.regions
        as: item

For CR with spec.regions: ["us-east-1", "eu-west-1"]: Produces two DeploymentTemplateSources:

{Name: "my-app-us-east-1", Image: "nginx:latest", ...}
{Name: "my-app-eu-west-1", Image: "nginx:latest", ...}

The expansion resolves ALL template expressions immediately — the returned slice contains static (non-template) values ready for the registry functions.

when: and anyOf: on forEach sources are evaluated per-item — each expanded source may pass or fail conditions independently.

pkg/children/gvr.go