Skip to content

API Reference

All CRDs are in the glitchtip.ruck.io/v1alpha1 API group. Field-by-field tables live on each kind's user guide page:

The full generated OpenAPI schema is checked into the chart at charts/glitchtip-operator/crds/glitchtip.ruck.io.yaml — that's the authoritative source; the tables here are a human-readable summary of it. Print it locally with:

cargo run --bin crdgen

Shared types

These appear across multiple CRDs' specs.

ObjectRef

Reference to another CR. namespace defaults to the referencing object's own namespace when unset.

Field Type Required
name string yes
namespace string no

SecretKeyRef

Reference to a key within a Secret in the same namespace.

Field Type Required
name string yes
key string yes

DeletionPolicy

Either Delete (remove the GlitchTip-side object via the API when the CR is deleted) or Retain (release the CR without touching GlitchTip). Defaults vary by kind — Retain for GlitchTip.spec.database, Delete for organizations/teams/projects.

Status conditions

Every kind exposes a standard status.conditions[] (metav1 Condition) list with at least a Ready type; some kinds add intermediate conditions (DatabaseReady, MigrationsComplete, BootstrapComplete on GlitchTip). status.observedGeneration lets you tell whether a condition reflects the CR's current spec or a stale one. See each kind's page for its specific conditions and reasons.

Printer columns

kubectl get output for each kind surfaces the fields you'll want most often — e.g. gt shows Domain/Ready, gtorg/gtteam/gtproj show Slug/Ready. Use -o wide or -o yaml for everything else.