Katalog

1 min read

A Katalog declares one or more CRDs and defines how Orkestra manages them. It is the unit of operator definition.

Wire format

apiVersion: orkestra.orkspace.io/v1   # required
kind: Katalog                          # required

metadata:
  name: my-operator                    # required
  description: string                  # optional

spec:
  finalizers:                          # optional — applied to every CRD
    - platform.example.io/cleanup

  crds:                                # required — map of CRD entries by name
    <name>:                            # ← map key is the CRD name
      ...                              # → see crd-entry.md

security:                              # optional → see katalog-security.md
  ...

notification:                          # optional → see katalog-notification.md
  ...

providers:                             # optional → see katalog-providers.md
  - ...

metadata

FieldRequiredDescription
nameyesUnique identifier. Written as the managed-by annotation on all CRs.
descriptionnoShown in ork status and the /katalog API response.

spec.finalizers

Katalog-level finalizers applied to every CRD in this Katalog. Override per-CRD via operatorBox.finalizers.

spec.crds

A map — the key is the CRD name, the value is a CRDEntry.

spec:
  crds:
    database:          # ← CRD name
      enabled: true
      apiTypes:
        group: apps.example.io
        version: v1alpha1
        kind: Database
        plural: databases

→ Full field reference: crd-entry.md

See also