This repository contains Helm Charts to deploy Formal on your Kubernetes cluster.
| Charts | Description |
|---|---|
| connector | Formal Connector base Helm chart. |
| data-discovery-satellite | Data Discovery Satellite Helm chart. |
| ai-satellite | AI Satellite Helm chart (requires NVIDIA GPU). |
| policy-data-loader-satellite | Policy Data Loader Satellite Helm chart. |
| kubernetes-operator | Formal Kubernetes Operator. Automatically registers in-cluster services as Formal resources. |
| kubernetes-egress | Inject Formal Endpoint as a sidecar. Requires Kubernetes 1.36+. |
| ecr-cred | ECR credentials job. Required when pulling Formal images from ECR outside AWS. Requires pullWithCredentials=true in workload chart values. |
| azure-gar-cred | GAR credentials job for AKS using Azure Workload Identity and GCP WIF. Requires pullWithCredentials=true in workload chart values. |
formal-common is a library chart with templates that
other charts share. You cannot install it. Published charts already contain it.
To install a chart from a checkout, run helm dependency build charts/<chart>
first.
On AKS, use GAR images with azure-gar-cred. Install the credential chart before Formal workload charts.
Use ecr-cred when pulling Formal ECR images outside AWS.
Never install both credential charts in the same namespace. Both manage
formal-ecr-secret.
To get started with the Formal Helm charts, first add the Formal Helm repository:
$ helm repo add formal https://formalco.github.io/helm-charts
"formal" has been added to your repositories
Next, retrieve the default values and save them to a local file for customization:
$ helm show values formal/connector > values.yaml
You can then edit values.yaml to fit your deployment needs. For the
Connector, you will need to update the API key and set at least one
port.
Finally, install the Connector chart using:
$ helm install formal-connector formal/connector -f values.yaml
The satellites can be installed similarly:
$ helm install formal-data-discovery-satellite formal/data-discovery-satellite -f values.yaml
$ helm install formal-ai-satellite formal/ai-satellite -f values.yaml
$ helm install formal-policy-data-loader-satellite formal/policy-data-loader-satellite -f values.yaml
Our team always welcomes any and all questions -- don't hesitate to reach out to a team member directly.