Configuration property reference

This section lists all of the configuration properties that you can use to customize the runtime plane of your Apigee hybrid deployment.

About configuration properties

You can override many configuration properties, if needed, by adding them to HYBRID_ROOT_DIR/overrides.yaml.

For example, to change the replica count minimum and maximum for the MART service, you could add this stanza to overrides.yaml:

mart:
    replicaCountMin: 3
    replicaCountMax: 6

You can also find these config properties and their default settings in HYBRID_ROOT_INSTALL/1.0.0/values.yaml

For more information, see Manage runtime plane components.

Additionally, if you are configuring an Anthos-based deployment see Step 6: Configure the cluster for information on setting these properties for Anthos.

Filter this page

To filter the properties displayed on this page, select Basic (most common properties) or Advanced (properties that rarely need changing):

^{filter_list_alt} Display

configuration properties on this page.

Top-level properties

The following table describes the top-level properties in the overrides.yaml file. These are properties that do not belong to another object, and apply at the org or environment level:

Property	Type	Description
`axHashSalt`	Advanced	Introduced in version: 1.3.0 Default value: `iloveapis123` Optional The name of a Kubernetes secret that contains a salt used when computing hashes to obfuscate user data before it is sent to Apigee analytics. If you do not specify a salt value, `iloveapis123` is used by default. Create the secret with the salt value as its input. You can use the same salt across multiple clusters to ensure consistent hashing results between the clusters. Apigee uses SHA512 to hash the original value before sending data from the runtime plane to the control plane. See: Obfuscate user data for analytics.
`contractProvider`	Advanced	Introduced in version: 1.0.0 Default value: `https://apigee.googleapis.com` Defines the API path for all APIs in your installation.
`gcpProjectID`	Advanced	`Deprecated:` For v1.2.0 and later, use `gcp.projectID` instead. Introduced in version: 1.0.0 Default value: none Required ID of your Google Cloud project. Works with `k8sClusterName` (deprecated) and `gcpRegion` (deprecated) to identify the project and determine where the `apigee-logger` and the `apigee-metrics` push their data.
`gcpRegion`	Advanced	`Deprecated:` For v1.2.0 and later, use `gcp.region` instead. Introduced in version: 1.0.0 Default value: `us-central1` Required The closet Google Cloud region or zone of your Kubernetes cluster. Works with `gcpProjectID` (deprecated) and `k8sClusterName` (deprecated) to identify the project and determine where the `apigee-logger` and the `apigee-metrics` push their data.
`hub`	Advanced	Introduced in version: 1.11.0 Default value: None Helm only: The URL of a private image container repository used to pull images for all apigee components from a private repo. `hub` provides a default path for all Apigee hybrid components. If you are using a private repository, use `hub` to set the repository URL for all components rather than using the individual `image.url` property for each component. Only configure indivisual URLs if you are using a separate repository for a specific component. The image path for each individual component will be the value of `hub` plus the image name and tag for the component. For example, if the value of `hub` `private-docker-host.example.com`, individual components will automatically resolve the image path: hub: private-docker-host.example.com as: ## an example of internal component vs 3rd party containers: - name: apigee-udca image: private-docker-host.example.com/apigee-udca:1.11.2 imagePullPolicy: IfNotPresent containers: - name: apigee-ingressgateway image: private-docker-host.example.com/apigee-asm-ingress:1.18.7-asm.26-distroless imagePullPolicy: IfNotPresent The other components will follow a similar pattern. Use `apigee-pull-push --list` to see the current repository URL for all components. See Use a private image repository with Helm. You can override image URL for components individualy with the following properties: `ao.image.url` `apigeeIngressGateway.image.url`