> [!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/customize-services.md.txt)
- [v1.16](https://docs.cloud.google.com/apigee/docs/hybrid/v1.16/customize-services.md.txt)
- [v1.15](https://docs.cloud.google.com/apigee/docs/hybrid/v1.15/customize-services.md.txt)
- [v1.14](https://docs.cloud.google.com/apigee/docs/hybrid/v1.14/customize-services.md.txt)
- [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/customize-services.md.txt)
- [v1.12](https://docs.cloud.google.com/apigee/docs/hybrid/v1.12/customize-services.md.txt)
- [v1.11](https://docs.cloud.google.com/apigee/docs/hybrid/v1.11/customize-services.md.txt)
- [v1.10](https://docs.cloud.google.com/apigee/docs/hybrid/v1.10/customize-services.md.txt)
- [v1.9](https://docs.cloud.google.com/apigee/docs/hybrid/v1.9/customize-services.md.txt)
- [v1.8](https://docs.cloud.google.com/apigee/docs/hybrid/v1.8/customize-services.md.txt)
- [v1.7](https://docs.cloud.google.com/apigee/docs/hybrid/v1.7/customize-services.md.txt)
- [v1.6](https://docs.cloud.google.com/apigee/docs/hybrid/v1.6/customize-services.md.txt)
- [v1.5](https://docs.cloud.google.com/apigee/docs/hybrid/v1.5/customize-services.md.txt)
- [v1.4](https://docs.cloud.google.com/apigee/docs/hybrid/v1.4/customize-services.md.txt)
- [v1.3](https://docs.cloud.google.com/apigee/docs/hybrid/v1.3/customize-services.md.txt)
- [v1.2](https://docs.cloud.google.com/apigee/docs/hybrid/v1.2/customize-services.md.txt)
- [v1.1](https://docs.cloud.google.com/apigee/docs/hybrid/v1.1/customize-services.md.txt)

This topic explains how to configure and manage the Apigee hybrid
[runtime plane components](https://docs.cloud.google.com/apigee/docs/hybrid/v1.8/what-is-hybrid.md.txt#about-the-runtime-plane).

## About the overrides file

The first time you install the hybrid runtime into a cluster, you must
create a configuration *overrides file* . This file lets you provide required property values
needed to install hybrid, such as the name of your Google project, organization name, environment
details, certificate files, and so on. You can also override certain default values for most
hybrid components in the overrides file. For a complete
list of configurable properties, see the [Configuration property reference](https://docs.cloud.google.com/apigee/docs/hybrid/v1.8/config-prop-ref.md.txt).


The hybrid [installation steps](https://docs.cloud.google.com/apigee/docs/hybrid/v1.8/install-before-begin.md.txt) walk through the process of creating
an overrides file and applying your configuration to a cluster. If you want to change
the configuration later, modify the overrides file
you created and re-apply it. See [Making a configuration change](https://docs.cloud.google.com/apigee/docs/hybrid/v1.8/customize-services.md.txt#making-a-configuration-change).

## Making a configuration change

To make a configuration change to a hybrid runtime plane component,
edit your overrides file and
apply the changes with [`apigeectl`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.3/cli-reference.md.txt). For a complete
list of configurable properties, see the [Configuration property reference](https://docs.cloud.google.com/apigee/docs/hybrid/v1.8/config-prop-ref.md.txt).

For example, to enable the `logger` component, update the overrides file and re-apply it:

1. Open your overrides file. Be sure to use the same overrides file that was used to install the hybrid runtime into the cluster.
2. Locate the `logger` element in the file. For example:

   ```
   ...
   logger:
     enabled: false
   ...
   ```
3. Change the property value to `true`:

   ```
   ...
     logger:
     enabled: true
   ...
   ```
4. Use [`apigeectl`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.3/cli-reference.md.txt) to apply the change to the cluster:

   ```
   $APIGEECTL_HOME/apigeectl apply -f $HYBRID_FILES/overrides/OVERRIDES.yaml --telemetry
   ```

   The `--telemetry` flag tells `apigeectl` to only update the logger component. For
   information about scoping parameters, like `--telemetry`, see [Scopes for applying apigeectl](https://docs.cloud.google.com/apigee/docs/hybrid/v1.8/cli-reference.md.txt#scopes-for-applying-apigeectl).

## Which configuration properties can you modify?

You can find the complete list of configurable properties in the [Configuration property reference](https://docs.cloud.google.com/apigee/docs/hybrid/v1.8/config-prop-ref.md.txt).
The reference only lists the properties you can modify; if you try to modify a property that's not in the
reference, the change is ignored.

## How to use the configuration reference

The [Configuration property reference](https://docs.cloud.google.com/apigee/docs/hybrid/v1.8/config-prop-ref.md.txt) uses dot notation to
describe configuration elements, where
the first item is the top-level element name followed by properties and child properties.
For example:

```
authz.image.pullPolicy
```

In the overrides file, the properties are formatted in proper YAML. For the above example,
the top-level `authz` element is left-indented
and sub-element properties are indented under it. Also, YAML requires a colon at the
end of each element and sub-element.


For example, to set the `authz.image.pullPolicy` property to `Always`, locate
this YAML stanza in the overrides file and set it as follows:

```
authz:
  image:
    pullPolicy: Always
```

For another example, the property `cassandra.auth.admin.password` (as it
is listed in **Configuration property reference**) is used to set the Cassandra
admin password. To change it, locate the following YAML in the overrides file and set
it as follows:

```
cassandra:
  auth:
    admin:
      password: abc123
```


Remember, the [Configuration property reference](https://docs.cloud.google.com/apigee/docs/hybrid/v1.8/config-prop-ref.md.txt) describes all of the properties that you can set
on hybrid runtime plane components. Follow the pattern explained above to modify
these elements in your overrides file before applying the changes to your cluster.

## About configuration defaults

Apigee maintains its default component configuration in the file
`$HYBRID_FILES/config/values.yaml`. This file specifies defaults, when possible, for
each hybrid component.

Your overrides files follow the same YAML
structure as `values.yaml`; however, an overrides file includes
only a subset of the configuration properties found in
`values.yaml`. Remember, [not
all properties are editable](https://docs.cloud.google.com/apigee/docs/hybrid/v1.8/customize-services#which-configuration-properties-can-you-modify). When you apply a configuration
to a cluster, your overrides are merged with the defaults to create the complete Kubernetes
cluster configuration.

> [!TIP]
> If you want to modify a component's defaults and the component is not already in your overrides file, you can copy its YAML from `values.yaml` into your overrides file and modify it there.

> [!WARNING]
> Never edit `values.yaml` directly; always use an overrides file to specify your configuration properties.

## Using pre-defined sample overrides files

Apigee provides a set of sample overrides files to
help guide you in setting up your hybrid deployment. It's a good practice
to copy and modify the overrides file that most closely matches your installation requirements.

> [!NOTE]
> When getting started, it's a good idea to use one of the [overrides file
> examples](https://docs.cloud.google.com/apigee/docs/hybrid/v1.8/customize-services#sample-override-configurations). The examples provide all of the configuration settings you need to set up a working cluster, including comments that explain which values you need to provide. After things are working, you can always go back later and [make configuration changes](https://docs.cloud.google.com/apigee/docs/hybrid/v1.8/customize-services.md.txt#making-a-configuration-change) as needed.

The following samples are included in the
directory `$APIGEECTL_HOME/examples`:

| Sample overrides files | Description |
|---|---|
| `overrides-small.yaml` | This sample is ideal for getting started quickly. It uses the minimum recommended footprint to start the hybrid runtime components. This sample configuration relies as much as possible on default settings and values. All the minimum replicas are set to `1`. |
| `overrides-medium.yaml` | This sample is a good starting point for testing and QA environments. Individual components have been granted a higher level of resources to deal with additional traffic. Cassandra uses SSD disks for performance. In this environment, it is recommended that users install stateful and stateless components on separate nodes. See [Configure dedicated nodes](https://docs.cloud.google.com/apigee/docs/hybrid/v1.8/configure-dedicated-nodes.md.txt). |
| `overrides-large.yaml` | This sample is a good starting point for high performance environments such as pre-production and production. The sample includes properties for setting encryption keys, passwords, and others. Individual components have a minimum of two replicas. |
| `private-overrides.yaml` | This sample illustrates how to use images from a private image repository. See [Use a private image repository.](https://docs.cloud.google.com/apigee/docs/hybrid/v1.8/container-images.md.txt) |

## Custom annotations

[Annotations](https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/) are key/value maps used to attach metadata to Kubernetes pods.
You can create custom annotations for the following hybrid component properties listed in
[Configuration property reference](https://docs.cloud.google.com/apigee/docs/hybrid/v1.8/config-prop-ref.md.txt):

- [`cassandra`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.8/config-prop-ref.md.txt#cassandra)
- [`connectAgent`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.8/config-prop-ref.md.txt#connectagent)
- [`logger`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.8/config-prop-ref.md.txt#logger)
- [`mart`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.8/config-prop-ref.md.txt#mart)
- [`metrics`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.8/config-prop-ref.md.txt#metrics)
- [`runtime`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.8/config-prop-ref.md.txt#runtime)
- [`synchronizer`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.8/config-prop-ref.md.txt#synchronizer)
- [`udca`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.8/config-prop-ref.md.txt#udca)
- [`watcher`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.8/config-prop-ref.md.txt#watcher)

To add a custom name/value pair annotation, open your overrides file and add an `annotations` stanza
for the respective component, then apply the change with `apigeectl`. For example:

```
runtime:
  annotations:
    businessunit: "bu1"
```

## Use dry runs to test configuration changes

You can use the `--dry-run` flag with [`apigeectl`](https://docs.cloud.google.com/apigee/docs/hybrid/v1.3/cli-reference.md.txt) to test your
overrides configuration file without actually applying it to your cluster. This option is useful for debugging an
installation problem because it shows you exactly what will be applied to the cluster.

In Apigee hybrid, the syntax of the `--dry-run` flag depends on the version of
`kubectl` you are running. Check the version of `kubectl` with the
following command:

```
kubectl version
```

**kubectl version 1.17 and older:**

```
$APIGEECTL_HOME/apigeectl init -f $HYBRID_FILES/overrides/OVERRIDES.yaml --dry-run=true
```

**kubectl version 1.18 and newer:**

```
  $APIGEECTL_HOME/apigeectl init -f $HYBRID_FILES/overrides/OVERRIDES.yaml --dry-run=client
```

> [!CAUTION]
> **Caution:** Be aware that the configuration output contains password and secret information.

## Create multiple overrides files as needed


You can create multiple overrides files, where each one serves a specific
requirement. For example, you might have an overrides file that tunes your cluster for
production, and another for creating a cluster for testing.
You can then maintain these
files in your source control system.

Use the [apigeectl apply](https://docs.cloud.google.com/apigee/docs/hybrid/v1.8/cli-reference.md.txt#commands) command to apply an overrides
file to the cluster. For example:

```
$APIGEECTL_HOME/apigeectl apply  -f $HYBRID_FILES/overrides/test_env_override.yaml
```

## Delete runtime components


The [apigeectl delete](https://docs.cloud.google.com/apigee/docs/hybrid/v1.8/cli-reference.md.txt#commands) command provides flags that let
you delete all or a subset of the installed hybrid runtime components. For details,
on command usage, see the [apigeectl](https://docs.cloud.google.com/apigee/docs/hybrid/v1.8/cli-reference.md.txt#commands) reference page.
See also [Uninstall hybrid runtime](https://docs.cloud.google.com/apigee/docs/hybrid/v1.8/uninstall.md.txt).

## Delete an environment

To completely delete an environment, you have to remove both the runtime (local) and management (cloud)
planes. For details, see [Delete environments](https://docs.cloud.google.com/apigee/docs/hybrid/v1.8/environment-delete.md.txt).