> [!CAUTION]
> You are currently viewing version 1.14 of the Apigee hybrid documentation. For more information, see [Supported versions](https://docs.cloud.google.com/apigee/docs/hybrid/supported-platforms.md.txt#supported-versions).

<button class="button button-with-icon cloud-select-dropdown__button button-primary" aria-haspopup="true">Version 1.14 </button>

- Supported versions:
- [v1.17 (latest)](https://docs.cloud.google.com/apigee/docs/hybrid/v1.17/config-prop-ref.md.txt)
- [v1.16](https://docs.cloud.google.com/apigee/docs/hybrid/v1.16/config-prop-ref.md.txt)
- [v1.15](https://docs.cloud.google.com/apigee/docs/hybrid/v1.15/config-prop-ref.md.txt)
- [v1.14](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt)
- [List of supported versions](https://docs.cloud.google.com/apigee/docs/hybrid/supported-platforms.md.txt#supported-versions)
- Unsupported versions:
- [v1.13](https://docs.cloud.google.com/apigee/docs/hybrid/v1.13/config-prop-ref.md.txt)
- [v1.12](https://docs.cloud.google.com/apigee/docs/hybrid/v1.12/config-prop-ref.md.txt)
- [v1.11](https://docs.cloud.google.com/apigee/docs/hybrid/v1.11/config-prop-ref.md.txt)
- [v1.10](https://docs.cloud.google.com/apigee/docs/hybrid/v1.10/config-prop-ref.md.txt)
- [v1.9](https://docs.cloud.google.com/apigee/docs/hybrid/v1.9/config-prop-ref.md.txt)
- [v1.8](https://docs.cloud.google.com/apigee/docs/hybrid/v1.8/config-prop-ref.md.txt)
- [v1.7](https://docs.cloud.google.com/apigee/docs/hybrid/v1.7/config-prop-ref.md.txt)
- [v1.6](https://docs.cloud.google.com/apigee/docs/hybrid/v1.6/config-prop-ref.md.txt)
- [v1.5](https://docs.cloud.google.com/apigee/docs/hybrid/v1.5/config-prop-ref.md.txt)
- [v1.4](https://docs.cloud.google.com/apigee/docs/hybrid/v1.4/config-prop-ref.md.txt)
- [v1.3](https://docs.cloud.google.com/apigee/docs/hybrid/v1.3/config-prop-ref.md.txt)
- [v1.2](https://docs.cloud.google.com/apigee/docs/hybrid/v1.2/config-prop-ref.md.txt)
- [v1.1](https://docs.cloud.google.com/apigee/docs/hybrid/v1.1/config-prop-ref.md.txt)

This section lists all of the configuration properties
that you can use to customize the runtime plane of your Apigee hybrid deployment.

> [!NOTE]
> **Note:** For instructions on how to add custom annotations, which are key/value maps used to attach metadata to Apigee hybrid Kubernetes pods, see [Custom annotations](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/customize-services.md.txt#custom-annotations).

#### About configuration properties

You can override many configuration properties, if needed, by
adding them to `HYBRID_ROOT_DIR/overrides.yaml`.

> [!IMPORTANT]
> **Tip:** Apigee provides a small set of sample configurations that you can use for further guidance. See [Sample overrides file](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/customize-services.md.txt#sample-override-configurations).

For example, to change the replica count minimum and maximum for
the MART service, you could add this stanza to `overrides.yaml`:

```
mart:
    replicaCountMin: 3
    replicaCountMax: 6
```

You can also find these config properties and their default
settings in `HYBRID_ROOT_INSTALL/1.0.0/values.yaml`

For more information, see [`Manage runtime plane components`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/customize-services.md.txt).

Additionally, if you are configuring a deployment outside Google Cloud see [Step 6: Create the overrides](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/install-create-overrides.md.txt) for information on setting these properties.

## Filter this page


To filter the properties displayed on this page, select **Basic**
(most common properties) or **Advanced** (properties that rarely need
changing):
**Display** All Basic Advanced **configuration properties on this page.**

> [!CAUTION]
> **Caution:** Do not change advanced properties without first testing them in lower environments and verifying them in the specific operating environment.

## Top-level properties

The following table describes the top-level properties in the `overrides.yaml` file. These are properties
that do not belong to another object, and apply at the org or environment level:

| Property | Type | Description |
|---|---|---|
| `axHashSalt` | Advanced | **Introduced in version:** 1.3.0 **Default value:** `iloveapis123` **Optional** The name of a [Kubernetes secret](https://kubernetes.io/docs/concepts/configuration/secret/) that contains a salt used when computing hashes to [obfuscate user data](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/obfuscate-userdata-for-analytics.md.txt) before it is sent to Apigee analytics. If you do not specify a salt value, `iloveapis123` is used by default. [Create the secret](https://kubernetes.io/docs/concepts/configuration/secret/#creating-a-secret-using-kubectl) with the salt value as its input. You can use the same salt across multiple clusters to ensure consistent hashing results between the clusters. Apigee uses SHA512 to hash the original value before sending data from the runtime plane to the control plane. See: [Obfuscate user data for analytics](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/obfuscate-userdata-for-analytics.md.txt). |
| `contractProvider` | Advanced | **Introduced in version:** 1.0.0 **Default value:** `https://apigee.googleapis.com` Defines the API path for all APIs in your installation. Required if your hybrid installation is using [Data residency](https://docs.cloud.google.com/apigee/docs/api-platform/get-started/drz-concepts.md.txt#drz-regions) in the following format: ``` contractProvider: https://CONTROL_PLANE_LOCATION-apigee.googleapis.com ``` Where <var translate="no">CONTROL_PLANE_LOCATION</var> is the location where control plane data like proxy bundles are stored. For a list see [Available Apigee API control plane regions](https://cloud.google.com/apigee/docs/locations#available-apigee-api-control-plane-regions). For example: ``` contractProvider: https://us-apigee.googleapis.com ``` |
| `customAutoscaling.enabled` | Basic | **Introduced in version:** 1.14.0 **Default value:** `true` Enables Apigee's [metric-based autoscaling](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/scale-and-autoscale.md.txt#metrics-scaling) when set to `true` (the default). Set to `false` to disable custom autoscaling. Apply changes to `customAutoscaling.enabled` by updating the `apigee-telemetry` chart. |
| `enhanceProxyLimits` | Advanced | **Introduced in version:** 1.14.0 **Default value:** `false` **Required** `enhanceProxyLimits` is required for Apigee's Enhanced per-environment proxy limits feature. Set this to `enhanceProxyLimits: true` if your hybrid organization is entitled for Enhanced per-environment proxy limits. > [!NOTE] > **Note:** This feature is available as part of the [2024 subscription plan](https://cloud.google.com/apigee/docs/api-platform/reference/subscription-entitlements#subscription-2024-entitlements). See: - [API Proxy limits](https://docs.cloud.google.com/apigee/docs/api-platform/reference/limits.md.txt#api-proxies). - [Enhanced per-environment proxy limits](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/enhanced-proxy-limits.md.txt). - [Subscription entitlements](https://docs.cloud.google.com/apigee/docs/api-platform/reference/subscription-entitlements.md.txt#subscription-2024-entitlements). Setting `enhanceProxyLimits: true` is required for proxy chaining, endpoint chaining, and ServiceCallout chaining. For information, see: - [Chaining API proxies together](https://docs.cloud.google.com/apigee/docs/api-platform/fundamentals/connecting-proxies-other-proxies.md.txt) - [ServiceCallout policy](https://docs.cloud.google.com/apigee/docs/api-platform/reference/policies/service-callout-policy.md.txt) **Alert:** Do not set this value to `false` once set to `true`. Apply changes to `enhanceProxyLimits` by updating the `apigee-org` chart and the `apigee-virtualhost` chart for every environment group. |
| `gcpProjectID` | Advanced | <var translate="no">Deprecated:</var> For v1.2.0 and later, use `gcp.projectID` instead. **Introduced in version:** 1.0.0 **Default value:**none **Required** ID of your Google Cloud project. Works with `k8sClusterName` (deprecated) and `gcpRegion` (deprecated) to identify the project and determine where the `apigee-logger` and the `apigee-metrics` push their data. |
| `gcpRegion` | Advanced | <var translate="no">Deprecated:</var> For v1.2.0 and later, use `gcp.region` instead. **Introduced in version:** 1.0.0 **Default value:** `us-central1` **Required** The closet Google Cloud region or zone of your Kubernetes cluster. Works with `gcpProjectID` (deprecated) and `k8sClusterName` (deprecated) to identify the project and determine where the `apigee-logger` and the `apigee-metrics` push their data. |
| `hub` | Advanced | **Introduced in version:** 1.11.0 **Default value:** None The URL of a private image container repository used to pull images for all apigee components from a private repo. `hub` provides a default path for all Apigee hybrid components. If you are using a private repository, use `hub` to set the repository URL for all components rather than using the individual `image.url` property for each component. Only configure indivisual URLs if you are using a separate repository for a specific component. The image path for each individual component will be the value of `hub` plus the image name and tag for the component. For example, if the value of `hub` `private-docker-host.example.com`, individual components will automatically resolve the image path: ``` hub: private-docker-host.example.com ``` as: ``` containers: - name: apigee-udca image: private-docker-host.example.com/apigee-udca:1.14.10 imagePullPolicy: IfNotPresent ``` > [!NOTE] > **Note:** Prior to Apigee hybrid version 1.14.2, third party components had a unique to the version of the image from the third-party vendor. For example: > ``` > ## an example of internal component vs 3rd party > containers: >   - name: apigee-udca >     image: private-docker-host.example.com/apigee-udca:1.14.10 >     imagePullPolicy: IfNotPresent > > containers: >   - name: apigee-ingressgateway >     image: private-docker-host.example.com/apigee-asm-ingress:1.22.6-asm.2-distroless >     imagePullPolicy: IfNotPresent > ``` The other components will follow a similar pattern. Use `apigee-pull-push --list` to see the current repository URL for all components. See [Use a private image repository with Apigee hybrid](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/container-images.md.txt). You can override image URL for components individualy with the following properties: - [`ao.image.url`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#ao-image-url) - [`apigeeIngressGateway.image.url`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#apigeeingressgateway-image-url) - [`cassandra.image.url`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#cassandra-image-url) - [`cassandra.auth.image.url`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#cassandra-auth-image-url) - [`cassandra.backup.image.url`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#cassandra-backup-image-url) - [`cassandra.restore.image.url`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#cassandra-restore-image-url) - [`connectAgent.image.url`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#connectagent-image-url) - [`ingressGateways[].image.url`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#ingressgateways-image-url) - [`istiod.image.url`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#istiod-image-url) - [`kubeRBACProxy.image.url`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#kuberbacproxy-image-url) - [`logger.image.url`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#logger-image-url) - [`mart.image.url`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#mart-image-url) - [`metrics.adapter.image.url`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#metrics-adapter-image-url) - [`metrics.prometheus.image.url`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#metrics-prometheus-image-url) - [`metrics.sdSidecar.image.url`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#metrics-sdsidecar-image-url) - [`mintTaskScheduler.image.url`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#minttaskscheduler-image-url) - [`redis.image.url`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#redis-image-url) - [`redis.envoy.image.url`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#redis-envoy-image-url) - [`runtime.image.url`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#runtime-image-url) - [`synchronizer.image.url`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#synchronizer-image-url) - [`udca.image.url`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#udca-image-url) - [`udca.fluentd.image.url`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#udca-fluentd-image-url) - [`watcher.image.url`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#watcher-image-url) |
| `imagePullSecrets.name` | Advanced | **Introduced in version:** 1.0.0 **Default value:** None Kubernetes secret name configured as docker-registry type; used to pull images from private repo. |
| `instanceID` | Basic | **Introduced in version:** 1.3.0 **Default value:** None **Required** A unique identifier for this installation. A unique string to identify this instance. This can be any combination of letters and numbers up to 63 characters in length. > [!NOTE] > You can create multiple organizations in the same cluster, but the `instanceID` must be the same for all orgs in the same Kubernetes cluster. For multi-region installations, each region requires its own cluster (individual clusters do not span regions). |
| `k8sClusterName` | Advanced | <var translate="no">Deprecated:</var> For v1.2.0 and later, use `k8sCluster.name` and `k8sCluster.region` instead. **Introduced in version:** 1.0.0 **Default value:** None Name of the Kubernetes (K8S) procluster where your hybrid project is running. Works with `gcpProjectID` (deprecated) and `gcpRegion` (deprecated) to identify the project and determine where the `apigee-logger` and the `apigee-metrics` push their data. |
| `kmsEncryptionKey` | Advanced | **Introduced in version:** 1.0.0 **Default value:** `defaults.org.kmsEncryptionKey` **Optional.** Use only one of **kmsEncryptionKey** or **kmsEncryptionPath** or **kmsEncryptionSecret**. Local file system path for the Apigee data's encryption key. |
| `kmsEncryptionPath` | Advanced | **Introduced in version:** 1.2.0 **Default value:** None **Optional.** Use only one of **kmsEncryptionKey** or **kmsEncryptionPath** or **kmsEncryptionSecret**. The path to a file containing a base64-encoded encryption key. See [Data encryption](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/key-encryption.md.txt). |
| `kmsEncryptionSecret.key` | Advanced | **Introduced in version:** 1.2.0 **Default value:** None **Optional.** Use only one of **kmsEncryptionKey** or **kmsEncryptionPath** or **kmsEncryptionSecret**. The key of a [Kubernetes secret](https://kubernetes.io/docs/concepts/configuration/secret/) containing a base64-encoded encryption key. See [Data encryption](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/key-encryption.md.txt). |
| `kmsEncryptionSecret.name` | Advanced | **Introduced in version:** 1.2.0 **Default value:** None **Optional.** Use only one of **kmsEncryptionKey** or **kmsEncryptionPath** or **kmsEncryptionSecret**. The name of a [Kubernetes secret](https://kubernetes.io/docs/concepts/configuration/secret/) containing a base64-encoded encryption key. See [Data encryption](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/key-encryption.md.txt). |
| `kvmEncryptionKey` | Advanced | **Introduced in version:** 1.0.0 **Default value:** `defaults.org.kmsEncryptionKey` **Optional.** Use only one of **kvmEncryptionKey** or **kvmEncryptionPath** or **kvmEncryptionSecret**. Local file system path for the Apigee data's encryption key. |
| `kvmEncryptionPath` | Advanced | **Introduced in version:** 1.2.0 **Default value:** None **Optional.** Use only one of **kvmEncryptionKey** or **kvmEncryptionPath** or **kvmEncryptionSecret**. The path to a file containing a base64-encoded encryption key. See [Data encryption](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/key-encryption.md.txt). |
| `kvmEncryptionSecret.key` | Advanced | **Introduced in version:** 1.2.0 **Default value:** None **Optional.** Use only one of **kvmEncryptionKey** or **kvmEncryptionPath** or **kvmEncryptionSecret**. The key of a [Kubernetes secret](https://kubernetes.io/docs/concepts/configuration/secret/) containing a base64-encoded encryption key. See [Data encryption](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/key-encryption.md.txt). |
| `kvmEncryptionSecret.name` | Advanced | **Introduced in version:** 1.2.0 **Default value:** None **Optional.** Use only one of **kvmEncryptionKey** or **kvmEncryptionPath** or **kvmEncryptionSecret**. The name of a [Kubernetes secret](https://kubernetes.io/docs/concepts/configuration/secret/) containing a base64-encoded encryption key. See [Data encryption](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/key-encryption.md.txt). |
| `multiOrgCluster` | Advanced | **Introduced in version:** 1.10.0 **Default value:** `false` For multi-org clusters, this property enables the organization's metrics to be exported to the project listed in the [`gcp.projectID`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#gcp-projectid) property. Apply this setting in the overrides file for each organization in a multi-org cluster. For more information, see [Adding multiple hybrid orgs to a cluster](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/multi-org.md.txt). |
| `namespace` | Basic | **Introduced in version:** 1.0.0 **Default value:** `apigee` The namespace of your Kubernetes cluster where the Apigee components will be installed. |
| `org` | Basic | **Introduced in version:** 1.0.0 **Default value:** None **Required** The hybrid-enabled organization that was provisioned for you by Apigee during the hybrid installation. An organization is the top-level container in Apigee. It contains all your API proxies and related resources. If the value is empty, you must update it with your org name once you have created it. |
| `orgScopedUDCA` | Advanced | **Introduced in version:** 1.8.0 **Default value:** `true` Enables the Universal Data Collection Agent service (UDCA) at the org level, that extracts analytics, monetization and debug (trace) and sends it to the Unified Analytics Platform (UAP) which resides in the Control Plane. Org-scoped UDCA uses a single Google service account for all Apigee environments. The service account needs to have the Apigee Analytics Agent (`roles/apigee.analyticsAgent`) role. Specify the path to the service account key file with the [`udca.serviceAccountPath`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#udca-serviceaccountpath) property or provide the key in a Kubernetes secret with the [`udca.serviceAccountRef`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#udca-serviceaccountref) property in your `overrides.yaml` configuration file. If you prefer to use a separate UDCA agent for each environment, set `orgScopedUDCA: false` and set the values for [`envs[].serviceAccountPaths.udca`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#envs-saactpaths-udca) and [`envs[].serviceAccountSecretRefs.udca`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#envs-sasecretrefs-udca). See also: [udca](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#udca). |
| `revision` | Advanced | **Introduced in version:** 1.0.0 **Default value:** `"11410"` (Your Apigee hybrid version without periods. For example for version 1.12.0, the default value is `"1120"`.) Apigee hybrid supports rolling Kubernetes updates, which allow deployment updates to take place with zero downtime by incrementally updating Pod instances with new ones. When updating certain YAML overrides that result in underlying Kubernetes `PodTemplateSpec` change, the `revision` override property must also be changed in the customer's `override.yaml`. This is required for the underlying Kubernetes *ApigeeDeployment* (AD) controller to conduct a safe rolling update of from the previous version to the new version. You can use any lowercase text value, eg: `blue`, `a`, `1.0.0` > [!NOTE] > **Note:** `revision` can accept only lowercase alpha characters, numbers, and punctuation. When the `revision` property is changed and applied, a rolling update will occur for all components Changes to properties of the following objects require an update to `revision`: - [nodeSelector](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#nodeselector) - [envs](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#envs) - [imagePullSecrets](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#imagePullSecrets) - [gcpProjectID](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#gcpProjectID) - [k8sClusterName](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#k8sClusterName) - [contractProvider](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#contractprovider) - [org](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#org) For more information, see [Rolling updates](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/revision.md.txt). |
| `serviceAccountSecretProviderClass` | Advanced | **Introduced in version:** 1.12.0 **Default value:** None The name of the organization-specific secret provider class (`SecretProviderClass`) used for storing service account keys in Vault. See [Storing service account keys in Hashicorp Vault](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/storing-sa-keys-in-vault.md.txt). |
| `validateOrg` | Advanced | **Introduced in version:** 1.8.0 **Default value:** `true` Enables strict validation of the link between the Apigee Org and Google Cloud project and checks for the existence of environment groups. See also [`org`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#org) |
| `validateServiceAccounts` | Advanced | **Introduced in version:** 1.0.0 **Default value:** `true` Enables strict validation of service account permissions. This uses Cloud Resource Manager API method `testIamPermissions` to verify that the provided service account has the required permissions. In the case of service accounts for an Apigee Org, the project ID check is the one mapped to the Organization. For Metrics and Logger, the project checked is based on the `gcpProjectID` `overrides.yaml` configuration. See also [`gcpProjectID`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#gcpProjectID) |

## `ao`

*Apigee Operators* (AO) creates and updates
low level Kubernetes and Istio resources that are required to deploy and maintain a component.
For example, the controller carries out the release of message processors.

> [!NOTE]
> **Note:**In version 1.2.0, Apigee Operators replaces Apigee Deployment Admissionhook (ADAH) and Apigee Deployment Controller (ADC).

The following table describes the properties of the apigee-operators `ao` object:

| Property | Type | Description |
|---|---|---|
| `ao.args.disableIstioConfigInAPIServer` | Advanced | **Introduced in version:** 1.8.0 **Default value:** `true` Stops Apigee from supplying configuration to customer-installed Cloud Service Mesh. - Set to `true` for hybrid installations using Apigee ingress gateway. - Set to `false` for hybrid installations using Cloud Service Mesh (Apigee hybrid versions 1.8 and earlier). |
| `ao.args.disableManagedClusterRoles` | Advanced | **Introduced in version:** 1.10.0 **Default value:** `true` When `true` (the default), Apigee hybrid does not manage Kubernetes `ClusterRole` and `ClursterRoleBinding` directly. If you have a process that requires managing these resources, the process must be performed by a user with the correct permissions to do so. |
| `ao.image.pullPolicy` | Advanced | **Introduced in version:** 1.2.0 **Default value:** `IfNotPresent` Determines when [kubelet](https://kubernetes.io/docs/reference/command-line-tools-reference/kubelet/#kubelet) pulls the pod's Docker image. Possible values include: - `IfNotPresent`: Do not pull a new image if it already exists. - `Always`: Always pull the image, regardless of whether it exists already. For more information, see [Updating images](https://kubernetes.io/docs/concepts/containers/images/#updating-images). |
| `ao.image.tag` | Advanced | **Introduced in version:** 1.2.0 **Default value:** `1.14.10` The version label for this service's Docker image. |
| `ao.image.url` | Advanced | **Introduced in version:** 1.2.0 **Default value:** None The location of the Docker image for this service. Use `apigee-pull-push --list` to see the current repository URL for this component. > [!TIP] > **Tip:** Consider using [`hub`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#hub) to set a private repository URL for all components instead of configuring them individually. |
| `ao.resources.limits.cpu` | Advanced | **Introduced in version:** 1.2.0 **Default value:** `250m` The CPU limit for the resource in a Kubernetes container, in millicores. |
| `ao.resources.limits.memory` | Advanced | **Introduced in version:** 1.2.0 **Default value:** `256Mi` The memory limit for the resource in a Kubernetes container, in mebibytes. |
| `ao.resources.requests.cpu` | Advanced | **Introduced in version:** 1.2.0 **Default value:** `250m` The CPU needed for normal operation of the resource in a Kubernetes container, in millicores. |
| `ao.resources.requests.memory` | Advanced | **Introduced in version:** 1.2.0 **Default value:** `256Mi` The memory needed for normal operation of the resource in a Kubernetes container, in mebibytes. |
| `ao.tolerations.effect` | Advanced | **Introduced in version:** 1.10.1 **Default value:** None Required to use the [Taints and Tolerations feature of Kubernetes](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/). `effect` specifies the effect that matching a toleration with a taint will have. Values for `effect` can be: - `NoExecute` - `NoSchedule` - `PreferNoSchedule` See [Taints and Tolerations: Concepts](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/#concepts) for details. |
| `ao.tolerations.key` | Advanced | **Introduced in version:** 1.10.1 **Default value:** None Required to use the [Taints and Tolerations feature of Kubernetes](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/). `key` identifies pods to which the toleration can be applied. See [Taints and Tolerations: Concepts](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/#concepts) for details. |
| `ao.tolerations.operator` | Advanced | **Introduced in version:** 1.10.1 **Default value:** `"Equal"` Required to use the [Taints and Tolerations feature of Kubernetes](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/). `operator` specifies the operation used to trigger the [`effect`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#ao-tolerations-effect). Values for `operator` can be: - `Equal` matches the value set in [`value`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#ao-tolerations-value). - `Exists` ignores the value set in [`value`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#ao-tolerations-value). See [Taints and Tolerations: Concepts](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/#concepts) for details. |
| `ao.tolerations.tolerationSeconds` | Advanced | **Introduced in version:** 1.10.1 **Default value:** None Used by the [Taints and Tolerations feature of Kubernetes](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/). `tolerationSeconds` defines in seconds how long a pod stays bound to a failing or unresponsive node. See [Taints and Tolerations: Concepts](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/#concepts) for details. |
| `ao.tolerations.value` | Advanced | **Introduced in version:** 1.10.1 **Default value:** None Used by the [Taints and Tolerations feature of Kubernetes](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/). `value` is the value that triggers the [`effect`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#ao-tolerations-effect) when [`operator`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#ao-tolerations-operator) is set to `Equal`. See [Taints and Tolerations: Concepts](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/#concepts) for details. |

## `apigeeIngressGateway`

Configures the Apigee ingress gateway for Apigee Hybrid. Use `apigeeIngressGateway`
properties to apply common configuration to all instances of the Apigee ingress gateway.

See [`ingressGateways`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#ingressgateways) to configure individual instances
uniquely.

Apply changes to `apigeeIngressGateway` properties with the `apigee-org`
chart.

The following table describes the properties of the `apigeeIngressGateway` object:

| Property | Type | Description |
|---|---|---|
| `apigeeIngressGateway.image.pullPolicy` | Advanced | **Introduced in version:** 1.11.0 **Default value:** `IfNotPresent` Determines when [kubelet](https://kubernetes.io/docs/reference/command-line-tools-reference/kubelet/#kubelet) pulls the pod's Docker image. Possible values include: - `IfNotPresent`: Do not pull a new image if it already exists. - `Always`: Always pull the image, regardless of whether it exists already. For more information, see [Updating images](https://kubernetes.io/docs/concepts/containers/images/#updating-images). |
| `apigeeIngressGateway.image.tag` | Advanced | **Introduced in version:** 1.11.0 **Default value:** `1.14.10` The version label for this service's Docker image. |
| `apigeeIngressGateway.image.url` | Advanced | **Introduced in version:** 1.11.0 **Default value:** None The location of the Docker image for this service. Use `apigee-pull-push --list` to see the current repository URL for this component. > [!TIP] > **Tip:** Consider using [`hub`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#hub) to set a private repository URL for all components instead of configuring them individually. |
| `apigeeIngressGateway.nodeSelector.key` | Advanced | **Introduced in version:** 1.11.0 **Default value:** None **Required** Node selector label key used to target dedicated Kubernetes nodes for ingress gateway services. See [Configuring dedicated node pools](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/configure-dedicated-nodes.md.txt). |
| `apigeeIngressGateway.nodeSelector.value` | Advanced | **Introduced in version:** 1.11.0 **Default value:** None Optional node selector label value used to target dedicated Kubernetes nodes for ingress gateway services and override the `nodeSelector.apigeeData` settings. See [nodeSelector](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#nodeselector). |
| `apigeeIngressGateway.podDisruptionBudget.minAvailable` | Advanced | **Introduced in version:** 1.14.10 **Default value:** None **Chart:** `apigee-org` The minimum number of Apigee ingress gateway pods that must stay available during a voluntary disruption, such as during a node pool upgrade or a node drain. This field sets the `minAvailable` field of the [PodDisruptionBudget](https://kubernetes.io/docs/concepts/workloads/pods/disruptions/) for these pods. It takes either an integer number of pods (`1`) or a percentage string (`"50%"`). `minAvailable` and `maxUnavailable` are mutually exclusive; set only one. The Apigee operator rejects setting both at once. If you set neither field, the Apigee operator still generates a PodDisruptionBudget for these pods, using `maxUnavailable: 1` by default. To set a different budget for a specific gateway, use [`ingressGateways[].podDisruptionBudget.minAvailable`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#ingressgateways-poddisruptionbudget-minavailable). For example, in `overrides.yaml`: ``` apigeeIngressGateway: podDisruptionBudget: minAvailable: "50%" ``` |
| `apigeeIngressGateway.podDisruptionBudget.maxUnavailable` | Advanced | **Introduced in version:** 1.14.10 **Default value:** None **Chart:** `apigee-org` The maximum number of Apigee ingress gateway pods that can be unavailable during a voluntary disruption, such as during a node pool upgrade or a node drain. This field sets the `maxUnavailable` field of the [PodDisruptionBudget](https://kubernetes.io/docs/concepts/workloads/pods/disruptions/) for these pods. It takes either an integer number of pods (`1`) or a percentage string (`"50%"`). `maxUnavailable` and `minAvailable` are mutually exclusive; set only one. The Apigee operator rejects setting both at once. If you set neither field, the Apigee operator still generates a PodDisruptionBudget for these pods, using `maxUnavailable: 1` by default. To set a different budget for a specific gateway, use [`ingressGateways[].podDisruptionBudget.maxUnavailable`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#ingressgateways-poddisruptionbudget-maxunavailable). For example, in `overrides.yaml`: ``` apigeeIngressGateway: podDisruptionBudget: maxUnavailable: 1 ``` |
| `apigeeIngressGateway.replicaCountMax` | Basic | **Introduced in version:** 1.11.0 **Default value:** `4` The maximum number of pods that hybrid can automatically add for the ingress gateway available for autoscaling. |
| `apigeeIngressGateway.replicaCountMin` | Basic | **Introduced in version:** 1.11.0 **Default value:** `2` The minimum number of pods for the ingress gateway available for autoscaling. |
| `apigeeIngressGateway.targetCPUUtilizationPercentage` | Advanced | **Introduced in version:** 1.10.5, 1.11.2, 1.12.1 **Default value:** `75` The threshold of CPU usage for scaling the number of pods in the ReplicaSet, as a percentage of total available CPU resources. When CPU usage goes above this value, then hybrid will gradually increase the number of pods in the ReplicaSet, up to [`apigeeIngressGateway.replicaCountMax`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#apigeeingressgateway-replicacountmax). For more information on scaling in Kubernetes, see [Horizontal Pod Autoscaling](https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale/) in the Kubernetes documentation. |
| `apigeeIngressGateway.tolerations.effect` | Advanced | **Introduced in version:** 1.11.0 **Default value:** None Required to use the [Taints and Tolerations feature of Kubernetes](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/). `effect` specifies the effect that matching a toleration with a taint will have. Values for `effect` can be: - `NoExecute` - `NoSchedule` - `PreferNoSchedule` See [Taints and Tolerations: Concepts](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/#concepts) for details. |
| `apigeeIngressGateway.tolerations.key` | Advanced | **Introduced in version:** 1.11.0 **Default value:** None Required to use the [Taints and Tolerations feature of Kubernetes](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/). `key` identifies pods to which the toleration can be applied. See [Taints and Tolerations: Concepts](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/#concepts) for details. |
| `apigeeIngressGateway.tolerations.operator` | Advanced | **Introduced in version:** 1.11.0 **Default value:** `"Equal"` Required to use the [Taints and Tolerations feature of Kubernetes](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/). `operator` specifies the operation used to trigger the [`effect`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#apigeeingressgateway-tolerations-effect). Values for `operator` can be: - `Equal` matches the value set in [`value`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#apigeeingressgateway-tolerations-value). - `Exists` ignores the value set in [`value`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#apigeeingressgateway-tolerations-value). See [Taints and Tolerations: Concepts](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/#concepts) for details. |
| `apigeeIngressGateway.tolerations.tolerationSeconds` | Advanced | **Introduced in version:** 1.11.0 **Default value:** None Used by the [Taints and Tolerations feature of Kubernetes](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/). `tolerationSeconds` defines in seconds how long a pod stays bound to a failing or unresponsive node. See [Taints and Tolerations: Concepts](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/#concepts) for details. |
| `apigeeIngressGateway.tolerations.value` | Advanced | **Introduced in version:** 1.11.0 **Default value:** None Used by the [Taints and Tolerations feature of Kubernetes](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/). `value` is the value that triggers the [`effect`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#apigeeingressgateway-tolerations-effect) when [`operator`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#apigeeingressgateway-tolerations-operator) is set to `Equal`. See [Taints and Tolerations: Concepts](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/#concepts) for details. |

## `cassandra`

Defines the hybrid service that manages the runtime data repository. This repository stores
application configurations, distributed quota counters, API keys, and OAuth tokens for applications
running on the gateway.

For more information, see [StorageClass configuration](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/cassandra-config.md.txt).

The following table describes the properties of the `cassandra` object:

> [!NOTE]
> **Note:** This #cassandra-storage-capacity property is deprecated starting from v1.12.0.Use [`cassandra.storage.storageSize`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#cassandra-storage-storagesize) instead.

| Property | Type | Description |
|---|---|---|
| `cassandra.annotations` | Advanced | **Introduced in version:** 1.5.0 **Default value:** None Optional key/value map used to annotate pods. For more information, see [Custom annotations](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/customize-services.md.txt#custom-annotations). |
| `cassandra.auth.admin.password` | Basic | **Introduced in version:** 1.0.0 **Default value:** `iloveapis123` **Required** Password for the Cassandra administrator. The admin user is used for any administrative activities performed on the Cassandra cluster, such as backup and restore. |
| `cassandra.auth.ddl.password` | Basic | **Introduced in version:** 1.0.0 **Default value:** `iloveapis123` **Required** Password for the Cassandra Data Definition Language (DDL) user. Used by MART for any of the data definition tasks like keyspace creation, update, and deletion. |
| `cassandra.auth.default.password` | Basic | **Introduced in version:** 1.0.0 **Default value:** `iloveapis123` **Required** The password for the default Cassandra user created when Authentication is enabled. This password must be reset when configuring Cassandra authentication. See [Configuring TLS for Cassandra](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/cassandra-tls.md.txt). |
| `cassandra.auth.dml.password` | Basic | **Introduced in version:** 1.0.0 **Default value:** `iloveapis123` **Required** Password for the Cassandra Data Manipulation Language (DML) user. The DML user is used by the client communication to read and write data to Cassandra. |
| `cassandra.auth.image.pullPolicy` | Advanced | **Introduced in version:** 1.0.0 **Default value:** `IfNotPresent` Determines when [kubelet](https://kubernetes.io/docs/reference/command-line-tools-reference/kubelet/#kubelet) pulls the pod's Docker image. Possible values include: - `IfNotPresent`: Do not pull a new image if it already exists. - `Always`: Always pull the image, regardless of whether it exists already. For more information, see [Updating images](https://kubernetes.io/docs/concepts/containers/images/#updating-images). |
| `cassandra.auth.image.tag` | Advanced | **Introduced in version:** 1.0.0 **Default value:** `1.14.10` The version label for this service's Docker image. |
| `cassandra.auth.image.url` | Advanced | **Introduced in version:** 1.0.0 **Default value:** None The location of the Docker image for this service. Use `apigee-pull-push --list` to see the current repository URL for this component. > [!TIP] > **Tip:** Consider using [`hub`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#hub) to set a private repository URL for all components instead of configuring them individually. |
| `cassandra.auth.jmx.password` | Basic | **Introduced in version:** 1.4.0 **Default value:** `iloveapis123` **Required** Password for the Cassandra JMX operations user. Used to authenticate and communicate with the Cassandra JMX interface. |
| `cassandra.auth.jmx.username` | Basic | **Introduced in version:** 1.4.0 **Default value:** `jmxuser` **Required** Username for the Cassandra JMX operations user. Used to authenticate and communicate with the Cassandra JMX interface. |
| `cassandra.auth.jolokia.password` | Basic | **Introduced in version:** 1.4.0 **Default value:** `iloveapis123` **Required** Password for the Cassandra Jolokia JMX operations user. Used to authenticate and communicate with the Cassandra JMX API. |
| `cassandra.auth.jolokia.username` | Basic | **Introduced in version:** 1.4.0 **Default value:** `apigee` **Required** Username for the Cassandra Jolokia JMX operations user. Used to authenticate and communicate with the Cassandra JMX API. |
| `cassandra.auth.secret` | Basic | **Introduced in version:** 1.3.3 **Default value:** None The name of the file stored in a Kubernetes secret that contains the Cassandra users and passwords. You can create the secret using following the following instructions: [Create the Secret](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/cassandra-tls.md.txt#create-the-secret). See also: - [Storing data in a Kubernetes secret](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/k8s-secrets.md.txt) - [Secrets](https://kubernetes.io/docs/concepts/configuration/secret/) in the Kubernetes documentation - [Creating a Secret Using kubectl](https://kubernetes.io/docs/concepts/configuration/secret/#creating-a-secret) in the Kubernetes documentation |
| `cassandra.auth.secretProviderClass` | Advanced | **Introduced in version:** 1.10.3 **Default value:** None The Cassandra secret storage policy. When set, it must match the SecretProviderClass which references the external secret provider, like Hashicorp Vault. When unset, Apigee hybrid uses either the usernames and passwords stored in: - [`cassandra.auth.admin.password`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#cassandra-auth-admin-password) - [`cassandra.auth.ddl.password`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#cassandra-auth-ddl-password) - [`cassandra.auth.default.password`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#cassandra-auth-default-password) - [`cassandra.auth.dml.password`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#cassandra-auth-dml-password) - [`cassandra.auth.jmx.password`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#cassandra-auth-jmx-password) - [`cassandra.auth.jmx.username`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#cassandra-auth-jmx-username) - [`cassandra.auth.jolokia.password`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#cassandra-auth-jolokia-password) - [`cassandra.auth.jolokia.username`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#cassandra.auth.jolokia-username) or the Kubernetes secret stored in: - [`cassandra.auth.secret`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#cassandra-auth-secret) See [Storing Cassandra secrets in Hashicorp Vault](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/storing-cassandra-secrets-in-vault.md.txt) for instructions to create the policy. |
| `cassandra.backup.cloudProvider` | Advanced | **Introduced in version:** 1.0.0 **Default value:** `GCP` The name of a backup provider. Supported values: `GCP`, `HYBRID`, and `CSI`. Set the value to: - `GCP` to store backup archives on Google Cloud Storage. - `HYBRID` to store backup archives on a remote SSH server. - `CSI` (recommended) to utilize Kubernetes CSI [Volume Snapshots](https://kubernetes.io/docs/concepts/storage/volume-snapshots/) for backup. For information on `CSI` backup and restore for cloud platforms such as Google Cloud, AWS, and Azure, see [CSI backup and restore](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/cassandra-csi-backup-restore.md.txt). |
| `cassandra.backup.dbStorageBucket` | Advanced | **Introduced in version:** 1.0.0 **Default value:** None **Required if backup is enabled and [`cassandra.backup.cloudProvider`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#cassandra-backup-cloudprovider) is set to `GCP`.** The name of an existing Google Cloud Storage bucket that will be used to store backup archives. See [Creating buckets](https://cloud.google.com/storage/docs/creating-buckets) if you need to create one. > [!NOTE] > **Note:** Starting in Hybrid version 1.13, the bucket name doesn't need to be prefixed with `gs://`. Support for this prefix has been deprecated and will be removed in future releases. |
| `cassandra.backup.enabled` | Advanced | **Introduced in version:** 1.0.0 **Default value:** `false` Data backup is not enabled by default. To enable, set to `true`. See [Cassandra backup and recovery](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/backup-recovery). |
| `cassandra.backup.gsa` | Advanced | **Introduced in version:** 1.10.0 **Default value:** None **Helm only** : The email address of the `apigee-cassandra` Google IAM service account (GSA) to associate with the cassandra backup Kubernetes service account when enabling Workload Identity on GKE clusters. Set this when you have set [`gcp.workloadIdentity.enabled`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#gcp-workloadidentity-enabled) to `true` and [`cassandra.backup.enabled`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#cassandra-backup-enabled) to `true`. GSA email addresses typically have the format of: ``` GSA_NAME@PROJECT_ID.iam.gserviceaccount.com ``` For example: ``` apigee-cassandra@my-hybrid-project.iam.gserviceaccount.com ``` > [!TIP] > **Tip:** You can find the email address of your service accounts with the following command: > ``` > gcloud iam service-accounts list --project ${PROJECT_ID} --filter "apigee" > ``` See [Enabling Workload Identity Federation on GKE](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/enable-workload-identity-gke.md.txt). |
| `cassandra.backup.image.pullPolicy` | Advanced | **Introduced in version:** 1.0.0 **Default value:** `IfNotPresent` Determines when [kubelet](https://kubernetes.io/docs/reference/command-line-tools-reference/kubelet/#kubelet) pulls the pod's Docker image. Possible values include: - `IfNotPresent`: Do not pull a new image if it already exists. - `Always`: Always pull the image, regardless of whether it exists already. For more information, see [Updating images](https://kubernetes.io/docs/concepts/containers/images/#updating-images). |
| `cassandra.backup.image.tag` | Advanced | **Introduced in version:** 1.0.0 **Default value:** `1.14.10` The version label for this service's Docker image. |
| `cassandra.backup.image.url` | Advanced | **Introduced in version:** 1.0.0 **Default value:** None The location of the Docker image for this service. Use `apigee-pull-push --list` to see the current repository URL for this component. > [!TIP] > **Tip:** Consider using [`hub`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#hub) to set a private repository URL for all components instead of configuring them individually. |
| `cassandra.backup.keyfile` | Advanced | **Introduced in version:** 1.3.0 **Default value:** None **Required if backup is enabled and [`cassandra.backup.cloudProvider`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#cassandra-backup-cloudprovider) is set to `HYBRID`.** The path on your local file system to the SSH private key file. |
| `cassandra.backup.schedule` | Advanced | **Introduced in version:** 1.0.0 **Default value:** `0 2 * * *` The schedule for the backup cron job. See [Cassandra backup and recovery](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/backup-recovery). |
| `cassandra.backup.server` | Advanced | **Introduced in version:** 1.3.0 **Default value:** None **Required if backup is enabled and [`cassandra.backup.cloudProvider`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#cassandra-backup-cloudprovider) is set to `HYBRID`.** The IP address of your remote SSH backup server. |
| `cassandra.backup.serviceAccountPath` | Advanced | **Introduced in version:** 1.0.0 **Default value:** None Path to a [Google Service Account](https://cloud.google.com/iam/docs/service-account-overview) key file that has the **Storage Object Admin** (`roles/storage.objectAdmin`) role. This Google Service Account will be used for uploading backup archives to a specified [`cassandra.backup.dbStorageBucket`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#cassandra-backup-dbstoragebucket). **If backup is enabled and [`cassandra.backup.cloudProvider`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#cassandra-backup-cloudprovider) is set to `GCP`, one of the following is required to ensure Apigee Hybrid can access the Google Cloud Storage bucket to upload backup archives:** - Specified [`cassandra.backup.serviceAccountPath`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#cassandra-backup-serviceaccountpath). - Specified [`cassandra.backup.serviceAccountRef`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#cassandra-backup-serviceaccountref). - Configured [Workload Identity for Apigee Hybrid in GKE](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/install-workload-identity.md.txt). - Configured [Workload Identity Federation for Apigee Hybrid in AKS or EKS](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/enable-workload-identity-federation.md.txt). <br /> |
| `cassandra.backup.serviceAccountRef` | Advanced | **Introduced in version:** 1.2.0 **Default value:** None The name of an existing Kubernetes secret that stores the content of a [Google Service Account](https://cloud.google.com/iam/docs/service-account-overview) key file that has the **Storage Object Admin** (`roles/storage.objectAdmin`) role. This Google Service Account will be used for uploading backup archives to a specified [`cassandra.backup.dbStorageBucket`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#cassandra-backup-dbstoragebucket). **If backup is enabled and [`cassandra.backup.cloudProvider`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#cassandra-backup-cloudprovider) is set to `GCP`, one of the following is required to ensure Apigee Hybrid can access the Google Cloud Storage bucket to upload backup archives:** - Specified [`cassandra.backup.serviceAccountPath`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#cassandra-backup-serviceaccountpath). - Specified [`cassandra.backup.serviceAccountRef`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#cassandra-backup-serviceaccountref). - Configured [Workload Identity for Apigee Hybrid in GKE](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/install-workload-identity.md.txt). - Configured [Workload Identity Federation for Apigee Hybrid in AKS or EKS](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/enable-workload-identity-federation.md.txt). <br /> |
| `cassandra.backup.storageDirectory` | Advanced | **Introduced in version:** 1.3.0 **Default value:** None **Required if backup is enabled and [`cassandra.backup.cloudProvider`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#cassandra-backup-cloudprovider) is set to `HYBRID`.** **Can either be an absolute or relative path to the `apigee` user's home directory.** The name of the backup directory on your backup SSH server. |
| `cassandra.clusterName` | Basic | **Introduced in version:** 1.0.0 **Default value:** `apigeecluster` Specifies the name of the Cassandra cluster. > [!NOTE] > **Note:** For multi-region installs the value of `clusterName` needs to match for all regions. |
| `cassandra.datacenter` | Basic | **Introduced in version:** 1.0.0 **Default value:** `dc-1` Specifies the datacenter of the Cassandra node. |
| `cassandra.dnsPolicy` | Basic | **Introduced in version:** 1.1.1 **Default value:** None <br /> > [!NOTE] > **Note:** In Apigee hybrid v1.3, this property is no longer supported. When you set `hostNetwork` to true, the DNS policy is set to `ClusterFirstWithHostNet` for you. |
| `cassandra.externalSeedHost` | Basic | **Introduced in version:** 1.0.0 **Default value:** None Hostname or IP of a Cassandra cluster node. If not set, the Kubernetes local service is used. |
| `cassandra.heapNewSize` | Basic | **Introduced in version:** 1.0.0 **Default value:** `100M` The amount of system memory allocated to newer objects, in megabytes. |
| `cassandra.hostNetwork` | Basic | **Introduced in version:** 1.1.1 **Default value:** `false` Enables the Kubernetes [`hostNetwork`](https://kubernetes.io/docs/concepts/policy/pod-security-policy/#host-namespaces) feature. Apigee uses this feature in multi-region installations to communicate between pods if the pod network namespace does not have connectivity between clusters (the clusters are running in "island network mode"), which is the default case in non-GKE installations, including Google Distributed Cloud on VMware or bare metal, AKS, EKS, and OpenShift. Set `cassandra.hostNetwork` to `false` for single region installations and multi-region installations with connectivity between pods in different clusters, for example GKE installations. Set `cassandra.hostNetwork` to `true` for multi-region installations with no communication between between pods in different clusters, for example Google Distributed Cloud on VMware or bare metal, AKS, EKS, and OpenShift installations. See [Multi-region deployment: Prerequisites](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/multi-region.md.txt#prerequisites). When `true`, [DNS policy](https://kubernetes.io/docs/concepts/services-networking/dns-pod-service/#pod-s-dns-policy) is automatically set to `ClusterFirstWithHostNet`. |
| `cassandra.image.pullPolicy` | Advanced | **Introduced in version:** 1.0.0 **Default value:** `IfNotPresent` Determines when [kubelet](https://kubernetes.io/docs/reference/command-line-tools-reference/kubelet/#kubelet) pulls the pod's Docker image. Possible values include: - `IfNotPresent`: Do not pull a new image if it already exists. - `Always`: Always pull the image, regardless of whether it exists already. For more information, see [Updating images](https://kubernetes.io/docs/concepts/containers/images/#updating-images). |
| `cassandra.image.tag` | Advanced | **Introduced in version:** 1.0.0 **Default value:** `1.14.10` The version label for this service's Docker image. |
| `cassandra.image.url` | Advanced | **Introduced in version:** 1.0.0 **Default value:** None The location of the Docker image for this service. Use `apigee-pull-push --list` to see the current repository URL for this component. > [!TIP] > **Tip:** Consider using [`hub`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#hub) to set a private repository URL for all components instead of configuring them individually. |
| `cassandra.maxHeapSize` | Advanced | **Introduced in version:** 1.0.0 **Default value:** `512M` The upper limit of system memory available for Cassandra operations, in megabytes. |
| `cassandra.multiRegionSeedHost` | Basic | **Introduced in version:** 1.0.0 **Default value:** None IP address of an existing Cassandra cluster used to expand the existing cluster to a new region. See [Configure the multi-region seed host](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/multi-region.md.txt#configure-the-multi-region-seed-host). |
| `cassandra.nodeSelector.key` | Advanced | **Introduced in version:** 1.0.0 **Default value:** None **Required** Node selector label key used to target dedicated Kubernetes nodes for `cassandra` data services. See [Configuring dedicated node pools](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/configure-dedicated-nodes.md.txt). |
| `cassandra.nodeSelector.value` | Advanced | **Introduced in version:** 1.0.0 **Default value:** None Optional node selector label value used to target dedicated Kubernetes nodes for `cassandra` data services and override the `nodeSelector.apigeeData` settings. See [nodeSelector](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#nodeselector). |
| `cassandra.podDisruptionBudget.minAvailable` | Advanced | **Introduced in version:** 1.14.10 **Default value:** None **Chart:** `apigee-datastore` The minimum number of Cassandra pods that must stay available during a voluntary disruption, for example during a node pool upgrade or a node drain. This field sets the `minAvailable` field of the [PodDisruptionBudget](https://kubernetes.io/docs/concepts/workloads/pods/disruptions/) for these pods. It takes either an integer number of pods (`1`) or a percentage string (`"50%"`). `minAvailable` and `maxUnavailable` are mutually exclusive; set only one. Setting both at once is rejected by the Apigee operator. If you set neither field, the Apigee operator still generates a PodDisruptionBudget for these pods, using `maxUnavailable: 1` by default. For example, in `overrides.yaml`: ``` cassandra: podDisruptionBudget: minAvailable: "50%" ``` |
| `cassandra.podDisruptionBudget.maxUnavailable` | Advanced | **Introduced in version:** 1.14.10 **Default value:** None **Chart:** `apigee-datastore` The maximum number of Cassandra pods that can be unavailable during a voluntary disruption, for example during a node pool upgrade or a node drain. This field sets the `maxUnavailable` field of the [PodDisruptionBudget](https://kubernetes.io/docs/concepts/workloads/pods/disruptions/) for these pods. It takes either an integer number of pods (`1`) or a percentage string (`"50%"`). `maxUnavailable` and `minAvailable` are mutually exclusive; set only one. Setting both at once is rejected by the Apigee operator. If you set neither field, the Apigee operator still generates a PodDisruptionBudget for these pods, using `maxUnavailable: 1` by default. For example, in `overrides.yaml`: ``` cassandra: podDisruptionBudget: maxUnavailable: 1 ``` |
| `cassandra.port` | Advanced | **Introduced in version:** 1.0.0 **Default value:** `9042` Port number used to connect to cassandra. |
| `cassandra.rack` | Basic | **Introduced in version:** 1.0.0 **Default value:** `ra-1` Specifies the rack of the Cassandra node. |
| `cassandra.readinessProbe.failureThreshold` | Advanced | **Introduced in version:** 1.0.0 **Default value:** `2` The number of times Kubernetes will verify that readiness probes have failed before marking the pod *unready*. The minimum value is 1. |
| `cassandra.readinessProbe.initialDelaySeconds` | Advanced | **Introduced in version:** 1.0.0 **Default value:** `0` The number of seconds after a container is started before a readiness probe is initiated. |
| `cassandra.readinessProbe.periodSeconds` | Advanced | **Introduced in version:** 1.0.0 **Default value:** `10` Determines how often to perform a readiness probe, in seconds. The minimum value is 1. |
| `cassandra.readinessProbe.successThreshold` | Advanced | **Introduced in version:** 1.0.0 **Default value:** `1` The minimum consecutive successes needed for a readiness probe to be considered successful after a failure. The minimum value is 1. |
| `cassandra.readinessProbe.timeoutSeconds` | Advanced | **Introduced in version:** 1.0.0 **Default value:** `5` The number of seconds after which a liveness probe times out. The minimum value is 1. |
| `cassandra.replicaCount` | Basic | **Introduced in version:** 1.0.0 **Default value:** `1` Cassandra is a replicated database. This property specifies the number of Cassandra nodes employed as a [StatefulSet](https://kubernetes.io/docs/concepts/workloads/controllers/statefulset/). > [!NOTE] > **Note:** The default value of `1` is only acceptable for demo or test installations. For production installations, the value of `replicaCount` must be a multiple of `3`. To determine your desired `replicaCount` value, consider the following: > - Estimate the traffic demands for your proxies. > - Load test and make reasonable predictions of your CPU utilization. > - You can specify different `replicaCount` values in different regions. > - You can expand the `replicaCount` in the future in your overrides file. |
| `cassandra.resources.requests.cpu` | Advanced | **Introduced in version:** 1.0.0 **Default value:** `500m` The CPU needed for normal operation of the resource in a Kubernetes container, in millicores. |
| `cassandra.resources.requests.memory` | Advanced | **Introduced in version:** 1.0.0 **Default value:** `1Gi` The memory needed for normal operation of the resource in a Kubernetes container, in mebibytes. |
| `cassandra.restore.cloudProvider` | Advanced | **Introduced in version:** 1.0.0 **Default value:** `GCP` The name of a restore provider. Supported values: `GCP`, `HYBRID`, and `CSI`. Set the value to: - `GCP` to restore data from a backup stored on Google Cloud Storage. - `HYBRID` to restore data from a backup stored on a remote SSH server. - `CSI` (recommended) to utilize Kubernetes CSI [Volume Snapshots](https://kubernetes.io/docs/concepts/storage/volume-snapshots/) for restore. For information on `CSI` backup and restore for cloud platforms such as Google Cloud, AWS, and Azure, see [CSI backup and restore](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/cassandra-csi-backup-restore.md.txt). |
| `cassandra.restore.dbStorageBucket` | Advanced | **Introduced in version:** 1.0.0 **Default value:** None **Required if restore is enabled and [`cassandra.restore.cloudProvider`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#cassandra-restore-cloudprovider) is set to `GCP`.** The name of a Google Cloud Storage bucket that stores backup archives to be used for data restoration. > [!NOTE] > **Note:** Starting in Hybrid version 1.13, the bucket name doesn't need to be prefixed with `gs://`. Support for this prefix has been deprecated and will be removed in future releases. |
| `cassandra.restore.enabled` | Advanced | **Introduced in version:** 1.0.0 **Default value:** `false` Data restoration is not enabled by default. To enable, set to `true`. See [Cassandra backup and recovery](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/backup-recovery). |
| `cassandra.restore.gsa` | Advanced | **Introduced in version:** 1.10.0 **Default value:** None **Helm only** : The email address of the `apigee-cassandra` Google IAM service account (GSA) to associate with the cassandra restore Kubernetes service account when enabling Workload Identity on GKE clusters. Set this when you have set [`gcp.workloadIdentity.enabled`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#gcp-workloadidentity-enabled) to `true` and [`cassandra.restore.enabled`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#cassandra-restore-enabled) to `true`. GSA email addresses typically have the format of: ``` GSA_NAME@PROJECT_ID.iam.gserviceaccount.com ``` For example: ``` apigee-cassandra@my-hybrid-project.iam.gserviceaccount.com ``` > [!TIP] > **Tip:** You can find the email address of your service accounts with the following command: > ``` > gcloud iam service-accounts list --project ${PROJECT_ID} --filter "apigee" > ``` See [Enabling Workload Identity Federationon GKE](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/enable-workload-identity-gke.md.txt). |
| `cassandra.restore.image.pullPolicy` | Advanced | **Introduced in version:** 1.0.0 **Default value:** `IfNotPresent` Determines when [kubelet](https://kubernetes.io/docs/reference/command-line-tools-reference/kubelet/#kubelet) pulls the pod's Docker image. Possible values include: - `IfNotPresent`: Do not pull a new image if it already exists. - `Always`: Always pull the image, regardless of whether it exists already. For more information, see [Updating images](https://kubernetes.io/docs/concepts/containers/images/#updating-images). |
| `cassandra.restore.image.tag` | Advanced | **Introduced in version:** 1.0.0 **Default value:** `1.14.10` The version label for this service's Docker image. |
| `cassandra.restore.image.url` | Advanced | **Introduced in version:** 1.0.0 **Default value:** None The location of the Docker image for this service. Use `apigee-pull-push --list` to see the current repository URL for this component. > [!TIP] > **Tip:** Consider using [`hub`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#hub) to set a private repository URL for all components instead of configuring them individually. |
| `cassandra.restore.serviceAccountPath` | Advanced | **Introduced in version:** 1.0.0 **Default value:** None Path to a [Google Service Account](https://cloud.google.com/iam/docs/service-account-overview) key file that has the **Storage Object Admin** (`roles/storage.objectAdmin`) role. This Google Service Account will be used to download backup archives from a specified [`cassandra.restore.dbStorageBucket`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#cassandra-restore-dbstoragebucket). **If restore is enabled and [`cassandra.restore.cloudProvider`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#cassandra-restore-cloudprovider) is set to `GCP`, one of the following is required to ensure Apigee Hybrid can access the Google Cloud Storage bucket to download backup archives for restoration:** - Specified [`cassandra.restore.serviceAccountPath`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#cassandra-restore-serviceaccountpath). - Specified [`cassandra.restore.serviceAccountRef`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#cassandra-restore-serviceaccountref). - Configured [Workload Identity for Apigee Hybrid in GKE](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/install-workload-identity.md.txt). - Configured [Workload Identity Federation for Apigee Hybrid in AKS or EKS](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/enable-workload-identity-federation.md.txt). <br /> |
| `cassandra.restore.serviceAccountRef` | Advanced | **Introduced in version:** 1.2.0 **Default value:** None The name of an existing Kubernetes secret that stores the content of a [Google Service Account](https://cloud.google.com/iam/docs/service-account-overview) key file that has the **Storage Object Admin** (`roles/storage.objectAdmin`) role. This Google Service Account will be used to download backup archives from a specified [`cassandra.restore.dbStorageBucket`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#cassandra-restore-dbstoragebucket). <br /> **If restore is enabled and [`cassandra.restore.cloudProvider`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#cassandra-restore-cloudprovider) is set to `GCP`, one of the following is required to ensure Apigee Hybrid can access the Google Cloud Storage bucket to download backup archives for restoration:** - Specified [`cassandra.restore.serviceAccountPath`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#cassandra-restore-serviceaccountpath). - Specified [`cassandra.restore.serviceAccountRef`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#cassandra-restore-serviceaccountref). - Configured [Workload Identity for Apigee Hybrid in GKE](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/install-workload-identity.md.txt). - Configured [Workload Identity Federation for Apigee Hybrid in AKS or EKS](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/enable-workload-identity-federation.md.txt). <br /> |
| `cassandra.restore.snapshotTimestamp` | Advanced | **Introduced in version:** 1.0.0 **Default value:** None **Required if restore is enabled.** Timestamp of the backup that should be restored. |
| `cassandra.sslCertPath` | Basic | **Introduced in version:** 1.2.0 **Default value:** None The path on your system to a TLS certificate file. > [!NOTE] > **Note:** For each configured environment, the Common Name (CN) in the cert must match the domain in the `hostAliases[]` property. For example, if the CN is `*.example.com`, the `hostAliases[]` could be `foo.example.com` or `bar.example.com`. > <br /> |
| `cassandra.sslKeyPath` | Basic | **Introduced in version:** 1.2.0 **Default value:** None The path on your system to the TLS private key file. <br /> |
| `cassandra.sslRootCAPath` | Basic | **Introduced in version:** 1.2.0 **Default value:** None The certificate chain to the root CA (certificate authority). |
| `cassandra.storage.capacity` | Basic | **Introduced in version:** 1.0.0 **Default value:** `10Gi` **Required if `storage.storageclass` is specified** Specifies the disk size required, in mebibytes (Mi) or gibibytes (Gi). |
| `cassandra.storage.storageclass` | Basic | **Introduced in version:** 1.0.0 **Default value:** None Specifies the class of on-prem storage being used. |
| `cassandra.storage.storageSize` | Basic | **Introduced in version:** 1.0.0 **Default value:** `10Gi` **Required if `storage.storageclass` is specified** Specifies the disk size required, in mebibytes (Mi) or gibibytes (Gi). |
| `cassandra.terminationGracePeriodSeconds` | Advanced | **Introduced in version:** 1.0.0 **Default value:** `300` The maximum time between a request for pod deletion and when the pod is killed, in seconds. During this period, any prestop hooks will be executed and any running process should terminate gracefully. The pod will be killed when all running processes have terminated or at the end of the grace period, whichever comes first. If there are no running processes, the pod will be killed immediately. |
| `cassandra.tolerations.effect` | Advanced | **Introduced in version:** 1.10.1 **Default value:** None Required to use the [Taints and Tolerations feature of Kubernetes](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/). `effect` specifies the effect that matching a toleration with a taint will have. Values for `effect` can be: - `NoExecute` - `NoSchedule` - `PreferNoSchedule` See [Taints and Tolerations: Concepts](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/#concepts) for details. |
| `cassandra.tolerations.key` | Advanced | **Introduced in version:** 1.10.1 **Default value:** None Required to use the [Taints and Tolerations feature of Kubernetes](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/). `key` identifies pods to which the toleration can be applied. See [Taints and Tolerations: Concepts](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/#concepts) for details. |
| `cassandra.tolerations.operator` | Advanced | **Introduced in version:** 1.10.1 **Default value:** `"Equal"` Required to use the [Taints and Tolerations feature of Kubernetes](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/). `operator` specifies the operation used to trigger the [`effect`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#cassandra-tolerations-effect). Values for `operator` can be: - `Equal` matches the value set in [`value`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#cassandra-tolerations-value). - `Exists` ignores the value set in [`value`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#cassandra-tolerations-value). See [Taints and Tolerations: Concepts](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/#concepts) for details. |
| `cassandra.tolerations.tolerationSeconds` | Advanced | **Introduced in version:** 1.10.1 **Default value:** None Used by the [Taints and Tolerations feature of Kubernetes](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/). `tolerationSeconds` defines in seconds how long a pod stays bound to a failing or unresponsive node. See [Taints and Tolerations: Concepts](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/#concepts) for details. |
| `cassandra.tolerations.value` | Advanced | **Introduced in version:** 1.10.1 **Default value:** None Used by the [Taints and Tolerations feature of Kubernetes](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/). `value` is the value that triggers the [`effect`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#cassandra-tolerations-effect) when [`operator`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#cassandra-tolerations-operator) is set to `Equal`. See [Taints and Tolerations: Concepts](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/#concepts) for details. |

## `certManager`

Apigee uses [cert-manager](https://cert-manager.io/) for certificate
validation.

The following table describes the properties of the `certManager` object:

| Property | Type | Description |
|---|---|---|
| `certManager.namespace` | Advanced | **Introduced in version:** 1.9.0 **Default value:** `cert-manager` The namespace for [cert-manager](https://cert-manager.io/). See [Running cert-manager in a custom namespace](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/cert-manager-custom-namespace.md.txt). |

## `connectAgent`

Apigee Connect allows the Apigee hybrid management plane to connect securely to the MART service
in the runtime plane without requiring you to expose the MART endpoint on the internet.

The following table describes the properties of the `connectAgent` object:

| Property | Type | Description |
|---|---|---|
| `connectAgent.annotations` | Advanced | **Introduced in version:** 1.5.0 **Default value:** None Optional key/value map used to annotate pods. For more information, see [Custom annotations](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/customize-services.md.txt#custom-annotations). |
| `connectAgent.gsa` | Advanced | **Introduced in version:** 1.10.0 **Default value:** None **Helm only** : The email address of the Google IAM service account (GSA) for connectAgent to associate with the corresponding Kubernetes service account when enabling Workload Identity on GKE clusters using Helm charts. Set this when you have set [`gcp.workloadIdentity.enabled`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#gcp-workloadidentity-enabled) to `true`. > [!NOTE] > **Note:** connectAgent uses the `apigee-mart` service account. GSA email addresses typically have the format of: ``` GSA_NAME@PROJECT_ID.iam.gserviceaccount.com ``` For example: ``` apigee-mart@my-hybrid-project.iam.gserviceaccount.com ``` > [!TIP] > **Tip:** You can find the email address of your service accounts with the following command: > ``` > gcloud iam service-accounts list --project ${PROJECT_ID} --filter "apigee" > ``` See [Enabling Workload Identity on GKE](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/enable-workload-identity-gke.md.txt) or [Enabling Workload Identity Federation on AKS and EKS](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/enable-workload-identity-federation.md.txt). |
| `connectAgent.logLevel` | Advanced | **Introduced in version:** 1.2.0 **Default value:** `INFO` The level of log reporting. Values can be: - `INFO`: Informational messages in addition to warning, error, and fatal messages. Most useful for debugging. - `WARNING`: Non-fatal warnings in addition to error and fatal messages. - `ERROR`: Internal errors and errors that are not returned to the user in addition to fatal messages. - `FATAL`: Unrecoverable errors and events that cause Apigee Connect to crash. |
| `connectAgent.image.pullPolicy` | Advanced | **Introduced in version:** 1.2.0 **Default value:** `IfNotPresent` Determines when [kubelet](https://kubernetes.io/docs/reference/command-line-tools-reference/kubelet/#kubelet) pulls the pod's Docker image. Possible values include: - `IfNotPresent`: Do not pull a new image if it already exists. - `Always`: Always pull the image, regardless of whether it exists already. For more information, see [Updating images](https://kubernetes.io/docs/concepts/containers/images/#updating-images). |
| `connectAgent.image.tag` | Advanced | **Introduced in version:** 1.2.0 **Default value:** `1.14.10` The version label for this service's Docker image. |
| `connectAgent.image.url` | Advanced | **Introduced in version:** 1.2.0 **Default value:** None The location of the Docker image for this service. Use `apigee-pull-push --list` to see the current repository URL for this component. > [!TIP] > **Tip:** Consider using [`hub`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#hub) to set a private repository URL for all components instead of configuring them individually. |
| `connectAgent.podDisruptionBudget.minAvailable` | Advanced | **Introduced in version:** 1.14.10 **Default value:** None **Chart:** `apigee-org` The minimum number of Apigee Connect agent pods that must stay available during a voluntary disruption, for example during a node pool upgrade or a node drain. This field sets the `minAvailable` field of the [PodDisruptionBudget](https://kubernetes.io/docs/concepts/workloads/pods/disruptions/) for these pods. It takes either an integer number of pods (`1`) or a percentage string (`"50%"`). `minAvailable` and `maxUnavailable` are mutually exclusive; set only one. Setting both at once is rejected by the Apigee operator. If you set neither field, the Apigee operator still generates a PodDisruptionBudget for these pods, using `maxUnavailable: 1` by default. For example, in `overrides.yaml`: ``` connectAgent: podDisruptionBudget: minAvailable: "50%" ``` |
| `connectAgent.podDisruptionBudget.maxUnavailable` | Advanced | **Introduced in version:** 1.14.10 **Default value:** None **Chart:** `apigee-org` The maximum number of Apigee Connect agent pods that can be unavailable during a voluntary disruption, for example during a node pool upgrade or a node drain. This field sets the `maxUnavailable` field of the [PodDisruptionBudget](https://kubernetes.io/docs/concepts/workloads/pods/disruptions/) for these pods. It takes either an integer number of pods (`1`) or a percentage string (`"50%"`). `maxUnavailable` and `minAvailable` are mutually exclusive; set only one. Setting both at once is rejected by the Apigee operator. If you set neither field, the Apigee operator still generates a PodDisruptionBudget for these pods, using `maxUnavailable: 1` by default. For example, in `overrides.yaml`: ``` connectAgent: podDisruptionBudget: maxUnavailable: 1 ``` |
| `connectAgent.replicaCountMax` | Basic | **Introduced in version:** 1.2.0 **Default value:** `5` Maximum number of replicas available for autoscaling. |
| `connectAgent.replicaCountMin` | Basic | **Introduced in version:** 1.2.0 **Default value:** `1` Minimum number of replicas available for autoscaling. In production, you may want to increase `replicaCountMin` to 1, to have a greater number of connections to the control plane for reliability and scalability. |
| `connectAgent.resources.limits.cpu` | Advanced | **Introduced in version:** 1.11.0 **Default value:** `512m` The CPU limit for the resource in a Kubernetes container, in millicores. |
| `connectAgent.resources.limits.memory` | Advanced | **Introduced in version:** 1.11.0 **Default value:** `512Mi` The memory limit for the resource in a Kubernetes container, in mebibytes. |
| `connectAgent.resources.requests.cpu` | Advanced | **Introduced in version:** 1.11.0 **Default value:** `100m` The CPU needed for normal operation of the resource in a Kubernetes container, in millicores. |
| `connectAgent.resources.requests.memory` | Advanced | **Introduced in version:** 1.2.0 **Default value:** `30Mi` The memory needed for normal operation of the resource in a Kubernetes container, in mebibytes. |
| `connectAgent.server` | Advanced | **Introduced in version:** 1.2.0 **Default value:** `apigeeconnect.googleapis.com:443` The location of the server and port for this service. |
| `connectAgent.serviceAccountPath` | Basic | **Introduced in version:** 1.1.1 **Default value:** None One of either `serviceAccountPath` or `serviceAccountRef` is required. Path to Google Service Account key file for the `apigee-mart` service account. In most installations, the value of `connectAgent.serviceAccountPath` must match the value of [`mart.serviceAccountPath`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#mart-serviceaccountpath). |
| `connectAgent.serviceAccountRef` | Basic | **Introduced in version:** 1.2.0 **Default value:** None One of either `serviceAccountPath` or `serviceAccountRef` is required. In most installations, the value of `connectAgent.serviceAccountRef` must match the value of [`mart.serviceAccountRef`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#mart-serviceaccountref). |
| `connectAgent.targetCPUUtilizationPercentage` | Advanced | **Introduced in version:** 1.2.0 **Default value:** `75` Target CPU utilization for the Apigee Connect agent on the pod. The value of this field enables Apigee Connect to auto-scale when CPU utilization reaches this value, up to `replicaCountMax`. |
| `connectAgent.terminationGracePeriodSeconds` | Advanced | **Introduced in version:** 1.2.0 **Default value:** `600` The maximum time between a request for pod deletion and when the pod is killed, in seconds. During this period, any prestop hooks will be executed and any running process should terminate gracefully. The pod will be killed when all running processes have terminated or at the end of the grace period, whichever comes first. If there are no running processes, the pod will be killed immediately. |
| `connectAgent.tolerations.effect` | Advanced | **Introduced in version:** 1.10.1 **Default value:** None Required to use the [Taints and Tolerations feature of Kubernetes](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/). `effect` specifies the effect that matching a toleration with a taint will have. Values for `effect` can be: - `NoExecute` - `NoSchedule` - `PreferNoSchedule` See [Taints and Tolerations: Concepts](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/#concepts) for details. |
| `connectAgent.tolerations.key` | Advanced | **Introduced in version:** 1.10.1 **Default value:** None Required to use the [Taints and Tolerations feature of Kubernetes](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/). `key` identifies pods to which the toleration can be applied. See [Taints and Tolerations: Concepts](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/#concepts) for details. |
| `connectAgent.tolerations.operator` | Advanced | **Introduced in version:** 1.10.1 **Default value:** `"Equal"` Required to use the [Taints and Tolerations feature of Kubernetes](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/). `operator` specifies the operation used to trigger the [`effect`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#connectagent-tolerations-effect). Values for `operator` can be: - `Equal` matches the value set in [`value`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#connectagent-tolerations-value). - `Exists` ignores the value set in [`value`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#connectagent-tolerations-value). See [Taints and Tolerations: Concepts](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/#concepts) for details. |
| `connectAgent.tolerations.tolerationSeconds` | Advanced | **Introduced in version:** 1.10.1 **Default value:** None Used by the [Taints and Tolerations feature of Kubernetes](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/). `tolerationSeconds` defines in seconds how long a pod stays bound to a failing or unresponsive node. See [Taints and Tolerations: Concepts](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/#concepts) for details. |
| `connectAgent.tolerations.value` | Advanced | **Introduced in version:** 1.10.1 **Default value:** None Used by the [Taints and Tolerations feature of Kubernetes](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/). `value` is the value that triggers the [`effect`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#connectagent-tolerations-effect) when [`operator`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#connectagent-tolerations-operator) is set to `Equal`. See [Taints and Tolerations: Concepts](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/#concepts) for details. |

## `defaults`

The Default encryption keys for the Apigee hybrid installation.

> [!NOTE]
> **Note:** You need to update these for your installation.

The following table describes the properties of the `defaults` object:

| Property | Type | Description |
|---|---|---|
| `defaults.org.kmsEncryptionKey` | Basic | **Introduced in version:** 1.0.0 **Default value:** `aWxvdmVhcGlzMTIzNDU2Nw==` Default encryption key for the org in KMS. |
| `defaults.org.kvmEncryptionKey` | Basic | **Introduced in version:** 1.0.0 **Default value:** `aWxvdmVhcGlzMTIzNDU2Nw==` Default encryption key for the org in KVM. |
| `defaults.env.kmsEncryptionKey` | Basic | **Introduced in version:** 1.0.0 **Default value:** `aWxvdmVhcGlzMTIzNDU2Nw==` Default encryption key for the environment (env) in KMS. |
| `defaults.env.kvmEncryptionKey` | Basic | **Introduced in version:** 1.0.0 **Default value:** `aWxvdmVhcGlzMTIzNDU2Nw==` Default encryption key for the environment (env) in KVM. |
| `defaults.env.cacheEncryptionKey` | Basic | **Introduced in version:** 1.0.0 **Default value:** `aWxvdmVhcGlzMTIzNDU2Nw==` Default cache encryption key for the environment (env). |

## `envs`

Defines an array of environments to which you can deploy your API proxies. Each environment
provides an isolated context or *sandbox* for running API proxies.

Your hybrid-enabled organization must have at least one environment.

For more information, see [About environments](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/environments-about.md.txt).

The following table describes the properties of the `envs`
object:

| Property | Type | Description |
|---|---|---|
| `envs[].cacheEncryptionKey` | Basic | **Introduced in version:** 1.0.0 **Default value:** None One of either `cacheEncryptionKey`, `cacheEncryptionPath`, or `cacheEncryptionSecret` is required. A base64-encoded encryption key. See [Data encryption](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/key-encryption.md.txt). |
| `envs[].cacheEncryptionPath` | Basic | **Introduced in version:** 1.2.0 **Default value:** None One of either `cacheEncryptionKey`, `cacheEncryptionPath`, or `cacheEncryptionSecret` is required. The path to a file containing a base64-encoded encryption key. See [Data encryption](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/key-encryption.md.txt). |
| `envs[].cacheEncryptionSecret.key` | Basic | **Introduced in version:** 1.2.0 **Default value:** None One of either `cacheEncryptionKey`, `cacheEncryptionPath`, or `cacheEncryptionSecret` is required. The key of a [Kubernetes secret](https://kubernetes.io/docs/concepts/configuration/secret/) containing a base64-encoded encryption key. See [Data encryption](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/key-encryption.md.txt). |
| `envs[].cacheEncryptionSecret.name` | Basic | **Introduced in version:** 1.2.0 **Default value:** None One of either `cacheEncryptionKey`, or `cacheEncryptionPath`, or `cacheEncryptionSecret` is required. The name of a [Kubernetes secret](https://kubernetes.io/docs/concepts/configuration/secret/) containing a base64-encoded encryption key. See [Data encryption](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/key-encryption.md.txt). |
| `envs[].components.runtime.resources.limits.memory` | Advanced | **Introduced in version:** 1.14.1 **Default value:** None The memory limit for the resource in a Kubernetes container, in mebibytes (Mi) or gibibytes (Gi). **Important:** Setting this property for this environment causes Apigee not to use the values of: - [`runtime.resources.limits.memory`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#runtime-resources-limits-memory) - [`runtime.resources.requests.memory`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#runtime-resources-requests-memory) If you set this property, you must also set [`envs[].components.runtime.resources.requests.memory`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#envs-components-runtime-resources-requests-memory) for this environment. > [!NOTE] > **Note:** If you are using message payloads larger than 10MB for this environment, you must make the following configuration changes: > - Increase the heap size to 4Gi. > - Increase [`envs[].components.runtime.resources.limits.memory`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#envs-components-runtime-resources-limits-memory) to 6Gi. > - Increase [`envs[].components.runtime.resources.requests.memory`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#envs-components-runtime-resources-requests-memory) to 4Gi. > See [Configure large message payload support in Apigee hybrid](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/configure-large-payload-support.md.txt) for more details. |
| `envs[].components.runtime.resources.requests.memory` | Advanced | **Introduced in version:** 1.14.1 **Default value:** None The memory needed for normal operation of the resource in a Kubernetes container, in mebibytes (`Mi`) or Gibibytes (`Gi`). **Important:** Setting this property for this environment causes Apigee not to use the values of: - [`runtime.resources.limits.memory`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#runtime-resources-limits-memory) - [`runtime.resources.requests.memory`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#runtime-resources-requests-memory) If you set this property, you must also set [`envs[].components.runtime.resources.limits.memory`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#envs-components-runtime-resources-limits-memory) for this environment. > [!NOTE] > **Note:** If you are using message payloads larger than 10MB for this environment, you must make the following configuration changes: > - Increase the heap size to 4Gi. > - Increase [`envs[].components.runtime.resources.limits.memory`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#envs-components-runtime-resources-limits-memory) to 6Gi. > - Increase [`envs[].components.runtime.resources.requests.memory`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#envs-components-runtime-resources-requests-memory) to 4Gi. > See [Configure large message payload support in Apigee hybrid](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/configure-large-payload-support.md.txt) for more details. |
| `envs[].components.runtime.podDisruptionBudget.minAvailable` | Advanced | **Introduced in version:** 1.14.10 **Default value:** None **Chart:** `apigee-env` The minimum number of runtime pods in this environment that must stay available during a voluntary disruption, such as during a node pool upgrade or a node drain. Overrides [`runtime.podDisruptionBudget.minAvailable`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#runtime-poddisruptionbudget-minavailable). This field sets the `minAvailable` field of the [PodDisruptionBudget](https://kubernetes.io/docs/concepts/workloads/pods/disruptions/) for these pods. It takes either an integer number of pods (`1`) or a percentage string (`"50%"`). `minAvailable` and `maxUnavailable` are mutually exclusive; set only one. The Apigee operator rejects setting both at once. If you set neither field, this environment uses `runtime.podDisruptionBudget.minAvailable` or [`runtime.podDisruptionBudget.maxUnavailable`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#runtime-poddisruptionbudget-maxunavailable); if neither of those is set, the Apigee operator applies its default of `maxUnavailable: 1`. For example, in `overrides.yaml`: ``` envs: - name: test components: runtime: podDisruptionBudget: minAvailable: "50%" ``` |
| `envs[].components.runtime.podDisruptionBudget.maxUnavailable` | Advanced | **Introduced in version:** 1.14.10 **Default value:** None **Chart:** `apigee-env` The maximum number of runtime pods in this environment that can be unavailable during a voluntary disruption, such as during a node pool upgrade or a node drain. Overrides [`runtime.podDisruptionBudget.maxUnavailable`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#runtime-poddisruptionbudget-maxunavailable). This field sets the `maxUnavailable` field of the [PodDisruptionBudget](https://kubernetes.io/docs/concepts/workloads/pods/disruptions/) for these pods. It takes either an integer number of pods (`1`) or a percentage string (`"50%"`). `maxUnavailable` and `minAvailable` are mutually exclusive; set only one. The Apigee operator rejects setting both at once. If you set neither field, this environment uses [`runtime.podDisruptionBudget.minAvailable`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#runtime-poddisruptionbudget-minavailable) or `runtime.podDisruptionBudget.maxUnavailable`; if neither of those is set, the Apigee operator applies its default of `maxUnavailable: 1`. For example, in `overrides.yaml`: ``` envs: - name: test components: runtime: podDisruptionBudget: maxUnavailable: 1 ``` |
| `envs[].components.runtime.replicaCountMax` | Basic | **Introduced in version:** 1.9.3 **Default value:** 4 Maximum number of replicas for autoscaling. Overrides `runtime.replicaCountMax` if specified. |
| `envs[].components.runtime.replicaCountMin` | Basic | **Introduced in version:** 1.9.3 **Default value:** 1 Minimum number of replicas for autoscaling. Overrides `runtime.replicaCountMin` if specified. |
| `envs[].components.synchronizer.podDisruptionBudget.minAvailable` | Advanced | **Introduced in version:** 1.14.10 **Default value:** None **Chart:** `apigee-env` The minimum number of synchronizer pods in this environment that must stay available during a voluntary disruption, such as during a node pool upgrade or a node drain. Overrides [`synchronizer.podDisruptionBudget.minAvailable`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#synchronizer-poddisruptionbudget-minavailable). This field sets the `minAvailable` field of the [PodDisruptionBudget](https://kubernetes.io/docs/concepts/workloads/pods/disruptions/) for these pods. It takes either an integer number of pods (`1`) or a percentage string (`"50%"`). `minAvailable` and `maxUnavailable` are mutually exclusive; set only one. The Apigee operator rejects setting both at once. If you set neither field, this environment uses `synchronizer.podDisruptionBudget.minAvailable` or [`synchronizer.podDisruptionBudget.maxUnavailable`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#synchronizer-poddisruptionbudget-maxunavailable); if neither of those is set, the Apigee operator applies its default of `maxUnavailable: 1`. For example, in `overrides.yaml`: ``` envs: - name: test components: synchronizer: podDisruptionBudget: minAvailable: "50%" ``` |
| `envs[].components.synchronizer.podDisruptionBudget.maxUnavailable` | Advanced | **Introduced in version:** 1.14.10 **Default value:** None **Chart:** `apigee-env` The maximum number of synchronizer pods in this environment that can be unavailable during a voluntary disruption, such as during a node pool upgrade or a node drain. Overrides [`synchronizer.podDisruptionBudget.maxUnavailable`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#synchronizer-poddisruptionbudget-maxunavailable). This field sets the `maxUnavailable` field of the [PodDisruptionBudget](https://kubernetes.io/docs/concepts/workloads/pods/disruptions/) for these pods. It takes either an integer number of pods (`1`) or a percentage string (`"50%"`). `maxUnavailable` and `minAvailable` are mutually exclusive; set only one. The Apigee operator rejects setting both at once. If you set neither field, this environment uses [`synchronizer.podDisruptionBudget.minAvailable`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#synchronizer-poddisruptionbudget-minavailable) or `synchronizer.podDisruptionBudget.maxUnavailable`; if neither of those is set, the Apigee operator applies its default of `maxUnavailable: 1`. For example, in `overrides.yaml`: ``` envs: - name: test components: synchronizer: podDisruptionBudget: maxUnavailable: 1 ``` |
| `envs[].components.synchronizer.pollInterval` | Advanced | **Introduced in version:** 1.14.11 **Default value:** None **Chart:** `apigee-env` Override [`synchronizer.pollInterval`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#synchronizer-pollinterval) to set the number of seconds that Synchronizer waits between polling operations in this environment. If you set a value less than `60`, Synchronizer uses `60`. If you don't set this property, this environment uses [`envs[].pollInterval`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#envs-pollinterval). If you set neither property, this environment uses `synchronizer.pollInterval`, which defaults to `60`. For example, in `overrides.yaml`: ``` envs: - name: test components: synchronizer: pollInterval: 120 ``` |
| `envs[].components.synchronizer.replicaCountMax` | Basic | **Introduced in version:** 1.9.3 **Default value:** 4 Maximum number of replicas for autoscaling. Overrides `synchronizer.replicaCountMax` if specified. |
| `envs[].components.synchronizer.replicaCountMin` | Basic | **Introduced in version:** 1.9.3 **Default value:** 1 Minimum number of replicas for autoscaling. Overrides `synchronizer.replicaCountMin` if specified. |
| `envs[].components.udca.replicaCountMax` | Basic | **Introduced in version:** 1.9.3 **Default value:** 4 Maximum number of replicas for autoscaling. Overrides `udca.replicaCountMax` if specified. |
| `envs[].components.udca.replicaCountMin` | Basic | **Introduced in version:** 1.9.3 **Default value:** 1 Minimum number of replicas for autoscaling. Overrides `udca.replicaCountMin` if specified. |
| `envs.gsa.runtime` | Advanced | **Introduced in version:** 1.10.0 **Default value:** None **Helm only**: The email address of the runtime Google IAM service account to associate with the corresponding Kubernetes service account when enabling Workload Identity on GKE clusters using Helm charts. > [!TIP] > **Tip:** You can find the email address of your service accounts with the following command: > ``` > gcloud iam service-accounts list --project ${PROJECT_ID} --filter "apigee" > ``` See [Enabling Workload Identity on GKE](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/enable-workload-identity-gke.md.txt) or [Enabling Workload Identity Federation on AKS and EKS](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/enable-workload-identity-federation.md.txt). |
| `envs.gsa.synchronizer` | Advanced | **Introduced in version:** 1.10.0 **Default value:** None **Helm only**: The email address of the synchronizer Google IAM service account to associate with the corresponding Kubernetes service account when enabling Workload Identity on GKE clusters using Helm charts. > [!TIP] > **Tip:** You can find the email address of your service accounts with the following command: > ``` > gcloud iam service-accounts list --project ${PROJECT_ID} --filter "apigee" > ``` See [Enabling Workload Identity on GKE](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/enable-workload-identity-gke.md.txt) or [Enabling Workload Identity Federation on AKS and EKS](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/enable-workload-identity-federation.md.txt). |
| `envs.gsa.udca` | Advanced | **Introduced in version:** 1.10.0 **Default value:** None **Helm only**: The email address of the udca Google IAM service account for env-scoped udca to associate with the corresponding Kubernetes service account when enabling Workload Identity on GKE clusters using Helm charts. > [!TIP] > **Tip:** You can find the email address of your service accounts with the following command: > ``` > gcloud iam service-accounts list --project ${PROJECT_ID} --filter "apigee" > ``` See [Enabling Workload Identity on GKE](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/enable-workload-identity-gke.md.txt) or [Enabling Workload Identity Federation on AKS and EKS](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/enable-workload-identity-federation.md.txt). |
| `envs[].hostAliases[]` | Basic | **Introduced in version:** 1.2.0 **Default value:** None <var translate="no">Deprecated</var>: Starting in Hybrid version 1.4 the runtime plane receives this information from the management plane. See [About environments and environment groups](https://docs.cloud.google.com/apigee/docs/api-platform/fundamentals/environments-overview.md.txt). |
| `envs[].httpProxy.host` | Basic | **Introduced in version:** 1.2.0 **Default value:** None Specifies the host name or IP address where the HTTP proxy is running. List `httpProxy` properties in the order `scheme`, `host`, `port`. For example: ``` envs: - name: test httpProxy: scheme: HTTP host: 10.12.0.47 port: 3128 ... ``` See also: [Configure forward proxying for API proxies](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/forward-proxy.md.txt). |
| `envs[].httpProxy.port` | Basic | **Introduced in version:** 1.2.0 **Default value:** None Specifies the port on which the HTTP proxy is running. If this property is omitted, by default it uses port `80` for HTTP and port `443` for HTTPS. |
| `envs[].httpProxy.scheme` | Basic | **Introduced in version:** 1.2.0 **Default value:** `HTTPS` Specifies the type of the HTTP proxy as HTTP or HTTPS. By default, it uses `HTTPS`. |
| `envs[].httpProxy.username` | Basic | **Introduced in version:** 1.2.0 **Default value:** None If the HTTP proxy requires basic authentication, then use this property to provide a username. |
| `envs[].httpProxy.password` | Basic | **Introduced in version:** 1.2.0 **Default value:** None If the HTTP proxy requires basic authentication, then use this property to provide a password. |
| `envs[].name` | Basic | **Introduced in version:** 1.0.0 **Default value:** None **Required** Apigee environment name to be synchronized. |
| `envs[].pollInterval` | Advanced | **Introduced in version:** 1.0.0 **Default value:** None Interval used for polling organization and environment synchronization changes, in seconds. > [!NOTE] > **Note:** Use [`envs[].components.synchronizer.pollInterval`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#envs-components-synchronizer-pollinterval) instead. If you set both properties for an environment, `envs[].components.synchronizer.pollInterval` takes precedence. Starting in version 1.14.11, this property overrides [`synchronizer.pollInterval`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#synchronizer-pollinterval) for this environment. If you set a value less than `60`, Synchronizer uses `60`. In versions earlier than 1.14.11, Apigee hybrid doesn't apply this property. |
| `envs[].port` | Advanced | **Introduced in version:** 1.0.0 **Default value:** None TCP port number for HTTPS traffic. |
| `envs[].serviceAccountPaths.runtime` | Basic | **Introduced in version:** 1.4.0 **Default value:** None Path to file on local system to a Google Service Account key with the **Cloud Trace Agent** role, usually the `apigee-runtime` service account. See the [About service accounts]() for the default names of the service accounts and their assigned roles. |
| `envs[].serviceAccountPaths.synchronizer` | Basic | **Introduced in version:** 1.0 **Default value:** None Path to file on local system to a Google Service Account key with the **Apigee Synchronizer Manager** role. |
| `envs[].serviceAccountPaths.udca` | Basic | **Introduced in version:** 1.0 **Default value:** None Path to file on local system to a Google Service Account key with the **Apigee Analytic Agent** role. Only set this property if [`orgScopedUDCA`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#orgscopedudca) is set to `false`. |
| `envs[].serviceAccountSecretProviderClass` | Advanced | **Introduced in version:** 1.12.0 **Default value:** None The name of the environment-specific secret provider class (`SecretProviderClass`) used for storing service account keys in Vault. See [Storing service account keys in Hashicorp Vault](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/storing-sa-keys-in-vault.md.txt). |
| `envs[].serviceAccountSecretRefs.runtime` | Basic | **Introduced in version:** 1.4.0 **Default value:** None The name of a [Kubernetes secret](https://kubernetes.io/docs/concepts/configuration/secret/). You must [create the secret](https://kubernetes.io/docs/concepts/configuration/secret/#creating-a-secret-using-kubectl) using a Google Service Account key with the **Cloud Trace Agent** role as its input. |
| `envs[].serviceAccountSecretRefs.synchronizer` | Basic | **Introduced in version:** 1.2.0 **Default value:** None The name of a [Kubernetes secret](https://kubernetes.io/docs/concepts/configuration/secret/). You must [create the secret](https://kubernetes.io/docs/concepts/configuration/secret/#creating-a-secret-using-kubectl) using a Google Service Account key with the **Apigee Synchronizer Manager** role as its input. |
| `envs[].serviceAccountSecretRefs.udca` | Basic | **Introduced in version:** 1.2.0 **Default value:** None The name of a [Kubernetes secret](https://kubernetes.io/docs/concepts/configuration/secret/). You must [create the secret](https://kubernetes.io/docs/concepts/configuration/secret/#creating-a-secret-using-kubectl) using a Google Service Account key with the **Apigee Analytic Agent** role as its input. Only set this property if [`orgScopedUDCA`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#orgscopedudca) is set to `false`. |
| `envs[].sslCertPath` | Basic | **Introduced in version:** 1.2.0 **Default value:** None **Either `sslCertPath`/`sslKeyPath` or `sslSecret` is required**. The path on your system to a TLS certificate file. > [!NOTE] > **Note:** For each configured environment, the Common Name (CN) in the cert must match the domain in the `hostAliases[]` property. For example, if the CN is `*.example.com`, the `hostAliases[]` could be `foo.example.com` or `bar.example.com`. > <br /> |
| `envs[].sslKeyPath` | Basic | **Introduced in version:** 1.2.0 **Default value:** None Either `sslCertPath`/`sslKeyPath` or `sslSecret` is required. The path on your system to the TLS private key file. <br /> |
| `envs[].sslSecret` | Basic | **Introduced in version:** 1.2.0 **Default value:** None **Either `sslCertPath`/`sslKeyPath` or `sslSecret` is required**. The name if the file stored in a Kubernetes secret that contains the Cassandra users and passwords. You can create the secret using following the following instructions: [Create the Secret](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/cassandra-tls.md.txt#create-the-secret). See also: - [Storing data in a Kubernetes secret](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/k8s-secrets.md.txt) - [Secrets](https://kubernetes.io/docs/concepts/configuration/secret/) in the Kubernetes documentation - [Creating a Secret Using kubectl](https://kubernetes.io/docs/concepts/configuration/secret/#creating-a-secret) in the Kubernetes documentation <br /> |

## `gcp`

Identifies the Google Cloud project ID (required for all hybrid installations), the Workload Identity and federated workload identity configurations, and the region where the `apigee-logger`
and the `apigee-metrics` push their data.

The following table describes the properties of the `gcp` object:

| Property | Type | Description |
|---|---|---|
| `gcp.federatedWorkloadIdentity.audience` | Basic | **Introduced in version:** 1.12.0 **Default value:** None The allowed audience of the Workload Identity Provider on non-GKE platforms. See [Enabling Workload Identity Federation on AKS and EKS](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/enable-workload-identity-federation.md.txt). |
| `gcp.federatedWorkloadIdentity.credentialSourceFile` | Basic | **Introduced in version:** 1.12.0 **Default value:** None The filename and path to the credential source file used by Workload Identity Federation to obtain the credentials for the service accounts. This is the value you provide for `credential-source-file` when you configure Workload Identity Federation with the `create-cred-config` command. See [Enabling Workload Identity Federation on AKS and EKS](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/enable-workload-identity-federation.md.txt). |
| `gcp.federatedWorkloadIdentity.enabled` | Basic | **Introduced in version:** 1.12.0 **Default value:** `false` Enables Workload Identity Federation on non-GKE platforms. Must not be set `true` if [`gcp.workloadIdentity.enabled`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#gcp-workloadidentity-enabled") is set to `true` in the same cluster. See [Enabling Workload Identity Federation on AKS and EKS](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/enable-workload-identity-federation.md.txt). |
| `gcp.federatedWorkloadIdentity.sidecarSpec.annotations` | Advanced | **Introduced in version:** 1.14.4 **Default value:** None **Chart:** `apigee-datastore`, `apigee-env`, `apigee-org`, `apigee-telemetry` A map of annotations to apply to hybrid pods when `gcp.federatedWorkloadIdentity.type` is `sidecar`. These can be supplemented or overridden by component-level annotations such as `runtime.annotations`. See [Use a sidecar for Workload Identity Federation](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/use-sidecar-for-wif.md.txt). |
| `gcp.federatedWorkloadIdentity.sidecarSpec.container` | Advanced | **Introduced in version:** 1.14.4 **Default value:** None **Chart:** `apigee-datastore`, `apigee-env`, `apigee-org`, `apigee-telemetry` A Kubernetes container specification map for the sidecar container, such as `image`, `imagePullPolicy`, `name`, etc. See Kubernetes container documentation. You must provide your custom container image here. Required when `gcp.federatedWorkloadIdentity.type` is `sidecar`. See [Use a sidecar for Workload Identity Federation](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/use-sidecar-for-wif.md.txt). |
| `gcp.federatedWorkloadIdentity.sidecarSpec.volumes` | Advanced | **Introduced in version:** 1.14.4 **Default value:** None **Chart:** `apigee-datastore`, `apigee-env`, `apigee-org`, `apigee-telemetry` A list of additional Kubernetes volumes to be mounted to hybrid pods when `gcp.federatedWorkloadIdentity.type` is `sidecar`. See [Use a sidecar for Workload Identity Federation](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/use-sidecar-for-wif.md.txt). |
| `gcp.federatedWorkloadIdentity.tokenExpiration` | Basic | **Introduced in version:** 1.12.0 **Default value:** `3600` The lifetime of the token in seconds. Used when `gcp.federatedWorkloadIdentity.type` is `kubernetes`. See [Enabling Workload Identity Federation on AKS and EKS](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/enable-workload-identity-token-expiration). |
| `gcp.federatedWorkloadIdentity.type` | Advanced | **Introduced in version:** 1.14.4 **Default value:** `kubernetes` **Chart:** `apigee-datastore`, `apigee-env`, `apigee-org`, `apigee-telemetry` The method used for obtaining Workload Identity Federation tokens. Supported values are: - `kubernetes`: Use Kubernetes Projected Service Account Tokens. See [Enabling Workload Identity Federation on AKS and EKS](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/enable-workload-identity-federation.md.txt). - `sidecar`: Use a sidecar container to fetch tokens from an Identity Provider. See [Use a sidecar for Workload Identity Federation](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/use-sidecar-for-wif.md.txt). |
| `gcp.projectID` | Basic | **Introduced in version:** 1.2.0 **Default value:** None **Required** Identifies the Google Cloud project where `apigee-logger` and the `apigee-metrics` push their data. |
| `gcp.projectIDRuntime` | Basic | **Introduced in version:** 1.2.0 **Default value:** None Identifies the runtime Kubernetes cluster project. The `projectIDRuntime` property is optional. If not used, it is assumed that the `projectID` value is used for both the Apigee organization's Google Cloud project and the runtime K8S cluster's project. |
| `gcp.region` | Basic | **Introduced in version:** 1.2.0 **Default value:** `us-central1` **Required** Identifies the Google Cloud [region](https://cloud.google.com/compute/docs/regions-zones#available) where the `apigee-logger` and the `apigee-metrics` push their data. |
| `gcp.workloadIdentity.enabled` | Basic | **Introduced in version:** 1.10.0 **Default value:** `false` **Helm only**: Enables using Workload Identity on GKE. Workload Identity allows workloads in your GKE clusters to impersonate Identity and Access Management (IAM) service accounts to access Google Cloud services. Must not be set `true` if [`gcp.federatedWorkloadIdentity.enabled`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#gcp-federatedworkloadidentity-enabled") is set to `true` in the same cluster. When `enabled` is `false`, the default, Apigee uses the IAM service accounts for each Apigee hybrid component. See [About service accounts](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/sa-about.md.txt). When `workloadIdentityEnabled` is `true`, Apigee uses Kubernetes service accounts and maps them to the appropriate IAM service accounts for each component. Specify the IAM service accounts to map to the Kubernetes service accounts with: - [`gcp.workloadIdentity.gsa`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#gcp-workloadidentity-gsa) - [`connectAgent.gsa`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#connectagent-gsa) - [`envs.gsa.runtime`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#envs-gsa-runtime) - [`envs.gsa.synchronizer`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#envs-gsa-synchronizer) - [`envs.gsa.udca`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#envs-gsa-udca) - [`logger.gsa`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#logger-gsa) - [`mart.gsa`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#mart-gsa) - [`metrics.gsa`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#metrics-gsa) - [`mintTaskScheduler.gsa`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#minttaskscheduler-gsa) - [`udca.gsa`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#udca-gsa) - [`watcher.gsa`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#watcher-gsa) |
| `gcp.workloadIdentity.gsa` | Advanced | **Introduced in version:** 1.10.0 **Default value:** None **Helm only** : The email address of the Google IAM service account (GSA) for all components to associate with the corresponding Kubernetes service account when enabling Workload Identity on GKE clusters using Helm charts. Set this when you have set [`gcp.workloadIdentity.enabled`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#gcp-workloadidentity-enabled) to `true`. `gcp.workloadIdentity.gsa` applies to all hybrid components. If you specify a value for `gcp.workloadIdentity.gsa`, you do not need to provide a GSA for any individual hybrid components. If you do supply a GSA for an individual component, that component's GSA overrides `gcp.workloadIdentity.gsa` for that component only. GSA email addresses typically have the format of: ``` GSA_NAME@PROJECT_ID.iam.gserviceaccount.com ``` For example: ``` apigee-non-prod@my-hybrid-project.iam.gserviceaccount.com ``` > [!TIP] > **Tip:** You can find the email address of your service accounts with the following command: > ``` > gcloud iam service-accounts list --project ${PROJECT_ID} --filter "apigee" > ``` See [`Enabling Workload Identity on GKE`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/enable-workload-identity-gke.md.txt). |
| `gcp.workloadIdentityEnabled` | Basic | **Introduced in version:** 1.4.0 **Default value:** `false` **`apigeectl` only**: Enables using Workload Identity. Workload Identity allows workloads in your GKE clusters to impersonate Identity and Access Management (IAM) service accounts to access Google Cloud services. When `workloadIdentityEnabled` is `false`, the default, Apigee uses the IAM service accounts for each Apigee hybrid component. See [About service accounts](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/sa-about.md.txt). When `workloadIdentityEnabled` is `true`, Apigee uses Kubernetes service accounts instead of IAM service accounts and will ignore the following configuration properties: - [`validateServiceAccounts`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#validateserviceaccounts) - [`cassandra.backup.serviceAccountPath`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#cassandra-backup-serviceaccountpath) - [`cassandra.backup.serviceAccountRef`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#cassandra-backup-serviceaccountref) - [`cassandra.restore.serviceAccountPath`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#cassandra-restore-serviceaccountpath) - [`cassandra.restore.serviceAccountRef`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#cassandra-restore-serviceaccountref) - [`envs[].serviceAccountPaths.*`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#envs-serviceaccountpaths-runtime) - [`logger.serviceAccountPath`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#logger-serviceaccountpath) - [`logger.serviceAccountRef`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#logger-serviceaccountref) - [`mart.serviceAccountPath`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#mart-serviceaccountpath) - [`mart.serviceAccountRef`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#mart-serviceaccountref) - [`metrics.serviceAccountPath`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#metrics-serviceaccountpath) - [`metrics.serviceAccountRef`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#metrics-serviceaccountref) - [`mintTaskScheduler.serviceAccountPath`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#minttaskscheduler-serviceaccountpath) - [`mintTaskScheduler.serviceAccountRef`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#minttaskscheduler-serviceaccountref) - [`synchronizer.serviceAccountPath`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#synchronizer-serviceaccountpath) - [`synchronizer.serviceAccountRef`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#synchronizer-serviceaccountref) - [`udca.serviceAccountPath`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#udca-serviceaccountpath) - [`udca.serviceAccountRef`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#udca-serviceaccountref) - [`watcher.serviceAccountPath`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#watcher-serviceaccountpath) - [`watcher.serviceAccountRef`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#watcher-serviceaccountref) |

## `httpProxy`

`httpProxy` provides configuration parameters for an HTTP forward proxy server. When
configured in `overrides.yaml`, all internet communication for the Apigee Connect, Logger, MART, Metrics, Synchronizer, and UDCA
components pass through the proxy server.

> [!NOTE]
> **Note:** Because the Apigee runtime uses environment-scoped HTTP proxy settings, you must ensure these proxy settings are configured so that API proxy requests to Target Endpoints and communication with Google APIs (\*.googleapis.com) that the hybrid runtime makes are routed through the forward proxy. See [Configure proxy forwarding for API proxies](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/forward-proxy.md.txt).


See also: [connectAgent](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#connectagent), [logger](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#logger), [mart](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#mart), [metrics](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#metrics),
[synchronizer](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#synchronizer), and [udca](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#udca).

The following table describes the properties of the `httpProxy` object:

| Property | Type | Description |
|---|---|---|
| `httpProxy.host` | Basic | **Introduced in version:** 1.1.1 **Default value:** None The hostname of the HTTP Proxy. |
| `httpProxy.password` | Basic | **Introduced in version:** 1.1.1 **Default value:** None If the HTTP proxy requires basic authentication, then use this property to provide a password. |
| `httpProxy.port` | Basic | **Introduced in version:** 1.1.1 **Default value:** None The port of the HTTP Proxy. |
| `httpProxy.scheme` | Basic | **Introduced in version:** 1.1.1 **Default value:** `HTTPS` The scheme used by the proxy. Values can be **`HTTP`** or **`HTTPS`**. Values must be uppercase only. |
| `httpProxy.useForRuntimeManagement` | Advanced | **Introduced in version:** 1.14.2 **Default value:** None If `useForRuntimeManagement` is set to `true`, debug or analytics data are routed by runtime using this forward proxy. You can set this flag even if runtime has its own proxy setup for its environment. In that case, runtime's debug or analytics data will use the proxy shared at the org level, whereas backend/proxy traffic will continue to use the environment level proxy (this includes calls to googleapis.com as well). |
| `httpProxy.username` | Basic | **Introduced in version:** 1.1.1 **Default value:** None If the HTTP proxy requires basic authentication, then use this property to provide a username. |

## `ingressGateways`

Configures each individual instance of the Apigee ingress gateway. Use these properties when you want
to manage individual instances separately by
[](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#ingressgateways-name)`ingressGateways[].name`.

See [`apigeeIngressGateway`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#apigeeingressgateway) to apply common
configuration across all instances of the Apigee ingress gateway.

Apply changes to `ingressGateways` properties with the `apigee-org`
chart.

The following table describes the properties of the `ingressGateways` object:

| Property | Type | Description |
|---|---|---|
| `ingressGateways[].name` | Basic | **Introduced in version:** 1.8.0 **Default value:** None **Required** The name of ingress gateway. Other services will use this name to address traffic to the gateway. The name must meet the following requirements: - have a maximum length of 17 characters - contain only lowercase alphanumeric characters, '-' or '.' - start with an alphanumeric character - end with an alphanumeric character For more information, see [DNS Subdomain Names](https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#dns-subdomain-names) in the Kubernetes documentation. |
| `ingressGateways[].podDisruptionBudget.minAvailable` | Advanced | **Introduced in version:** 1.14.10 **Default value:** None **Chart:** `apigee-org` The minimum number of pods for this ingress gateway that must stay available during a voluntary disruption, such as during a node pool upgrade or a node drain. Overrides [`apigeeIngressGateway.podDisruptionBudget.minAvailable`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#apigeeingressgateway-poddisruptionbudget-minavailable). This field sets the `minAvailable` field of the [PodDisruptionBudget](https://kubernetes.io/docs/concepts/workloads/pods/disruptions/) for these pods. It takes either an integer number of pods (`1`) or a percentage string (`"50%"`). `minAvailable` and `maxUnavailable` are mutually exclusive; set only one. The Apigee operator rejects setting both at once. If you set neither field, this gateway uses `apigeeIngressGateway.podDisruptionBudget.minAvailable` or [`apigeeIngressGateway.podDisruptionBudget.maxUnavailable`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#apigeeingressgateway-poddisruptionbudget-maxunavailable); if neither of those is set, the Apigee operator applies its default of `maxUnavailable: 1`. For example, in `overrides.yaml`: ``` ingressGateways: - name: my-gateway podDisruptionBudget: minAvailable: "50%" ``` |
| `ingressGateways[].podDisruptionBudget.maxUnavailable` | Advanced | **Introduced in version:** 1.14.10 **Default value:** None **Chart:** `apigee-org` The maximum number of pods for this ingress gateway that can be unavailable during a voluntary disruption, such as during a node pool upgrade or a node drain. Overrides [`apigeeIngressGateway.podDisruptionBudget.maxUnavailable`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#apigeeingressgateway-poddisruptionbudget-maxunavailable). This field sets the `maxUnavailable` field of the [PodDisruptionBudget](https://kubernetes.io/docs/concepts/workloads/pods/disruptions/) for these pods. It takes either an integer number of pods (`1`) or a percentage string (`"50%"`). `maxUnavailable` and `minAvailable` are mutually exclusive; set only one. The Apigee operator rejects setting both at once. If you set neither field, this gateway uses [`apigeeIngressGateway.podDisruptionBudget.minAvailable`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#apigeeingressgateway-poddisruptionbudget-minavailable) or `apigeeIngressGateway.podDisruptionBudget.maxUnavailable`; if neither of those is set, the Apigee operator applies its default of `maxUnavailable: 1`. For example, in `overrides.yaml`: ``` ingressGateways: - name: my-gateway podDisruptionBudget: maxUnavailable: 1 ``` |
| `ingressGateways[].resources.limits.cpu` | Advanced | **Introduced in version:** 1.8.0 **Default value:** `2000m` The CPU limit for the resource, in millicores. |
| `ingressGateways[].resources.limits.memory` | Advanced | **Introduced in version:** 1.8.0 **Default value:** `1Gi` The memory limit for the resource, in mebibytes. |
| `ingressGateways[].resources.requests.cpu` | Advanced | **Introduced in version:** 1.8.0 **Default value:** `300m` The CPU needed for normal operation of the resource, in millicores. |
| `ingressGateways[].resources.requests.memory` | Advanced | **Introduced in version:** 1.8.0 **Default value:** `128Mi` The memory needed for normal operation of the resource, in mebibytes. |
| `ingressGateways[].replicaCountMax` | Basic | **Introduced in version:** 1.8.0 **Default value:** `10` The maximum number of pods that hybrid can automatically add for the ingress gateway available for autoscaling. |
| `ingressGateways[].replicaCountMin` | Basic | **Introduced in version:** 1.8.0 **Default value:** `2` The minimum number of pods for the ingress gateway available for autoscaling. |
| `ingressGateways[].svcAnnotations` | Basic | **Introduced in version:** 1.8.0 **Default value:** None Optional key/value map used to annotate the ingress gateway on platforms that support annotation. For example: ``` ingressGateways: svcAnnotations: networking.gke.io/load-balancer-type: "Internal" ``` |
| `ingressGateways[].svcLoadBalancerIP` | Basic | **Introduced in version:** 1.8.0 **Default value:** None On platforms that support specifying the load balancer IP address, the load balancer will be created with this IP address. On platforms that do not allow you to specify the load balancer IP address, this property is ignored. |
| `ingressGateways[].svcType` | Basic | **Introduced in version:** 1.8.1 **Default value:** LoadBalancer Used to change the type of the default k8s service for ingress deployment. Set the value to `ClusterIP` if you want to disable creation of default load balancer. Possible values: - `ClusterIP` - `LoadBalancer` |
| `ingressGateways[].targetCPUUtilizationPercentage` | Advanced | **Introduced in version:** 1.10.5, 1.11.2, 1.12.1 **Default value:** `75` The threshold of CPU usage for scaling the number of pods in the ReplicaSet, as a percentage of total available CPU resources. When CPU usage goes above this value, then hybrid will gradually increase the number of pods in the ReplicaSet, up to [`ingressGateways[].replicaCountMax`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#ingressgateways-replicacountmax). For more information on scaling in Kubernetes, see [Horizontal Pod Autoscaling](https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale/) in the Kubernetes documentation. |
| `ingressGateways[].tolerations.effect` | Advanced | **Introduced in version:** 1.10.1 **Default value:** None Required to use the [Taints and Tolerations feature of Kubernetes](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/). `effect` specifies the effect that matching a toleration with a taint will have. Values for `effect` can be: - `NoExecute` - `NoSchedule` - `PreferNoSchedule` See [Taints and Tolerations: Concepts](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/#concepts) for details. |
| `ingressGateways[].tolerations.key` | Advanced | **Introduced in version:** 1.10.1 **Default value:** None Required to use the [Taints and Tolerations feature of Kubernetes](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/). `key` identifies pods to which the toleration can be applied. See [Taints and Tolerations: Concepts](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/#concepts) for details. |
| `ingressGateways[].tolerations.operator` | Advanced | **Introduced in version:** 1.10.1 **Default value:** `"Equal"` Required to use the [Taints and Tolerations feature of Kubernetes](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/). `operator` specifies the operation used to trigger the [`effect`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#ingressgateways-tolerations-effect). Values for `operator` can be: - `Equal` matches the value set in [`value`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#ingressgateways-tolerations-value). - `Exists` ignores the value set in [`value`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#ingressgateways-tolerations-value). See [Taints and Tolerations: Concepts](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/#concepts) for details. |
| `ingressGateways[].tolerations.tolerationSeconds` | Advanced | **Introduced in version:** 1.10.1 **Default value:** None Used by the [Taints and Tolerations feature of Kubernetes](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/). `tolerationSeconds` defines in seconds how long a pod stays bound to a failing or unresponsive node. See [Taints and Tolerations: Concepts](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/#concepts) for details. |
| `ingressGateways[].tolerations.value` | Advanced | **Introduced in version:** 1.10.1 **Default value:** None Used by the [Taints and Tolerations feature of Kubernetes](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/). `value` is the value that triggers the [`effect`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#ingressgateways-tolerations-effect) when [`operator`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#ingressgateways-tolerations-operator) is set to `Equal`. See [Taints and Tolerations: Concepts](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/#concepts) for details. |

## `istiod`

Configures the Apigee ingress.

The following table describes the properties of the `istiod` object:

| Property | Type | Description |
|---|---|---|
| `istiod.accessLogFile` | Advanced | **Introduced in version:** 1.8.0 **Default value:** `/dev/stdout` The file address for the ingress access log, for example `/dev/stdout`. Leaving this value undefined disables access logging. |
| `istiod.accessLogFormat` | Advanced | **Introduced in version:** 1.8.0 The format for the ingress access log. Leaving this value undefined results in using the proxy's default access log format. **Default access log format:** ``` '{"start_time":"%START_TIME%","remote_address":"%DOWNSTREAM_DIRECT_REMOTE_ADDRESS%","user_agent":"%REQ(USER-AGENT)%","host":"%REQ(:AUTHORITY)%","request":"%REQ(:METHOD)% %REQ(X-ENVOY-ORIGINAL-PATH?:PATH)% %PROTOCOL%","request_time":"%DURATION%","status":"%RESPONSE_CODE%","status_details":"%RESPONSE_CODE_DETAILS%","bytes_received":"%BYTES_RECEIVED%","bytes_sent":"%BYTES_SENT%","upstream_address":"%UPSTREAM_HOST%","upstream_response_flags":"%RESPONSE_FLAGS%","upstream_response_time":"%RESPONSE_DURATION%","upstream_service_time":"%RESP(X-ENVOY-UPSTREAM-SERVICE-TIME)%","upstream_cluster":"%UPSTREAM_CLUSTER%","x_forwarded_for":"%REQ(X-FORWARDED-FOR)%","request_method":"%REQ(:METHOD)%","request_path":"%REQ(X-ENVOY-ORIGINAL-PATH?:PATH)%","request_protocol":"%PROTOCOL%","tls_protocol":"%DOWNSTREAM_TLS_VERSION%","request_id":"%REQ(X-REQUEST-ID)%","sni_host":"%REQUESTED_SERVER_NAME%","apigee_dynamic_data":"%DYNAMIC_METADATA(envoy.lua)%"}' ``` The following is a copy of the default access log format with line breaks added for readability. ``` '{"start_time":"%START_TIME%", "remote_address":"%DOWNSTREAM_DIRECT_REMOTE_ADDRESS%", "user_agent":"%REQ(USER-AGENT)%", "host":"%REQ(:AUTHORITY)%", "request":"%REQ(:METHOD)% %REQ(X-ENVOY-ORIGINAL-PATH?:PATH)% %PROTOCOL%", "request_time":"%DURATION%", "status":"%RESPONSE_CODE%", "status_details":"%RESPONSE_CODE_DETAILS%", "bytes_received":"%BYTES_RECEIVED%", "bytes_sent":"%BYTES_SENT%", "upstream_address":"%UPSTREAM_HOST%", "upstream_response_flags":"%RESPONSE_FLAGS%", "upstream_response_time":"%RESPONSE_DURATION%", "upstream_service_time":"%RESP(X-ENVOY-UPSTREAM-SERVICE-TIME)%", "upstream_cluster":"%UPSTREAM_CLUSTER%", "x_forwarded_for":"%REQ(X-FORWARDED-FOR)%", "request_method":"%REQ(:METHOD)%", "request_path":"%REQ(X-ENVOY-ORIGINAL-PATH?:PATH)%", "request_protocol":"%PROTOCOL%", "tls_protocol":"%DOWNSTREAM_TLS_VERSION%", "request_id":"%REQ(X-REQUEST-ID)%", "sni_host":"%REQUESTED_SERVER_NAME%", "apigee_dynamic_data":"%DYNAMIC_METADATA(envoy.lua)%"}' ``` |
| `istiod.forwardClientCertDetails` | Advanced | **Introduced in version:** 1.9.2 **Default value:** `SANITIZE_SET` Determines how the Envoy proxy (for the Apigee ingress gateway) handles the `x-forwarded-client-cert` (XFCC) HTTP header. Possible values are: - `SANITIZE_SET` (default) When the client connection is mTLS, reset the XFCC header with the client certificate information and send it to the next hop. - `FORWARD_ONLY` When the client connection is mTLS (Mutual TLS), forward the XFCC header in the request only. - `APPEND_FORWARD` When the client connection is mTLS, append the client certificate information to the request's XFCC header and forward it. - `SANITIZE` Do not forward the XFCC header. - `ALWAYS_FORWARD_ONLY` Always forward the XFCC header in the request, regardless of whether the client connection is mTLS. For more information on these values, see the Envoy documentation for [Enum extensions.filters.network.http_connection_manager.v3.HttpConnectionManager.ForwardClientCertDetails](https://www.envoyproxy.io/docs/envoy/v1.26.1/api-v3/extensions/filters/network/http_connection_manager/v3/http_connection_manager.proto.html#enum-extensions-filters-network-http-connection-manager-v3-httpconnectionmanager-forwardclientcertdetails). If you change this setting after installing Hybrid, apply it with `apigeectl init` and then restart your Apigee ingress gateway pods. |
| `istiod.healthCheckUserAgents` | Advanced | **Introduced in version:** 1.12.0 **Default values:** ``` - "GoogleStackdriverMonitoring-UptimeChecks(https://cloud.google.com/monitoring)" - "Edge Health Probe" ``` Enables non-Google Cloud loadbalancers to check the ingress gateway's health check endpoints (`/healthz/ingress` and `/healthz`) by overriding the default user-agent allow list in hybrid. > [!NOTE] > **Note** : Usage of this configuration property is only supported in hybrid installations using Helm charts. It is not supported for use with `apigeectl`. To override the default user agents specified, use the following syntax, inserting the custom user agents: ``` istiod: healthCheckUserAgents: - "CUSTOM_USER_AGENT_1" - "CUSTOM_USER_AGENT_2" ``` To remove the user agent requirement, use the following: ``` istiod: healthCheckUserAgents: [] ``` <br /> > [!NOTE] > **Note** : The pods must be restarted for this to take effect. Use `kubectl rollout restart deployment -n apigee apigee-ingressgateway-manager` to restart the pods and `kubectl rollout status deployment -n apigee apigee-ingressgateway-manager` to check the status of the rollout. |
| `istiod.image.pullPolicy` | Advanced | **Introduced in version:** 1.8.0 **Default value:** `IfNotPresent` Determines when [kubelet](https://kubernetes.io/docs/reference/command-line-tools-reference/kubelet/#kubelet) pulls the pod's Docker image. Possible values include: - `IfNotPresent`: Do not pull a new image if it already exists. - `Always`: Always pull the image, regardless of whether it exists already. For more information, see [Updating images](https://kubernetes.io/docs/concepts/containers/images/#updating-images). |
| `istiod.image.tag` | Advanced | **Introduced in version:** 1.8.0 **Default value:** `1.14.10` The version label for this service's Docker image. |
| `istiod.image.url` | Advanced | **Introduced in version:** 1.8.0 **Default value:** None The location of the Docker image for this service. Use `apigee-pull-push --list` to see the current repository URL for this component. > [!TIP] > **Tip:** Consider using [`hub`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#hub) to set a private repository URL for all components instead of configuring them individually. |
| `istiod.tolerations.effect` | Advanced | **Introduced in version:** 1.10.1 **Default value:** None Required to use the [Taints and Tolerations feature of Kubernetes](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/). `effect` specifies the effect that matching a toleration with a taint will have. Values for `effect` can be: - `NoExecute` - `NoSchedule` - `PreferNoSchedule` See [Taints and Tolerations: Concepts](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/#concepts) for details. |
| `istiod.tolerations.key` | Advanced | **Introduced in version:** 1.10.1 **Default value:** None Required to use the [Taints and Tolerations feature of Kubernetes](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/). `key` identifies pods to which the toleration can be applied. See [Taints and Tolerations: Concepts](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/#concepts) for details. |
| `istiod.tolerations.operator` | Advanced | **Introduced in version:** 1.10.1 **Default value:** `"Equal"` Required to use the [Taints and Tolerations feature of Kubernetes](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/). `operator` specifies the operation used to trigger the [`effect`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#istiod-tolerations-effect). Values for `operator` can be: - `Equal` matches the value set in [`value`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#istiod-tolerations-value). - `Exists` ignores the value set in [`value`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#istiod-tolerations-value). See [Taints and Tolerations: Concepts](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/#concepts) for details. |
| `istiod.tolerations.tolerationSeconds` | Advanced | **Introduced in version:** 1.10.1 **Default value:** None Used by the [Taints and Tolerations feature of Kubernetes](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/). `tolerationSeconds` defines in seconds how long a pod stays bound to a failing or unresponsive node. See [Taints and Tolerations: Concepts](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/#concepts) for details. |
| `istiod.tolerations.value` | Advanced | **Introduced in version:** 1.10.1 **Default value:** None Used by the [Taints and Tolerations feature of Kubernetes](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/). `value` is the value that triggers the [`effect`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#istiod-tolerations-effect) when [`operator`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#istiod-tolerations-operator) is set to `Equal`. See [Taints and Tolerations: Concepts](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/#concepts) for details. |

## `k8sCluster`

Identifies Kubernetes cluster where the hybrid runtime is installed.

The following table describes the properties of the `k8sCluster` object:

| Property | Type | Description |
|---|---|---|
| `k8sCluster.name` | Basic | **Introduced in version:** 1.2.0 **Default value:** None The name of the Kubernetes cluster where the hybrid runtime is installed. |
| `k8sCluster.region` | Basic | **Introduced in version:** 1.2.0 **Default value:** None Identifies the Google Cloud [region](https://cloud.google.com/compute/docs/regions-zones#available) in which your Kubernetes cluster was created. |

## `kubeRBACProxy`

Identifies where Apigee should look for Kubernetes role-based access controls.

The following table describes the properties of the `kubeRBACProxy` object:

| Property | Type | Description |
|---|---|---|
| `kubeRBACProxy.image.pullPolicy` | Advanced | **Introduced in version:** 1.2.0 **Default value:** `IfNotPresent` Determines when [kubelet](https://kubernetes.io/docs/reference/command-line-tools-reference/kubelet/#kubelet) pulls the pod's Docker image. Possible values include: - `IfNotPresent`: Do not pull a new image if it already exists. - `Always`: Always pull the image, regardless of whether it exists already. For more information, see [Updating images](https://kubernetes.io/docs/concepts/containers/images/#updating-images). |
| `kubeRBACProxy.image.tag` | Advanced | **Introduced in version:** `1.2.0` **Default value:** `1.14.10` The version label for this service's Docker image. |
| `kubeRBACProxy.image.url` | Advanced | **Introduced in version:** 1.2.0 **Default value:** None The location of the Docker image for this service. Use `apigee-pull-push --list` to see the current repository URL for this component. > [!TIP] > **Tip:** Consider using [`hub`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#hub) to set a private repository URL for all components instead of configuring them individually. |
| `kubeRBACProxy.resources.limits.cpu` | Advanced | **Introduced in version:** 1.11.0 **Default value:** `500m` The CPU limit for the resource in a Kubernetes container, in millicores. |
| `kubeRBACProxy.resources.limits.memory` | Advanced | **Introduced in version:** 1.11.0 **Default value:** `128Mi` The memory limit for the resource in a Kubernetes container, in mebibytes. |
| `kubeRBACProxy.resources.requests.cpu` | Advanced | **Introduced in version:** 1.11.0 **Default value:** `5m` The CPU needed for normal operation of the resource in a Kubernetes container, in millicores. |
| `kubeRBACProxy.resources.requests.memory` | Advanced | **Introduced in version:** 1.11.0 **Default value:** `64Mi` The memory needed for normal operation of the resource in a Kubernetes container, in mebibytes. |

## `logger`

Defines the service that manages operational logs. All of the Apigee hybrid services
that run in your Kubernetes cluster output this information.

For more information, see [Logging overview](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/logging.md.txt).

The following table describes the properties of the `logger` object:

| Property | Type | Description |
|---|---|---|
| `logger.annotations` | Advanced | **Introduced in version:** 1.5.0 **Default value:** None Optional key/value map used to annotate pods. For more information, see [Custom annotations](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/customize-services.md.txt#custom-annotations). |
| `logger.bufferChunkSize` | Advanced | **Introduced in version:** 1.12.0 **Default value:** 256k The initial buffer size to read log files. |
| `logger.bufferMaxSize` | Advanced | **Introduced in version:** 1.12.0 **Default value:** 104857600 The limit of the buffer size per monitored file. Files exceeding this limit are removed from the monitored file list. |
| `logger.bufferMemoryLimit` | Advanced | **Introduced in version:** 1.12.0 **Default value:** 150MB The limit of memory that logger can consumed. If reach, the logger will momentarily pause reading more data until the existing data is flushed in memory. |
| `logger.enabled` | Basic | **Introduced in version:** 1.0.0 **Default value:** `false` Enables or disables logging on the cluster. For non- set to `true`, for GKE on Google Cloud or Google Distributed Cloudset to `false`. |
| `logger.envVars` | Basic | **Introduced in version:** 1.8.5 **Default value:** None Allows you to include the `NO_PROXY` Fluent Bit environment variable, which specifies URLs for which traffic is not routed through the HTTP proxy. The `NO_PROXY` variable should be defined as a comma-separated string of host names, in the format: ``` logger: ... envVars: NO_PROXY: '<comma-separated-values>' ``` for example: ``` envVars: NO_PROXY: 'kubernetes.default.svc,oauth2.googleapis.com,logging.googleapis.com' ``` Use `envVars: NO_PROXY` optionally when you have HTTP forward proxy enabled. See [NO_PROXY](https://docs.fluentbit.io/manual/administration/http-proxy#no_proxy) in the Fluent Bit documentation. |
| `logger.flushInterval` | Advanced | **Introduced in version:** 1.12.0 **Default value:** 1 The interval to wait before invoking the next buffer flushed, in seconds. |
| `logger.gsa` | Advanced | **Introduced in version:** 1.10.0 **Default value:** None **Helm only** : The email address of the `apigee-logger` Google IAM service account (GSA) to associate with the corresponding Kubernetes service account when enabling Workload Identity on GKE clusters using Helm charts. Set this when you have set [`gcp.workloadIdentity.enabled`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#gcp-workloadidentity-enabled) to `true`. GSA email addresses typically have the format of: ``` GSA_NAME@PROJECT_ID.iam.gserviceaccount.com ``` For example: ``` apigee-logger@my-hybrid-project.iam.gserviceaccount.com ``` > [!TIP] > **Tip:** You can find the email address of your service accounts with the following command: > ``` > gcloud iam service-accounts list --project ${PROJECT_ID} --filter "apigee" > ``` See [Enabling Workload Identity on GKE](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/enable-workload-identity-gke.md.txt) or [Enabling Workload Identity Federation on AKS and EKS](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/enable-workload-identity-federation.md.txt). |
| `logger.image.pullPolicy` | Advanced | **Introduced in version:** 1.0.0 **Default value:** `IfNotPresent` Determines when [kubelet](https://kubernetes.io/docs/reference/command-line-tools-reference/kubelet/#kubelet) pulls the pod's Docker image. Possible values include: - `IfNotPresent`: Do not pull a new image if it already exists. - `Always`: Always pull the image, regardless of whether it exists already. For more information, see [Updating images](https://kubernetes.io/docs/concepts/containers/images/#updating-images). |
| `logger.image.tag` | Advanced | **Introduced in version:** 1.0.0 **Default value:** `1.14.10` The version label for this service's Docker image. |
| `logger.image.url` | Advanced | **Introduced in version:** 1.0.0 **Default value:** None The location of the Docker image for this service. Use `apigee-pull-push --list` to see the current repository URL for this component. > [!TIP] > **Tip:** Consider using [`hub`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#hub) to set a private repository URL for all components instead of configuring them individually. |
| `logger.livenessProbe.failureThreshold` | Advanced | **Introduced in version:** 1.0.0 **Default value:** `3` The number of times Kubernetes will verify that liveness probes have failed before restarting the container. The minimum value is 1. |
| `logger.livenessProbe.initialDelaySeconds` | Advanced | **Introduced in version:** 1.0.0 **Default value:** `0` The number of seconds after a container is started before a liveness probe is initiated. |
| `logger.livenessProbe.periodSeconds` | Advanced | **Introduced in version:** 1.0.0 **Default value:** `60` Determines how often to perform a liveness probe, in seconds. The minimum value is 1. |
| `logger.livenessProbe.successThreshold` | Advanced | **Introduced in version:** 1.0.0 **Default value:** `1` The minimum consecutive successes needed for a liveness probe to be considered successful after a failure. The minimum value is 1. |
| `logger.livenessProbe.timeoutSeconds` | Advanced | **Introduced in version:** 1.0.0 **Default value:** `1` The number of seconds after which a liveness probe times out. The minimum value is 1. |
| `logger.nodeSelector.key` | Basic | **Introduced in version:** 1.0.0 **Default value:** `apigee.cloud.google.com/apigee-logger-enabled` **Required** Node selector label key used to target dedicated Kubernetes nodes for `logger` runtime services. See [Configuring dedicated node pools](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/configure-dedicated-nodes.md.txt). |
| `logger.nodeSelector.value` | Basic | **Introduced in version:** 1.0.0 **Default value:** `true` **Required** Node selector label value used to target dedicated Kubernetes nodes for `logger` runtime services. See [Configuring dedicated node pools](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/configure-dedicated-nodes.md.txt). |
| `logger.resources.limits.cpu` | Advanced | **Introduced in version:** 1.0.0 **Default value:** `200m` The CPU limit for the resource in a Kubernetes container, in millicores. |
| `logger.resources.limits.memory` | Advanced | **Introduced in version:** 1.0.0 **Default value:** `500Mi` The memory limit for the resource in a Kubernetes container, in mebibytes. |
| `logger.resources.requests.cpu` | Advanced | **Introduced in version:** 1.0.0 **Default value:** `100m` The CPU needed for normal operation of the resource in a Kubernetes container, in millicores. |
| `logger.resources.requests.memory` | Advanced | **Introduced in version:** 1.0.0 **Default value:** `250Mi` The memory needed for normal operation of the resource in a Kubernetes container, in mebibytes. |
| `logger.serviceAccountPath` | Basic | **Introduced in version:** 1.0.0 **Default value:** None One of either `serviceAccountPath` or `serviceAccountRef` is required. Path to Google Service Account key file with **Logs Writer** role. |
| `logger.serviceAccountRef` | Basic | **Introduced in version:** 1.2.0 **Default value:** None One of either `serviceAccountPath` or `serviceAccountRef` is required. |
| `logger.storageMaxChunks` | Advanced | **Introduced in version:** 1.12.0 **Default value:** 128 The maximum number of chunks that can be up in memory. Chunks exceeding the limit will be saved in the file system. |
| `logger.terminationGracePeriodSeconds` | Advanced | **Introduced in version:** 1.0.0 **Default value:** `30` The maximum time between a request for pod deletion and when the pod is killed, in seconds. During this period, any prestop hooks will be executed and any running process should terminate gracefully. The pod will be killed when all running processes have terminated or at the end of the grace period, whichever comes first. If there are no running processes, the pod will be killed immediately. |
| `logger.tolerations.effect` | Advanced | **Introduced in version:** 1.10.1 **Default value:** None Required to use the [Taints and Tolerations feature of Kubernetes](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/). `effect` specifies the effect that matching a toleration with a taint will have. Values for `effect` can be: - `NoExecute` - `NoSchedule` - `PreferNoSchedule` See [Taints and Tolerations: Concepts](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/#concepts) for details. |
| `logger.tolerations.key` | Advanced | **Introduced in version:** 1.10.1 **Default value:** None Required to use the [Taints and Tolerations feature of Kubernetes](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/). `key` identifies pods to which the toleration can be applied. See [Taints and Tolerations: Concepts](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/#concepts) for details. |
| `logger.tolerations.operator` | Advanced | **Introduced in version:** 1.10.1 **Default value:** `"Equal"` Required to use the [Taints and Tolerations feature of Kubernetes](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/). `operator` specifies the operation used to trigger the [`effect`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#logger-tolerations-effect). Values for `operator` can be: - `Equal` matches the value set in [`value`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#logger-tolerations-value). - `Exists` ignores the value set in [`value`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#logger-tolerations-value). See [Taints and Tolerations: Concepts](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/#concepts) for details. |
| `logger.tolerations.tolerationSeconds` | Advanced | **Introduced in version:** 1.10.1 **Default value:** None Used by the [Taints and Tolerations feature of Kubernetes](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/). `tolerationSeconds` defines in seconds how long a pod stays bound to a failing or unresponsive node. See [Taints and Tolerations: Concepts](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/#concepts) for details. |
| `logger.tolerations.value` | Advanced | **Introduced in version:** 1.10.1 **Default value:** None Used by the [Taints and Tolerations feature of Kubernetes](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/). `value` is the value that triggers the [`effect`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#logger-tolerations-effect) when [`operator`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#logger-tolerations-operator) is set to `Equal`. See [Taints and Tolerations: Concepts](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/#concepts) for details. |

## `mart`

Defines the MART (Management API for RunTime data) service, which acts as an API provider for
public Apigee APIs so that you can access and manage runtime data entities such as KMS (API Keys and
OAuth tokens), KVM, Quota, and API products.

The following table describes the properties of the `mart` object:

| Property | Type | Description |
|---|---|---|
| `mart.annotations` | Advanced | **Introduced in version:** 1.5.0 **Default value:** None Optional key/value map used to annotate pods. For more information, see [Custom annotations](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/customize-services.md.txt#custom-annotations). |
| `mart.gsa` | Advanced | **Introduced in version:** 1.10.0 **Default value:** None **Helm only** : The email address of the `apigee-mart` Google IAM service account (GSA) to associate with the corresponding Kubernetes service account when enabling Workload Identity on GKE clusters using Helm charts. Set this when you have set [`gcp.workloadIdentity.enabled`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#gcp-workloadidentity-enabled) to `true`. GSA email addresses typically have the format of: ``` GSA_NAME@PROJECT_ID.iam.gserviceaccount.com ``` For example: ``` apigee-mart@my-hybrid-project.iam.gserviceaccount.com ``` > [!TIP] > **Tip:** You can find the email address of your service accounts with the following command: > ``` > gcloud iam service-accounts list --project ${PROJECT_ID} --filter "apigee" > ``` See [Enabling Workload Identity on GKE](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/enable-workload-identity-gke.md.txt) or [Enabling Workload Identity Federation on AKS and EKS](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/enable-workload-identity-federated). |
| `mart.hostAlias` | Basic | **Introduced in version:** 1.0.0 **Default value:** None The host alias pointing to the object. You can set this property to `*` or a fully-qualified domain name. |
| `mart.image.pullPolicy` | Advanced | **Introduced in version:** 1.0.0 **Default value:** `IfNotPresent` Determines when [kubelet](https://kubernetes.io/docs/reference/command-line-tools-reference/kubelet/#kubelet) pulls the pod's Docker image. Possible values include: - `IfNotPresent`: Do not pull a new image if it already exists. - `Always`: Always pull the image, regardless of whether it exists already. For more information, see [Updating images](https://kubernetes.io/docs/concepts/containers/images/#updating-images). |
| `mart.image.tag` | Advanced | **Introduced in version:** 1.0.0 **Default value:** `1.14.10` The version label for this service's Docker image. |
| `mart.image.url` | Advanced | **Introduced in version:** 1.0.0 **Default value:** None The location of the Docker image for this service. Use `apigee-pull-push --list` to see the current repository URL for this component. > [!TIP] > **Tip:** Consider using [`hub`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#hub) to set a private repository URL for all components instead of configuring them individually. |
| `mart.initCheckCF.resources.requests.cpu` | Advanced | **Introduced in version:** 1.0.0 **Default value:** `10m` The amount of CPU resources allocated to the initialization check of the Cloud Foundry process. |
| `mart.livenessProbe.failureThreshold` | Advanced | **Introduced in version:** 1.0.0 **Default value:** `12` The number of times Kubernetes will verify that liveness probes have failed before restarting the container. The minimum value is 1. |
| `mart.livenessProbe.initialDelaySeconds` | Advanced | **Introduced in version:** 1.0.0 **Default value:** `15` The number of seconds after a container is started before a liveness probe is initiated. |
| `mart.livenessProbe.periodSeconds` | Advanced | **Introduced in version:** 1.0.0 **Default value:** `5` Determines how often to perform a liveness probe, in seconds. The minimum value is 1. |
| `mart.livenessProbe.timeoutSeconds` | Advanced | **Introduced in version:** 1.0.0 **Default value:** `1` The number of seconds after which a liveness probe times out. The minimum value is 1. |
| `mart.metricsURL` | Basic | **Introduced in version:** 1.0.0 **Default value:** `/v1/server/metrics` |
| `mart.nodeSelector.key` | Basic | **Introduced in version:** 1.0.0 **Default value:** None Optional node selector label key for targeting Kubernetes nodes for `mart` runtime services. If you do not specify a key for mart.nodeselector, then your runtime uses the node specified in the [nodeSelector](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#nodeselector) object. See [Configuring dedicated node pools](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/configure-dedicated-nodes.md.txt). |
| `mart.nodeSelector.value` | Basic | **Introduced in version:** 1.0.0 **Default value:** None Optional node selector label value for targeting Kubernetes nodes for `mart` runtime services. See also the [nodeSelector](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#nodeselector) object. See [Configuring dedicated node pools](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/configure-dedicated-nodes.md.txt). |
| `mart.podDisruptionBudget.minAvailable` | Advanced | **Introduced in version:** 1.14.10 **Default value:** None **Chart:** `apigee-org` The minimum number of MART pods that must stay available during a voluntary disruption, for example during a node pool upgrade or a node drain. This field sets the `minAvailable` field of the [PodDisruptionBudget](https://kubernetes.io/docs/concepts/workloads/pods/disruptions/) for these pods. It takes either an integer number of pods (`1`) or a percentage string (`"50%"`). `minAvailable` and `maxUnavailable` are mutually exclusive; set only one. Setting both at once is rejected by the Apigee operator. If you set neither field, the Apigee operator still generates a PodDisruptionBudget for these pods, using `maxUnavailable: 1` by default. For example, in `overrides.yaml`: ``` mart: podDisruptionBudget: minAvailable: "50%" ``` |
| `mart.podDisruptionBudget.maxUnavailable` | Advanced | **Introduced in version:** 1.14.10 **Default value:** None **Chart:** `apigee-org` The maximum number of MART pods that can be unavailable during a voluntary disruption, for example during a node pool upgrade or a node drain. This field sets the `maxUnavailable` field of the [PodDisruptionBudget](https://kubernetes.io/docs/concepts/workloads/pods/disruptions/) for these pods. It takes either an integer number of pods (`1`) or a percentage string (`"50%"`). `maxUnavailable` and `minAvailable` are mutually exclusive; set only one. Setting both at once is rejected by the Apigee operator. If you set neither field, the Apigee operator still generates a PodDisruptionBudget for these pods, using `maxUnavailable: 1` by default. For example, in `overrides.yaml`: ``` mart: podDisruptionBudget: maxUnavailable: 1 ``` |
| `mart.readinessProbe.failureThreshold` | Advanced | **Introduced in version:** 1.0.0 **Default value:** `2` The number of times Kubernetes will verify that readiness probes have failed before marking the pod *unready*. The minimum value is 1. |
| `mart.readinessProbe.initialDelaySeconds` | Advanced | **Introduced in version:** 1.0.0 **Default value:** `15` The number of seconds after a container is started before a readiness probe is initiated. |
| `mart.readinessProbe.periodSeconds` | Advanced | **Introduced in version:** 1.0.0 **Default value:** `5` Determines how often to perform a readiness probe, in seconds. The minimum value is 1. |
| `mart.readinessProbe.successThreshold` | Advanced | **Introduced in version:** 1.0.0 **Default value:** `1` The minimum consecutive successes needed for a readiness probe to be considered successful after a failure. The minimum value is 1. |
| `mart.readinessProbe.timeoutSeconds` | Advanced | **Introduced in version:** 1.0.0 **Default value:** `1` The number of seconds after which a liveness probe times out. The minimum value is 1. |
| `mart.replicaCountMax` | Basic | **Introduced in version:** 1.0.0 **Default value:** `5` Maximum number of replicas available for autoscaling. |
| `mart.replicaCountMin` | Basic | **Introduced in version:** 1.0.0 **Default value:** `1` Minimum number of replicas available for autoscaling. |
| `mart.resources.limits.cpu` | Advanced | **Introduced in version:** 1.11.0 **Default value:** `2000m` The CPU limit for the resource in a Kubernetes container, in millicores. |
| `mart.resources.limits.memory` | Advanced | **Introduced in version:** 1.11.0 **Default value:** `5Gi` The memory limit for the resource in a Kubernetes container, in mebibytes. |
| `mart.resources.requests.cpu` | Advanced | **Introduced in version:** 1.0.0 **Default value:** `500m` The CPU needed for normal operation of the resource in a Kubernetes container, in millicores. |
| `mart.resources.requests.memory` | Advanced | **Introduced in version:** 1.0.0 **Default value:** `512Mi` The memory needed for normal operation of the resource in a Kubernetes container, in mebibytes. |
| `mart.serviceAccountPath` | Basic | **Introduced in version:** 1.1.1 **Default value:** None One of either `serviceAccountPath` or `serviceAccountRef` is required. Path to Google Service Account key file with **no role**. |
| `mart.serviceAccountRef` | Basic | **Introduced in version:** 1.2.0 **Default value:** None One of either `serviceAccountPath` or `serviceAccountRef` is required. |
| `mart.sslCertPath` | Basic | **Introduced in version:** 1.0.0 **Default value:** None Either `sslCertPath`/`sslKeyPath` or `sslSecret` is required. Local file system path for loading and encoding the SSL cert to a Secret. |
| `mart.sslKeyPath` | Basic | **Introduced in version:** 1.0.0 **Default value:** None **Either `sslCertPath`/`sslKeyPath` or `sslSecret` is required**. Local file system path for loading and encoding the SSL key to a Secret. |
| `mart.sslSecret` | Basic | **Introduced in version:** 1.2.0 **Default value:** None Either `sslCertPath`/`sslKeyPath` or `sslSecret` is required. The name of a file stored in a Kubernetes secret that contains the TLS certificate and private key. You must create the secret using the TLS certificate and key data as its input. See also: - [Storing data in a Kubernetes secret](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/k8s-secrets.md.txt) - [Secrets](https://kubernetes.io/docs/concepts/configuration/secret/) in the Kubernetes documentation - [Creating a Secret Using kubectl](https://kubernetes.io/docs/concepts/configuration/secret/#creating-a-secret-using-kubectl) in the Kubernetes documentation |
| `mart.targetCPUUtilizationPercentage` | Advanced | **Introduced in version:** 1.0.0 **Default value:** `75` Target CPU utilization for the MART process on the pod. The value of this field enables MART to auto-scale when CPU utilization reaches this value, up to `replicaCountMax`. |
| `mart.terminationGracePeriodSeconds` | Advanced | **Introduced in version:** 1.0.0 **Default value:** `30` The maximum time between a request for pod deletion and when the pod is killed, in seconds. During this period, any prestop hooks will be executed and any running process should terminate gracefully. The pod will be killed when all running processes have terminated or at the end of the grace period, whichever comes first. If there are no running processes, the pod will be killed immediately. |
| `mart.tolerations.effect` | Advanced | **Introduced in version:** 1.10.1 **Default value:** None Required to use the [Taints and Tolerations feature of Kubernetes](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/). `effect` specifies the effect that matching a toleration with a taint will have. Values for `effect` can be: - `NoExecute` - `NoSchedule` - `PreferNoSchedule` See [Taints and Tolerations: Concepts](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/#concepts) for details. |
| `mart.tolerations.key` | Advanced | **Introduced in version:** 1.10.1 **Default value:** None Required to use the [Taints and Tolerations feature of Kubernetes](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/). `key` identifies pods to which the toleration can be applied. See [Taints and Tolerations: Concepts](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/#concepts) for details. |
| `mart.tolerations.operator` | Advanced | **Introduced in version:** 1.10.1 **Default value:** `"Equal"` Required to use the [Taints and Tolerations feature of Kubernetes](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/). `operator` specifies the operation used to trigger the [`effect`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#mart-tolerations-effect). Values for `operator` can be: - `Equal` matches the value set in [`value`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#mart-tolerations-value). - `Exists` ignores the value set in [`value`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#mart-tolerations-value). See [Taints and Tolerations: Concepts](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/#concepts) for details. |
| `mart.tolerations.tolerationSeconds` | Advanced | **Introduced in version:** 1.10.1 **Default value:** None Used by the [Taints and Tolerations feature of Kubernetes](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/). `tolerationSeconds` defines in seconds how long a pod stays bound to a failing or unresponsive node. See [Taints and Tolerations: Concepts](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/#concepts) for details. |
| `mart.tolerations.value` | Advanced | **Introduced in version:** 1.10.1 **Default value:** None Used by the [Taints and Tolerations feature of Kubernetes](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/). `value` is the value that triggers the [`effect`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#mart-tolerations-effect) when [`operator`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#mart-tolerations-operator) is set to `Equal`. See [Taints and Tolerations: Concepts](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/#concepts) for details. |

## `metrics`

Defines the service that collects operations metrics. You can use metrics data to monitor the
health of Hybrid services, to set up alerts, and so on.

For more information, see [Metrics collection overview](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/metrics-collection.md.txt).

The following table describes the properties of the `metrics` object:

| Property | Type | Description |
|---|---|---|
| `metrics.adapter.image.pullPolicy` | Advanced | **Introduced in version:** 1.8.1 **Default value:** `IfNotPresent` Determines when [kubelet](https://kubernetes.io/docs/reference/command-line-tools-reference/kubelet/#kubelet) pulls the pod's Docker image. Possible values include: - `IfNotPresent`: Do not pull a new image if it already exists. - `Always`: Always pull the image, regardless of whether it exists already. For more information, see [Updating images](https://kubernetes.io/docs/concepts/containers/images/#updating-images). |
| `metrics.adapter.image.tag` | Advanced | **Introduced in version:** 1.8.1 **Default value:** `1.14.10` The version label for this service's Docker image. |
| `metrics.adapter.image.url` | Advanced | **Introduced in version:** 1.8.1 **Default value:** None The location of the Docker image for this service. Use `apigee-pull-push --list` to see the current repository URL for this component. > [!TIP] > **Tip:** Consider using [`hub`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#hub) to set a private repository URL for all components instead of configuring them individually. |
| `metrics.adapter.podDisruptionBudget.minAvailable` | Advanced | **Introduced in version:** 1.14.10 **Default value:** None **Chart:** `apigee-telemetry` The minimum number of metrics adapter pods that must stay available during a voluntary disruption, for example during a node pool upgrade or a node drain. This field sets the `minAvailable` field of the [PodDisruptionBudget](https://kubernetes.io/docs/concepts/workloads/pods/disruptions/) for these pods. It takes either an integer number of pods (`1`) or a percentage string (`"50%"`). `minAvailable` and `maxUnavailable` are mutually exclusive; set only one. Setting both at once is rejected by the Apigee operator. If you set neither field, the Apigee operator still generates a PodDisruptionBudget for these pods, using `maxUnavailable: 1` by default. For example, in `overrides.yaml`: ``` metrics: adapter: podDisruptionBudget: minAvailable: "50%" ``` |
| `metrics.adapter.podDisruptionBudget.maxUnavailable` | Advanced | **Introduced in version:** 1.14.10 **Default value:** None **Chart:** `apigee-telemetry` The maximum number of metrics adapter pods that can be unavailable during a voluntary disruption, for example during a node pool upgrade or a node drain. This field sets the `maxUnavailable` field of the [PodDisruptionBudget](https://kubernetes.io/docs/concepts/workloads/pods/disruptions/) for these pods. It takes either an integer number of pods (`1`) or a percentage string (`"50%"`). `maxUnavailable` and `minAvailable` are mutually exclusive; set only one. Setting both at once is rejected by the Apigee operator. If you set neither field, the Apigee operator still generates a PodDisruptionBudget for these pods, using `maxUnavailable: 1` by default. For example, in `overrides.yaml`: ``` metrics: adapter: podDisruptionBudget: maxUnavailable: 1 ``` |
| `metrics.adapter.resources.limits.cpu` | Advanced | **Introduced in version:** 1.14.1 **Default value:** `500m` The CPU limit for the adapter resource in a Kubernetes container, in millicores. |
| `metrics.adapter.resources.limits.memory` | Advanced | **Introduced in version:** 1.14.1 **Default value:** `4Gi` The memory limit for the adapter resource in a Kubernetes container, in gibibytes. |
| `metrics.adapter.resources.requests.cpu` | Advanced | **Introduced in version:** 1.14.1 **Default value:** `100m` The CPU needed for normal operation of the adapter in a Kubernetes container, in millicores. |
| `metrics.adapter.resources.requests.memory` | Advanced | **Introduced in version:** 1.14.1 **Default value:** `128Mi` The memory needed for normal operation of the adapter in a Kubernetes container, in mebibytes. |
| `metrics.aggregator.resources.requests.cpu` | Advanced | **Introduced in version:** 1.4.0 **Default value:** `500m` The CPU needed for normal operation of the aggregator in a Kubernetes container, in millicores. |
| `metrics.aggregator.resources.requests.memory` | Advanced | **Introduced in version:** 1.4.0 **Default value:** `512Mi` The memory needed for normal operation of the aggregator in a Kubernetes container, in mebibytes. |
| `metrics.aggregator.resources.limits.cpu` | Advanced | **Introduced in version:** 1.4.0 **Default value:** `500m` The CPU limit for the aggregator resource in a Kubernetes container, in millicores. |
| `metrics.aggregator.resources.limits.memory` | Advanced | **Introduced in version:** 1.4.0 **Default value:** `3Gi` The memory limit for the aggregator resource in a Kubernetes container, in gibibytes. |
| `metrics.annotations` | Advanced | **Introduced in version:** 1.5.0 **Default value:** None Optional key/value map used to annotate pods. For more information, see [Custom annotations](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/customize-services.md.txt#custom-annotations). |
| `metrics.app.resources.requests.cpu` | Advanced | **Introduced in version:** 1.4.0 **Default value:** `500m` The CPU needed for normal operation of the app in a Kubernetes container, in millicores. |
| `metrics.app.resources.requests.memory` | Advanced | **Introduced in version:** 1.4.0 **Default value:** `512Mi` The memory needed for normal operation of the app in a Kubernetes container, in mebibytes. |
| `metrics.app.resources.limits.cpu` | Advanced | **Introduced in version:** 1.4.0 **Default value:** `500m` The CPU limit for the app resource in a Kubernetes container, in millicores. |
| `metrics.app.resources.limits.memory` | Advanced | **Introduced in version:** 1.4.0 **Default value:** `1Gi` The memory limit for the app resource in a Kubernetes container, in gibibytes. |
| `metrics.appStackdriverExporter.podDisruptionBudget.minAvailable` | Advanced | **Introduced in version:** 1.14.10 **Default value:** None **Chart:** `apigee-telemetry` The minimum number of `appStackdriverExporter` pods that must stay available during a voluntary disruption, such as during a node pool upgrade or a node drain. This field sets the `minAvailable` field of the [PodDisruptionBudget](https://kubernetes.io/docs/concepts/workloads/pods/disruptions/) for these pods. It takes either an integer number of pods (`1`) or a percentage string (`"50%"`). `minAvailable` and `maxUnavailable` are mutually exclusive; set only one. The Apigee operator rejects setting both at once. If you set neither field, the Apigee operator still generates a PodDisruptionBudget for these pods, using `maxUnavailable: 1` by default. For example, in `overrides.yaml`: ``` metrics: appStackdriverExporter: podDisruptionBudget: minAvailable: "50%" ``` |
| `metrics.appStackdriverExporter.podDisruptionBudget.maxUnavailable` | Advanced | **Introduced in version:** 1.14.10 **Default value:** None **Chart:** `apigee-telemetry` The maximum number of `appStackdriverExporter` pods that can be unavailable during a voluntary disruption, such as during a node pool upgrade or a node drain. This field sets the `maxUnavailable` field of the [PodDisruptionBudget](https://kubernetes.io/docs/concepts/workloads/pods/disruptions/) for these pods. It takes either an integer number of pods (`1`) or a percentage string (`"50%"`). `maxUnavailable` and `minAvailable` are mutually exclusive; set only one. The Apigee operator rejects setting both at once. If you set neither field, the Apigee operator still generates a PodDisruptionBudget for these pods, using `maxUnavailable: 1` by default. For example, in `overrides.yaml`: ``` metrics: appStackdriverExporter: podDisruptionBudget: maxUnavailable: 1 ``` |
| `metrics.appStackdriverExporter.resources.limits.cpu` | Advanced | **Introduced in version:** 1.7.0 **Default value:** `500m` The CPU limit for the stackdriverExporter resource in a Kubernetes container, in millicores. |
| `metrics.appStackdriverExporter.resources.limits.memory` | Advanced | **Introduced in version:** 1.7.0 **Default value:** `1Gi` The memory limit for the stackdriverExporter resource in a Kubernetes container, in gibibytes. |
| `metrics.appStackdriverExporter.resources.requests.cpu` | Advanced | **Introduced in version:** 1.7.0 **Default value:** `128m` The CPU needed for normal operation of the stackdriverExporter in a Kubernetes container, in millicores. |
| `metrics.appStackdriverExporter.resources.requests.memory` | Advanced | **Introduced in version:** 1.7.0 **Default value:** `512Mi` The memory needed for normal operation of the stackdriverExporter in a Kubernetes container, in mebibytes. |
| `metrics.collector.envVars` | Basic | **Introduced in version:** 1.13 **Default value:** None Allows you to pass in and override environment variables in OpenTelemetry. For example, you can define `HTTP_PROXY`, `HTTPS_PROXY`, or `NO_PROXY` to have its requests pass through the proxy server. The `HTTP_PROXY` variable can be defined as a string containing the host name, in the format: ``` metrics: ... envVars: HTTP_PROXY: '<host-name>' ``` for example: ``` envVars: HTTP_PROXY: 'http://1.1.1.1:80' ``` The `HTTPS_PROXY` variable can be defined as a string containing the host name, in the format: ``` metrics: ... envVars: HTTPS_PROXY: '<host-name>' ``` for example: ``` envVars: HTTPS_PROXY: 'https://1.1.1.1:80' ``` The `NO_PROXY` variable should be defined as a comma-separated string of host names, in the format: ``` metrics: ... envVars: NO_PROXY: '<comma-separated-values>' ``` for example: ``` envVars: NO_PROXY: 'https://1.1.1.1:80, https://1.1.1.1:81' ``` Use `envVars: HTTP_PROXY`, `envVars: HTTPS_PROXY`, or `envVars: NO_PROXY` optionally when you have HTTP forward proxy enabled. See [Proxy support](https://opentelemetry.io/docs/collector/configuration/#proxy-support) in the OpenTelemetry documentation. |
| `metrics.collector.imagePullPolicy` | Advanced | **Introduced in version:** 1.12.0 **Default value:** `IfNotPresent` Determines when kubelet pulls the pod's Docker image. Possible values include: - `IfNotPresent`: Do not pull a new image if it already exists. - `Always`: Always pull the image, regardless of whether it exists already. For more information, see [Use a private image repository with Apigee hybrid](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/container-images.md.txt). |
| `metrics.collector.image.tag` | Basic | **Introduced in version:** 1.12.0 **Default value:** `1.14.10` The version label for this service's Docker image. |
| `metrics.collector.image.url` | Basic | **Introduced in version:** 1.12.0 **Default value:** None The location of the Docker image for this service. Use `apigee-pull-push --list` to see the current repository URL for this component. > [!TIP] > **Tip:** Consider using [`hub`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#hub) to set a private repository URL for all components instead of configuring them individually. |
| `metrics.collector.podDisruptionBudget.minAvailable` | Advanced | **Introduced in version:** 1.14.10 **Default value:** None **Chart:** `apigee-telemetry` The minimum number of metrics collector pods that must stay available during a voluntary disruption, for example during a node pool upgrade or a node drain. This field sets the `minAvailable` field of the [PodDisruptionBudget](https://kubernetes.io/docs/concepts/workloads/pods/disruptions/) for these pods. It takes either an integer number of pods (`1`) or a percentage string (`"50%"`). `minAvailable` and `maxUnavailable` are mutually exclusive; set only one. Setting both at once is rejected by the Apigee operator. If you set neither field, the Apigee operator still generates a PodDisruptionBudget for these pods. Because the collector runs as a DaemonSet, that default sets `minAvailable` to 80% of the collector pods (rounded down) instead of using `maxUnavailable: 1`. For example, in `overrides.yaml`: ``` metrics: collector: podDisruptionBudget: minAvailable: "50%" ``` |
| `metrics.collector.podDisruptionBudget.maxUnavailable` | Advanced | **Introduced in version:** 1.14.10 **Default value:** None **Chart:** `apigee-telemetry` The maximum number of metrics collector pods that can be unavailable during a voluntary disruption, for example during a node pool upgrade or a node drain. This field sets the `maxUnavailable` field of the [PodDisruptionBudget](https://kubernetes.io/docs/concepts/workloads/pods/disruptions/) for these pods. It takes either an integer number of pods (`1`) or a percentage string (`"50%"`). `maxUnavailable` and `minAvailable` are mutually exclusive; set only one. Setting both at once is rejected by the Apigee operator. If you set neither field, the Apigee operator still generates a PodDisruptionBudget for these pods. Because the collector runs as a DaemonSet, that default sets `minAvailable` to 80% of the collector pods (rounded down) instead of using `maxUnavailable: 1`. For example, in `overrides.yaml`: ``` metrics: collector: podDisruptionBudget: maxUnavailable: 1 ``` |
| `metrics.collector.resources.requests.cpu` | Advanced | **Introduced in version:** 1.12.0 **Default value:** `500m` The CPU needed for normal operation of the app in a Kubernetes container, in millicores. |
| `metrics.collector.resources.requests.memory` | Advanced | **Introduced in version:** 1.12.0 **Default value:** `512Mi` The memory needed for normal operation of the app in a Kubernetes container, in mebibytes. |
| `metrics.collector.resources.limits.cpu` | Advanced | **Introduced in version:** 1.12.0 **Default value:** `500m` The CPU limit for the app resource in a Kubernetes container, in millicores. |
| `metrics.collector.resources.limits.memory` | Advanced | **Introduced in version:** 1.12.0 **Default value:** `1Gi` The memory limit for the app resource in a Kubernetes container, in gibibytes. |
| `metrics.collector.livenessProbe.failureThreshold` | Advanced | **Introduced in version:** 1.12.0 **Default value:** `5` The number of times Kubernetes will verify that liveness probes have failed before restarting the container. The minimum value is 1. |
| `metrics.collector.livenessProbe.initialDelaySeconds` | Advanced | **Introduced in version:** 1.12.0 **Default value:** `30` The number of seconds after a container is started before a liveness probe is initiated. |
| `metrics.collector.livenessProbe.periodSeconds` | Advanced | **Introduced in version:** 1.12.0 **Default value:** `10` Determines how often to perform a liveness probe, in seconds. The minimum value is 1. |
| `metrics.collector.livenessProbe.successThreshold` | Advanced | **Introduced in version:** 1.12.0 **Default value:** `1` The minimum consecutive successes needed for a liveness probe to be considered successful after a failure. The minimum value is 1. |
| `metrics.collector.livenessProbe.timeoutSeconds` | Advanced | **Introduced in version:** 1.12.0 **Default value:** `5` The number of seconds after which a liveness probe times out. The minimum value is 1. |
| `metrics.collector.readinessProbe.failureThreshold` | Advanced | **Introduced in version:** 1.12.0 **Default value:** `3` The number of times Kubernetes will verify that readiness probes have failed before marking the pod unready. The minimum value is 1. |
| `metrics.collector.readinessProbe.initialDelaySeconds` | Advanced | **Introduced in version:** 1.12.0 **Default value:** `30` The number of seconds after a container is started before a readiness probe is initiated. |
| `metrics.collector.readinessProbe.periodSeconds` | Advanced | **Introduced in version:** 1.12.0 **Default value:** `10` Determines how often to perform a readiness probe, in seconds. The minimum value is 1. |
| `metrics.collector.readinessProbe.successThreshold` | Advanced | **Introduced in version:** 1.12.0 **Default value:** `1` The minimum consecutive successes needed for a readiness probe to be considered successful after a failure. The minimum value is 1. |
| `metrics.collector.readinessProbe.timeoutSeconds` | Advanced | **Introduced in version:** 1.12.0 **Default value:** `5` The number of seconds after which a liveness probe times out. The minimum value is 1. |
| `metrics.disablePrometheusPipeline` | Basic | **Introduced in version:** 1.12.0 **Default value:** `true` Metrics for `ProxyV2` and `TargetV2` monitored resources are not emitted when set to `true`. Use metrics for `Proxy` and `Target` monitored resources instead. |
| `metrics.enabled` | Basic | **Introduced in version:** 1.0.0 **Default value:** `true` Enables Apigee metrics. Set to `true` to enable metrics. Set to `false` to disable metrics. |
| `metrics.gsa` | Advanced | **Introduced in version:** 1.10.0 **Default value:** None **Helm only** : The email address of the `apigee-metrics` Google IAM service account (GSA) to associate with the corresponding Kubernetes service account when enabling Workload Identity on GKE clusters using Helm charts. Set this when you have set [`gcp.workloadIdentity.enabled`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#gcp-workloadidentity-enabled) to `true`. GSA email addresses typically have the format of: ``` GSA_NAME@PROJECT_ID.iam.gserviceaccount.com ``` For example: ``` apigee-metrics@my-hybrid-project.iam.gserviceaccount.com ``` > [!TIP] > **Tip:** You can find the email address of your service accounts with the following command: > ``` > gcloud iam service-accounts list --project ${PROJECT_ID} --filter "apigee" > ``` See [Enabling Workload Identity on GKE](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/enable-workload-identity-gke.md.txt) or [Enabling Workload Identity Federation on AKS and EKS](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/enable-workload-identity-federated). |
| `metrics.nodeSelector.key` | Basic | **Introduced in version:** 1.0.0 **Default value:** None **Required** Node selector label key used to target dedicated Kubernetes nodes for `metrics` runtime services. See [Configuring dedicated node pools](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/configure-dedicated-nodes.md.txt). |
| `metrics.nodeSelector.value` | Basic | **Introduced in version:** 1.0.0 **Default value:** None **Required** Node selector label value used to target dedicated Kubernetes nodes for `metrics` runtime services. See [Configuring dedicated node pools](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/configure-dedicated-nodes.md.txt). |
| `metrics.prometheus.containerPort` | Advanced | **Introduced in version:** 1.0.0 **Default value:** `9090` The port to connect to the Prometheus metrics service. |
| `metrics.prometheus.image.pullPolicy` | Advanced | **Introduced in version:** 1.0.0 **Default value:** `IfNotPresent` Determines when [kubelet](https://kubernetes.io/docs/reference/command-line-tools-reference/kubelet/#kubelet) pulls the pod's Docker image. Possible values include: - `IfNotPresent`: Do not pull a new image if it already exists. - `Always`: Always pull the image, regardless of whether it exists already. For more information, see [Updating images](https://kubernetes.io/docs/concepts/containers/images/#updating-images). |
| `metrics.prometheus.image.tag` | Advanced | **Introduced in version:** 1.0.0 **Default value:** `1.14.10` The version label for this service's Docker image. |
| `metrics.prometheus.image.url` | Advanced | **Introduced in version:** 1.0.0 **Default value:** None The location of the Docker image for this service. Use `apigee-pull-push --list` to see the current repository URL for this component. > [!TIP] > **Tip:** Consider using [`hub`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#hub) to set a private repository URL for all components instead of configuring them individually. |
| `metrics.prometheus.livenessProbe.failureThreshold` | Advanced | **Introduced in version:** 1.0.0 **Default value:** `6` The number of times Kubernetes will verify that liveness probes have failed before restarting the container. The minimum value is 1. |
| `metrics.prometheus.livenessProbe.periodSeconds` | Advanced | **Introduced in version:** 1.0.0 **Default value:** `5` Determines how often to perform a liveness probe, in seconds. The minimum value is 1. |
| `metrics.prometheus.livenessProbe.timeoutSeconds` | Advanced | **Introduced in version:** 1.0.0 **Default value:** `3` The number of seconds after which a liveness probe times out. The minimum value is 1. |
| `metrics.prometheus.readinessProbe.failureThreshold` | Advanced | **Introduced in version:** 1.0.0 **Default value:** `120` The number of times Kubernetes will verify that readiness probes have failed before marking the pod *unready*. The minimum value is 1. |
| `metrics.prometheus.readinessProbe.periodSeconds` | Advanced | **Introduced in version:** 1.0.0 **Default value:** `5` Determines how often to perform a readiness probe, in seconds. The minimum value is 1. |
| `metrics.prometheus.readinessProbe.timeoutSeconds` | Advanced | **Introduced in version:** 1.0.0 **Default value:** `3` The number of seconds after which a liveness probe times out. The minimum value is 1. |
| `metrics.prometheus.resources.limits.cpu` | Advanced | **Introduced in version:** 1.14.1 **Default value:** `500m` The CPU limit for the prometheus resource in a Kubernetes container, in millicores. |
| `metrics.prometheus.resources.limits.memory` | Advanced | **Introduced in version:** 1.14.1 **Default value:** `4Gi` The memory limit for the prometheus resource in a Kubernetes container, in gibibytes. |
| `metrics.prometheus.resources.requests.cpu` | Advanced | **Introduced in version:** 1.14.1 **Default value:** `128m` The CPU needed for normal operation of the prometheus in a Kubernetes container, in millicores. |
| `metrics.prometheus.resources.requests.memory` | Advanced | **Introduced in version:** 1.14.1 **Default value:** `512Mi` The memory needed for normal operation of the prometheus in a Kubernetes container, in mebibytes. |
| `metrics.prometheus.sslCertPath` | Basic | **Introduced in version:** 1.0.0 **Default value:** None **Required** Path to the SSL cert for the Prometheus metrics collection process. Prometheus is a tool Apigee can use for collecting and processing metrics. See: - [metrics](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#metrics) - For background information, the [Prometheus website](https://prometheus.io/) |
| `metrics.prometheus.sslKeyPath` | Basic | **Introduced in version:** 1.0.0 **Default value:** None **Required** Path to the SSL Key for the Prometheus metrics collection process. Prometheus is a tool Apigee can use for collecting and processing metrics. See: - [metrics](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#metrics) - For background information, the [Prometheus website](https://prometheus.io/) |
| `metrics.proxy.resources.requests.cpu` | Advanced | **Introduced in version:** 1.4.0 **Default value:** `500m` The CPU needed for normal operation of the proxy in a Kubernetes container, in millicores. |
| `metrics.proxy.resources.requests.memory` | Advanced | **Introduced in version:** 1.4.0 **Default value:** `512Mi` The memory needed for normal operation of the proxy in a Kubernetes container, in mebibytes. |
| `metrics.proxy.resources.limits.cpu` | Advanced | **Introduced in version:** 1.4.0 **Default value:** `500m` The CPU limit for the proxy resource in a Kubernetes container, in millicores. |
| `metrics.proxy.resources.limits.memory` | Advanced | **Introduced in version:** 1.4.0 **Default value:** `1Gi` The memory limit for the proxy resource in a Kubernetes container, in gibibytes. |
| `metrics.proxyStackdriverExporter.podDisruptionBudget.minAvailable` | Advanced | **Introduced in version:** 1.14.10 **Default value:** None **Chart:** `apigee-telemetry` The minimum number of `proxyStackdriverExporter` pods that must stay available during a voluntary disruption, such as during a node pool upgrade or a node drain. This field sets the `minAvailable` field of the [PodDisruptionBudget](https://kubernetes.io/docs/concepts/workloads/pods/disruptions/) for these pods. It takes either an integer number of pods (`1`) or a percentage string (`"50%"`). `minAvailable` and `maxUnavailable` are mutually exclusive; set only one. The Apigee operator rejects setting both at once. If you set neither field, the Apigee operator still generates a PodDisruptionBudget for these pods, using `maxUnavailable: 1` by default. For example, in `overrides.yaml`: ``` metrics: proxyStackdriverExporter: podDisruptionBudget: minAvailable: "50%" ``` |
| `metrics.proxyStackdriverExporter.podDisruptionBudget.maxUnavailable` | Advanced | **Introduced in version:** 1.14.10 **Default value:** None **Chart:** `apigee-telemetry` The maximum number of `proxyStackdriverExporter` pods that can be unavailable during a voluntary disruption, such as during a node pool upgrade or a node drain. This field sets the `maxUnavailable` field of the [PodDisruptionBudget](https://kubernetes.io/docs/concepts/workloads/pods/disruptions/) for these pods. It takes either an integer number of pods (`1`) or a percentage string (`"50%"`). `maxUnavailable` and `minAvailable` are mutually exclusive; set only one. The Apigee operator rejects setting both at once. If you set neither field, the Apigee operator still generates a PodDisruptionBudget for these pods, using `maxUnavailable: 1` by default. For example, in `overrides.yaml`: ``` metrics: proxyStackdriverExporter: podDisruptionBudget: maxUnavailable: 1 ``` |
| `metrics.proxyStackdriverExporter.resources.requests.cpu` | Advanced | **Introduced in version:** 1.7.0 **Default value:** `128m` The CPU needed for normal operation of the stackdriverExporter in a Kubernetes container, in millicores. |
| `metrics.proxyStackdriverExporter.resources.requests.memory` | Advanced | **Introduced in version:** 1.7.0 **Default value:** `512Mi` The memory needed for normal operation of the stackdriverExporter in a Kubernetes container, in mebibytes. |
| `metrics.proxyStackdriverExporter.resources.limits.cpu` | Advanced | **Introduced in version:** 1.7.0 **Default value:** `500m` The CPU limit for the stackdriverExporter resource in a Kubernetes container, in millicores. |
| `metrics.proxyStackdriverExporter.resources.limits.memory` | Advanced | **Introduced in version:** 1.7.0 **Default value:** `1Gi` The memory limit for the stackdriverExporter resource in a Kubernetes container, in gibibytes. |
| `metrics.proxyURL` | Basic | **Introduced in version:** 1.0.0 **Default value:** None URL for the metrics process sidecar proxy in the Kubernetes cluster. |
| `metrics.sdSidecar.containerPort` | Advanced | **Introduced in version:** 1.0.0 **Default value:** `9091` The port for connecting to the Cloud Monitoring metrics service. |
| `metrics.sdSidecar.image.pullPolicy` | Advanced | **Introduced in version:** 1.0.0 **Default value:** `IfNotPresent` Determines when Kubelet pulls this service's Docker image. Possible values include: - `IfNotPresent`: Do not pull a new image if it already exists - `Always`: Always pull the policy, even if it already exists For more information, see [Updating images](https://kubernetes.io/docs/concepts/containers/images/#updating-images). |
| `metrics.sdSidecar.image.tag` | Advanced | **Introduced in version:** 1.0.0 **Default value:** `1.14.10` The version label for this service's Docker image. |
| `metrics.sdSidecar.image.url` | Advanced | **Introduced in version:** 1.0.0 **Default value:** None The location of the Docker image for this service. Use `apigee-pull-push --list` to see the current repository URL for this component. > [!TIP] > **Tip:** Consider using [`hub`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#hub) to set a private repository URL for all components instead of configuring them individually. |
| `metrics.serviceAccountPath` | Basic | **Introduced in version:** 1.0.0 **Default value:** None One of either `serviceAccountPath` or `serviceAccountRef` is required. Path to Google Service Account key file with **Monitoring Metric Writer** role. |
| `metrics.serviceAccountRef` | Basic | **Introduced in version:** 1.2.0 **Default value:** None One of either `serviceAccountPath` or `serviceAccountRef` is required. |
| `metrics.stackdriverExporter.resources.requests.cpu` | Advanced | **Introduced in version:** 1.4.0 <var translate="no">Deprecated</var>: Starting in Hybrid version 1.8, `metrics:stackdriverExporter` has been replaced with `metrics:appStackdriverExporter` and `metrics:proxyStackdriverExporter`. See: - [metrics.appStackdriverExporter.resources.requests.cpu](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#appstackdriverexporter-resources-requests-cpu) - [metrics.proxyStackdriverExporter.resources.requests.cpu](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#proxystackdriverexporter-resources-requests-cpu) |
| `metrics.stackdriverExporter.resources.requests.memory` | Advanced | *Introduced in version:* 1.4.0 <var translate="no">Deprecated</var>: Starting in Hybrid version 1.8, `metrics:stackdriverExporter` has been replaced with `metrics:appStackdriverExporter` and `metrics:proxyStackdriverExporter`. See: - [metrics.appStackdriverExporter.resources.requests.memory](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#appstackdriverexporter-resources-requests-memory) - [metrics.proxyStackdriverExporter.resources.requests.memory](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#proxystackdriverexporter-resources-requests-memory) |
| `metrics.stackdriverExporter.resources.limits.cpu` | Advanced | **Introduced in version:** 1.4.0 <var translate="no">Deprecated</var>: Starting in Hybrid version 1.8, `metrics:stackdriverExporter` has been replaced with `metrics:appStackdriverExporter` and `metrics:proxyStackdriverExporter`. See: - [metrics.appStackdriverExporter.resources.limits.cpu](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#appstackdriverexporter-resources-limits-cpu) - [metrics.proxyStackdriverExporter.resources.limits.cpu](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#proxystackdriverexporter-resources-limits-cpu) |
| `metrics.stackdriverExporter.resources.limits.memory` | Advanced | **Introduced in version:** 1.4.0 <var translate="no">Deprecated</var>: Starting in Hybrid version 1.8, `metrics:stackdriverExporter` has been replaced with `metrics:appStackdriverExporter` and `metrics:proxyStackdriverExporter`. See: - [metrics.appStackdriverExporter.resources.limits.memory](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#appstackdriverexporter-resources-limits-memory) - [metrics.proxyStackdriverExporter.resources.limits.memory](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#proxystackdriverexporter-resources-limits-memory) |
| `metrics.terminationGracePeriodSeconds` | Advanced | **Introduced in version:** 1.0.0 **Default value:** `300` The maximum time between a request for pod deletion and when the pod is killed, in seconds. During this period, any prestop hooks will be executed and any running process should terminate gracefully. The pod will be killed when all running processes have terminated or at the end of the grace period, whichever comes first. If there are no running processes, the pod will be killed immediately. |
| `metrics.tolerations.effect` | Advanced | **Introduced in version:** 1.10.1 **Default value:** None Required to use the [Taints and Tolerations feature of Kubernetes](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/). `effect` specifies the effect that matching a toleration with a taint will have. Values for `effect` can be: - `NoExecute` - `NoSchedule` - `PreferNoSchedule` See [Taints and Tolerations: Concepts](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/#concepts) for details. |
| `metrics.tolerations.key` | Advanced | **Introduced in version:** 1.10.1 **Default value:** None Required to use the [Taints and Tolerations feature of Kubernetes](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/). `key` identifies pods to which the toleration can be applied. See [Taints and Tolerations: Concepts](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/#concepts) for details. |
| `metrics.tolerations.operator` | Advanced | **Introduced in version:** 1.10.1 **Default value:** `"Equal"` Required to use the [Taints and Tolerations feature of Kubernetes](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/). `operator` specifies the operation used to trigger the [`effect`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#metrics-tolerations-effect). Values for `operator` can be: - `Equal` matches the value set in [`value`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#metrics-tolerations-value). - `Exists` ignores the value set in [`value`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#metrics-tolerations-value). See [Taints and Tolerations: Concepts](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/#concepts) for details. |
| `metrics.tolerations.tolerationSeconds` | Advanced | **Introduced in version:** 1.10.1 **Default value:** None Used by the [Taints and Tolerations feature of Kubernetes](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/). `tolerationSeconds` defines in seconds how long a pod stays bound to a failing or unresponsive node. See [Taints and Tolerations: Concepts](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/#concepts) for details. |
| `metrics.tolerations.value` | Advanced | **Introduced in version:** 1.10.1 **Default value:** None Used by the [Taints and Tolerations feature of Kubernetes](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/). `value` is the value that triggers the [`effect`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#metrics-tolerations-effect) when [`operator`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#metrics-tolerations-operator) is set to `Equal`. See [Taints and Tolerations: Concepts](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/#concepts) for details. |

## `mintTaskScheduler`

`mintTaskScheduler` is the cron job to schedule monetization tasks, like recurring fee calculation on a periodic basis.

The following table describes the properties of the `mintTaskScheduler` object:

| Property | Type | Description |
|---|---|---|
| `mintTaskScheduler.gsa` | Advanced | **Introduced in version:** 1.14.3 **Default value:** None The email address of the `apigee-mint-task-scheduler` Google IAM service account (GSA) to associate with the corresponding Kubernetes service account when enabling Workload Identity on GKE clusters using Helm charts. Set this when you have set [`gcp.workloadIdentity.enabled`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#gcp-workloadidentity-enabled) to `true`. GSA email addresses typically have the format of: ``` GSA_NAME@PROJECT_ID.iam.gserviceaccount.com ``` For example: ``` apigee-mint-task-scheduler@my-hybrid-project.iam.gserviceaccount.com ``` > [!TIP] > **Tip:** You can find the email address of your service accounts with the following command: > ``` > gcloud iam service-accounts list --project ${PROJECT_ID} --filter "apigee" > ``` See [Enabling Workload Identity on GKE](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/enable-workload-identity-gke.md.txt) or [Enabling Workload Identity Federation on AKS and EKS](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/enable-workload-identity-federation.md.txt). |
| `mintTaskScheduler.image.pullPolicy` | Advanced | **Introduced in version:** 1.7.0 **Default value:** `IfNotPresent` Determines when [kubelet](https://kubernetes.io/docs/reference/command-line-tools-reference/kubelet/#kubelet) pulls the pod's Docker image. Possible values include: - `IfNotPresent`: Do not pull a new image if it already exists. - `Always`: Always pull the image, regardless of whether it exists already. For more information, see [Updating images](https://kubernetes.io/docs/concepts/containers/images/#updating-images). |
| `mintTaskScheduler.image.tag` | Advanced | **Introduced in version:** 1.7.0 **Default value:** `1.14.10` The version label for this service's Docker image. |
| `mintTaskScheduler.image.url` | Advanced | **Introduced in version:** 1.7.0 **Default value:** None The location of the Docker image for this service. Use `apigee-pull-push --list` to see the current repository URL for this component. > [!TIP] > **Tip:** Consider using [`hub`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#hub) to set a private repository URL for all components instead of configuring them individually. |
| `mintTaskScheduler.resources.limits.cpu` | Advanced | **Introduced in version:** 1.1.0 **Default value:** `2000m` The CPU limit for the resource in a Kubernetes container, in millicores. |
| `mintTaskScheduler.resources.limits.memory` | Advanced | **Introduced in version:** 1.1.0 **Default value:** `4Gi` The memory limit for the resource in a Kubernetes container, in mebibytes. |
| `mintTaskScheduler.resources.requests.cpu` | Advanced | **Introduced in version:** 1.7.0 **Default value:** `500m` The CPU needed for normal operation of the resource in a Kubernetes container, in millicores. |
| `mintTaskScheduler.resources.requests.memory` | Advanced | **Introduced in version:** 1.7.0 **Default value:** `512Mi` The memory needed for normal operation of the resource in a Kubernetes container, in mebibytes. |
| `mintTaskScheduler.serviceAccountPath` | Basic | **Introduced in version:** 1.14.3 **Default value:** None One of either `serviceAccountPath` or `serviceAccountRef` is required. Path to Google Service Account key file. |
| `mintTaskScheduler.serviceAccountRef` | Basic | **Introduced in version:** 1.14.3 **Default value:** None One of either `serviceAccountPath` or `serviceAccountRef` is required. |
| `mintTaskScheduler.tolerations.effect` | Advanced | **Introduced in version:** 1.10.1 **Default value:** None Required to use the [Taints and Tolerations feature of Kubernetes](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/). `effect` specifies the effect that matching a toleration with a taint will have. Values for `effect` can be: - `NoExecute` - `NoSchedule` - `PreferNoSchedule` See [Taints and Tolerations: Concepts](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/#concepts) for details. |
| `mintTaskScheduler.tolerations.key` | Advanced | **Introduced in version:** 1.10.1 **Default value:** None Required to use the [Taints and Tolerations feature of Kubernetes](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/). `key` identifies pods to which the toleration can be applied. See [Taints and Tolerations: Concepts](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/#concepts) for details. |
| `mintTaskScheduler.tolerations.operator` | Advanced | **Introduced in version:** 1.10.1 **Default value:** `"Equal"` Required to use the [Taints and Tolerations feature of Kubernetes](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/). `operator` specifies the operation used to trigger the [`effect`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#minttaskscheduler-tolerations-effect). Values for `operator` can be: - `Equal` matches the value set in [`value`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#minttaskscheduler-tolerations-value). - `Exists` ignores the value set in [`value`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#minttaskscheduler-tolerations-value). See [Taints and Tolerations: Concepts](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/#concepts) for details. |
| `mintTaskScheduler.tolerations.tolerationSeconds` | Advanced | **Introduced in version:** 1.10.1 **Default value:** None Used by the [Taints and Tolerations feature of Kubernetes](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/). `tolerationSeconds` defines in seconds how long a pod stays bound to a failing or unresponsive node. See [Taints and Tolerations: Concepts](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/#concepts) for details. |
| `mintTaskScheduler.tolerations.value` | Advanced | **Introduced in version:** 1.10.1 **Default value:** None Used by the [Taints and Tolerations feature of Kubernetes](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/). `value` is the value that triggers the [`effect`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#minttaskscheduler-tolerations-effect) when [`operator`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#minttaskscheduler-tolerations-operator) is set to `Equal`. See [Taints and Tolerations: Concepts](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/#concepts) for details. |

## `newDataPipeline`

`newDataPipeline` determines if Apigee hybrid uses the [new data pipeline](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/data-collection-with-data-residency.md.txt) for the
runtime components to write data directly to the control plane.

The following table describes the properties of the `newDataPipeline` object:

| Property | Type | Description |
|---|---|---|
| `newDataPipeline.analytics` | Advanced | **Introduced in version:** 1.13.1 **Default value:** `true` Determines if analytics use the new Pub/Sub data pipeline. Set this property to `true` to use the new data pipeline if you are using hybrid v1.13 with data residency enabled or if you are using hybrid v1.14 or later and have previously set it to `false`. Set it to `false` to disable the new data pipeline. For more information, see [Configure hybrid to use the new data pipeline](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/data-collection-with-data-residency.md.txt). > [!NOTE] > **Note:** `newDataPipeline.analytics` is set to `true` by default in hybrid v1.14.0 and later. |
| `newDataPipeline.debugSession` | Advanced | **Introduced in version:** 1.13.1 **Default value:** `true` (starting with hybrid v1.14.0) Determines if the new Pub/Sub data pipeline is enabled. Set this property to `true` to use the new data pipeline if you are using hybrid v1.13 with data residency enabled or if you are using hybrid v1.14 or later and have previously set it to `false`. Set it to `false` to disable the new data pipeline. For more information, see [Configure hybrid to use the new data pipeline](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/data-collection-with-data-residency.md.txt). > [!NOTE] > **Note:** `newDataPipeline.debugSession` is set to `true` by default in hybrid v1.14.0 and later. |

## `nodeSelector`

The `nodeSelector` object defines the node for your Apigee instance. Behind the scenes
Apigee hybrid takes care to map the label key/value for
`apigeeRuntime` and `apigeeData`
to the individual Istio and MART components when you install or upgrade the
`apigee-org` and `apigee-ingress-manager` charts.
You can override this for individual objects in the [mart:nodeSelector](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#mart) property.

The following table describes the properties of the `nodeSelector` object:

| Property | Type | Description |
|---|---|---|
| `nodeSelector.apigeeData.key` | Advanced | **Introduced in version:** 1.0.0 **Default value:** `cloud.google.com/gke-nodepool` ApigeeData is the node for the Cassandra database. Node selector label key for targeting Kubernetes nodes for working with Apigee services data. See [Configure dedicated node pools](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/configure-dedicated-nodes.md.txt). |
| `nodeSelector.apigeeData.value` | Advanced | **Introduced in version:** 1.0.0 **Default value:** `apigee-data` apigee-data is the node for the Cassandra database. Node selector label value for targeting Kubernetes nodes for working with Apigee services data. See [Configure dedicated node pools](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/configure-dedicated-nodes.md.txt). |
| `nodeSelector.apigeeRuntime.key` | Advanced | **Introduced in version:** 1.0.0 **Default value:** `cloud.google.com/gke-nodepool` Apigee Runtime is the node for the runtime environment for the project. Node selector label key for targeting Kubernetes nodes for Apigee runtime services. See [Configure dedicated node pools](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/configure-dedicated-nodes.md.txt). |
| `nodeSelector.apigeeRuntime.value` | Advanced | **Introduced in version:** 1.0.0 **Default value:** `apigee-runtime` `apigee-runtime` is the node for the runtime environment for the project. Node selector label value for targeting Kubernetes nodes for Apigee runtime services. See [Configure dedicated node pools](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/configure-dedicated-nodes.md.txt). |
| `nodeSelector.requiredForScheduling` | Advanced | **Introduced in version:** 1.0.0 **Default value:** true The `requiredForScheduling` property defaults to `true`. When `true`, it means that if Kubernetes cannot find nodes with the label key/value that is configured then the underlying Pods will not get scheduled on VM worker nodes. For production, `nodeSelector.requiredForScheduling` should be set to true. See [Configure dedicated node pools](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/configure-dedicated-nodes.md.txt). |

## `redis`

The following table describes the properties of the `redis` object:

| Property | Type | Description |
|---|---|---|
| `redis.auth.password` | Basic | **Introduced in version:** 1.6.0 **Default value:** `iloveapis123` **Required** Password for the Redis administrator. The admin user is used for any administrative activities performed on the Redis cluster. |
| `redis.auth.secret` | Basic | **Introduced in version:** 1.9.1 **Default value:** None The name of the file stored in a Kubernetes secret that contains the password for the Redis administrator. The secret file should contain the key: ``` data: redis.auth.password: encoded_value ``` See also: - [`redis.auth.password`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#redis-auth-password) - [Storing data in a Kubernetes secret](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/k8s-secrets.md.txt) - [Secrets](https://kubernetes.io/docs/concepts/configuration/secret/) in the Kubernetes documentation - [Creating a Secret Using kubectl](https://kubernetes.io/docs/concepts/configuration/secret/#creating-a-secret) in the Kubernetes documentation |
| `redis.envoy.image.pullPolicy` | Advanced | **Introduced in version:** 1.6.0 **Default value:** `IfNotPresent` Determines when [kubelet](https://kubernetes.io/docs/reference/command-line-tools-reference/kubelet/#kubelet) pulls the pod's Docker image. Possible values include: - `IfNotPresent`: Do not pull a new image if it already exists. - `Always`: Always pull the image, regardless of whether it exists already. For more information, see [Updating images](https://kubernetes.io/docs/concepts/containers/images/#updating-images). |
| `redis.envoy.image.tag` | Advanced | **Introduced in version:** 1.6.0 **Default value:** `1.14.10` The version label for this service's Docker image. |
| `redis.envoy.image.url` | Advanced | **Introduced in version:** 1.6.0 **Default value:** None The location of the Docker image for this service. Use `apigee-pull-push --list` to see the current repository URL for this component. > [!TIP] > **Tip:** Consider using [`hub`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#hub) to set a private repository URL for all components instead of configuring them individually. |
| `redis.envoy.podDisruptionBudget.minAvailable` | Advanced | **Introduced in version:** 1.14.10 **Default value:** None **Chart:** `apigee-redis` The minimum number of Redis Envoy pods that must stay available during a voluntary disruption, for example during a node pool upgrade or a node drain. This field sets the `minAvailable` field of the [PodDisruptionBudget](https://kubernetes.io/docs/concepts/workloads/pods/disruptions/) for these pods. It takes either an integer number of pods (`1`) or a percentage string (`"50%"`). `minAvailable` and `maxUnavailable` are mutually exclusive; set only one. Setting both at once is rejected by the Apigee operator. If you set neither field, the Apigee operator still generates a PodDisruptionBudget for these pods, using `maxUnavailable: 1` by default. For example, in `overrides.yaml`: ``` redis: envoy: podDisruptionBudget: minAvailable: "50%" ``` |
| `redis.envoy.podDisruptionBudget.maxUnavailable` | Advanced | **Introduced in version:** 1.14.10 **Default value:** None **Chart:** `apigee-redis` The maximum number of Redis Envoy pods that can be unavailable during a voluntary disruption, for example during a node pool upgrade or a node drain. This field sets the `maxUnavailable` field of the [PodDisruptionBudget](https://kubernetes.io/docs/concepts/workloads/pods/disruptions/) for these pods. It takes either an integer number of pods (`1`) or a percentage string (`"50%"`). `maxUnavailable` and `minAvailable` are mutually exclusive; set only one. Setting both at once is rejected by the Apigee operator. If you set neither field, the Apigee operator still generates a PodDisruptionBudget for these pods, using `maxUnavailable: 1` by default. For example, in `overrides.yaml`: ``` redis: envoy: podDisruptionBudget: maxUnavailable: 1 ``` |
| `redis.image.pullPolicy` | Advanced | **Introduced in version:** 1.6.0 **Default value:** `IfNotPresent` Determines when [kubelet](https://kubernetes.io/docs/reference/command-line-tools-reference/kubelet/#kubelet) pulls the pod's Docker image. Possible values include: - `IfNotPresent`: Do not pull a new image if it already exists. - `Always`: Always pull the image, regardless of whether it exists already. For more information, see [Updating images](https://kubernetes.io/docs/concepts/containers/images/#updating-images). |
| `redis.image.tag` | Advanced | **Introduced in version:** 1.6.0 **Default value:** `1.14.10` The version label for this service's Docker image. |
| `redis.image.url` | Advanced | **Introduced in version:** 1.6.0 **Default value:** None The location of the Docker image for this service. Use `apigee-pull-push --list` to see the current repository URL for this component. > [!TIP] > **Tip:** Consider using [`hub`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#hub) to set a private repository URL for all components instead of configuring them individually. |
| `redis.replicaCount` | Basic | **Introduced in version:** 1.6.0 **Default value:** `2` Redis is a replicated storage. This property specifies the number of Redis nodes employed as a [StatefulSet](https://kubernetes.io/docs/concepts/workloads/controllers/statefulset/). |
| `redis.resources.requests.cpu` | Advanced | **Introduced in version:** 1.6.0 **Default value:** `500m` The CPU needed for normal operation of the resource in a Kubernetes container, in millicores. > [!TIP] > Apigee recommends a value from `500m` to `1000m`. With 0.5 cores, a Redis node can typically handle 10K QPS. With 1.0 core, it can typically handle 20K QPS. CPU request resources above 1000m are not helpful in most cases. |
| `redis.tolerations.effect` | Advanced | **Introduced in version:** 1.10.1 **Default value:** None Required to use the [Taints and Tolerations feature of Kubernetes](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/). `effect` specifies the effect that matching a toleration with a taint will have. Values for `effect` can be: - `NoExecute` - `NoSchedule` - `PreferNoSchedule` See [Taints and Tolerations: Concepts](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/#concepts) for details. |
| `redis.tolerations.key` | Advanced | **Introduced in version:** 1.10.1 **Default value:** None Required to use the [Taints and Tolerations feature of Kubernetes](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/). `key` identifies pods to which the toleration can be applied. See [Taints and Tolerations: Concepts](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/#concepts) for details. |
| `redis.tolerations.operator` | Advanced | **Introduced in version:** 1.10.1 **Default value:** `"Equal"` Required to use the [Taints and Tolerations feature of Kubernetes](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/). `operator` specifies the operation used to trigger the [`effect`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#redis-tolerations-effect). Values for `operator` can be: - `Equal` matches the value set in [`value`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#redis-tolerations-value). - `Exists` ignores the value set in [`value`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#redis-tolerations-value). See [Taints and Tolerations: Concepts](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/#concepts) for details. |
| `redis.tolerations.tolerationSeconds` | Advanced | **Introduced in version:** 1.10.1 **Default value:** None Used by the [Taints and Tolerations feature of Kubernetes](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/). `tolerationSeconds` defines in seconds how long a pod stays bound to a failing or unresponsive node. See [Taints and Tolerations: Concepts](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/#concepts) for details. |
| `redis.tolerations.value` | Advanced | **Introduced in version:** 1.10.1 **Default value:** None Used by the [Taints and Tolerations feature of Kubernetes](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/). `value` is the value that triggers the [`effect`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#redis-tolerations-effect) when [`operator`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#redis-tolerations-operator) is set to `Equal`. See [Taints and Tolerations: Concepts](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/#concepts) for details. |

## `runtime`

The following table describes the properties of the `runtime` object:

| Property | Type | Description |
|---|---|---|
| `runtime.annotations` | Advanced | **Introduced in version:** 1.5.0 **Default value:** None Optional key/value map used to annotate pods. For more information, see [Custom annotations](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/customize-services.md.txt#custom-annotations). |
| `runtime.envVars` | Basic | **Introduced in version:** 1.13.1 **Default value:** None Allows you to supply additional env variables to the runtime component in a key-value pair: ``` runtime: envVars: KEY_1: VALUE_N ... ... KEY_N: VALUE_N ``` for example: ``` runtime: envVars: RUNTIME_ENV_VAR1: "value of runtime env-var 1" RUNTIME_ENV_VAR2: "value of runtime env-var 2" ``` |
| `runtime.image.pullPolicy` | Advanced | **Introduced in version:** 1.0.0 **Default value:** `IfNotPresent` Determines when [kubelet](https://kubernetes.io/docs/reference/command-line-tools-reference/kubelet/#kubelet) pulls the pod's Docker image. Possible values include: - `IfNotPresent`: Do not pull a new image if it already exists. - `Always`: Always pull the image, regardless of whether it exists already. For more information, see [Updating images](https://kubernetes.io/docs/concepts/containers/images/#updating-images). |
| `runtime.hpaBehavior.scaleDown.percent.periodSeconds` | Advanced | **Introduced in version:** 1.7.0 **Default value:** 60 The window of time for which the policy should hold true when scaling down a percentage of runtime instances. |
| `runtime.hpaBehavior.scaleDown.percent.value` | Advanced | **Introduced in version:** 1.7.0 **Default value:** 20 The amount of change which is permitted by the policy when scaling down a percentage of runtime instances. |
| `runtime.hpaBehavior.scaleDown.pods.periodSeconds` | Advanced | **Introduced in version:** 1.7.0 **Default value:** 60 The window of time for which the policy should hold true when scaling down a number of runtime instances. |
| `runtime.hpaBehavior.scaleDown.pods.value` | Advanced | **Introduced in version:** 1.7.0 **Default value:** 20 The amount of change which is permitted by the policy when scaling down a number of runtime instances. |
| `runtime.hpaBehavior.scaleDown.selectPolicy` | Advanced | **Introduced in version:** 1.7.0 **Default value:** Min The decision that autoscaler makes between multiple autoscaling policies. Set the value to **Min** allows the smallest change in scaling down runtime instances. Set the value to **Max** allows the largest change in scaling down runtime instances. |
| `runtime.hpaBehavior.scaleDown.stabilizationWindowSeconds` | Advanced | **Introduced in version:** 1.7.0 **Default value:** 120 The number of seconds for which past recommendations should be considered while scaling down. |
| `runtime.hpaBehavior.scaleUp.percent.periodSeconds` | Advanced | **Introduced in version:** 1.7.0 **Default value:** 60 The window of time for which the policy should hold true when scaling up a percentage of runtime instances. |
| `runtime.hpaBehavior.scaleUp.percent.value` | Advanced | **Introduced in version:** 1.7.0 **Default value:** 20 The window of time for which the policy should hold true when scaling up a percentage of runtime instances. |
| `runtime.hpaBehavior.scaleUp.pods.periodSeconds` | Advanced | **Introduced in version:** 1.7.0 **Default value:** 60 The window of time for which the policy should hold true when scaling up a number of runtime instances. |
| `runtime.hpaBehavior.scaleUp.pods.value` | Advanced | **Introduced in version:** 1.7.0 **Default value:** 4 The amount of change which is permitted by the policy when scaling up a number of runtime instances. |
| `runtime.hpaBehavior.scaleUp.selectPolicy` | Advanced | **Introduced in version:** 1.7.0 **Default value:** Max The decision that autoscaler makes between multiple autoscaling policies. Set the value to **Min** allows the smallest change in scaling up runtime instances. Set the value to **Max**allows the largest change in scaling up runtime instances. |
| `runtime.hpaBehavior.scaleUp.stabilizationWindowSeconds` | Advanced | **Introduced in version:** 1.7.0 **Default value:** 30 The number of seconds for which past recommendations should be considered while scaling up runtime instances. |
| `runtime.hpaMetrics.serverMainTaskWaitTime` | Advanced | **Introduced in version:** 1.7.0 **Default value:** 400M The desired average wait time (in ms) of processing queue in runtime instances for proxy requests at the http layer. |
| `runtime.hpaMetrics.serverNioTaskWaitTime` | Advanced | **Introduced in version:** 1.7.0 **Default value:** 400M The desired average wait time (in ms) of processing queue in runtime instances for proxy requests to process policies. |
| `runtime.hpaMetrics.targetCPUUtilizationPercentage` | Advanced | **Introduced in version:** 1.7.0 **Default value:** 75 The desired CPU utilization percentage across all runtime instances. |
| `runtime.image.tag` | Advanced | **Introduced in version:** 1.0.0 **Default value:** `1.14.10` The version label for this service's Docker image. |
| `runtime.image.url` | Advanced | **Introduced in version:** 1.0.0 **Default value:** None The location of the Docker image for this service. Use `apigee-pull-push --list` to see the current repository URL for this component. > [!TIP] > **Tip:** Consider using [`hub`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#hub) to set a private repository URL for all components instead of configuring them individually. |
| `runtime.livenessProbe.failureThreshold` | Advanced | **Introduced in version:** 1.0.0 **Default value:** `2` The number of times Kubernetes will verify that liveness probes have failed before restarting the container. The minimum value is 1. |
| `runtime.livenessProbe.initialDelaySeconds` | Advanced | **Introduced in version:** 1.0.0 **Default value:** `60` The number of seconds after a container is started before a liveness probe is initiated. |
| `runtime.livenessProbe.periodSeconds` | Advanced | **Introduced in version:** 1.0.0 **Default value:** `5` Determines how often to perform a liveness probe, in seconds. The minimum value is 1. |
| `runtime.livenessProbe.timeoutSeconds` | Advanced | **Introduced in version:** 1.0.0 **Default value:** `1` The number of seconds after which a liveness probe times out. The minimum value is 1. |
| `runtime.nodeSelector.key` | Basic | **Introduced in version:** 1.0.0 **Default value:** None Optional Node selector label key for targeting Kubernetes nodes for `runtime` services. See [nodeSelector property](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#nodeselector). |
| `runtime.nodeSelector.value` | Basic | **Introduced in version:** 1.0.0 **Default value:** None Node selector label value for targeting Kubernetes nodes for `runtime` services. See [Configuring dedicated node pools](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/configure-dedicated-nodes.md.txt). |
| `runtime.podDisruptionBudget.minAvailable` | Advanced | **Introduced in version:** 1.14.10 **Default value:** None **Chart:** `apigee-env` The minimum number of runtime pods that must stay available during a voluntary disruption, for example during a node pool upgrade or a node drain. This field sets the `minAvailable` field of the [PodDisruptionBudget](https://kubernetes.io/docs/concepts/workloads/pods/disruptions/) for these pods. It takes either an integer number of pods (`1`) or a percentage string (`"50%"`). `minAvailable` and `maxUnavailable` are mutually exclusive; set only one. Setting both at once is rejected by the Apigee operator. If you set neither field, the Apigee operator still generates a PodDisruptionBudget for these pods, using `maxUnavailable: 1` by default. To set a different budget for the runtime pods in a specific environment, use [`envs[].components.runtime.podDisruptionBudget.minAvailable`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#envs-components-runtime-poddisruptionbudget-minavailable). For example, in `overrides.yaml`: ``` runtime: podDisruptionBudget: minAvailable: "50%" ``` |
| `runtime.podDisruptionBudget.maxUnavailable` | Advanced | **Introduced in version:** 1.14.10 **Default value:** None **Chart:** `apigee-env` The maximum number of runtime pods that can be unavailable during a voluntary disruption, for example during a node pool upgrade or a node drain. This field sets the `maxUnavailable` field of the [PodDisruptionBudget](https://kubernetes.io/docs/concepts/workloads/pods/disruptions/) for these pods. It takes either an integer number of pods (`1`) or a percentage string (`"50%"`). `maxUnavailable` and `minAvailable` are mutually exclusive; set only one. Setting both at once is rejected by the Apigee operator. If you set neither field, the Apigee operator still generates a PodDisruptionBudget for these pods, using `maxUnavailable: 1` by default. To set a different budget for the runtime pods in a specific environment, use [`envs[].components.runtime.podDisruptionBudget.maxUnavailable`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#envs-components-runtime-poddisruptionbudget-maxunavailable). For example, in `overrides.yaml`: ``` runtime: podDisruptionBudget: maxUnavailable: 1 ``` |
| `runtime.readinessProbe.failureThreshold` | Advanced | **Introduced in version:** 1.0.0 **Default value:** `2` The number of times Kubernetes will verify that readiness probes have failed before marking the pod *unready*. The minimum value is 1. |
| `runtime.readinessProbe.initialDelaySeconds` | Advanced | **Introduced in version:** 1.0.0 **Default value:** `60` The number of seconds after a container is started before a readiness probe is initiated. |
| `runtime.readinessProbe.periodSeconds` | Advanced | **Introduced in version:** 1.0.0 **Default value:** `5` Determines how often to perform a readiness probe, in seconds. The minimum value is 1. |
| `runtime.readinessProbe.successThreshold` | Advanced | **Introduced in version:** 1.0.0 **Default value:** `1` The minimum consecutive successes needed for a readiness probe to be considered successful after a failure. The minimum value is 1. |
| `runtime.readinessProbe.timeoutSeconds` | Advanced | **Introduced in version:** 1.0.0 **Default value:** `1` The number of seconds after which a liveness probe times out. The minimum value is 1. |
| `runtime.release.strategy` | Advanced | **Introduced in version:** 1.14.7 **Default value:** `rolling` Selects the strategy used to roll out a new runtime (message processor) ReplicaSet when an environment configuration change triggers a release. You can also set this per environment with `envs[].components.runtime.release.strategy`. Allowed values: - `rolling` (default): Stands up the new ReplicaSet alongside the existing one and shifts traffic to it in stages before scaling down the old ReplicaSet. This provides staged traffic migration but temporarily requires extra compute headroom (up to roughly double the steady-state pod count) during the release. Recommended for most production environments. - `scale-down-first`: Replaces pods one at a time, draining an existing pod before creating its replacement. Because each swap is one-for-one, the release stays within the steady-state pod count and does not require extra compute headroom. Use this for clusters without node autoscaling, such as hardware-constrained or bare-metal installations. Releases are slower and do not include staged traffic migration. - `none`: Performs an immediate transition to the new ReplicaSet without staged traffic migration. |
| `runtime.replicaCountMax` | Basic | **Introduced in version:** 1.0.0 **Default value:** `4` Maximum number of replicas available for autoscaling. If using [Enhanced per-environment proxy limits](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/enhanced-proxy-limits.md.txt), this will be applied to all replicasets for the environment. Each replicaset will still autoscale independently. |
| `runtime.replicaCountMin` | Basic | **Introduced in version:** 1.0.0 **Default value:** `1` Minimum number of replicas available for autoscaling. If using [Enhanced per-environment proxy limits](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/enhanced-proxy-limits.md.txt), this will be applied to all replicasets for the environment. Each replicaset will still autoscale independently.. |
| `runtime.resources.limits.cpu` | Advanced | **Introduced in version:** 1.11.0 **Default value:** `4000m` The CPU limit for the resource in a Kubernetes container, in millicores. |
| `runtime.resources.limits.memory` | Advanced | **Introduced in version:** 1.11.0 **Default value:** `6Gi` The memory limit for the resource in a Kubernetes container, in mebibytes (Mi) or gibibytes (Gi). > [!NOTE] > **Note:** If you are using message payloads larger than 10MB, you must make the following configuration changes: > - Increase the heap size to 4Gi. > - Increase [`runtime.resources.limits.memory`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#runtime-resources-limits-memory) to 6Gi. > - Increase [`runtime.resources.requests.memory`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#runtime-resources-requests-memory) to 4Gi. > See [Configure large message payload support in Apigee hybrid](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/configure-large-payload-support.md.txt) for more details. |
| `runtime.resources.requests.cpu` | Advanced | **Introduced in version:** 1.0.0 **Default value:** `500m` The CPU needed for normal operation of the resource in a Kubernetes container, in millicores. > [!NOTE] > **Note:** To achieve smooth autoscaling of the message processors to accommodate traffic increases, we recommend that you do not exceed two cores (2000 millicores) if you decide to override the default. > Apigee runtime components are bounded by I/O, and adding more CPU capacity does not always help > with traffic increases. When there are high CPU requests, message processors may not > autoscale and liveliness probes may fail with high traffic. |
| `runtime.resources.requests.memory` | Advanced | **Introduced in version:** 1.0.0 **Default value:** `512Mi` (see note below) The memory needed for normal operation of the resource in a Kubernetes container, in mebibytes (`Mi`) or Gibibytes (`Gi`). > [!NOTE] > **Note:** Reset the value of `runtime.resources.requests.memory` to at least `1Gi` in your `overrides.yaml`. The default of `512Mi` is enough for initial operation and configuration, but should be raised for production. > To achieve smooth autoscaling of the message processors to > accommodate traffic increases, we recommend that you do not exceed 2.5Gi (2560Mi) > if you decide to override the default. > [!NOTE] > **Note:** If you are using message payloads larger than 10MB, you must make the following configuration changes: > - Increase the heap size to 4Gi. > - Increase [`runtime.resources.limits.memory`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#runtime-resources-limits-memory) to 6Gi. > - Increase [`runtime.resources.requests.memory`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#runtime-resources-requests-memory) to 4Gi. > See [Configure large message payload support in Apigee hybrid](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/configure-large-payload-support.md.txt) for more details. |
| `runtime.service.type` | Advanced | **Introduced in version:** 1.0.0 **Default value:** `ClusterIP` The type of service. You can set this to a service other than ClusterIP; for example, `LoadBalancer`. |
| `runtime.targetCPUUtilizationPercentage` | Advanced | **Introduced in version:** 1.0.0 **Default value:** `75` Target CPU utilization for the runtime process on the pod. The value of this field enables the runtime to auto-scale when CPU utilization reaches this value, up to `replicaCountMax`. |
| `runtime.terminationGracePeriodSeconds` | Advanced | **Introduced in version:** 1.0.0 **Default value:** `3600` The maximum time between a request for pod deletion and when the pod is killed, in seconds. During this period, any prestop hooks will be executed and any running process should terminate gracefully. The pod will be killed when all running processes have terminated or at the end of the grace period, whichever comes first. If there are no running processes, the pod will be killed immediately. > [!NOTE] > **Note:** This value is set by the Apigee controller and cannot be overridden. |
| `runtime.tolerations.effect` | Advanced | **Introduced in version:** 1.10.1 **Default value:** None Required to use the [Taints and Tolerations feature of Kubernetes](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/). `effect` specifies the effect that matching a toleration with a taint will have. Values for `effect` can be: - `NoExecute` - `NoSchedule` - `PreferNoSchedule` See [Taints and Tolerations: Concepts](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/#concepts) for details. |
| `runtime.tolerations.key` | Advanced | **Introduced in version:** 1.10.1 **Default value:** None Required to use the [Taints and Tolerations feature of Kubernetes](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/). `key` identifies pods to which the toleration can be applied. See [Taints and Tolerations: Concepts](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/#concepts) for details. |
| `runtime.tolerations.operator` | Advanced | **Introduced in version:** 1.10.1 **Default value:** `"Equal"` Required to use the [Taints and Tolerations feature of Kubernetes](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/). `operator` specifies the operation used to trigger the [`effect`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#runtime-tolerations-effect). Values for `operator` can be: - `Equal` matches the value set in [`value`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#runtime-tolerations-value). - `Exists` ignores the value set in [`value`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#runtime-tolerations-value). See [Taints and Tolerations: Concepts](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/#concepts) for details. |
| `runtime.tolerations.tolerationSeconds` | Advanced | **Introduced in version:** 1.10.1 **Default value:** None Used by the [Taints and Tolerations feature of Kubernetes](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/). `tolerationSeconds` defines in seconds how long a pod stays bound to a failing or unresponsive node. See [Taints and Tolerations: Concepts](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/#concepts) for details. |
| `runtime.tolerations.value` | Advanced | **Introduced in version:** 1.10.1 **Default value:** None Used by the [Taints and Tolerations feature of Kubernetes](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/). `value` is the value that triggers the [`effect`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#runtime-tolerations-effect) when [`operator`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#runtime-tolerations-operator) is set to `Equal`. See [Taints and Tolerations: Concepts](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/#concepts) for details. |

## `synchronizer`

Ensures that the Message Processors are kept up to date with the latest deployed API proxy
bundles. To do this, the Synchronizer polls the management plane; when a new contract is detected,
the Synchronizer sends it to the runtime plane. By default, Synchronizer stores environment
configuration data in Cassandra.

For more information, see [Configure the Synchronizer](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/synchronizer-access.md.txt).

The following table describes the properties of the `synchronizer` object:

| Property | Type | Description |
|---|---|---|
| `synchronizer.annotations` | Advanced | **Introduced in version:** 1.5.0 **Default value:** None Optional key/value map used to annotate pods. For more information, see [Custom annotations](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/customize-services.md.txt#custom-annotations). |
| `synchronizer.image.pullPolicy` | Advanced | **Introduced in version:** 1.0.0 **Default value:** `IfNotPresent` Determines when [kubelet](https://kubernetes.io/docs/reference/command-line-tools-reference/kubelet/#kubelet) pulls the pod's Docker image. Possible values include: - `IfNotPresent`: Do not pull a new image if it already exists. - `Always`: Always pull the image, regardless of whether it exists already. For more information, see [Updating images](https://kubernetes.io/docs/concepts/containers/images/#updating-images). |
| `synchronizer.image.tag` | Advanced | **Introduced in version:** 1.0.0 **Default value:** `1.14.10` The version label for this service's Docker image. |
| `synchronizer.image.url` | Advanced | **Introduced in version:** 1.0.0 **Default value:** None The location of the Docker image for this service. Use `apigee-pull-push --list` to see the current repository URL for this component. > [!TIP] > **Tip:** Consider using [`hub`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#hub) to set a private repository URL for all components instead of configuring them individually. |
| `synchronizer.livenessProbe.failureThreshold` | Advanced | **Introduced in version:** 1.0.0 **Default value:** `2` The number of times Kubernetes will verify that liveness probes have failed before restarting the container. The minimum value is 1. |
| `synchronizer.livenessProbe.initialDelaySeconds` | Advanced | **Introduced in version:** 1.0.0 **Default value:** `0` The number of seconds after a container is started before a liveness probe is initiated. |
| `synchronizer.livenessProbe.periodSeconds` | Advanced | **Introduced in version:** 1.0.0 **Default value:** `5` Determines how often to perform a liveness probe, in seconds. The minimum value is 1. |
| `synchronizer.livenessProbe.timeoutSeconds` | Advanced | **Introduced in version:** 1.0.0 **Default value:** `1` The number of seconds after which a liveness probe times out. The minimum value is 1. |
| `synchronizer.nodeSelector.key` | Basic | **Introduced in version:** 1.0.0 **Default value:** None **Required** Optional node selector label key for targeting Kubernetes nodes for `synchronizer` runtime services. See [nodeSelector](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#nodeselector). |
| `synchronizer.nodeSelector.value` | Basic | **Introduced in version:** 1.0.0 **Default value:** None Optional node selector label value used for targeting Kubernetes nodes for `synchronizer` runtime services. See [nodeSelector](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#nodeselector). |
| `synchronizer.podDisruptionBudget.minAvailable` | Advanced | **Introduced in version:** 1.14.10 **Default value:** None **Chart:** `apigee-env` The minimum number of synchronizer pods that must stay available during a voluntary disruption, for example during a node pool upgrade or a node drain. This field sets the `minAvailable` field of the [PodDisruptionBudget](https://kubernetes.io/docs/concepts/workloads/pods/disruptions/) for these pods. It takes either an integer number of pods (`1`) or a percentage string (`"50%"`). `minAvailable` and `maxUnavailable` are mutually exclusive; set only one. Setting both at once is rejected by the Apigee operator. If you set neither field, the Apigee operator still generates a PodDisruptionBudget for these pods, using `maxUnavailable: 1` by default. To set a different budget for the synchronizer pods in a specific environment, use [`envs[].components.synchronizer.podDisruptionBudget.minAvailable`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#envs-components-synchronizer-poddisruptionbudget-minavailable). For example, in `overrides.yaml`: ``` synchronizer: podDisruptionBudget: minAvailable: "50%" ``` |
| `synchronizer.podDisruptionBudget.maxUnavailable` | Advanced | **Introduced in version:** 1.14.10 **Default value:** None **Chart:** `apigee-env` The maximum number of synchronizer pods that can be unavailable during a voluntary disruption, for example during a node pool upgrade or a node drain. This field sets the `maxUnavailable` field of the [PodDisruptionBudget](https://kubernetes.io/docs/concepts/workloads/pods/disruptions/) for these pods. It takes either an integer number of pods (`1`) or a percentage string (`"50%"`). `maxUnavailable` and `minAvailable` are mutually exclusive; set only one. Setting both at once is rejected by the Apigee operator. If you set neither field, the Apigee operator still generates a PodDisruptionBudget for these pods, using `maxUnavailable: 1` by default. To set a different budget for the synchronizer pods in a specific environment, use [`envs[].components.synchronizer.podDisruptionBudget.maxUnavailable`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#envs-components-synchronizer-poddisruptionbudget-maxunavailable). For example, in `overrides.yaml`: ``` synchronizer: podDisruptionBudget: maxUnavailable: 1 ``` |
| `synchronizer.pollInterval` | Advanced | **Introduced in version:** 1.0.0 **Default value:** `60` The length of time, in seconds, that Synchronizer waits between polling operations. Synchronizer polls Apigee control plane services to detect and pull new runtime contracts. This property is the default for all environments. To set a different value for one environment, use [`envs[].components.synchronizer.pollInterval`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#envs-components-synchronizer-pollinterval). A per-environment value takes precedence over this property. If you set a value less than `60`, Synchronizer uses `60`. > [!NOTE] > **Note:** In versions earlier than 1.14.11, Apigee hybrid doesn't apply this property. |
| `synchronizer.readinessProbe.failureThreshold` | Advanced | **Introduced in version:** 1.0.0 **Default value:** `2` The number of times Kubernetes will verify that readiness probes have failed before marking the pod *unready*. The minimum value is 1. |
| `synchronizer.readinessProbe.initialDelaySeconds` | Advanced | **Introduced in version:** 1.0.0 **Default value:** `0` The number of seconds after a container is started before a readiness probe is initiated. |
| `synchronizer.readinessProbe.periodSeconds` | Advanced | **Introduced in version:** 1.0.0 **Default value:** `5` Determines how often to perform a readiness probe, in seconds. The minimum value is 1. |
| `synchronizer.readinessProbe.successThreshold` | Advanced | **Introduced in version:** 1.0.0 **Default value:** `1` The minimum consecutive successes needed for a readiness probe to be considered successful after a failure. The minimum value is 1. |
| `synchronizer.readinessProbe.timeoutSeconds` | Advanced | **Introduced in version:** 1.0.0 **Default value:** `1` The number of seconds after which a liveness probe times out. The minimum value is 1. |
| `synchronizer.replicaCount` | Basic | **Introduced in version:** 1.0.0 <var translate="no">Deprecated</var>: Starting in Hybrid version 1.2, manage the Synchronizer replica count with: [`synchronizer.replicaCountMax`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#synchronizer-replicacountmax) and [`synchronizer.replicaCountMin`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#synchronizer-replicacountmin) |
| `synchronizer.replicaCountMax` | Basic | **Introduced in version:** 1.2.0 **Default value:** `4` Maximum number of replicas for autoscaling. |
| `synchronizer.replicaCountMin` | Basic | **Introduced in version:** 1.2.0 **Default value:** `1` Minimum number of replicas for autoscaling. |
| `synchronizer.resources.limits.cpu` | Advanced | **Introduced in version:** 1.11.0 **Default value:** `2000m` The CPU limit for the resource in a Kubernetes container, in millicores. |
| `synchronizer.resources.limits.memory` | Advanced | **Introduced in version:** 1.11.0 **Default value:** `5Gi` The memory limit for the resource in a Kubernetes container, in mebibytes. |
| `synchronizer.resources.requests.cpu` | Advanced | **Introduced in version:** 1.0.0 **Default value:** `100m` The CPU needed for normal operation of the resource in a Kubernetes container, in millicores. |
| `synchronizer.resources.requests.memory` | Advanced | **Introduced in version:** 1.0.0 **Default value:** `1Gi` The memory needed for normal operation of the resource in a Kubernetes container, in gigabytes. |
| `synchronizer.serviceAccountPath` | Basic | **Introduced in version:** 1.0.0 **Default value:** None One of either `serviceAccountPath` or `serviceAccountRef` is required. Path to Google Service Account key file with **Apigee Synchronizer Manager** role. |
| `synchronizer.serviceAccountRef` | Basic | **Introduced in version:** 1.2.0 **Default value:** None One of either `serviceAccountPath` or `serviceAccountRef` is required. |
| `synchronizer.serviceAccountSecret` | Basic | **Introduced in version:** 1.1.0 **Default value:** None The name of a [Kubernetes secret](https://kubernetes.io/docs/concepts/configuration/secret/). You must create the secret using a Google Service Account key with the **Apigee Synchronizer Manager** role as its input. |
| `synchronizer.targetCPUUtilizationPercentage` | Advanced | **Introduced in version:** 1.0.0 **Default value:** `75` Target CPU utilization for the Synchronizer process on the pod. The value of this field enables Synchronizer to auto-scale when CPU utilization reaches this value, up to `replicaCountMax`. |
| `synchronizer.terminationGracePeriodSeconds` | Advanced | **Introduced in version:** 1.0.0 **Default value:** `30` The maximum time between a request for pod deletion and when the pod is killed, in seconds. During this period, any prestop hooks will be executed and any running process should terminate gracefully. The pod will be killed when all running processes have terminated or at the end of the grace period, whichever comes first. If there are no running processes, the pod will be killed immediately. |
| `synchronizer.tolerations.effect` | Advanced | **Introduced in version:** 1.10.1 **Default value:** None Required to use the [Taints and Tolerations feature of Kubernetes](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/). `effect` specifies the effect that matching a toleration with a taint will have. Values for `effect` can be: - `NoExecute` - `NoSchedule` - `PreferNoSchedule` See [Taints and Tolerations: Concepts](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/#concepts) for details. |
| `synchronizer.tolerations.key` | Advanced | **Introduced in version:** 1.10.1 **Default value:** None Required to use the [Taints and Tolerations feature of Kubernetes](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/). `key` identifies pods to which the toleration can be applied. See [Taints and Tolerations: Concepts](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/#concepts) for details. |
| `synchronizer.tolerations.operator` | Advanced | **Introduced in version:** 1.10.1 **Default value:** `"Equal"` Required to use the [Taints and Tolerations feature of Kubernetes](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/). `operator` specifies the operation used to trigger the [`effect`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#synchronizer-tolerations-effect). Values for `operator` can be: - `Equal` matches the value set in [`value`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#synchronizer-tolerations-value). - `Exists` ignores the value set in [`value`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#synchronizer-tolerations-value). See [Taints and Tolerations: Concepts](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/#concepts) for details. |
| `synchronizer.tolerations.tolerationSeconds` | Advanced | **Introduced in version:** 1.10.1 **Default value:** None Used by the [Taints and Tolerations feature of Kubernetes](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/). `tolerationSeconds` defines in seconds how long a pod stays bound to a failing or unresponsive node. See [Taints and Tolerations: Concepts](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/#concepts) for details. |
| `synchronizer.tolerations.value` | Advanced | **Introduced in version:** 1.10.1 **Default value:** None Used by the [Taints and Tolerations feature of Kubernetes](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/). `value` is the value that triggers the [`effect`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#synchronizer-tolerations-effect) when [`operator`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#synchronizer-tolerations-operator) is set to `Equal`. See [Taints and Tolerations: Concepts](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/#concepts) for details. |

## `udca`

(Universal Data Collection Agent) Defines the service that runs within the data collection pod
in the runtime plane. This service extracts analytics and deployment status data and sends it to the
Unified Analytics Platform (UAP).

For more information, see [Analytics and deployment status data
collection](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/other-data-collection).

The following table describes the properties of the `udca` object:

| Property | Type | Description |
|---|---|---|
| `udca.annotations` | Advanced | **Introduced in version:** 1.5.0 **Default value:** None Optional key/value map used to annotate pods. For more information, see [Custom annotations](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/customize-services.md.txt#custom-annotations). |
| `udca.fluentd.image.pullPolicy` | Advanced | **Introduced in version:** 1.0.0 **Default value:** `IfNotPresent` Determines when [kubelet](https://kubernetes.io/docs/reference/command-line-tools-reference/kubelet/#kubelet) pulls the pod's Docker image. Possible values include: - `IfNotPresent`: Do not pull a new image if it already exists. - `Always`: Always pull the image, regardless of whether it exists already. For more information, see [Updating images](https://kubernetes.io/docs/concepts/containers/images/#updating-images). |
| `udca.fluentd.image.tag` | Advanced | **Introduced in version:** 1.0.0 **Default value:** `1.14.10` The version label for this service's Docker image. |
| `udca.fluentd.image.url` | Advanced | **Introduced in version:** 1.0.0 **Default value:** `gcr.io/apigee-release/hybrid/apigee-stackdriver-logging-agent` The location of the Docker image for this service. |
| `udca.fluentd.resources.limits.cpu` | Advanced | **Introduced in version:** 1.11.0 **Default value:** `1000m` The memory limit for the resource in a Kubernetes container, in mebibytes. |
| `udca.fluentd.resources.limits.memory` | Advanced | **Introduced in version:** 1.11.0 **Default value:** `500Mi` The memory limit for the resource in a Kubernetes container, in mebibytes. |
| `udca.fluentd.resources.requests.cpu` | Advanced | **Introduced in version:** 1.0.0 **Default value:** `500m` The CPU needed for normal operation of the resource in a Kubernetes container, in millicores. |
| `udca.fluentd.resources.requests.memory` | Advanced | **Introduced in version:** 1.0.0 **Default value:** `250Mi` The memory needed for normal operation of the resource in a Kubernetes container, in mebibytes. |
| `udca.gsa` | Advanced | **Introduced in version:** 1.10.0 **Default value:** None **Helm only** : The email address of the `apigee-udca` Google IAM service account (GSA) to associate with the corresponding Kubernetes service account when enabling Workload Identity on GKE clusters using Helm charts. Set this when you have set [`gcp.workloadIdentity.enabled`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#gcp-workloadidentity-enabled) to `true`. GSA email addresses typically have the format of: ``` GSA_NAME@PROJECT_ID.iam.gserviceaccount.com ``` For example: ``` apigee-udca@my-hybrid-project.iam.gserviceaccount.com ``` > [!TIP] > **Tip:** You can find the email address of your service accounts with the following command: > ``` > gcloud iam service-accounts list --project ${PROJECT_ID} --filter "apigee" > ``` See [Enabling Workload Identity on GKE](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/enable-workload-identity-gke.md.txt) or [Enabling Workload Identity Federation on AKS and EKS](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/enable-workload-identity-federated). |
| `udca.image.pullPolicy` | Advanced | **Introduced in version:** 1.0.0 **Default value:** IfNotPresent Determines when [kubelet](https://kubernetes.io/docs/reference/command-line-tools-reference/kubelet/#kubelet) pulls the pod's Docker image. Possible values include: - `IfNotPresent`: Do not pull a new image if it already exists. - `Always`: Always pull the image, regardless of whether it exists already. For more information, see [Updating images](https://kubernetes.io/docs/concepts/containers/images/#updating-images). |
| `udca.image.tag` | Advanced | **Introduced in version:** 1.0.0 **Default value:** `1.14.10` The version label for this service's Docker image. |
| `udca.image.url` | Advanced | **Introduced in version:** 1.0.0 **Default value:** None The location of the Docker image for this service. Use `apigee-pull-push --list` to see the current repository URL for this component. > [!TIP] > **Tip:** Consider using [`hub`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#hub) to set a private repository URL for all components instead of configuring them individually. |
| `udca.jvmXms` | Advanced | **Introduced in version:** 1.0.0 <var translate="no">Deprecated</var>: Starting in Hybrid version 1.8, `udca.jvmXms` is no longer used. |
| `udca.jvmXmx` | Advanced | **Introduced in version:** 1.0.0 <var translate="no">Deprecated</var>: Starting in Hybrid version 1.8, `udca.jvmXmx` is no longer used. |
| `udca.livenessProbe.failureThreshold` | Advanced | **Introduced in version:** 1.0.0 **Default value:** `2` The number of times Kubernetes will verify that liveness probes have failed before restarting the container. The minimum value is 1. |
| `udca.livenessProbe.initialDelaySeconds` | Advanced | **Introduced in version:** 1.0.0 **Default value:** `0` The number of seconds after a container is started before a liveness probe is initiated. |
| `udca.livenessProbe.periodSeconds` | Advanced | **Introduced in version:** 1.0.0 **Default value:** `5` Determines how often to perform a liveness probe, in seconds. The minimum value is 1. |
| `udca.livenessProbe.timeoutSeconds` | Advanced | **Introduced in version:** 1.0.0 **Default value:** `1` The number of seconds after which a liveness probe times out. The minimum value is 1. |
| `udca.nodeSelector.key` | Basic | **Introduced in version:** 1.0.0 **Default value:** None **Required** Node selector label key used to target dedicated Kubernetes nodes for `udca` runtime services. See [Configuring dedicated node pools](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/configure-dedicated-nodes.md.txt). |
| `udca.nodeSelector.value` | Basic | **Introduced in version:** 1.0.0 **Default value:** None **Required** Node selector label value used to target dedicated Kubernetes nodes for `udca` runtime services. See [Configuring dedicated node pools](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/configure-dedicated-nodes.md.txt). |
| `udca.pollingIntervalInSec` | Advanced | **Introduced in version:** 1.0.0 **Default value:** `1` The length of time, in seconds, that UDCA waits between polling operations. UDCA polls the data directory on the data collection pod's file system to detect new files to be uploaded. |
| `udca.replicaCountMax` | Basic | **Introduced in version:** 1.0.0 **Default value:** `4` The maximum number of pods that hybrid can automatically add for the UDCA deployment. Because UDCA is implemented as a ReplicaSet, the pods are replicas. It is recommended to set `udca.replicaCountMax` to a maximum number of replicas per environment times the number of environments in your Apigee org. For example, if you want to allow at most 4 replicas per environment and you have 3 environments, set `udca.replicaCountMax: 12`. > [!NOTE] > If you are using environment-scoped UDCA, set `udca.replicaCountMax` to the maximum number of replicas for a single environment. See [orgScopedUDCA](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#orgscopedudca). |
| `udca.replicaCountMin` | Basic | **Introduced in version:** 1.0.0 **Default value:** `1` The minimum number of pods for the UDCA deployment. Because UDCA is implemented as a ReplicaSet, the pods are replicas. If the CPU usage goes above `udca.targetCPUUtilizationPercentage`, then hybrid will gradually increase the number of pods, up to `udca.replicaCountMax`. |
| `udca.resources.limits.cpu` | Advanced | **Introduced in version:** 1.11.0 **Default value:** `1000m` The memory limit for the resource in a Kubernetes container, in mebibytes. |
| `udca.resources.limits.memory` | Advanced | **Introduced in version:** 1.11.0 **Default value:** `2Gi` The memory limit for the resource in a Kubernetes container, in mebibytes. |
| `udca.resources.requests.cpu` | Advanced | **Introduced in version:** 1.0.0 **Default value:** `250m` The CPU needed for normal operation of the resource in a Kubernetes container, in millicores. |
| `udca.resources.requests.memory` | Advanced | **Introduced in version:** 1.0.0 **Default value:** `250Mi` The memory needed for normal operation of the resource in a Kubernetes container, in mebibytes. |
| `udca.revision` | Advanced | **Introduced in version:** 1.0.0 **Default value:** `v1` A static value that is populated in a label to enable canary deployments. |
| `udca.serviceAccountPath` | Basic | **Introduced in version:** 1.0.0 **Default value:** None **One of either `serviceAccountPath` or `serviceAccountRef` is required.** Path to Google Service Account key file with **Apigee Analytics Agent** role. |
| `udca.serviceAccountRef` | Basic | **Introduced in version:** 1.2.0 **Default value:** None **One of either `serviceAccountPath` or `serviceAccountRef` is required.** |
| `udca.targetCPUUtilizationPercentage` | Advanced | **Introduced in version:** 1.0.0 **Default value:** `75` The threshold of CPU usage for scaling the number of pods in the ReplicaSet, as a percentage of total available CPU resources. Hybrid uses the combined utilization of all containers in the data collection pod (both fluentd and UDCA) to calculate the current utilization. When CPU usage goes above this value, then hybrid will gradually increase the number of pods in the ReplicaSet, up to `udca.replicaCountMax`. |
| `udca.terminationGracePeriodSeconds` | Advanced | **Introduced in version:** 1.0.0 **Default value:** `600` The maximum time between a request for pod deletion and when the pod is killed, in seconds. During this period, any prestop hooks will be executed and any running process should terminate gracefully. The pod will be killed when all running processes have terminated or at the end of the grace period, whichever comes first. If there are no running processes, the pod will be killed immediately. |
| `udca.tolerations.effect` | Advanced | **Introduced in version:** 1.10.1 **Default value:** None Required to use the [Taints and Tolerations feature of Kubernetes](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/). `effect` specifies the effect that matching a toleration with a taint will have. Values for `effect` can be: - `NoExecute` - `NoSchedule` - `PreferNoSchedule` See [Taints and Tolerations: Concepts](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/#concepts) for details. |
| `udca.tolerations.key` | Advanced | **Introduced in version:** 1.10.1 **Default value:** None Required to use the [Taints and Tolerations feature of Kubernetes](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/). `key` identifies pods to which the toleration can be applied. See [Taints and Tolerations: Concepts](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/#concepts) for details. |
| `udca.tolerations.operator` | Advanced | **Introduced in version:** 1.10.1 **Default value:** `"Equal"` Required to use the [Taints and Tolerations feature of Kubernetes](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/). `operator` specifies the operation used to trigger the [`effect`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#udca-tolerations-effect). Values for `operator` can be: - `Equal` matches the value set in [`value`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#udca-tolerations-value). - `Exists` ignores the value set in [`value`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#udca-tolerations-value). See [Taints and Tolerations: Concepts](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/#concepts) for details. |
| `udca.tolerations.tolerationSeconds` | Advanced | **Introduced in version:** 1.10.1 **Default value:** None Used by the [Taints and Tolerations feature of Kubernetes](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/). `tolerationSeconds` defines in seconds how long a pod stays bound to a failing or unresponsive node. See [Taints and Tolerations: Concepts](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/#concepts) for details. |
| `udca.tolerations.value` | Advanced | **Introduced in version:** 1.10.1 **Default value:** None Used by the [Taints and Tolerations feature of Kubernetes](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/). `value` is the value that triggers the [`effect`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#udca-tolerations-effect) when [`operator`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#udca-tolerations-operator) is set to `Equal`. See [Taints and Tolerations: Concepts](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/#concepts) for details. |

## `virtualhosts`


The `virtualhosts` property is a required configuration property.
Virtual hosts allow Apigee hybrid to handle API requests to a
specified environment group..

For more information, see [Configure virtual hosts](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/base-path-routing.md.txt).

The following table describes the properties of the `virtualhosts` object:
Property Type Description `virtualhosts[].additionalGateways` Basic **Introduced in version:** 1.2.0

**Default value:** None

A list of Istio Gateways to route traffic to.
`virtualhosts[].cipherSuites[]` Advanced **Introduced in version:** 1.9.2

**Default value:** None

This property configures the TLS ciphers used in the ingress gateway. Below is a list of the ciphers enabled by default in OpenSSL format. You can find more information about the supported ciphers in the documentation for the [Boring FIPS build of Envoy](https://www.envoyproxy.io/docs/envoy/latest/api-v3/extensions/transport_sockets/tls/v3/common.proto.html). A blank value defaults to the cipher suites supported by the Boring FIPS build of Envoy.

**TLS v1.3**:
Enabled by default Additional ciphersuites
- TLS_AES_128_GCM_SHA256
- TLS_AES_256_GCM_SHA384
- TLS_CHACHA20_POLY1305_SHA256
TLS 1.3 ciphersuites cannot   
be overridden.

**TLS v1.2**:
Enabled by default Additional ciphersuites
- ECDHE-ECDSA-AES128-GCM-SHA256
- ECDHE-RSA-AES128-GCM-SHA256
- ECDHE-ECDSA-AES256-GCM-SHA384
- ECDHE-RSA-AES256-GCM-SHA384
- AES128-GCM-SHA256
- AES128-SHA
- AES256-GCM-SHA384
- AES256-SHA
- ECDHE-ECDSA-AES128-GCM-SHA256
- ECDHE-ECDSA-AES128-SHA
- ECDHE-ECDSA-AES256-GCM-SHA384
- ECDHE-ECDSA-AES256-SHA
- ECDHE-ECDSA-CHACHA20-POLY1305
- ECDHE-RSA-AES128-GCM-SHA256
- ECDHE-RSA-AES128-SHA
- ECDHE-RSA-AES256-GCM-SHA384
- ECDHE-RSA-AES256-SHA
- ECDHE-RSA-CHACHA20-POLY1305

**TLS v1.1**:
Enabled by default Additional ciphersuites TLS v1.1 is not enabled by default.
- ECDHE-ECDSA-AES128-GCM-SHA256
- ECDHE-RSA-AES128-GCM-SHA256
- ECDHE-ECDSA-AES256-GCM-SHA384
- ECDHE-RSA-AES256-GCM-SHA384
- ECDHE-ECDSA-CHACHA20-POLY1305
- ECDHE-RSA-CHACHA20-POLY1305
- ECDHE-ECDSA-AES128-SHA
- ECDHE-ECDSA-AES256-SHA
- ECDHE-RSA-AES256-SHA

To enable more ciphersuites, add them to the `virtualhosts.cipherSuites` property along with the TLS version you want to enable them for in the `virtualhosts.minTLSProtocolVersion` property. For example, to enable all accepted TLS v.1.2 ciphersuites, add the following to your `virtualhosts` configuration:

```
virtualhosts:
- name: ENV_GROUP_NAME
  minTLSProtocolVersion: "1.2"
  cipherSuites:
  - "AES128-GCM-SHA256"
  - "AES128-SHA"
  - "AES256-GCM-SHA384"
  - "AES256-SHA"
  - "ECDHE-ECDSA-AES128-GCM-SHA256"
  - "ECDHE-ECDSA-AES128-SHA"
  - "ECDHE-ECDSA-AES256-GCM-SHA384"
  - "ECDHE-ECDSA-AES256-SHA"
  - "ECDHE-ECDSA-CHACHA20-POLY1305"
  - "ECDHE-RSA-AES128-GCM-SHA256"
  - "ECDHE-RSA-AES128-SHA"
  - "ECDHE-RSA-AES256-GCM-SHA384"
  - "ECDHE-RSA-AES256-SHA"
  - "ECDHE-RSA-CHACHA20-POLY1305"
...
```


If you want to enable older versions of TLS in your Apigee ingress gateway deployment, use the [`virtualhosts.minTLSProtocolVersion`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#virtualhosts-mintlsprotocolversion) and `virtualhosts.cipherSuites` properties.

For example, to enable TLS v.1.1:

```
virtualhosts:
- name: ENV_GROUP_NAME
  minTLSProtocolVersion: "1.1"
  cipherSuites:
  - "ECDHE-ECDSA-AES128-GCM-SHA256"
  - "ECDHE-RSA-AES128-GCM-SHA256"
  - "ECDHE-ECDSA-AES256-GCM-SHA384"
  - "ECDHE-RSA-AES256-GCM-SHA384"
  - "ECDHE-ECDSA-CHACHA20-POLY1305"
  - "ECDHE-RSA-CHACHA20-POLY1305"
  - "ECDHE-ECDSA-AES128-SHA"
  - "ECDHE-RSA-AES128-SHA"
  - "ECDHE-ECDSA-AES256-SHA"
  - "ECDHE-RSA-AES256-SHA"
...
```

> [!NOTE]
> **Note:** This property overrides the list of cipher suites supported by Envoy, and does not append to it.

> [!TIP]
> **Tip:** The `virtualhosts.cipherSuites` property uses the OpenSSL cipher suite format. For a list of ciphers with their names in both OpenSSL and IANA format, see [Translating OpenSSL cipher suite names to IANA](https://www.ssl.org/cipher-suite-mapping) in the SSL.org documentation.

`virtualhosts[].name` Basic **Introduced in version:** 1.2.0

**Default value:** None

**Required**

The name of the virtual host.
`virtualhosts[].maxTLSProtocolVersion` Basic **Introduced in version:** 1.3.0

**Default value:** None

The maximum version of the TLS protocol Envoy can select. Envoy automatically uses the
optimal TLS protocol version between `virtualhosts[].minTLSProtocolVersion` and
`virtualhosts[].maxTLSProtocolVersion`.


The value must be in the form of a number. For example:

```
virtualhosts:
- name: default
  maxTLSProtocolVersion: "1.3"
```


Where the number represents the TLS version number in the form `#.#`. In
the example above, `"1.3"` represents the Istio TLS version `TLSV1_3`.

See also
[`ServerTLSSettings.TLSProtocol`](https://istio.io/latest/docs/reference/config/networking/gateway/#ServerTLSSettings-TLSProtocol)
in the Istio documentation.
`virtualhosts[].minTLSProtocolVersion` Basic **Introduced in version:** 1.3.0

**Default value:** None

The minimum version of the TLS protocol Envoy can select. Envoy automatically uses the
optimal TLS protocol version between `virtualhosts[].minTLSProtocolVersion` and
`virtualhosts[].maxTLSProtocolVersion`.


The value must be in the form of a number. For example:

```
virtualhosts:
- name: default
  minTLSProtocolVersion: "1.2"
```


Where the number represents the TLS version number in the form `#.#`. In
the example above, `1.2` represents the Istio TLS version `TLSV1_2`.

See also
[`ServerTLSSettings.TLSProtocol`](https://istio.io/latest/docs/reference/config/networking/gateway/#ServerTLSSettings-TLSProtocol)
in the Istio documentation.
`virtualhosts[].requestTimeout` Basic **Introduced in version:** 1.10.0

**Default value:** `300`

**Chart:** `apigee-virtualhost`

The number of seconds after which a request times out. The minimum value is 1.
`virtualhosts[].selector` Basic **Introduced in version:** 1.2.0

**Default value:** `app: apigee-ingressgateway`

**Required**

A key-value selector-value pair for pointing to different ingress selectors.

- `apigee-ingressgateway`: for Apigee hybrid installations using Apigee ingress gateway.
- `istio-ingressgateway`: for Apigee hybrid installations using Cloud Service Mesh (Apigee hybrid versions 1.8 and earlier).


If no selector label is supplied, the configuration is supplied to Apigee ingress gateway.
`virtualhosts[].sslCertPath` Basic **Introduced in version:** 1.2.0

**Default value:** None

Either `sslCertPath`/`sslKeyPath` or `sslSecret`
is required.


The path on your system to a TLS certificate file.

> [!NOTE]
> **Note:** For each configured environment, the Common Name (CN) in the cert must match the domain in the `hostAliases[]` property. For example, if the CN is `*.example.com`, the `hostAliases[]` could be `foo.example.com` or `bar.example.com`.
>
> <br />
>
`virtualhosts[].sslKeyPath` Basic **Introduced in version:** 1.2.0

**Default value:** None

Either `sslCertPath`/`sslKeyPath` or `sslSecret`
is required.


The path on your system to the TLS private key file.

<br />

`virtualhosts[].sslSecret` Basic **Introduced in version:** 1.2.0

**Default value:** None

**Either `sslCertPath`/`sslKeyPath` or `sslSecret`
is required**.


The name if the file stored in a Kubernetes secret that contains the Cassandra users and
passwords. You can create the secret using following the following instructions:
[Create the Secret](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/cassandra-tls.md.txt#create-the-secret).

See also:

- [Storing data in a Kubernetes secret](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/k8s-secrets.md.txt)
- [Secrets](https://kubernetes.io/docs/concepts/configuration/secret/) in the Kubernetes documentation
- [Creating a Secret Using kubectl](https://kubernetes.io/docs/concepts/configuration/secret/#creating-a-secret) in the Kubernetes documentation

<br />

## `watcher`

The `watcher` property is a required configuration property.
The watcher is a process that watches for configuration changes and triggers their application to
the runtime plane.

The following table describes the properties of the `watcher` object:

| Property | Type | Description |
|---|---|---|
| `watcher.annotations` | Advanced | **Introduced in version:** 1.5.0 **Default value:** None Optional key/value map used to annotate pods. For more information, see [Custom annotations](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/customize-services.md.txt#custom-annotations). |
| `watcher.args.enableIssueScanning` | Advanced | **Introduced in version:** 1.10.0 **Default value:** `true` Enables or disables Automated issue surfacing. When `true`, Watcher automatically scans the control plane and Kubernetes API server state to determine if there are any configuration issues. Set to `false` to disable Automated issue surfacing. For more information, see [Automated issue surfacing](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/automated-issue-surfacing.md.txt). |
| `watcher.args.enableLeaderElect` | Advanced | **Introduced in version:** 1.13.0 **Default value:** `true` When `true` (the default) `watcher.args.enableLeaderElect` selects a single watcher pod to manage and report the routing information. Limiting this to a single pod is required to prevent downtime during upgrades or rollback. During these events, multiple versions of watcher can be running simultaneously. Each Watcher instance may have different route creation logic, which can cause downtime.[`watcher.replicaCountMax`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#watcher-replicacountmax). |
| `watcher.args.issueScanInterval` | Advanced | **Introduced in version:** 1.10.0 **Default value:** `60` The interval in seconds for how often Watcher scans the runtime plane for automated issue surfacing. For more information, see [Automated issue surfacing](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/automated-issue-surfacing.md.txt). |
| `watcher.gsa` | Advanced | **Introduced in version:** 1.10.0 **Default value:** None **Helm only** : The email address of the `apigee-watcher` Google IAM service account (GSA) to associate with the corresponding Kubernetes service account when enabling Workload Identity on GKE clusters using Helm charts. Set this when you have set [`gcp.workloadIdentity.enabled`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#gcp-workloadidentity-enabled) to `true`. GSA email addresses typically have the format of: ``` GSA_NAME@PROJECT_ID.iam.gserviceaccount.com ``` For example: ``` apigee-watcher@my-hybrid-project.iam.gserviceaccount.com ``` > [!TIP] > **Tip:** You can find the email address of your service accounts with the following command: > ``` > gcloud iam service-accounts list --project ${PROJECT_ID} --filter "apigee" > ``` See [Enabling Workload Identity on GKE](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/enable-workload-identity-gke.md.txt) or [Enabling Workload Identity Federation on AKS and EKS](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/enable-workload-identity-federation.md.txt). |
| `watcher.image.pullPolicy` | Advanced | **Introduced in version:** 1.4.0 **Default value:** `IfNotPresent` Determines when [kubelet](https://kubernetes.io/docs/reference/command-line-tools-reference/kubelet/#kubelet) pulls the pod's Docker image. Possible values include: - `IfNotPresent`: Do not pull a new image if it already exists. - `Always`: Always pull the image, regardless of whether it exists already. For more information, see [Updating images](https://kubernetes.io/docs/concepts/containers/images/#updating-images). |
| `watcher.image.tag` | Advanced | **Introduced in version:** 1.4.0 **Default value:** `1.14.10` The version label for this service's Docker image. |
| `watcher.image.url` | Advanced | **Introduced in version:** 1.4.0 **Default value:** None The location of the Docker image for this service. Use `apigee-pull-push --list` to see the current repository URL for this component. > [!TIP] > **Tip:** Consider using [`hub`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#hub) to set a private repository URL for all components instead of configuring them individually. |
| `watcher.podDisruptionBudget.minAvailable` | Advanced | **Introduced in version:** 1.14.10 **Default value:** None **Chart:** `apigee-org` The minimum number of watcher pods that must stay available during a voluntary disruption, for example during a node pool upgrade or a node drain. This field sets the `minAvailable` field of the [PodDisruptionBudget](https://kubernetes.io/docs/concepts/workloads/pods/disruptions/) for these pods. It takes either an integer number of pods (`1`) or a percentage string (`"50%"`). `minAvailable` and `maxUnavailable` are mutually exclusive; set only one. Setting both at once is rejected by the Apigee operator. If you set neither field, the Apigee operator still generates a PodDisruptionBudget for these pods, using `maxUnavailable: 1` by default. For example, in `overrides.yaml`: ``` watcher: podDisruptionBudget: minAvailable: "50%" ``` |
| `watcher.podDisruptionBudget.maxUnavailable` | Advanced | **Introduced in version:** 1.14.10 **Default value:** None **Chart:** `apigee-org` The maximum number of watcher pods that can be unavailable during a voluntary disruption, for example during a node pool upgrade or a node drain. This field sets the `maxUnavailable` field of the [PodDisruptionBudget](https://kubernetes.io/docs/concepts/workloads/pods/disruptions/) for these pods. It takes either an integer number of pods (`1`) or a percentage string (`"50%"`). `maxUnavailable` and `minAvailable` are mutually exclusive; set only one. Setting both at once is rejected by the Apigee operator. If you set neither field, the Apigee operator still generates a PodDisruptionBudget for these pods, using `maxUnavailable: 1` by default. For example, in `overrides.yaml`: ``` watcher: podDisruptionBudget: maxUnavailable: 1 ``` |
| `watcher.replicaCountMax` | Basic | **Introduced in version:** 1.3.0 **Default value:** `1` The maximum number of watcher replicas. This should be kept at **`1`** to avoid conflicts. Apigee hybrid uses one watcher pod per installation. Leader election automatically selects one watcher pod. Additional watcher pod replicas will be forced into an unstable state. See [watcher.args.enableLeaderElect](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#watcher-args-enableleaderelect). > [!WARNING] > **Warning:** Do not exceed a value of 1 for <var translate="no">watcher.replicaCountMax</var>. <br /> |
| `watcher.replicaCountMin` | Basic | **Introduced in version:** 1.3.0 **Default value:** `1` The minimum number of watcher replicas. |
| `watcher.resources.limits.cpu` | Advanced | **Introduced in version:** 1.11.0 **Default value:** `1000m` The CPU limit for the resource in a Kubernetes container, in millicores. |
| `watcher.resources.limits.memory` | Advanced | **Introduced in version:** 1.11.0 **Default value:** `2Gi` The memory limit for the resource in a Kubernetes container, in mebibytes. |
| `watcher.serviceAccountPath` | Basic | **Introduced in version:** 1.3.0 **Default value:** None **Required.** Path to Google Service Account key file with **Apigee Runtime Agent** role. |
| `watcher.serviceAccountRef` | Advanced | **Introduced in version:** 1.3.0 **Default value:** None **One of either serviceAccountPath or serviceAccountRef is required.** |
| `watcher.tolerations.effect` | Advanced | **Introduced in version:** 1.10.1 **Default value:** None Required to use the [Taints and Tolerations feature of Kubernetes](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/). `effect` specifies the effect that matching a toleration with a taint will have. Values for `effect` can be: - `NoExecute` - `NoSchedule` - `PreferNoSchedule` See [Taints and Tolerations: Concepts](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/#concepts) for details. |
| `watcher.tolerations.key` | Advanced | **Introduced in version:** 1.10.1 **Default value:** None Required to use the [Taints and Tolerations feature of Kubernetes](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/). `key` identifies pods to which the toleration can be applied. See [Taints and Tolerations: Concepts](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/#concepts) for details. |
| `watcher.tolerations.operator` | Advanced | **Introduced in version:** 1.10.1 **Default value:** `"Equal"` Required to use the [Taints and Tolerations feature of Kubernetes](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/). `operator` specifies the operation used to trigger the [`effect`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#watcher-tolerations-effect). Values for `operator` can be: - `Equal` matches the value set in [`value`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#watcher-tolerations-value). - `Exists` ignores the value set in [`value`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#watcher-tolerations-value). See [Taints and Tolerations: Concepts](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/#concepts) for details. |
| `watcher.tolerations.tolerationSeconds` | Advanced | **Introduced in version:** 1.10.1 **Default value:** None Used by the [Taints and Tolerations feature of Kubernetes](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/). `tolerationSeconds` defines in seconds how long a pod stays bound to a failing or unresponsive node. See [Taints and Tolerations: Concepts](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/#concepts) for details. |
| `watcher.tolerations.value` | Advanced | **Introduced in version:** 1.10.1 **Default value:** None Used by the [Taints and Tolerations feature of Kubernetes](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/). `value` is the value that triggers the [`effect`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#watcher-tolerations-effect) when [`operator`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/config-prop-ref.md.txt#watcher-tolerations-operator) is set to `Equal`. See [Taints and Tolerations: Concepts](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/#concepts) for details. |

*[KMS]: Key Management Service
*[JVM]: Java Virtual Machine
*[GKE]: Google Kubernetes Engine
*[KVM]: Key Value Map
*[MART]: Management API for Runtime data