> [!CAUTION]
> You are currently viewing version 1.11 of the Apigee hybrid documentation. **This version is end of life.** You should upgrade to a newer version. 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.11 </button>

- Supported versions:
- [v1.17 (latest)](https://docs.cloud.google.com/apigee/docs/hybrid/v1.17/helm-install-create-overrides.html)
- [v1.16](https://docs.cloud.google.com/apigee/docs/hybrid/v1.16/helm-install-create-overrides.html)
- [v1.15](https://docs.cloud.google.com/apigee/docs/hybrid/v1.15/helm-install-create-overrides.html)
- [v1.14](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/helm-install-create-overrides.html)
- [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/helm-install-create-overrides.html)
- [v1.12](https://docs.cloud.google.com/apigee/docs/hybrid/v1.12/helm-install-create-overrides.html)
- [v1.11](https://docs.cloud.google.com/apigee/docs/hybrid/v1.11/helm-install-create-overrides.md.txt)
- [v1.10](https://docs.cloud.google.com/apigee/docs/hybrid/v1.10/helm-install-create-overrides.html)
- [v1.9](https://docs.cloud.google.com/apigee/docs/hybrid/v1.9/helm-install-create-overrides.html)
- [v1.8](https://docs.cloud.google.com/apigee/docs/hybrid/v1.8/helm-install-create-overrides.html)
- [v1.7](https://docs.cloud.google.com/apigee/docs/hybrid/v1.7/helm-install-create-overrides.html)
- [v1.6](https://docs.cloud.google.com/apigee/docs/hybrid/v1.6/helm-install-create-overrides.html)
- [v1.5](https://docs.cloud.google.com/apigee/docs/hybrid/v1.5/helm-install-create-overrides.html)
- [v1.4](https://docs.cloud.google.com/apigee/docs/hybrid/v1.4/helm-install-create-overrides.html)
- [v1.3](https://docs.cloud.google.com/apigee/docs/hybrid/v1.3/helm-install-create-overrides.html)
- [v1.2](https://docs.cloud.google.com/apigee/docs/hybrid/v1.2/helm-install-create-overrides.html)
- [v1.1](https://docs.cloud.google.com/apigee/docs/hybrid/v1.1/helm-install-create-overrides.html)

## Specify configuration overrides


The Apigee hybrid installer uses defaults for many settings. However, there
are a few settings that do not have defaults. You must provide values for
these settings, as explained next.

### Before you begin

We recommend you review the following scenarios to determine if you want to configure your
cluster for them. These configurations are optional.

- If you are planning on installing hybrid in multiple regions, read [Multi-region deployment](https://docs.cloud.google.com/apigee/docs/hybrid/v1.11/multi-region.md.txt) before continuing.
- Apigee hybrid provides default passwords for the Cassandra users. We recommend that you change the default user passwords. See [Configuring TLS for Cassandra](https://docs.cloud.google.com/apigee/docs/hybrid/v1.11/cassandra-tls.md.txt) for details.
- If you want to configure the storage and heap settings for Cassandra, see [Configure storage and heap settings](https://docs.cloud.google.com/apigee/docs/hybrid/v1.11/cassandra-production.md.txt).
- As described in [Part 1: Project and Org setup--Step 1: Enable APIs](https://docs.cloud.google.com/apigee/docs/hybrid/v1.11/precog-enableapi.md.txt), For production installation scenarios, configure [persistent solid state disk (SSD)](https://docs.cloud.google.com/compute/docs/disks.md.txt#pdspecs) storage for Cassandra. Apigee does not support using [local SSDs](https://docs.cloud.google.com/compute/docs/disks.md.txt#localssds) for Apigee hybrid. For details, see [Add SSD
  storage for production deployments](https://docs.cloud.google.com/apigee/docs/hybrid/v1.11/cassandra-production#add-ssd-storage-for-production-deployments).

### Configure the cluster


By convention, configuration overrides are written in a file named `overrides.yaml`
typically stored in your `$APIGEE_HELM_CHARTS_HOME` directory.

> [!NOTE]
> **Note:** The `overrides.yaml` file will be used during upgrades, expansions and anytime you need to alter the configuration of your hybrid runtime installation. Apigee recommends you store this file in a source control repository with version control.

1. Create a new file named **`overrides.yaml`** in your `$APIGEE_HELM_CHARTS_HOME` directory.


   The `overrides.yaml` provides the configuration for
   your unique Apigee hybrid installation. The overrides file in this step
   provides a basic configuration for a small-footprint hybrid
   runtime installation, suitable for your first installation.
2. In `overrides.yaml`, add the required property values, shown below. A detailed description of each property is provided below.

   Select the tab for your installation, production, **Production** or non-production
   (demo, evaluation, or proof-of-concept installations), **Non-prod** depending on your choice
   in [Step 4: Create service accounts](https://docs.cloud.google.com/apigee/docs/hybrid/v1.11/helm-install-service-accounts.md.txt).

   For installations in production environments, look at the storage requirements for the
   Cassandra database in [Configure Cassandra for
   production](https://docs.cloud.google.com/apigee/docs/hybrid/v1.11/cassandra-production).

   If you are installing Apigee hybrid on GKE and you plan to use Workload Identity to
   authenticate hybrid components, select either the **Prod: Workload Identity** or
   **Non-prod: Workload Identity** tab to configure your
   `overrides.yaml` file.

   ### Production

   Make sure the `overrides.yaml` file has the
   following structure and syntax. Values in <var translate="no">red, bold italics</var>
   are property values that you must provide. You can edit their values on this page.
   They are described in the [table below](https://docs.cloud.google.com/apigee/docs/hybrid/v1.11/helm-install-create-overrides.md.txt#tablebelow).


   There are differences between the different platforms for the
   Google Cloud project region and Kubernetes cluster region. Choose the
   platform where you are installing Apigee hybrid.

   ```
   instanceID: "UNIQUE_INSTANCE_IDENTIFIER"
   namespace: APIGEE_NAMESPACE # Usually "apigee"

   gcp:
     projectID: PROJECT_ID
     region: ANALYTICS_REGION

   k8sCluster:
     name: CLUSTER_NAME
     region: CLUSTER_LOCATION # Must be the closest Google Cloud region to your cluster.
   org: ORG_NAME
     
   ao:
     image:
       url: "gcr.io/apigee-release/hybrid/apigee-operators"
       tag: "1.11.2-hotfix.3" # Required for Apigee hybrid v1.11.2

   runtime:
     image:
       url: "gcr.io/apigee-release/hybrid/apigee-runtime"
       tag: "1.11.2-hotfix.3" # Required for Apigee hybrid v1.11.2 

   envs:
   - name: ENVIRONMENT_NAME
     serviceAccountPaths:
       # Provide the path relative to the apigee-env chart directory.
       synchronizer: SYNCHRONIZER_SERVICE_ACCOUNT_FILEPATH
         # For example: "PROJECT_ID-apigee-synchronizer.json"
       runtime: RUNTIME_SERVICE_ACCOUNT_FILEPATH
         # For example: "PROJECT_ID-apigee-runtime.json"
       udca: UDCA_SERVICE_ACCOUNT_FILEPATH
         # For example: "PROJECT_ID-apigee-udca.json"

   cassandra:
     hostNetwork: false
       # Set to *false* for single region installations and multi-region installations
       # with connectivity between pods in different clusters, for example GKE installations.
       # Set to *true*  for multi-region installations with no communication between
       # pods in different clusters, for example GKE On-prem, GKE on AWS, Anthos on bare metal,
       # AKS, EKS, and OpenShift installations.
       # See Multi-region deployment: Prerequisites
     replicaCount: 3
       # Use multiples of 3 for production.
       # See Configure Cassandra for production for guidelines.
     storage:
       capacity: 500Gi
     resources:
       requests:
         cpu: 7
         memory: 15Gi
     maxHeapSize: 8192M
     heapNewSize: 1200M
       # Minimum storage requirements for a production environment.
       # See Configure Cassandra for production.

   ingressGateways:
   - name: INGRESS_NAME # maximum 17 characters.
     replicaCountMin: 2
     replicaCountMax: 10
     svcAnnotations:  # optional. If you are on AKS, see Known issue #260772383
       SVC_ANNOTATIONS_KEY: SVC_ANNOTATIONS_VALUE

   virtualhosts:
   - name: ENVIRONMENT_GROUP_NAME
     selector:
       app: apigee-ingressgateway
       ingress_name: INGRESS_NAME
     sslCertPath: PATH_TO_CERT_FILE
     sslKeyPath: PATH_TO_KEY_FILE

   mart:
     serviceAccountPath: MART_SERVICE_ACCOUNT_FILEPATH
       # Provide the path relative to the apigee-org chart directory.
       # For example: "PROJECT_ID-apigee-mart.json"

   connectAgent:
     serviceAccountPath: MART_SERVICE_ACCOUNT_FILEPATH
       # Use the same service account for mart and connectAgent
       # Provide the path relative to the apigee-org chart directory.
       # For example: "PROJECT_ID-apigee-mart.json"

   logger:
     enabled: true
       # enabled by default
       # See apigee-logger in Service accounts and roles used by hybrid components.
     serviceAccountPath: LOGGER_SERVICE_ACCOUNT_FILEPATH
       # Provide the path relative to the apigee-telemetry chart directory.
       # For example: "PROJECT_ID-apigee-logger.json"

   metrics:
     serviceAccountPath: METRICS_SERVICE_ACCOUNT_FILEPATH
       # Provide the path relative to the apigee-telemetry chart directory.
       # For example: "PROJECT_ID-apigee-metrics.json"

   udca:
     serviceAccountPath: UDCA_SERVICE_ACCOUNT_FILEPATH
       # Provide the path relative to the apigee-org chart directory.
       # For example: "PROJECT_ID-apigee-udca.json"

   watcher:
     serviceAccountPath: WATCHER_SERVICE_ACCOUNT_FILEPATH
       # Provide the path relative to the apigee-org chart directory.
       # For example: "PROJECT_ID-apigee-watcher.json"
   ```

   ### Non-prod

   Make sure the `overrides.yaml` file has the
   following structure and syntax. Values in <var translate="no">red, bold italics</var>
   are property values that you must provide. You can edit their values on this page.
   They are described in the [table below](https://docs.cloud.google.com/apigee/docs/hybrid/v1.11/helm-install-create-overrides.md.txt#tablebelow).


   There are differences between the different platforms for the
   Google Cloud project region and Kubernetes cluster region. Choose the
   platform where you are installing Apigee hybrid.

   ```
   instanceID: "UNIQUE_INSTANCE_IDENTIFIER"
   namespace: APIGEE_NAMESPACE # Usually "apigee"

   gcp:
     projectID: PROJECT_ID
     region: ANALYTICS_REGION

   k8sCluster:
     name: CLUSTER_NAME
     region: CLUSTER_LOCATION # Must be the closest Google Cloud region to your cluster.
   org: ORG_NAME
     
   ao:
     image:
       url: "gcr.io/apigee-release/hybrid/apigee-operators"
       tag: "1.11.2-hotfix.3" # Required for Apigee hybrid v1.11.2

   runtime:
     image:
       url: "gcr.io/apigee-release/hybrid/apigee-runtime"
       tag: "1.11.2-hotfix.3" # Required for Apigee hybrid v1.11.2 

   envs:
   - name: ENVIRONMENT_NAME
     serviceAccountPaths:
       # Provide the path relative to the apigee-env chart directory.
       synchronizer: NON_PROD_SERVICE_ACCOUNT_FILEPATH
       # For example: "PROJECT_ID-apigee-non-prod.json"
       runtime: NON_PROD_SERVICE_ACCOUNT_FILEPATH
       # For example: "PROJECT_ID-apigee-non-prod.json"
       udca: NON_PROD_SERVICE_ACCOUNT_FILEPATH
       # For example: "PROJECT_ID-apigee-non-prod.json"

   cassandra:
     hostNetwork: false
       # Set to *false* for single region installations and multi-region installations
       # with connectivity between pods in different clusters, for example GKE installations.
       # Set to *true*  for multi-region installations with no communication between
       # pods in different clusters, for example GKE On-prem, GKE on AWS, Anthos on bare metal,
       # AKS, EKS, and OpenShift installations.
       # See Multi-region deployment: Prerequisites
     replicaCount: 1
       # Use 1 for non-prod or "demo" installations and multiples of 3 for production.
       # See Configure Cassandra for production for guidelines.

   ingressGateways:
   - name: INGRESS_NAME # maximum 17 characters.
     replicaCountMin: 2
     replicaCountMax: 10
     svcAnnotations:  # optional. If you are on AKS, see Known issue #260772383
       SVC_ANNOTATIONS_KEY: SVC_ANNOTATIONS_VALUE

   virtualhosts:
   - name: ENVIRONMENT_GROUP_NAME
     selector:
       app: apigee-ingressgateway
       ingress_name: INGRESS_NAME
     sslCertPath: PATH_TO_CERT_FILE
     sslKeyPath: PATH_TO_KEY_FILE

   mart:
     serviceAccountPath: NON_PROD_SERVICE_ACCOUNT_FILEPATH
       # Provide the path relative to the apigee-org chart directory.
       # For example: "PROJECT_ID-apigee-non-prod.json"

   connectAgent:
     serviceAccountPath: NON_PROD_SERVICE_ACCOUNT_FILEPATH
       # Provide the path relative to the apigee-org chart directory.
       # Use the same service account for mart and connectAgent
       # For example: "PROJECT_ID-apigee-non-prod.json"

   logger:
     enabled: true
       # enabled by default
       # See apigee-logger in Service accounts and roles used by hybrid components.
     serviceAccountPath: NON_PROD_SERVICE_ACCOUNT_FILEPATH
       # Provide the path relative to the apigee-telemetry chart directory.
       # For example: "PROJECT_ID-apigee-non-prod.json"

   metrics:
     serviceAccountPath: NON_PROD_SERVICE_ACCOUNT_FILEPATH
       # Provide the path relative to the apigee-telemetry chart directory.
       # For example: "PROJECT_ID-apigee-non-prod.json"

   udca:
     serviceAccountPath: NON_PROD_SERVICE_ACCOUNT_FILEPATH
       # Provide the path relative to the apigee-org chart directory.
       # For example: "PROJECT_ID-apigee-non-prod.json"

   watcher:
     serviceAccountPath: NON_PROD_SERVICE_ACCOUNT_FILEPATH
       # Provide the path relative to the apigee-org chart directory.
       # For example: "PROJECT_ID-apigee-non-prod.json"
   ```

   ### Prod: Workload Identity

   This template is for Production installations on GKE using Workload Identity.
   Make sure the `overrides.yaml` file has the
   following structure and syntax. Values in <var translate="no">red, bold italics</var>
   are property values that you must provide. You can edit their values on this page.
   They are described in the [table below](https://docs.cloud.google.com/apigee/docs/hybrid/v1.11/helm-install-create-overrides.md.txt#tablebelow).

   If you are installing Apigee hybrid on **GKE** , you have an alternative to authenticate
   and make requests to Google APIs, **Workload Identity**. For overviews of Workload
   Identity, see:
   - [Introducing Workload Identity: Better authentication for your GKE applications](https://cloud.google.com/blog/products/containers-kubernetes/introducing-workload-identity-better-authentication-for-your-gke-applications)
   - [Using Workload Identity](https://docs.cloud.google.com/kubernetes-engine/docs/how-to/workload-identity.md.txt)


   To use Workload Identity with Apigee hybrid on GKE, use this template and then follow
   the steps in [Step 11: Install Apigee hybrid using Helm charts](https://docs.cloud.google.com/apigee/docs/hybrid/v1.11/helm-install-helm-charts.md.txt) to create
   the Kubernetes service accounts and associate them with the Google service accounts you
   created in [Step 4: Create service accounts](https://docs.cloud.google.com/apigee/docs/hybrid/v1.11/helm-install-service-accounts.md.txt).

   > [!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"
   > ```

   ```
   instanceID: "UNIQUE_INSTANCE_IDENTIFIER"
   namespace: APIGEE_NAMESPACE # Usually "apigee"

   gcp:
     projectID: PROJECT_ID
     region: ANALYTICS_REGION
     workloadIdentity:
       enabled: true

   k8sCluster:
     name: CLUSTER_NAME
     region: CLUSTER_LOCATION # Must be the closest Google Cloud region to your cluster.
   org: ORG_NAME
     
   ao:
     image:
       url: "gcr.io/apigee-release/hybrid/apigee-operators"
       tag: "1.11.2-hotfix.3" # Required for Apigee hybrid v1.11.2

   runtime:
     image:
       url: "gcr.io/apigee-release/hybrid/apigee-runtime"
       tag: "1.11.2-hotfix.3" # Required for Apigee hybrid v1.11.2 

   envs:
   - name: ENVIRONMENT_NAME
     gsa:
       synchronizer: "SYNCHRONIZER_SERVICE_ACCOUNT_EMAIL"
         # For example: "apigee-synchronizer@PROJECT_ID.iam.gserviceaccount.com"
       runtime: "RUNTIME_SERVICE_ACCOUNT_EMAIL"
         # For example: "apigee-runtime@PROJECT_ID.iam.gserviceaccount.com"
       udca: "UDCA_SERVICE_ACCOUNT_EMAIL"
         # For example: "apigee-udca@PROJECT_ID.iam.gserviceaccount.com"

   cassandra:
     hostNetwork: false
       # Set to *false* for single region installations and multi-region installations
       # with connectivity between pods in different clusters, for example GKE installations.
       # Set to *true*  for multi-region installations with no communication between
       # pods in different clusters, for example GKE On-prem, GKE on AWS, Anthos on bare metal,
       # AKS, EKS, and OpenShift installations.
       # See Multi-region deployment: Prerequisites
     replicaCount: 3
       # Use multiples of 3 for production.
       # See Configure Cassandra for production for guidelines.
     storage:
       capacity: 500Gi
     resources:
       requests:
         cpu: 7
         memory: 15Gi
     maxHeapSize: 8192M
     heapNewSize: 1200M
       # Minimum storage requirements for a production environment.
       # See Configure Cassandra for production.
     backup:
       enabled: true
       # Set to true for initial installation.
       # This triggers the chart to create the apigee-cassandra-backup Kubernetes service account when you install it.
       # See Cassandra backup overview for instructions on using cassandra.backup.

   ingressGateways:
   - name: INGRESS_NAME # maximum 17 characters.
     replicaCountMin: 2
     replicaCountMax: 10
     svcAnnotations:  # optional. If you are on AKS, see Known issue #260772383
       SVC_ANNOTATIONS_KEY: SVC_ANNOTATIONS_VALUE

   virtualhosts:
   - name: ENVIRONMENT_GROUP_NAME
     selector:
       app: apigee-ingressgateway
       ingress_name: INGRESS_NAME
     sslCertPath: PATH_TO_CERT_FILE
     sslKeyPath: PATH_TO_KEY_FILE

   mart:
     gsa: "MART_SERVICE_ACCOUNT_EMAIL"
       # For example: "apigee-mart@PROJECT_ID.iam.gserviceaccount.com"

   connectAgent:
     gsa: "MART_SERVICE_ACCOUNT_EMAIL"
       # Use the same service account for mart and connectAgent
       # For example: "apigee-mart@PROJECT_ID.iam.gserviceaccount.com"

   logger:
     enabled: true
       # enabled by default
       # See apigee-logger in Service accounts and roles used by hybrid components.
     gsa: "LOGGER_SERVICE_ACCOUNT_EMAIL"
       # For example: "apigee-logger@PROJECT_ID.iam.gserviceaccount.com"
   metrics:
     gsa: "METRICS_SERVICE_ACCOUNT_EMAIL"
       # For example: "apigee-metrics@PROJECT_ID.iam.gserviceaccount.com"

   udca:
     gsa: "UDCA_SERVICE_ACCOUNT_EMAIL"
       # For example: "apigee-udca@PROJECT_ID.iam.gserviceaccount.com"

   watcher:
     gsa: "WATCHER_SERVICE_ACCOUNT_EMAIL"
       # For example: "apigee-watcher@PROJECT_ID.iam.gserviceaccount.com"
   ```

   ### Non-prod: Workload Identity

   This template is for Non-Production installations on GKE using Workload Identity.
   Make sure the `overrides.yaml` file has the
   following structure and syntax. Values in <var translate="no">red, bold italics</var>
   are property values that you must provide. You can edit their values on this page.
   They are described in the [table below](https://docs.cloud.google.com/apigee/docs/hybrid/v1.11/helm-install-create-overrides.md.txt#tablebelow).

   If you are installing Apigee hybrid on **GKE** , you have an alternative to authenticate
   and make requests to Google APIs, **Workload Identity**. For overviews of Workload
   Identity, see:
   - [Introducing Workload Identity: Better authentication for your GKE applications](https://cloud.google.com/blog/products/containers-kubernetes/introducing-workload-identity-better-authentication-for-your-gke-applications)
   - [Using Workload Identity](https://docs.cloud.google.com/kubernetes-engine/docs/how-to/workload-identity.md.txt)


   To use Workload Identity with Apigee hybrid on GKE, use this template and then follow
   the steps in [Step 11: Install Apigee hybrid using Helm
   charts](https://docs.cloud.google.com/apigee/docs/hybrid/v1.11/helm-install-helm-charts) to create the Kubernetes service accounts and associate them with the Google
   service accounts you created in [Step 4: Create
   service accounts](https://docs.cloud.google.com/apigee/docs/hybrid/v1.11/helm-install-service-accounts).

   > [!TIP]
   > **Tip:** You can find the email address of your `apigee-non-prod` service account with the following command:
   >
   > ```
   > gcloud iam service-accounts list --project ${PROJECT_ID} --filter "apigee-non-prod"
   > ```

   ```
   instanceID: "UNIQUE_INSTANCE_IDENTIFIER"
   namespace: APIGEE_NAMESPACE # Usually "apigee"

   gcp:
     projectID: PROJECT_ID
     region: ANALYTICS_REGION
     workloadIdentity:
       enabled: true
       gsa: "NON_PROD_SERVICE_ACCOUNT_EMAIL"
       # For example: "apigee-non-prod@PROJECT_ID.iam.gserviceaccount.com"

   k8sCluster:
     name: CLUSTER_NAME
     region: CLUSTER_LOCATION # Must be the closest Google Cloud region to your cluster.
   org: ORG_NAME

   instanceID: "UNIQUE_INSTANCE_IDENTIFIER"

   cassandra:
     hostNetwork: false
       # *false* for all GKE installations.
       # See Multi-region deployment: Prerequisites
     replicaCount: 1
       # Use 1 for non-prod or "demo" installations and multiples of 3 for production.
       # See Configure Cassandra for production for guidelines.
     backup:
       enabled: true
       # Set to true for initial installation.
       # This triggers the chart to create the apigee-cassandra-backup Kubernetes service account when you install it.
       # See Cassandra backup overview for instructions on using cassandra.backup.

   virtualhosts:
   - name: ENVIRONMENT_GROUP_NAME
     selector:
       app: apigee-ingressgateway
       ingress_name: INGRESS_NAME
     sslCertPath: PATH_TO_CERT_FILE
     sslKeyPath: PATH_TO_KEY_FILE

   ingressGateways:
   - name: INGRESS_NAME # maximum 17 characters.
     replicaCountMin: 2
     replicaCountMax: 10
     svcAnnotations:  # optional. If you are on AKS, see Known issue #260772383
       SVC_ANNOTATIONS_KEY: SVC_ANNOTATIONS_VALUE
     svcLoadBalancerIP: SVC_LOAD_BALANCER_IP  # optional
     
   ao:
     image:
       url: "gcr.io/apigee-release/hybrid/apigee-operators"
       tag: "1.11.2-hotfix.3" # Required for Apigee hybrid v1.11.2

   runtime:
     image:
       url: "gcr.io/apigee-release/hybrid/apigee-runtime"
       tag: "1.11.2-hotfix.3" # Required for Apigee hybrid v1.11.2 

   envs:
   - name: ENVIRONMENT_NAME

   logger:
     enabled: false # Set to *false* for all GKE installations.
   ```

   ### Example

   The following example shows a completed overrides file with example
   property values added:

   ```
   instanceID: "my_hybrid_example"
   namespace: apigee

   gcp:
     projectID: hybrid-example
     region: us-central1

   k8sCluster:
     name: apigee-hybrid
     region: us-central1

   org: hybrid-example
     
   ao:
     image:
       url: "gcr.io/apigee-release/hybrid/apigee-operators"
       tag: "1.11.2-hotfix.3"

   runtime:
     image:
       url: "gcr.io/apigee-release/hybrid/apigee-runtime"
       tag: "1.11.2-hotfix.3"

   envs:
   - name: test
     serviceAccountPaths:
       synchronizer:my-hybrid-project-apigee-synchronizer.json
       runtime: my-hybrid-project-apigee-runtime.json
       udca: my-hybrid-project-apigee-udca.json

   cassandra:
     hostNetwork: false
     replicaCount: 3

   ingressGateways:
   - name: my-ingress-1
     replicaCountMin: 2
     replicaCountMax: 10

   virtualhosts:
   - name: example-env-group
     selector:
       app: apigee-ingressgateway
       ingress_name: my-ingress-1
     sslCertPath: certs/keystore.pem
     sslKeyPath: certs/keystore.key

   logger:
     enabled: true # Set to "false" for GKE. Set to "true" for all other Kubernetes platforms.
     serviceAccountPath: my-hybrid-project-apigee-logger.json

   mart:
     serviceAccountPath: my-hybrid-project-apigee-mart.json

   connectAgent:
     serviceAccountPath: my-hybrid-project-apigee-mart.json

   metrics:
     serviceAccountPath: my-hybrid-project-apigee-metrics.json

   udca:
     serviceAccountPath: my-hybrid-project-apigee-udca.json

   watcher:
     serviceAccountPath: my-hybrid-project-apigee-watcher.json
   ```
3. When you are finished, save the file.


The following table describes each of the property values that you must
provide in the overrides file. For more information, see
[Configuration property reference](https://docs.cloud.google.com/apigee/docs/hybrid/v1.11/config-prop-ref.md.txt).
Variable Description <var translate="no">UNIQUE_INSTANCE_IDENTIFIER</var> A unique string to identify this instance. This can be any
combination of letters and numbers up to 63 characters.

> [!NOTE]
> **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).

You can create multiple organizations in the same cluster, but
the `instanceID` must be the same for all orgs in the
same Kubernetes cluster.
<var translate="no">APIGEE_NAMESPACE</var> The Kubernetes namespace for your Apigee hybrid components.

The default value is `apigee`.
<var translate="no">ANALYTICS_REGION</var> In GKE, You must set this value to the same region where the cluster is running. In all other platforms, select the closest analytics region to your cluster that has Analytics support (see the table in [Part 1, Step 2: Create an organization](https://docs.cloud.google.com/apigee/docs/hybrid/v1.11/precog-provision.md.txt).

This is the value you assigned to the environment variable
`ANALYTICS_REGION` previously.
<var translate="no">PROJECT_ID</var> Identifies the Google Cloud project where the `apigee-logger` and the `apigee-metrics` push their data. This is the value assigned to the environment variable `PROJECT_ID`. <var translate="no">CLUSTER_NAME</var> Your Kubernetes cluster name. This is the value assigned to the environment variable `CLUSTER_NAME`. <var translate="no">CLUSTER_LOCATION</var> The region where the cluster is running. This is the region where you created the cluster in [Step 1: Create a cluster](https://docs.cloud.google.com/apigee/docs/hybrid/v1.11/helm-install-create-cluster.md.txt).

This is the value you assigned to the environment variable
`CLUSTER_LOCATION` previously.

> [!NOTE]
> If you are working with zonal clusters, you must specify the **region** in which your cluster was created. For example, if you created your cluster in the `us-central1-a` zone, specify `us-central1` for the <var translate="no">CLUSTER_LOCATION</var>.

<var translate="no">ORG_NAME</var> The ID of your Apigee hybrid organization. This is the value assigned to the environment variable `ORG_NAME`. <var translate="no">ENVIRONMENT_GROUP_NAME</var> The name of the environment group your environments are assigned to. This is the group you created in [Project and org setup - Step 3: Create an environment group](https://docs.cloud.google.com/apigee/docs/hybrid/v1.11/precog-add-environment.md.txt). This is the value assigned to the environment variable `ENV_GROUP`.

> [!NOTE]
> **Note:**If you wish to place cluster instances in multiple regions, you must be careful about how you define your environments and virtual hosts. If you have one or more environments attached to an environment group, you must include that same environment group configuration in each cluster instance's overrides file.

<var translate="no">PATH_TO_CERT_FILE</var>  
<var translate="no">PATH_TO_KEY_FILE</var> Enter the path and filename of the self-signed TLS key and certificate files that you generated previously in [Step 5: Create TLS certificates](https://docs.cloud.google.com/apigee/docs/hybrid/v1.11/helm-install-create-tls-certificates.md.txt). These files must be located in the `APIGEE_HELM_CHARTS_HOME/apigee-virtualhosts/certs` directory. For example:

```
sslCertPath: certs/keystore.crt
sslKeyPath: certs/keystore.key
```
<var translate="no">INGRESS_NAME</var> The name of the Apigee ingress gateway for your deployment. This can be any name that meets 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


See [`ingressGateways[].name`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.11/config-prop-ref.md.txt#ingressgateways-name)
in the Configuration property reference
<var translate="no">SVC_ANNOTATIONS_KEY</var>: <var translate="no">SVC_ANNOTATIONS_VALUE</var> (Optional). This is a key-value pair that provides annotations for your default ingress service. Your cloud platform uses annotations to help configure your hybrid installation, for example setting the loadbalancer type to either internal or external.

Annotations vary from platform to platform. Refer to your platform
documentation for required and suggested annotations.

> [!NOTE]
> **Note:** You do not need to set `svcAnnotations` if you are creating your own Kubernetes service for ingress deployment as documented in [Expose Apigee ingress gateway](https://docs.cloud.google.com/apigee/docs/hybrid/v1.11/install-expose-apigee-ingress.md.txt).

Comment out or delete this section if you are not using it.
<var translate="no">SVC_LOAD_BALANCER_IP</var> (Optional). An IP address you have reserved for your load balancer. 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, this property is ignored.

> [!NOTE]
> **Note:** You do not need to set `LoadBalancerIP` if you are creating your own Kubernetes service for ingress deployment as documented in [Expose Apigee ingress gateway](https://docs.cloud.google.com/apigee/docs/hybrid/v1.11/install-expose-apigee-ingress.md.txt). In production installations, it is recommended to create your own Kubernetes service.

Comment out or delete this section if you are not using it.
<var translate="no">ENVIRONMENT_NAME</var> Use the same name that you used when you created an environment in the UI, as explained in [Project and org setup - Step 3: Create an environment group](https://docs.cloud.google.com/apigee/docs/hybrid/v1.11/precog-add-environment.md.txt). **\*_SERVICE_ACCOUNT_FILEPATH** The path and filename account of the service account JSON files in your corresponding chart directory. Provide the names with the path relative to the chart directory. For example:

- If the `my-hybrid-project-apigee-synchronizer.json` file resides in the `apigee-env/` chart directory, you only need to provide the file name, such as:

  ```
  synchronizer:  "my-hybrid-project-apigee-synchronizer.json"
  ```
- If the file resides in a `apigee-env/service-accounts/` directory, you would specify a relative path:

  ```
  synchronizer:  "service-accounts/my-hybrid-project-apigee-synchronizer.json"
  ```

For non-production environments, the name of the single service account is
`PROJECT_ID-non-prod.json` by default.

For production environments, the name of the service account key
file that you generated with the `create-service-account`
tool in [Step 4: Create service accounts](https://docs.cloud.google.com/apigee/docs/hybrid/v1.11/helm-install-service-accounts.md.txt).

You can see the service account files in each corresponding chart directory.

The default names of the and corresponding chart directories for the service accounts are:
Service account file name Chart directory Storage Object Admin `PROJECT_ID-apigee-cassandra.json` `apigee-datastore/` Logs Writer `PROJECT_ID-apigee-logger.json` `apigee-telemetry/` Apigee Connect Agent `PROJECT_ID-apigee-mart.json` `apigee-org/` Monitoring Metric Writer `PROJECT_ID-apigee-metrics.json` `apigee-telemetry/` No role required `PROJECT_ID-apigee-runtime.json` `apigee-env/` Apigee Synchronizer Manager `PROJECT_ID-apigee-synchronizer.json` `apigee-env/` Apigee Analytics Agent `PROJECT_ID-apigee-udca.json` `apigee-org/` Apigee Runtime Agent `PROJECT_ID-apigee-watcher.json` `apigee-org/`

> [!NOTE]
> **Note:** Both `mart` and `connectAgent` use the `apigee-mart` service account.

**\*_SERVICE_ACCOUNT_EMAIL** The service account email addresses for the Google service accounts (GSA) you need to supply if you are using [Workload Identity](https://docs.cloud.google.com/apigee/docs/hybrid/v1.11/enable-workload-identity.md.txt) on GKE. These are the service accounts you created in [Step 4: Create service accounts](https://docs.cloud.google.com/apigee/docs/hybrid/v1.11/helm-install-service-accounts.md.txt). You can find the email addresses for the service accounts with the following command:

```
gcloud iam service-accounts list --project ${PROJECT_ID} --filter "apigee"
```

> [!NOTE]
> **Note:** If you want to create a security perimeter around your cluster and related Cloud services, you can configure one using Google Cloud [Virtual Private Cloud (VPC) Service Controls](https://cloud.google.com/vpc-service-controls) with Apigee hybrid. See [Using VPC Service Controls with Apigee and Apigee hybrid](https://docs.cloud.google.com/apigee/docs/api-platform/security/vpc-sc.md.txt) for instructions.

## Summary


The configuration file tells Kubernetes how to deploy the hybrid
components to a cluster. Next, you will enable synchronizer access so the
Apigee runtime and management planes will be able to communicate.
[1](https://docs.cloud.google.com/apigee/docs/hybrid/v1.11/helm-install-create-cluster.md.txt) [2](https://docs.cloud.google.com/apigee/docs/hybrid/v1.11/helm-install-download-charts.md.txt) [3](https://docs.cloud.google.com/apigee/docs/hybrid/v1.11/helm-install-create-namespace.md.txt) [4](https://docs.cloud.google.com/apigee/docs/hybrid/v1.11/helm-install-service-accounts.md.txt) [5](https://docs.cloud.google.com/apigee/docs/hybrid/v1.11/helm-install-create-tls-certificates.md.txt) [6](https://docs.cloud.google.com/apigee/docs/hybrid/v1.11/helm-install-create-overrides.md.txt) [(NEXT) Step 7: Enable Synchronizer access](https://docs.cloud.google.com/apigee/docs/hybrid/v1.11/helm-install-enable-synchronizer-access.md.txt) [8](https://docs.cloud.google.com/apigee/docs/hybrid/v1.11/helm-install-cert-manager.md.txt) [9](https://docs.cloud.google.com/apigee/docs/hybrid/v1.11/helm-install-crds.md.txt) [10](https://docs.cloud.google.com/apigee/docs/hybrid/v1.11/helm-install-check-cluster.md.txt) [11](https://docs.cloud.google.com/apigee/docs/hybrid/v1.11/helm-install-helm-charts.md.txt) [12](https://docs.cloud.google.com/apigee/docs/hybrid/v1.11/helm-install-workload-identity.md.txt)

<br />