> [!CAUTION]
> You are currently viewing version 1.7 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.7 (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.

1. Be sure you are in the `hybrid-base-directory/hybrid-files/overrides/` directory.

   ```
   cd hybrid-base-directory/hybrid-files/overrides
   ```
2. Create a new file named **`overrides.yaml`** in your favorite text editor. For example:

   ```
   vi 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.
3. In `overrides.yaml`, add the required property values, shown below. A detailed description of each property is also provided below:

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

   ### Syntax

   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.7/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"  # See the property description table below information about this parameter.
     
   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
       sslCertPath: ./certs/cert-name.pem
       sslKeyPath: ./certs/key-name.key

   envs:
     - name: environment-name
       serviceAccountPaths:
         synchronizer: ./service-accounts/synchronizer-service-account-name.json
           # for non-production environments, gcp-project-id-apigee-non-prod.json
           # for production environments, gcp-project-id-apigee-synchronizer.json
         udca: ./service-accounts/udca-service-account-name.json
           # for non-production environments, gcp-project-id-apigee-non-prod.json
           # for production environments, gcp-project-id-apigee-udca.json
         runtime: ./service-accounts/runtime-service-account-name.json
           # for non-production environments, gcp-project-id-apigee-non-prod.json
           # for production environments, gcp-project-id-apigee-runtime.json

   mart:
     serviceAccountPath: ./service-accounts/mart-service-account-name.json
           # for non-production environments, gcp-project-id-apigee-non-prod.json
           # for production environments, gcp-project-id-apigee-mart.json

   connectAgent:
     serviceAccountPath: ./service-accounts/mart-service-account-name.json
           # for non-production environments, gcp-project-id-apigee-non-prod.json
           # for production environments, gcp-project-id-apigee-mart.json
           # Use the same service account for mart and connectAgent

   metrics:
     serviceAccountPath: ./service-accounts/metrics-service-account-name.json
           # for non-production environments, gcp-project-id-apigee-non-prod.json
           # for production environments, gcp-project-id-apigee-metrics.json

   udca:
     serviceAccountPath: ./service-accounts/udca-service-account-name.json
           # for non-production environments, gcp-project-id-apigee-non-prod.json
           # for production environments, gcp-project-id-apigee-udca.json

   watcher:
     serviceAccountPath: ./service-accounts/watcher-service-account-name.json
           # for non-production environments, gcp-project-id-apigee-non-prod.json
           # for production environments, 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: ./service-accounts/logger-service-account-name.json
           # for non-production environments, gcp-project-id-apigee-non-prod.json
           # for production environments, 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
       sslCertPath: ./certs/keystore.pem
       sslKeyPath: ./certs/keystore.key

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

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

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

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

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

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

   logger:
     enabled: false # Set to "false" for GKE. Set to "true" for all other kubernetes platforms.
     serviceAccountPath: ./service-accounts/hybrid-project-apigee-non-prod.json
       # for production environments, logger-service-account-name.json

   ```
4. 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.7/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 4: Create an organization](https://docs.cloud.google.com/apigee/docs/hybrid/v1.7/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 an cluster](https://docs.cloud.google.com/apigee/docs/hybrid/v1.7/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 Apigee hybrid instance per cluster. The string can be a combination of letters and numbers up to 63 characters in length. - You can create multiple organizations in a single cluster. Just make sure to use the same `instanceID` value for each time you add a new org to the same cluster. - If you have multiple clusters (in the same region or across multiple regions), each cluster requires a unique `instanceID`. If you need help generating a unique ID, you can use a random string generation tool of your choice, such as [random.org/strings](https://docs.cloud.google.com/apigee/docs/hybrid/v1.7/random.org/strings). |
| <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 5: Create an environment group](https://docs.cloud.google.com/apigee/docs/hybrid/v1.7/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 6: Create TLS certificates](https://docs.cloud.google.com/apigee/docs/hybrid/v1.7/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">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 5: Create an environment group](https://docs.cloud.google.com/apigee/docs/hybrid/v1.7/precog-add-environment.md.txt). |
| <var translate="no">synchronizer-service-account-name</var> | For non-production environments, the name of the single service account, `non-prod` by default. For production environments, the name of the `apigee-synchronizer` service account key file that you generated with the `create-service-account` tool in [Hybrid runtime setup - Step 6: Create service accounts and credentials](https://docs.cloud.google.com/apigee/docs/hybrid/v1.7/install-service-accounts.md.txt). You can see the list of service account files in your `service-accounts/` directory. Fore example: ``` ls ../service-accounts/ ``` |
| <var translate="no">udca-service-account-name</var> | For non-production environments, the name of the single service account, `non-prod` by default. For production environments, the name of the `apigee-udca` service account key file that you generated with the `create-service-account` tool. |
| <var translate="no">runtime-service-account-name</var> | For non-production environments, the name of the single service account, `non-prod` by default. For production environments, the name of the `apigee-runtime` service account key file that you generated with the `create-service-account` tool. |
| <var translate="no">mart-service-account-name</var> | For non-production environments, the name of the single service account, `non-prod` by default. For production environments, the name of the `apigee-mart` service account key file that you generated with the `create-service-account` tool. > [!NOTE] > **Note:** Both `mart` and `connectAgent` use the `apigee-mart` service account. |
| <var translate="no">metrics-service-account-name</var> | For non-production environments, the name of the single service account, `non-prod` by default. For production environments, the name of the `apigee-metrics` service account key file that you generated with the `create-service-account` tool. |
| <var translate="no">udca-service-account-name</var> | For non-production environments, the name of the single service account, `non-prod` by default. For production environments, the name of the `apigee-udca` service account key file that you generated with the `create-service-account` tool. |
| <var translate="no">watcher-service-account-name</var> | For non-production environments, the name of the single service account, `non-prod` by default. For production environments, the name of the `apigee-watcher` service account key file that you generated with the `create-service-account` tool. |
| <var translate="no">logger-service-account-name</var> | For non-production environments, the name of the single service account, `non-prod` by default. For production environments, the name of the `apigee-logger` service account key file that you generated with the `create-service-account` tool. |

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

<br />