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

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

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

> [!WARNING]
> **UPGRADING:** If you are upgrading from v1.1.x to v1.2.0, see [Upgrading Apigee hybrid](https://docs.cloud.google.com/apigee/docs/hybrid/v1.2/upgrade.md.txt) for instructions. If you are performing a new installation, continue with the configurations described below.

1. Be sure you are in the `hybrid-base-directory/hybrid-files` directory.
2. Copy the `overrides-small.yaml` file from the `` `$APIGEECTL_HOME`/examples `` directory to your `overrides` directory:

       cp $APIGEECTL_HOME/examples/overrides-small.yaml ./overrides/overrides.yaml


   This example file provides a basic configuration for a small-footprint hybrid
   runtime installation, a configuration that is suitable for a your first installation.
3. `cd` into the `overrides` directory:

```
cd overrides
```
4. Open `overrides.yaml` and add the required property values, shown below. A detailed description of each property is also provided below:

   > [!NOTE]
   > **NOTE:** Be sure to disable logging in the overrides file by setting `logger:enabled:false`. Logging is provided by default as part of GKE.

   ### Syntax

   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.2/install-copy-overrides.md.txt#tablebelow).

   ```
   gcp:
     region: gcp-region
     projectID: gcp-project-id

   k8sCluster:
     name: cluster-name
     region: cluster-region

   org: org-name

   virtualhosts:
     - name: virtual-host-name
       hostAliases:
         - "host-alias-1"
         - "host-alias-2"
         - "host-alias-n"
       sslCertPath: ./certs/cert-name.pem
       sslKeyPath: ./certs/key-name.key
       routingRules:
         - paths:
           - /path-1
           - /path-2
           - /path-n
           env: environment-name

   envs:
     - name: environment-name          # The same name of the env you created in the UI
       serviceAccountPaths:
         synchronizer: ./service-accounts/synchronizer-service-account-name.json
         udca: ./service-accounts/udca-service-account-name.json

   mart:
     hostAlias: mart-host-alias
     serviceAccountPath: ./service-accounts/mart-service-account-name.json
     sslCertPath: ./certs/mart-cert-name.pem
     sslKeyPath: ./certs/mart-key-name.key

   metrics:
     serviceAccountPath: ./service-accounts/metrics-service-account-name.json

   logger:
     enabled: false
   ```

   ### Example

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

   ```
   gcp:
     region: us-central1
     projectID: my-gcp-project

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

   org: hybrid-org

   virtualhosts:
     - name: default
       hostAliases:
         - "*.acme.com"
       sslCertPath: ./certs/keystore.pem
       sslKeyPath: ./certs/keystore.key
       routingRules:
         # - paths:
         - env: my-environment

   envs:
     - name: test
       serviceAccountPaths:
         synchronizer: ./service-accounts/hybrid-project-apigee-synchronizer.json
         udca: ./service-accounts/hybrid-project-apigee-udca.json

   mart:
     hostAlias: "mart.apigee-hybrid-docs.net"
     serviceAccountPath: ./service-accounts/hybrid-project-apigee-mart.json
     sslCertPath: ./certs/fullchain.pem
     sslKeyPath: ./certs/privkey.key

   metrics:
     serviceAccountPath: ./service-accounts/hybrid-project-apigee-metrics.json

   logger:
     enabled: false
   ```

   > [!NOTE]
   > Although not required for this quick start installation, it's a good practice to create static IP addresses for the two ingress gateways that are exposed outside the cluster. These ingress gateways are used for MART and for handling API proxy traffic. For configuration details, see [Configure static IP addresses](https://docs.cloud.google.com/apigee/docs/hybrid/v1.2/static-ip.md.txt).

5. 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.2/config-prop-ref.md.txt).

