Deployment

The operator is distributed as a Helm chart and a Docker image hosted on ECR.

Installation

Add the Formal Helm repository:

helm repo add formal https://formalco.github.io/helm-charts

Install the operator:

helm install formal-kubernetes-operator formal/kubernetes-operator \
  --set formalAPIKey=<your-formal-api-key>

This will:

Parameter	Default	Description
`formalAPIKey`	`""`	Formal API key (required)
`image.tag`	`latest`	Docker image tag
`image.pullPolicy`	`Always`	Image pull policy
`replicaCount`	`1`	Number of operator replicas
`pullWithCredentials`	`false`	Set to `true` if using the `ecr-cred` chart to fetch ECR credentials
`resources`	See below	CPU/memory requests and limits
`metricsPort`	`8080`	Bind port for the metrics server

Default resource requests and limits:

resources:
  requests:
    cpu: 100m
    memory: 128Mi
  limits:
    cpu: 500m
    memory: 256Mi

If your cluster cannot pull from ECR directly, deploy the ecr-cred Helm chart first, then set pullWithCredentials=true:

helm install formal-kubernetes-operator formal/kubernetes-operator \
  --set formalAPIKey=<your-formal-api-key> \
  --set pullWithCredentials=true