> [!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-aks.html)
- [v1.16](https://docs.cloud.google.com/apigee/docs/hybrid/v1.16/install-copy-overrides-aks.html)
- [v1.15](https://docs.cloud.google.com/apigee/docs/hybrid/v1.15/install-copy-overrides-aks.html)
- [v1.14](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/install-copy-overrides-aks.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-aks.html)
- [v1.12](https://docs.cloud.google.com/apigee/docs/hybrid/v1.12/install-copy-overrides-aks.html)
- [v1.11](https://docs.cloud.google.com/apigee/docs/hybrid/v1.11/install-copy-overrides-aks.html)
- [v1.10](https://docs.cloud.google.com/apigee/docs/hybrid/v1.10/install-copy-overrides-aks.html)
- [v1.9](https://docs.cloud.google.com/apigee/docs/hybrid/v1.9/install-copy-overrides-aks.html)
- [v1.8](https://docs.cloud.google.com/apigee/docs/hybrid/v1.8/install-copy-overrides-aks.html)
- [v1.7](https://docs.cloud.google.com/apigee/docs/hybrid/v1.7/install-copy-overrides-aks.html)
- [v1.6](https://docs.cloud.google.com/apigee/docs/hybrid/v1.6/install-copy-overrides-aks.html)
- [v1.5](https://docs.cloud.google.com/apigee/docs/hybrid/v1.5/install-copy-overrides-aks.html)
- [v1.4](https://docs.cloud.google.com/apigee/docs/hybrid/v1.4/install-copy-overrides-aks.html)
- [v1.3](https://docs.cloud.google.com/apigee/docs/hybrid/v1.3/install-copy-overrides-aks.md.txt)
- [v1.2](https://docs.cloud.google.com/apigee/docs/hybrid/v1.2/install-copy-overrides-aks.md.txt)
- [v1.1](https://docs.cloud.google.com/apigee/docs/hybrid/v1.1/install-copy-overrides-aks.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-aks.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-aks.yaml` and add the required property values, shown below. A detailed description of each property is also provided below:

   > [!NOTE]
   > **NOTE:** You must explicitly enable logging by setting `logger:enabled:true` in the overrides file.

   ### 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 also described in the table below.

   ```
   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/test-cert-name.pem
       sslKeyPath: ./certs/test-key-name.key
       routingRules:
         - paths:
           - /path1
           - /path2
           - /pathn
           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: true
     serviceAccountPath: ./service-accounts/logger-service-account-name.json
   ```

   ### 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:
           - /foo
           - /bar
           env: test

   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: true
     serviceAccountPath: ./service-accounts/hybrid-project-apigee-logger.json
   ```
5. When your 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">project-id</var> | Your GCP project ID. |
| <var translate="no">cluster-name</var> | Your AKS Kubernetes cluster name. |
| <var translate="no">cluster-region</var> | The region in which the cluster was created. |
| <var translate="no">org-name</var> | The name of your Apigee hybrid organization. |
| <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">test-host-alias</var> | (Required) For the quickstart, use the wildcard character "`*`". The use of `*` is only recommended for a trial installation when using self-signed TLS credentials. Later, as you develop more complex Apigee hybrid configurations, such as creating multiple environments, you will need to use a qualified domain name for this value. |
| <var translate="no">test-cert-name</var> <var translate="no">test-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"><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">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 `apigee-logger` and the `apigee-metrics` push their data. |
| <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-aks.md.txt) [2](https://docs.cloud.google.com/apigee/docs/hybrid/v1.2/install-download-install-aks.md.txt) [3](https://docs.cloud.google.com/apigee/docs/hybrid/v1.2/install-copy-overrides-aks.md.txt) [(NEXT) Step 4: Install hybrid runtime](https://docs.cloud.google.com/apigee/docs/hybrid/v1.2/install-apply-hybrid-aks.md.txt)

<br />

*[Google Cloud]: Google Cloud