Helm value reference
In this section, you can find reference documentation to help you customize the Helm values for various Gloo Platform components.
Gloo Platform Helm charts
In Gloo Platform version 2.3 and later, you can manage your installation by using the gloo-platform and gloo-platform-crds Helm charts. To learn how to update your installation values through these Helm charts, see the upgrade guide.
Gloo Platform
All Gloo Platform components are available in the gloo-platform Helm chart. You can see all possible fields for the Helm chart by running helm show values gloo-platform/gloo-platform --version v2.4.1 > all-values.yaml.
Configuration options for the gloo-platform Helm chart are organized into the following sections:
| Component section | Description |
|---|---|
| clickhouse | Configuration for the Clickhouse deployment, which stores logs from Gloo Platform Telemetry Collectors. See the Bitnami Clickhouse Helm chart for the complete set of values. |
| common | Common values shared across components. When applicable, these can be overridden in specific components. |
| demo | Demo-specific features that improve quick setups. Do not use in production. |
| experimental | Experimental features for Gloo Platform. Disabled by default. Do not use in production. |
| extAuthService | Configuration for the Gloo external authentication service. |
| glooAgent | Configuration for the Gloo agent. |
| glooMgmtServer | Configuration for the Gloo management server. |
| glooNetwork | Gloo Network configuration options. |
| glooPortalServer | Configuration for the Gloo Platform Portal server deployment. |
| glooSpireServer | Configuration for the Gloo Platform Spire server deployment. |
| glooUi | Configuration for the Gloo UI. |
| istioInstallations | Configuration for deploying managed Istio control plane and gateway installations by using the Istio lifecycle manager. |
| jaeger | Configuration for the Gloo Platform Jaeger instance. |
| legacyMetricsPipeline | Configuration for the legacy metrics pipeline, which is unsupported in Gloo Platform version 2.4 and later. |
| licensing | Gloo Platform product licenses. |
| postgresql | Configuration for Gloo Platform PostgreSQL instance. |
| prometheus | Helm values for configuring Prometheus. See the Prometheus Helm chart for the complete set of values. |
| rateLimiter | Configuration for the Gloo rate limiting service. |
| redis | Configuration for the default Redis instance. |
| sidecarAccel | Experimental: Configuration for eBPF sidecar acceleration. Do not use in production. |
| telemetryCollector | Configuration for the Gloo Platform Telemetry Collector. See the OpenTelemetry Helm chart for the complete set of values. |
| telemetryCollectorCustomization | Optional customization for the Gloo Platform Telemetry Collector. |
| telemetryGateway | Configuration for the Gloo Platform Telemetry Gateway. See the OpenTelemetry Helm chart for the complete set of values. |
| telemetryGatewayCustomization | Optional customization for the Gloo Platform Telemetry Gateway. |
Gloo Platform CRDs
All Gloo Platform CRDs are available in the gloo-platform-crds Helm chart.
To see the CRDs that this chart installs, check out the list of Gloo CRDs. Or, if you already installed the chart, you can run kubectl get crds -A | grep gloo.solo.io.
Legacy Gloo Helm charts
In Gloo Platform version 2.3 and later, the ‘gloo-mesh-enterpise’, ‘gloo-mesh-agent’, ‘gloo-mesh-managed-installations’, and other included Helm charts are considered legacy. If you installed Gloo Platform by using these legacy Helm charts, or if you used ‘meshctl’ version 2.2 or earlier to install Gloo Platform, migrate your legacy installation to the new ‘gloo-platform’ Helm chart.
The following table provides an overview of the legacy Gloo Helm chart components. You might want to modify some of these charts’ values for your Gloo setup.
| Helm chart | Component | Prefix | Description |
|---|---|---|---|
| gloo-mesh-enterprise | Management server | glooMeshMgmtServer | A component of the Gloo Platform chart to deploy the management server on the management cluster. |
| gloo-mesh-enterprise | UI | glooMeshUi | A component of the Gloo Platform chart to render the UI that you can launch with the meshctl dashboard command. |
| gloo-mesh-enterprise | Redis | glooMeshRedis | An optional component of the Gloo Platform chart to store the ID tokens you use to log in to the UI. |
| gloo-mesh-agent | Agent | glooMeshAgent | The Gloo agent, deployed on each workload cluster. |
| gloo-mesh-managed-installations | Managed Istio installations | managedInstallations | An optional subchart for managed installations of Istio control planes and gateways in workload clusters. |
| ext-auth-service | External auth | ext-auth-service | An optional subchart of the enterprise server or agent Helm charts to configure the settings of the Gloo external auth service. |
| rate-limiter | Rate limiting | rate-limiter | An optional subchart of the enterprise server or agent Helm charts to configure the settings of the Gloo rate limiting service. |