Helm values
This page applies to the Enterprise plan, where you run the data plane in your own VPC. It covers how to apply configuration, the values to change for every install, the values you’re most likely to set, how environment variables are layered, and the hardening defaults that are already on. The chart’s own values.yaml has the full list, including advanced pod and container settings. The chart doesn’t support nodeSelector, affinity, or tolerations for gateway pods. Setting them fails the install.
Applying configuration
Keep your overrides in a values file in version control, and pass it on every install and upgrade:
You can also set a single value with --set, for example --set env.vars.LOG_LEVEL=debug. Helm doesn’t remember --set flags from a previous release, so a value set this way is lost on the next upgrade unless you repeat it. Prefer the values file for anything you want to keep.
The chart ships a values schema that checks the types of its core values, so a mistake such as a string where a boolean belongs fails when Helm renders the chart, before anything is deployed. It doesn’t reject keys it doesn’t know.
Retarget checklist
The chart’s defaults for your environment are placeholders. Before you install, set:
-
image.repositoryandimage.tag: your mirrored image and the tag Postman gives you. Addimage.imagePullSecretsif the registry is private. -
secrets.app.existingSecret: the name of the app Secret you created. Set it explicitly, even if you use the default name. -
syncCA.pem: the control plane CA certificate, unless you create thefabric-dp-sync-caSecret instead. -
attestation.enabled:trueif you enroll with workload attestation. -
env.vars.FABRIC_GW_TENANT_ID: your tenant ID. An empty value stops the data plane from starting. -
env.vars.FABRIC_GW_CP_ADDRESS: the control plane’s sync address. -
env.vars.FABRIC_GW_MYSQL_HOST,FABRIC_GW_MYSQL_USER, andFABRIC_GW_MYSQL_DATABASE: your MySQL, with the MySQL secret store. -
env.vars.FABRIC_GW_ADMIN_EXTERNAL_URLandFABRIC_GW_BROKER_EXTERNAL_URL: the external URL clients use. See Expose the gateway. -
otel.clickhouse.*, or another telemetry setup: the default ClickHouse endpoint is an example host. See OpenTelemetry. -
env.vars.FABRIC_GW_SSRF_BLOCK_PRIVATE_UPSTREAMS(optional):"true"to stop routes from reaching upstreams on private addresses. See Calls to private hosts. -
env.vars.OTEL_SERVICE_NAMEandOTEL_RESOURCE_ATTRIBUTES(optional): the service and environment labels on your telemetry. -
accountId,roleName, andiam.*(AWS only): leave them blank andiam.enabledoff unless you use an IAM role for the gateway’s ServiceAccount.roleNamebecomes the role ARNarn:aws:iam::<accountId>:role/auto-<roleName>. To use an existing role with any other name, leaveroleNameblank and set the annotation yourself:
Required values
Image
Secrets
For the keys the app Secret holds, see Secrets and keys.
Enrollment
See Connect to the control plane.
Gateway environment
The gateway is configured through environment variables under env.vars. The chart renders them into a ConfigMap. Helm merges maps, so you only need to list the variables you change.
The node ID isn’t set, so each pod uses its hostname and enrolls as its own node.
Shared rate limiting
By default, each gateway pod keeps its own rate-limit counters. To share counters across pods, run a Redis and set:
Environment variables
Every container the chart renders can take your own environment variables, except the OPA sidecar: the gateway, the collector sidecar, the embedder, and the migration Job.
Layers apply in this order, and a later layer replaces an earlier variable of the same name: the chart’s built-in variables and env.vars, then global.env, then extraEnv or sidecarEnv. So global.env overrides env.vars for the gateway. If a gateway value must not be overridden, don’t also set it in global.env.
A value in the app Secret overrides the same name in env.vars, but global.env overrides both, because it’s set directly on the container. Put secret values such as OTEL_EXPORTER_OTLP_HEADERS in the Secret.
Service
Scale and availability
The gateway’s liveness, readiness, and startup probes are pinned to /healthz on port 8080 (container.probes.*). Don’t reset them to the template defaults, because those paths return 404 and the pod is killed. Each pod also waits 60 seconds in a preStop hook and has a 100-second termination grace period (terminationGracePeriodSeconds), so a rollout or node drain takes about a minute or more per pod.
With an autoscaler on, each helm upgrade sets the gateway back to replicaCount replicas until the autoscaler scales it again. Run upgrades when traffic is low, or set replicaCount close to your usual replica count.
For guidance, see Scale and high availability.
Distributed secret store
These values apply when distributed.enabled is true. The chart then runs the gateway as a StatefulSet, adds a headless Service, and skips the migration Job.
Service account
Database migrations
See Database migrations.
Telemetry
For backends and overlays, see OpenTelemetry.
Embedder
The embedder powers MCP tool search.
For running the embedder offline or with a persistent cache, see Embedder.
Feature toggles
Every toggle below is off by default, except migrations.enabled and otelCollector.enabled. With all of them off, the chart renders a plain Kubernetes install with static replicas and no CRDs.
Turning on opa.enabled keeps gateway pods from becoming ready. The OPA sidecar listens only on loopback, so its readiness check fails, and the pods stay at READY 2/3 with no traffic. Don’t turn it on until the chart is fixed. Until then, the access-control, validator, and transformer policy plugins can’t run on this data plane.
With distributed.enabled, the chart’s NetworkPolicy allows only ports 3320 and 3322 into gateway pods. On a cluster that enforces NetworkPolicy, it also blocks client traffic to port 8080. Add a rule for 8080 to your values file:
Production-hardening defaults
These are on by default. Keep them on.
- Pod security. Gateway and embedder pods run as non-root with the
RuntimeDefaultseccomp profile. The gateway and embedder containers drop all Linux capabilities, disallow privilege escalation, and use a read-only root filesystem. The collector sidecar and the schema migration Job don’t set these restrictions, so they don’t meet the KubernetesrestrictedPod Security Standard. Use thebaselinelevel for the data plane’s namespace. Writable state lives only in mounted volumes:/data/cachefor the gateway, and/dataand/tmpfor the embedder. - Fail-closed startup.
FABRIC_GW_PRODUCTION_MODEis"true", so a data plane without a usable encryption key refuses to start. - Pinned images. The gateway image uses an explicit tag, never
latest. Setimage.digestandembedder.image.digestto pin by digest. The migration image,flyway/flyway:10, uses a tag that moves with each Flyway 10 release. To pin it, setmigrations.imageto a full version tag or toflyway/flyway@sha256:<digest>. - Limited trace data. Tracing samples 10% of traces, and message content capture is off. Raise either only after you review the cost and data-handling impact.
- Disruption budgets. PodDisruptionBudgets keep at least one gateway pod and one embedder pod available during node drains.
If you build your own gateway image on a base whose user isn’t numeric, the kubelet can’t verify that it runs as non-root and refuses to start it. Set podSecurityContext.runAsUser to the numeric user ID your image runs as. Postman’s image doesn’t need this.
Next steps
- To use these values in an install, see Install with Helm.
- To create the Secret these values reference, see Secrets and keys.
- For telemetry options, see Monitor the data plane.
- To run the distributed store, see Scale and run a highly available data plane.

