Ferriskey
discoverkubernetesmodules

FerrisKey Operator

The FerrisKey Operator manages FerrisKey instances declaratively through a Kubernetes Custom Resource Definition (CRD). Define your desired state in a FerrisKeyCluster manifest and the operator handles the rest.

FerrisKeyCluster CRD

The operator introduces the FerrisKeyCluster resource (API version ferriskey.rs/v1alpha1):

apiVersion: ferriskey.rs/v1alpha1
kind: FerrisKeyCluster
metadata:
  name: my-ferriskey
  namespace: ferriskey
spec:
  name: my-ferriskey
  replicas: 3
  version: "latest"
  api:
    apiUrl: "https://api.iam.yourorg.com"
    webappUrl: "https://iam.yourorg.com"
    allowedOrigins:
      - "https://iam.yourorg.com"
  database:
    secretRef:
      name: ferriskey-db-credentials
      namespace: ferriskey
    databaseName: ferriskey
    sslMode: require

Spec Reference

Root

FieldTypeDescription
namestringCluster name
replicasintegerNumber of API pod replicas
versionstringFerrisKey version to deploy

API Configuration (spec.api)

FieldTypeDescription
apiUrlstringPublic URL of the FerrisKey API
webappUrlstringPublic URL of the web UI
allowedOriginsstring[]Allowed CORS origins

Database Configuration (spec.database)

FieldTypeDescription
secretRef.namestringKubernetes Secret containing database credentials
secretRef.namespacestringSecret namespace (optional, defaults to resource namespace)
databaseNamestringDatabase name override
sslModestringPostgreSQL SSL mode (disable, require, verify-ca, verify-full)

Database Secret format

The referenced Secret should contain the standard PostgreSQL connection fields: host, port, user, password, and optionally database.

Status

The operator reports cluster status through the status subresource:

status:
  ready: true
  phase: Running
  databaseStatus:
    connected: true
    host: "postgres.database.svc.cluster.local"
    database: "ferriskey"
    lastCheck: "2026-03-17T10:30:00Z"
  conditions:
    - conditionType: Ready
      status: "True"
      lastTransitionTime: "2026-03-17T10:25:00Z"
    - conditionType: DatabaseConnected
      status: "True"
      lastTransitionTime: "2026-03-17T10:24:00Z"
FieldDescription
readyOverall cluster readiness
phaseCurrent phase (Pending, Running, Failed)
messageHuman-readable status message
databaseStatusDatabase connectivity information
conditionsStandard Kubernetes conditions

Deploying

Install the operator 

kubectl apply -f https://github.com/ferriskey/ferriskey/releases/latest/download/operator.yaml

Create a database secret 

kubectl create secret generic ferriskey-db-credentials \
  --namespace ferriskey \
  --from-literal=host=postgres.database.svc.cluster.local \
  --from-literal=port=5432 \
  --from-literal=user=ferriskey \
  --from-literal=password=your-db-password

Apply the FerrisKeyCluster manifest 

kubectl apply -f ferriskey-cluster.yaml

Check status 

kubectl get ferriskeyclusters -n ferriskey