Skip to content

CRD Reference ​

API group: operator.palena.aiVersion: v1alpha1

Authoritative field-level reference for every CRD the Palena Operator ships. These pages are hand-maintained against the Go types in api/v1alpha1/. Whenever a *_types.go file changes, the matching reference page should change too.

CRDs ​

CRDPurposePage
PalenaGatewayCNPG Cluster + Redis + LiteLLMInstanceReference
PalenaModelLiteLLMModel CRs per gatewayReference
PalenaUILibreChat + MongoDB + MeiliSearchReference
PalenaObservabilityLangfuse + ClickHouse + callback wiringReference
PalenaMCPServerwebsearch MCP + sidecarsReference

Shared types ​

All CRDs reuse a handful of cross-cutting types — SecretKeyRef, LocalObjectReference, ImageSpec, IngressSpec, OIDCSpec, and so on. They're documented on a single page to avoid repetition.

Versioning ​

The Palena API is currently v1alpha1. Breaking changes may occur between minor versions until the API graduates to v1beta1.

When new fields are added:

  1. They will be optional with a sensible default.
  2. The changelog describes the motivation and migration path.
  3. Deprecations are announced at least one minor release before removal.

Production deployments should pin to a specific bundle tag and test upgrades in a staging cluster first.

Reading these pages ​

Each CRD page follows the same structure:

  • Overview — what the CRD does and how it relates to the others.
  • spec — top-level fields with type, required, default, and description.
  • Nested types — sub-spec fields called out in dedicated sub-sections.
  • status — runtime state the controller writes back.
  • Print columns — what shows up in kubectl get.

Tables mark required fields with Yes. Enum fields list their accepted values in the description.

Released under the Apache 2.0 License. "Palena" is a trademark of bitkaio LLC.