| Variable | Description |
|---|---|
| <var translate="no">gcp-region</var> | Identifies the GCP [region](https://cloud.google.com/compute/docs/regions-zones#available) where the `apigee-logger` and the `apigee-metrics` push their data. |
| <var translate="no">gcp-project-id</var> | Identifies the project where the `apigee-logger` and the `apigee-metrics` push their data. |
| <var translate="no">cluster-name</var> | Your Kubernetes cluster name. |
| <var translate="no">cluster-region</var> | The [region](https://cloud.google.com/compute/docs/regions-zones#available) in which the cluster was created. |
| <var translate="no">org-name</var> | The name of your Apigee hybrid organization. |
| <var translate="no">virtual-host-name</var> | A name to identify the virtual host. |
| <var translate="no">host-alias (*1 - n*)</var> | (Required) A qualified DNS name for the environment. You can use a partial wildcard like `*.foo.com`. The generic wildcard `"*"` is not allowed. |
| <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 the step [Create TLS credentials for the runtime gateway](https://docs.cloud.google.com/apigee/docs/hybrid/v1.2/install-download-install.md.txt#create-tls-credentials-for-the-runtime-gateway). 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">path *(1 - n)*</var> | Routing rules direct API calls to the provided paths to the environment mentioned. <var translate="no">path-1</var> through <var translate="no">path-*n*</var> are the base paths to API proxies deployed in the environment named in <var translate="no">environment-name</var>. **`paths:`** is optional. The default path is **/** . See also [Configure virtual hosts](https://docs.cloud.google.com/apigee/docs/hybrid/v1.2/base-path-routing.md.txt). **Note** : **`paths:`** is not required at this time. Delete or comment out `paths:` and any path entries. |
| <var translate="no">environment-name</var> (under `routingRules`) | This is the environment API calls will be routed to. Use the same name that you used when you created an environment in the UI, as explained in [Step 5: Add a new environment in the hybrid UI](https://docs.cloud.google.com/apigee/docs/hybrid/v1.2/precog-add-environment.md.txt). > [!TIP] > If you commented out or deleted the `path` entries, make sure `env` starts with a dash aligned under `routingRules`, like: > ``` >     routingRules: >       - env: my-environment > ``` . |
| <var translate="no">environment-name</var> | Use the same name that you used when you created an environment in the UI, as explained in [Step 5: Add a new environment in the hybrid UI](https://docs.cloud.google.com/apigee/docs/hybrid/v1.2/precog-add-environment.md.txt). |
| <var translate="no"><var translate="no">synchronizer-service-account-name</var></var> | The name of the synchronizer service account key file that you generated with the `create-service-account` tool. For example: ``` synchronizer: ./service-accounts/hybrid-project-apigee-synchronizer.json ``` |
| <var translate="no"><var translate="no">udca-service-account-name</var></var> | The name of the udca service account key file that you generated with the `create-service-account` tool. For example: ``` udca: ./service-accounts/hybrid-project-apigee-udca.json ``` |
| <var translate="no">mart-host-alias</var> | A qualified DNS name for the MART server endpoint. This name must match the common name (CN) used in the authorized TLS certificate required for this configuration. For example, `mart.mydomain.com` > [!NOTE] > **NOTE:** The Common Name (CN) in the certificate must agree with the value specified in the `mart.hostAlias` property. If the CN is `*.hybrid-domain.net` and you've registered the host `mart.hybrid-domain.net`, then you would set `mart.hostAlias` to the value `mart.hybrid-domain.net`. |
| <var translate="no">mart-service-account-name</var> | The name of the mart service account key file that you generated with the `create-service-account` tool. |
| <var translate="no">mart-cert-name</var> <var translate="no">mart-key-name</var> | Enter the name of the authorized TLS key and certificate files that you generated previously in the step [Create TLS credentials for the MART gateway](https://docs.cloud.google.com/apigee/docs/hybrid/v1.2/install-download-install.md.txt#create-tls-credentials-for-the-mart-gateway). These files must be located in the `base_directory/hybrid-files/certs` directory. For example: ``` sslCertPath: ./certs/fullchain.pem sslKeyPath: ./certs/privkey.key ``` |
| <var translate="no"><var translate="no">metrics-service-account-name</var></var> | The name of the metrics service account key file that you generated with the `create-service-account` tool. For example: ``` serviceAccountPath: ./service-accounts/hybrid-project-apigee-metrics.json ``` |

## Summary


The configuration file tells Kubernetes how to deploy the hybrid components to
a cluster. Next, you will apply this configuration to your cluster.
[1](https://docs.cloud.google.com/apigee/docs/hybrid/v1.2/install-create-cluster.md.txt) [2](https://docs.cloud.google.com/apigee/docs/hybrid/v1.2/install-download-install.md.txt) [3](https://docs.cloud.google.com/apigee/docs/hybrid/v1.2/install-copy-overrides.md.txt) [(NEXT) Step 4: Install hybrid runtime](https://docs.cloud.google.com/apigee/docs/hybrid/v1.2/install-apply-hybrid.md.txt)

<br />

*[Google Cloud]: Google Cloud