This topic explains how to configure and manage the Apigee hybridruntime plane components. For a list of the runtime plane components that you can configure, seeRuntime service configuration overview.

About the overrides file

The first time you install the hybrid runtime into a cluster, you must create a configurationoverrides file. This file lets you override default configuration values as needed, configure environments, reference TLS certificates and service account keys, assign Kubernetes node pools to specific hybrid components, and so on.

The hybridinstallation steps 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.

Making a configuration change

To make a configuration change to a hybrid runtime plane component, edit your overrides file and apply the changes withapigeectl.

For example, to change the replica count on theMessage processor, follow these steps:

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

   ...runtime:  nodeSelector:    key: cloud.google.com/gke-nodepool    value: apigee-runtime  replicaCountMin: 1  replicaCountMax: 2...

3. Change the replica count properties as needed. For example:

   ...runtime:  nodeSelector:    key: cloud.google.com/gke-nodepool    value: apigee-runtime  replicaCountMin: 2  replicaCountMax: 4...

4. Useapigeectl to apply the change to the cluster:

   apigeectl apply -f ./my_overrides.yaml -c runtime

   Use the-c option when you want to restrict the cluster update to one component. If you omit the-c flag,apigeectl applies all of the changes changes it finds in the overrides file. If that's what you want, then omit the-c flag when applying. If not, use-c to specify a component to update. See also Apply the configuration for a single component.

Which configuration properties can you modify?

You can find the complete list of configurable properties in theConfiguration property reference. 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

TheConfiguration property reference 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 property are formatted in proper YAML. For the above example, the top-levelauthz 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 theauthz.image.pullPolicy property toAlways, locatethis YAML stanza in the overrides file and set it:

authz:  image:    pullPolicy: Always

For another example, the propertycassandra.auth.admin.password (as it is listed in the 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:

cassandra:  auth:    admin:      password: abc123

Remember, theConfiguration property reference 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.

Using pre-defined example overrides files

When you first install hybrid runtime, Apigee recommends that you use one of thepre-configured example overrides files. These examples provide a complete set of configuration properties for specific installation scenarios, such as for setting up a production or test installation. All you need to do is provide appropriate values for the properties andapply the overrides file to your cluster. SeeCreate an overrides file for more information.

About configuration defaults

Apigee maintains its default component configuration in the filehybrid_root_dir/config/values.yaml. Your overrides file(s) follows the same YAML structure asvalues.yaml.

An overrides file typically includes only a subset of the configuration properties found invalues.yaml. Remember,not all properties are editable. When you apply a configuration to a cluster, your overrides are merged with the defaults to create the complete Kubernetes cluster configuration. See alsoOutput the merged configuration.

The following code shows the default configuration for themart component as found invalues.yaml. Notethat some values have defaults, while others such assslCertPath andsslKeyPath do not. You must provide these missing values in youroverrides file, as explained in theinstallation steps. If you want to change any of the default values, make sure they are editable by checking in theConfiguration property reference.

...mart:  replicaCountMin: 2  replicaCountMax: 4  targetCPUUtilizationPercentage: 75  terminationGracePeriodSeconds: 30  sslCertPath:  sslKeyPath:  hostAlias:  nodeSelector:    key:    value:  revision: blue  image:    url: "google/apigee-mart-server"    tag: "1.0.0"    pullPolicy: IfNotPresent  resources:    requests:      cpu: 500m      memory: 512Mi  initCheckCF:    resources:      requests:        cpu: 10m  livenessProbe:    timeoutSeconds: 1    failureThreshold: 12    periodSeconds: 5    initialDelaySeconds: 15  readinessProbe:    timeoutSeconds: 1    successThreshold: 1    failureThreshold: 2    periodSeconds: 5    initialDelaySeconds: 15  metricsURL: "/v1/server/metrics"  cwcAppend: |...

If you want to modify a component's defaults and the component is not already in your overrides file, you can copy its YAML fromvalues.yaml into your overrides file and modify it there.

apigeectl apply -f ./my_overrides.yaml --dry-run --print-yaml > apigee-hybrid.yaml

For more information, seeapigeectl.

Create multiple overrides files as needed

You can create as many overrides files as you want, 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 testing cluster. You can then maintain these files in your source control system.

Use the-f option withapigeectl to specify the location and name of an overrides file. For example:

apigeectl apply  -f ./test_env_override.yaml

For more information, seeapigeectl.

Delete hybrid-specific runtime plane components

To delete the hybrid-specific runtime plane components from your cluster, use theapigeectl delete command. These components include synchronizer, mart, runtime, cassandra, and udca. Be sure to specify the same overrides file that you used to install the runtime components:

For example:

apigeectl delete -f ./my_overrides.yaml

You can use theapigeectl apply command to recreate a specific component or components:

apigeectl apply -c synchronizer -f ./my_overrides.yaml

For more information, seeapigeectl.

Delete a specific component

If you only want to delete a specific component, use the-c option withapigeectl delete Be sure to specify the same overrides file you used to install the runtime components.

For example, to delete the Synchronizer component, use this command:

apigeectl delete -c synchronizer -f ./my_overrides.yaml

You can then use theapigeectl apply command to recreate the component:

apigeectl apply -c synchronizer -f ./my_overrides.yaml

For more information, seeapigeectl.

Delete all components

To delete all of your cluster components hybrid, including those created by theapigeectl init command, use theapigeectl delete command with the--all flag. Be sure to specify the same overrides file that you used to install the runtime components:

For example:

apigeectl delete -f ./my_overrides.yaml --all

For more information, seeapigeectl.