> [!CAUTION]
> You are currently viewing version 1.8 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.8 (unsupported)</button>

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


By convention, configuration overrides are written in a file named `overrides.yaml` in
your `$HYBRID_FILES/overrides` directory.

1. Create a new file named **`overrides.yaml`** in your `$HYBRID_FILES/overrides` directory. For example:

   ```
   vi $HYBRID_FILES/overrides/overrides.yaml
   ```


   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 also provided below:

   ### 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. They are described in the
   [table below](https://docs.cloud.google.com/apigee/docs/hybrid/v1.8/install-configure-cluster.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.

   ```
   gcp:
     region: ANALYTICS_REGION
     projectID: GCP_PROJECT_ID

   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
       # 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

   virtualhosts:
   - name: ENVIRONMENT_GROUP_NAME
     selector:
       app: apigee-ingressgateway
       ingress_name: INGRESS_NAME
     sslCertPath: ./certs/CERT_NAME.pem
     sslKeyPath: ./certs/KEY_NAME.key

   ao:
     args:
     # This configuration is introduced in hybrid v1.8
       disableIstioConfigInAPIServer: true

   # This configuration is introduced in hybrid v1.8
   ingressGateways:
   - name: INGRESS_NAME # maximum 17 characters.
     replicaCountMin: 2
     replicaCountMax: 10
     # You do not need to set Annotations or LoadBalancerIP if you are creating your own Kubernetes
     # service for ingress deployment. In prod, it's recommended to create your own Kubernetes service.
     # See: Expose Apigee ingress gateway.
     svcAnnotations:  # optional. If you are on AKS, see Known issue #260772383.
       SVC_ANNOTATIONS_KEY: SVC_ANNOTATIONS_VALUE
     svcLoadBalancerIP: SVC_LOAD_BALANCER_IP  # optional

   envs:
   - name: ENVIRONMENT_NAME
     serviceAccountPaths:
       synchronizer: NON_PROD_SERVICE_ACCOUNT_FILEPATH
         # For example: "./service-accounts/GCP_PROJECT_ID-apigee-non-prod.json"
       udca: NON_PROD_SERVICE_ACCOUNT_FILEPATH
       runtime: NON_PROD_SERVICE_ACCOUNT_FILEPATH

   mart:
     serviceAccountPath: NON_PROD_SERVICE_ACCOUNT_FILEPATH

   connectAgent:
     serviceAccountPath: NON_PROD_SERVICE_ACCOUNT_FILEPATH

   metrics:
     serviceAccountPath: NON_PROD_SERVICE_ACCOUNT_FILEPATH

   udca:
     serviceAccountPath: NON_PROD_SERVICE_ACCOUNT_FILEPATH

   watcher:
     serviceAccountPath: NON_PROD_SERVICE_ACCOUNT_FILEPATH

   logger:
     enabled: false
           # Set to *false* to disable logger for GKE installations.
           # Set to *true* for all platforms other than GKE.
           # See apigee-logger in Service accounts and roles used by hybrid components.
     serviceAccountPath: NON_PROD_SERVICE_ACCOUNT_FILEPATH

   ```

   ### 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. They are described in the
   [table below](https://docs.cloud.google.com/apigee/docs/hybrid/v1.8/install-configure-cluster.md.txt#tablebelow).

   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.8/cassandra-production).

   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.

   ```
   gcp:
     region: ANALYTICS_REGION
     projectID: GCP_PROJECT_ID

   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
       # 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
     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.

   virtualhosts:
   - name: ENVIRONMENT_GROUP_NAME
     selector:
       app: apigee-ingressgateway
       ingress_name: INGRESS_NAME
     sslCertPath: ./certs/CERT_NAME.pem
     sslKeyPath: ./certs/KEY_NAME.key

   ao:
     args:
     # This configuration is introduced in hybrid v1.8
       disableIstioConfigInAPIServer: true

   # This configuration is introduced in hybrid v1.8
   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

   envs:
   - name: ENVIRONMENT_NAME
     serviceAccountPaths:
       synchronizer: SYNCHRONIZER_SERVICE_ACCOUNT_FILEPATH
         # For example: "./service-accounts/GCP_PROJECT_ID-apigee-synchronizer.json"
       udca: UDCA_SERVICE_ACCOUNT_FILEPATH
         # For example: "./service-accounts/GCP_PROJECT_ID-apigee-udca.json"
       runtime: RUNTIME_SERVICE_ACCOUNT_FILEPATH
         # For example: "./service-accounts/GCP_PROJECT_ID-apigee-runtime.json"

   mart:
     serviceAccountPath: MART_SERVICE_ACCOUNT_FILEPATH
           # For example: "./service-accounts/GCP_PROJECT_ID-apigee-mart.json"

   connectAgent:
     serviceAccountPath: MART_SERVICE_ACCOUNT_FILEPATH
           # Use the same service account for mart and connectAgent

   metrics:
     serviceAccountPath: METRICS_SERVICE_ACCOUNT_FILEPATH
           # For example: "./service-accounts/GCP_PROJECT_ID-apigee-metrics.json"

   udca:
     serviceAccountPath: UDCA_SERVICE_ACCOUNT_FILEPATH
           # For example: "./service-accounts/GCP_PROJECT_ID-apigee-udca.json"

   watcher:
     serviceAccountPath: WATCHER_SERVICE_ACCOUNT_FILEPATH
           # For example: "./service-accounts/GCP_PROJECT_ID-apigee-watcher.json"

   logger:
     enabled: false
           # Set to *false* to disable logger for GKE installations.
           # Set to *true* for all platforms other than GKE.
           # See apigee-logger in Service accounts and roles used by hybrid components.
     serviceAccountPath: LOGGER_SERVICE_ACCOUNT_FILEPATH
           # For example: "./service-accounts/GCP_PROJECT_ID-apigee-logger.json"
   ```

   ### Example

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

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

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

   org: hybrid-example

   instanceID: "my_hybrid_example"

   cassandra:
     hostNetwork: false

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

   ao:
     args:
       disableIstioConfigInAPIServer: true

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

   envs:
   - name: test
     serviceAccountPaths:
       synchronizer: ./service-accounts/my-hybrid-project-apigee-non-prod.json
         # for production environments, my-hybrid-project-apigee-synchronizer.json
       udca: ./service-accounts/my-hybrid-project-apigee-non-prod.json
         # for production environments, my-hybrid-project-apigee-udca.json
       runtime: ./service-accounts/my-hybrid-project-apigee-non-prod.json
         # for production environments, my-hybrid-project-apigee-runtime.json

   mart:
     serviceAccountPath: ./service-accounts/my-hybrid-project-apigee-non-prod.json
       # for production environments, my-hybrid-project-apigee-mart.json

   connectAgent:
     serviceAccountPath: ./service-accounts/my-hybrid-project-apigee-non-prod.json
       # for production environments, example-hybrid-apigee-mart.json

   metrics:
     serviceAccountPath: ./service-accounts/my-hybrid-project-apigee-non-prod.json
       # for production environments, my-hybrid-project-apigee-metrics.json

   udca:
     serviceAccountPath: ./service-accounts/my-hybrid-project-apigee-non-prod.json
       # for production environments, my-hybrid-project-apigee-udca.json

   watcher:
     serviceAccountPath: ./service-accounts/my-hybrid-project-apigee-non-prod.json
       # for production environments, my-hybrid-project-apigee-watcher.json

   logger:
     enabled: false # Set to "false" for GKE. Set to "true" for all other Kubernetes platforms.
     serviceAccountPath: ./service-accounts/my-hybrid-project-apigee-non-prod.json
       # for production environments, LOGGER_SERVICE_ACCOUNT_NAME.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.8/config-prop-ref.md.txt).

| Variable | Description |
|---|---|
| <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.8/precog-provision.md.txt). This is the value you assigned to the environment variable `ANALYTICS_REGION` previously. |
| <var translate="no">GCP_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.8/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">UNIQUE_INSTANCE_IDENTIFIER</var> | A unique string to identify this instance. This can be any combination of letters and numbers up to 63 characters in length. > [!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">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.8/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">CERT_NAME</var> <var translate="no">KEY_NAME</var> | Enter the name 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.8/install-create-tls-certificates.md.txt). These files must be located in the `base_directory/hybrid-files/certs` directory. For example: ``` sslCertPath: ./certs/keystore.pem 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.8/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. Annotations are used by your cloud platform 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.8/install-expose-apigee-ingress.md.txt). |
| <var translate="no">SVC_LOAD_BALANCER_IP</var> | (Optional). 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.8/install-expose-apigee-ingress.md.txt). |
| <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.8/precog-add-environment.md.txt). |
| **\*_SERVICE_ACCOUNT_FILEPATH** | The path and filename account of the service account JSON files in your `service-accounts/` directory. The names must include the path to the service account file. This can be a full path, or the path relative to your `hybrid-files/` directory. If you include a relative path, you must call `apigeectl`, the command to apply this configuration, from your `hybrid-files/` directory. For non-production environments, the name of the single service account is `GCP_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 [Hybrid runtime setup - Step 4: Create service accounts and credentials](https://docs.cloud.google.com/apigee/docs/hybrid/v1.8/install-service-accounts.md.txt). You can see the list of service account files in your `service-accounts/` directory. The default names of the production environment service accounts are: - **Cassandra:** <var translate="no">GCP_PROJECT_ID</var>-`apigee-cassandra.json` - **Logger:** <var translate="no">GCP_PROJECT_ID</var>-`apigee-logger.json` - **MART:** <var translate="no">GCP_PROJECT_ID</var>-`apigee-mart.json` - **Connect agent:** <var translate="no">GCP_PROJECT_ID</var>-`apigee-mart.json` - **Metrics:** <var translate="no">GCP_PROJECT_ID</var>-`apigee-metrics.json` - **Apigee runtime:** <var translate="no">GCP_PROJECT_ID</var>- - **Synchronizer:** <var translate="no">GCP_PROJECT_ID</var>-`apigee-synchronizer.json` - **UDCA:** <var translate="no">GCP_PROJECT_ID</var>-`apigee-udca.json` - **Watcher:** <var translate="no">GCP_PROJECT_ID</var>-`apigee-watcher.json` > [!NOTE] > **Note:** Both `mart` and `connectAgent` use the `apigee-mart` service account. |

> [!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.8/install-create-cluster.md.txt) [2](https://docs.cloud.google.com/apigee/docs/hybrid/v1.8/install-cert-manager.md.txt) [3](https://docs.cloud.google.com/apigee/docs/hybrid/v1.8/install-apigeectl.md.txt) [4](https://docs.cloud.google.com/apigee/docs/hybrid/v1.8/install-service-accounts.md.txt) [5](https://docs.cloud.google.com/apigee/docs/hybrid/v1.8/install-create-tls-certificates.md.txt) [6](https://docs.cloud.google.com/apigee/docs/hybrid/v1.8/install-configure-cluster.md.txt) [(NEXT) Step 7: Enable Synchronizer access](https://docs.cloud.google.com/apigee/docs/hybrid/v1.8/install-enable-synchronizer-access.md.txt) [8](https://docs.cloud.google.com/apigee/docs/hybrid/v1.8/install-hybrid-runtime.md.txt) [9](https://docs.cloud.google.com/apigee/docs/hybrid/v1.8/install-expose-apigee-ingress.md.txt) [10](https://docs.cloud.google.com/apigee/docs/hybrid/v1.8/install-deploy-proxy.md.txt)

<br />