Configuration property reference
This section lists all of the configuration propertiesthat you can use to customize the runtime plane of your Apigee hybrid deployment.
Note: For instructions on how to add custom annotations, see Custom annotations.About configuration properties
You can override many configuration properties, if needed, by adding them toHYBRID_ROOT_DIR/overrides.yaml.
For example, to change the replica count minimum and maximum for the MART service, you could add this stanza tooverrides.yaml:
mart:replicaCountMin:3replicaCountMax:6
You can also find these config properties and their default settings inHYBRID_ROOT_INSTALL/1.0.0/values.yaml
For more information, seeManage runtime plane components.
Additionally, if you are configuring an Anthos-based deployment see Step 7: Configure the hybrid runtime for information on setting these properties for Anthos.
Top-level properties
The following table describes the top-level properties in theoverrides.yaml file. These are properties that do not belong to another object, and apply at the org or environment level:
| Property | Description |
|---|---|
axHashSalt | Introduced in version: 1.3.0 Default value:Your organization name Optional The name of aKubernetes secret that contains a hashing salt value used to encryptobfuscated user data sent to Apigee analytics. If you do not specify a salt value, your organization name 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. |
contractProvider | Introduced in version: 1.0.0 Default value: Defines the API path for all APIs in your installation. |
gcpProjectID | Deprecated: For v1.2.0 and later, usegcp.projectID instead.Introduced in version: 1.0.0 Default value:none Required ID of your Google Cloud project. Works with |
gcpRegion | Deprecated: For v1.2.0 and later, usegcp.region instead.Introduced in version: 1.0.0 Default value: Required The closet Google Cloud region or zone of your Kubernetes cluster. Works with |
imagePullSecrets.name | Introduced in version: 1.0.0 Default value: None Kubernetes secret name configured as docker-registry type; used to pull images from private repo. |
instanceID | Introduced in version: 1.3.0 Default value: None Required A unique identifier for this installation. A unique string to identify this instance. This can be any combination of letters and numbers up to 63 characters in length. You can create multiple organizations in the same cluster, but theinstanceID must be the same for all orgs in the same Kubernetes cluster. For multi-region installations, each region requires its own cluster (individual clusters do not span regions). |
k8sClusterName | Deprecated: For v1.2.0 and later, usek8sCluster.name andk8sCluster.region instead.Introduced in version: 1.0.0 Default value: None Name of the Kubernetes (K8S) procluster where your hybrid project is running. Works with |
kmsEncryptionKey | Introduced in version: 1.0.0 Default value: Optional. Use only one ofkmsEncryptionKey orkmsEncryptionPath orkmsEncryptionSecret. Local file system path for the ApigeeKMS data's encryption key. |
kmsEncryptionPath | Introduced in version: 1.2.0 Default value: None Optional. Use only one ofkmsEncryptionKey orkmsEncryptionPath orkmsEncryptionSecret. The path to a file containing a base64-encoded encryption key. SeeData encryption. |
kmsEncryptionSecret.key | Introduced in version: 1.2.0 Default value: None Optional. Use only one ofkmsEncryptionKey orkmsEncryptionPath orkmsEncryptionSecret. The key of aKubernetes secret containing a base64-encoded encryption key. SeeData encryption. |
kmsEncryptionSecret.name | Introduced in version: 1.2.0 Default value: None Optional. Use only one ofkmsEncryptionKey orkmsEncryptionPath orkmsEncryptionSecret. The name of aKubernetes secret containing a base64-encoded encryption key. SeeData encryption. |
kvmEncryptionKey | Introduced in version: 1.0.0 Default value: Optional. Use only one ofkvmEncryptionKey orkvmEncryptionPath orkvmEncryptionSecret. Local file system path for the ApigeeKVM data's encryption key. |
kvmEncryptionPath | Introduced in version: 1.2.0 Default value: None Optional. Use only one ofkvmEncryptionKey orkvmEncryptionPath orkvmEncryptionSecret. The path to a file containing a base64-encoded encryption key. SeeData encryption. |
kvmEncryptionSecret.key | Introduced in version: 1.2.0 Default value: None Optional. Use only one ofkvmEncryptionKey orkvmEncryptionPath orkvmEncryptionSecret. The key of aKubernetes secret containing a base64-encoded encryption key. SeeData encryption. |
kvmEncryptionSecret.name | Introduced in version: 1.2.0 Default value: None Optional. Use only one ofkvmEncryptionKey orkvmEncryptionPath orkvmEncryptionSecret. The name of aKubernetes secret containing a base64-encoded encryption key. SeeData encryption. |
namespace | Introduced in version: 1.0.0 Default value: The namespace of your Kubernetes cluster where the Apigee components will be installed. |
org | Introduced in version: 1.0.0 Default value: None Required The hybrid-enabled organization that was provisioned for you by Apigee during the hybrid installation. An organization is the top-level container in Apigee. It contains all your API proxies and related resources. If the value is empty, you must update it with your org name once you have created it. |
orgScopedUDCA | Introduced in version: 1.8.0 Default value: Enables the Universal Data Collection Agent service (UDCA) at the org level, that extracts analytics, monetization and debug (trace) and sends it to the Unified Analytics Platform (UAP) which resides in the Control Plane. If you prefer to use a separate UDCA agent for each environment, set See also:udca. |
revision | Introduced in version: 1.0.0 Default value: Apigee hybrid supports rolling Kubernetes updates, which allow deployment updates to take place with zero downtime by incrementally updating Pod instances with new ones. When updating certain YAML overrides that result in underlying Kubernetes revision can accept only lowercase alpha characters, numbers, and punctuation. When the Changes to properties of the following objects require an update to For more information, seeRolling updates. |
validateOrg | Introduced in version: 1.8.0 Default value: Enables strict validation of the link between the Apigee Org and GCP project and checks for the existence of environment groups. See also |
validateServiceAccounts | Introduced in version: 1.0.0 Default value: Enables strict validation of service account permissions. This uses Cloud Resource Manager API method See also |
ao
Apigee Operators (AO) creates and updates low level Kubernetes and Istio resources that are required to deploy and maintain a component. For example, the controller carries out the release of message processors.
Note:In version 1.2.0, Apigee Operators replaces Apigee Deployment Admissionhook (ADAH) andApigee Deployment Controller (ADC).The following table describes the properties of the apigee-operatorsao object:
| Property | Description |
|---|---|
ao.args.disableIstioConfigInAPIServer | Introduced in version: 1.8.0 Default value: Stops Apigee from supplying configuration to customer-installed ASM.
|
ao.image.pullPolicy | Introduced in version: 1.2.0 Default value: Determines when kubelet pulls the pod's Docker image. Possible values include:
For more information, seeUpdating images. |
ao.image.tag | Introduced in version: 1.2.0 Default value: The version label for this service's Docker image. |
ao.image.url | Introduced in version: 1.2.0 Default value: The location of the Docker image for this service. |
ao.installer.pullPolicy | Introduced in version: 1.3.0 Default value: Determines when kubelet pulls the pod's Docker image. Possible values include:
For more information, seeUpdating images. |
ao.installer.tag | Introduced in version: 1.3.0 Default value: The version label for this service's Docker image. |
ao.installer.url | Introduced in version: 1.3.0 Default value: The location of the Docker image for this service. |
ao.resources.limits.cpu | Introduced in version: 1.2.0 Default value: The CPU limit for the resource in a Kubernetes container, in millicores. |
ao.resources.limits.memory | Introduced in version: 1.2.0 Default value: The memory limit for the resource in a Kubernetes container, in mebibytes. |
ao.resources.requests.cpu | Introduced in version: 1.2.0 Default value: The CPU needed for normal operation of the resource in a Kubernetes container, in millicores. |
ao.resources.requests.memory | Introduced in version: 1.2.0 Default value: The memory needed for normal operation of the resource in a Kubernetes container, in mebibytes. |
cassandra
Defines the hybrid service that manages the runtime data repository. This repository storesapplication configurations, distributed quota counters, API keys, and OAuth tokens for applicationsrunning on the gateway.
For more information, seeStorageClass configuration.
The following table describes the properties of thecassandra object:
| Property | Description |
|---|---|
cassandra.annotations | Introduced in version: 1.5.0 Default value: None Optional key/value map used to annotate pods. For more information, seeCustom annotations. |
cassandra.auth.admin.password | Introduced in version: 1.0.0 Default value: Required Password for the Cassandra administrator. The admin user is used for any administrative activities performed on the Cassandra cluster. |
cassandra.auth.ddl.password | Introduced in version: 1.0.0 Default value: Required Password for the Cassandra Data Definition Language (DDL) user. Used by MART for any of the data definition tasks like keyspace creation, update, and deletion. |
cassandra.auth.default.password | Introduced in version: 1.0.0 Default value: Required The password for the default Cassandra user created when Authentication is enabled. This password must be reset when configuring Cassandra authentication. SeeConfiguring TLS for Cassandra. |
cassandra.auth.dml.password | Introduced in version: 1.0.0 Default value: Required Password for the Cassandra Data Manipulation Language (DML) user. The DML user is used by the client communication to read and write data to Cassandra. |
cassandra.auth.image.pullPolicy | Introduced in version: 1.0.0 Default value: Determines when kubelet pulls the pod's Docker image. Possible values include:
For more information, seeUpdating images. |
cassandra.auth.image.tag | Introduced in version: 1.0.0 Default value: The version label for this service's Docker image. |
cassandra.auth.image.url | Introduced in version: 1.0.0 Default value: The location of the Docker image for this service. |
cassandra.auth.jmx.password | Introduced in version: 1.4.0 Default value: Required Password for the Cassandra JMX operations user. Used to authenticate and communicate with the Cassandra JMX interface. |
cassandra.auth.jmx.username | Introduced in version: 1.4.0 Default value: Required Username for the Cassandra JMX operations user. Used to authenticate and communicate with the Cassandra JMX interface. |
cassandra.auth.jolokia.password | Introduced in version: 1.4.0 Default value: Required Password for the Cassandra Jolokia JMX operations user. Used to authenticate and communicate with the Cassandra JMX API. |
cassandra.auth.jolokia.username | Introduced in version: 1.4.0 Default value: Required Username for the Cassandra Jolokia JMX operations user. Used to authenticate and communicate with the Cassandra JMX API. |
cassandra.auth.secret | Introduced in version: 1.3.3 Default value: None The name of the file stored in a Kubernetes secret that contains the Cassandra users and passwords. You can create the secret using following the following instructions:Create the Secret. See also:
|
cassandra.backup.cloudProvider | Introduced in version: 1.0.0 Default value: Required if backup is enabled. Cloud provider for backup storage. You can set the value to either |
cassandra.backup.dbStorageBucket | Introduced in version: 1.0.0 Default value: None Required if backup is enabled. Cloud storage bucket for the backup data. |
cassandra.backup.enabled | Introduced in version: 1.0.0 Default value: Data backup is not enabled by default. To enable, set to |
cassandra.backup.image.pullPolicy | Introduced in version: 1.0.0 Default value: Determines when kubelet pulls the pod's Docker image. Possible values include:
For more information, seeUpdating images. |
cassandra.backup.image.tag | Introduced in version: 1.0.0 Default value: The version label for this service's Docker image. |
cassandra.backup.image.url | Introduced in version: 1.0.0 Default value: The location of the Docker image for this service. |
cassandra.backup.schedule | Introduced in version: 1.0.0 Default value: The schedule for the cron job. |
cassandra.backup.serviceAccountPath | Introduced in version: 1.0.0 Default value: None One of either Path to Google Service Account key file withStorage Object Admin role. |
cassandra.backup.serviceAccountRef | Introduced in version: 1.2.0 Default value: None One of either |
cassandra.clusterName | Introduced in version: 1.0.0 Default value: Specifies the name of the Cassandra cluster. Note: For multi-region installs the value ofclusterName needs to match for all regions. |
cassandra.datacenter | Introduced in version: 1.0.0 Default value: Specifies the datacenter of the Cassandra node. |
cassandra.dnsPolicy | Introduced in version: 1.1.1 Default value: None |
cassandra.externalSeedHost | Introduced in version: 1.0.0 Default value: None Hostname or IP of a Cassandra cluster node. If not set, the Kubernetes local service is used. |
cassandra.heapNewSize | Introduced in version: 1.0.0 Default value: The amount ofJVM system memory allocated to newer objects, in megabytes. |
cassandra.hostNetwork | Introduced in version: 1.1.1 Default value: Enables the Kubernetes Set Set When |
cassandra.image.pullPolicy | Introduced in version: 1.0.0 Default value: Determines when kubelet pulls the pod's Docker image. Possible values include:
For more information, seeUpdating images. |
cassandra.image.tag | Introduced in version: 1.0.0 Default value: The version label for this service's Docker image. |
cassandra.image.url | Introduced in version: 1.0.0 Default value: The location of the Docker image for this service. |
cassandra.maxHeapSize | Introduced in version: 1.0.0 Default value: The upper limit ofJVM system memory available for Cassandra operations, in megabytes. |
cassandra.multiRegionSeedHost | Introduced in version: 1.0.0 Default value: None IP address of an existing Cassandra cluster used to expand the existing cluster to a new region. SeeConfigure the multi-region seed host. |
cassandra.nodeSelector.key | Introduced in version: 1.0.0 Default value: None Required Node selector label key used to target dedicated Kubernetes nodes for |
cassandra.nodeSelector.value | Introduced in version: 1.0.0 Default value: None Optional node selector label value used to target dedicated Kubernetes nodes for SeenodeSelector. |
cassandra.port | Introduced in version: 1.0.0 Default value: Port number used to connect to cassandra. |
cassandra.rack | Introduced in version: 1.0.0 Default value: Specifies the rack of the Cassandra node. |
cassandra.readinessProbe.failureThreshold | Introduced in version: 1.0.0 Default value: The number of times Kubernetes will verify that readiness probes have failed before marking the podunready. The minimum value is 1. |
cassandra.readinessProbe.initialDelaySeconds | Introduced in version: 1.0.0 Default value: The number of seconds after a container is started before a readiness probe is initiated. |
cassandra.readinessProbe.periodSeconds | Introduced in version: 1.0.0 Default value: Determines how often to perform a readiness probe, in seconds. The minimum value is 1. |
cassandra.readinessProbe.successThreshold | Introduced in version: 1.0.0 Default value: The minimum consecutive successes needed for a readiness probe to be considered successful after a failure. The minimum value is 1. |
cassandra.readinessProbe.timeoutSeconds | Introduced in version: 1.0.0 Default value: The number of seconds after which a liveness probe times out. The minimum value is 1. |
cassandra.replicaCount | Introduced in version: 1.0.0 Default value: Cassandra is a replicated database. This property specifies the number of Cassandra nodes employed as aStatefulSet. |
cassandra.resources.requests.cpu | Introduced in version: 1.0.0 Default value: The CPU needed for normal operation of the resource in a Kubernetes container, in millicores. |
cassandra.resources.requests.memory | Introduced in version: 1.0.0 Default value: The memory needed for normal operation of the resource in a Kubernetes container, in mebibytes. |
cassandra.restore.cloudProvider | Introduced in version: 1.0.0 Default value: Required if restore is enabled. Cloud provider for backup storage. |
cassandra.restore.dbStorageBucket | Introduced in version: 1.0.0 Default value: None Required if restore is enabled. Cloud storage bucket for the backup data to restore. |
cassandra.restore.enabled | Introduced in version: 1.0.0 Default value: |
cassandra.restore.image.pullPolicy | Introduced in version: 1.0.0 Default value: Determines when kubelet pulls the pod's Docker image. Possible values include:
For more information, seeUpdating images. |
cassandra.restore.image.tag | Introduced in version: 1.0.0 Default value: The version label for this service's Docker image. |
cassandra.restore.image.url | Introduced in version: 1.0.0 Default value: The location of the Docker image for this service. |
cassandra.restore.serviceAccountPath | Introduced in version: 1.0.0 Default value: None One of either Path to Google Service Account key file withStorage Object Admin role. |
cassandra.restore.serviceAccountRef | Introduced in version: 1.2.0 Default value: None One of either |
cassandra.restore.snapshotTimestamp | Introduced in version: 1.0.0 Default value: None Required if restore is enabled. Timestamp of the backup that should be restored. |
cassandra.restore.user | Introduced in version: 1.0.0 Default value:admin account Cassandra username used for schema backup restoration. If not specified, the admin user will be used. |
cassandra.sslCertPath | Introduced in version: 1.2.0 Default value: None The path on your system to a TLS certificate file. Note: For each configured environment, the Common Name (CN) in the cert must match the domain in thehostAliases[] property. For example, if the CN is*.example.com, thehostAliases[] could befoo.example.com orbar.example.com. |
cassandra.sslKeyPath | Introduced in version: 1.2.0 Default value: None The path on your system to the TLS private key file. |
cassandra.sslRootCAPath | Introduced in version: 1.2.0 Default value: None The certificate chain to the root CA (certificate authority). |
cassandra.storage.capacity | Introduced in version: 1.0.0 Default value: Required if Specifies the disk size required, in mebibytes. |
cassandra.storage.storageclass | Introduced in version: 1.0.0 Default value: None Specifies the class of on-prem storage being used. |
cassandra.terminationGracePeriodSeconds | Introduced in version: 1.0.0 Default value: The time between a request for pod deletion and when the pod is killed, in seconds. During this period, any prestop hooks will be executed and any running process should terminate gracefully. |
connectAgent
Apigee Connect allows the Apigee hybrid management plane to connect securely to the MART service in the runtime plane without requiring you to expose the MART endpoint on the internet.
SeeApigee Connect.
The following table describes the properties of theconnectAgent object:
| Property | Description |
|---|---|
connectAgent.annotations | Introduced in version: 1.5.0 Default value: None Optional key/value map used to annotate pods. For more information, seeCustom annotations. |
connectAgent.server | Introduced in version: 1.2.0 Default value: The location of the server and port for this service. |
connectAgent.logLevel | Introduced in version: 1.2.0 Default value: The level of log reporting. Values can be:
|
connectAgent.image.pullPolicy | Introduced in version: 1.2.0 Default value: Determines when kubelet pulls the pod's Docker image. Possible values include:
For more information, seeUpdating images. |
connectAgent.image.tag | Introduced in version: 1.2.0 Default value: The version label for this service's Docker image. |
connectAgent.image.url | Introduced in version: 1.2.0 Default value: The location of the Docker image for this service. Check the |
connectAgent.replicaCountMax | Introduced in version: 1.2.0 Default value: Maximum number of replicas available for autoscaling. |
connectAgent.replicaCountMin | Introduced in version: 1.2.0 Default value: Minimum number of replicas available for autoscaling. In production, you may want to increase |
connectAgent.resources.requests.cpu | Introduced in version: 1.0.0 Default value: The CPU needed for normal operation of the resource in a Kubernetes container, in millicores. |
connectAgent.resources.requests.memory | Introduced in version: 1.0.0 Default value: The memory needed for normal operation of the resource in a Kubernetes container, in mebibytes. |
connectAgent.targetCPUUtilizationPercentage | Introduced in version: 1.2.0 Default value: Target CPU utilization for the Apigee Connect agent on the pod. The value of this field enables Apigee Connect to auto-scale when CPU utilization reaches this value, up to |
connectAgent.terminationGracePeriodSeconds | Introduced in version: 1.2.0 Default value: The time between a request for pod deletion and when the pod is killed, in seconds. During this period, any prestop hooks will be executed and any running process should terminate gracefully. |
defaults
The Default encryption keys for the Apigee hybrid installation.
Note: You need to update these for your installation.The following table describes the properties of thedefaults object:
| Property | Description |
|---|---|
defaults.org.kmsEncryptionKey | Introduced in version: 1.0.0 Default value: Default encryption key for the org in KMS. |
defaults.org.kvmEncryptionKey | Introduced in version: 1.0.0 Default value: Default encryption key for the org in KVM. |
defaults.env.kmsEncryptionKey | Introduced in version: 1.0.0 Default value: Default encryption key for the environment (env) in KMS. |
defaults.env.kvmEncryptionKey | Introduced in version: 1.0.0 Default value: Default encryption key for the environment (env) in KVM. |
defaults.env.cacheEncryptionKey | Introduced in version: 1.0.0 Default value: Default cache encryption key for the environment (env). |
diagnostic
The settings for the Diagnostic collector tool.
SeeUsing the Diagnostic collector
The following table describes the properties of thediagnostic object:
| Property | Description |
|---|---|
diagnostic.bucket | Introduced in version: 1.6.0 Default value: None Required The name of the Google Cloud storage bucket where your diagnostic data will be deposited. |
diagnostic.container | Introduced in version: 1.6.0 Default value: None Required This specifies which type of pod you are capturing data from. The values can be one of:
|
diagnostic.loggingDetails.logDuration | Introduced in version: 1.6.0 Default value: None Required if the diagnostic collection operation is "LOGGING" (set with The duration in milliseconds of the log data collected. A typical value is |
diagnostic.loggingDetails.loggerNames[] | Introduced in version: 1.6.0 Default value: None Required if the diagnostic collection operation is "LOGGING" (set with Specifies by name which loggers to collect data from. For Apigee hybrid version 1.6.0, the only value supported is diagnostic:loggingDetails:loggerNames:-ALL |
diagnostic.loggingDetails.logLevel | Introduced in version: 1.6.0 Default value: None Required if the diagnostic collection operation is "LOGGING" (set with Specifies the granularity of the logging data to collect. In Apigee hybrid 1.6, Only |
diagnostic.namespace | Introduced in version: 1.6.0 Default value: None Required The Kubernetes namespace in which the pods you are collecting data on reside. The namespace must be the correct one for the container you specify with
|
diagnostic.operation | Introduced in version: 1.6.0 Default value: None Required Specifies whether to collect all statistics or just logs. Values are:
|
diagnostic.podNames[] | Introduced in version: 1.6.0 Default value: None Required The names of the Kubernetes pods for which you are collecting data. For example: diagnostic:podNames:-apigee-runtime-eng-hybrid-example-3b2ebf3-150-8vfoj-2wcjn-apigee-runtime-eng-hybrid-example-3b2ebf3-150-8vfoj-6xzn2 |
diagnostic.serviceAccountPath | Introduced in version: 1.6.0 Default value: None Required The path to a service account key file ( |
diagnostic.tcpDumpDetails.maxMsgs | Introduced in version: 1.6.0 Default value: None One of either Sets the maximum number of |
diagnostic.tcpDumpDetails.timeoutInSeconds | Introduced in version: 1.6.0 Default value: None One of either Sets the amount of time in seconds to wait for |
diagnostic.threadDumpDetails.delayInSeconds | Introduced in version: 1.6.0 Default value: None Both The delay in seconds between collecting each thread dump. |
diagnostic.threadDumpDetails.iterations | Introduced in version: 1.6.0 Default value: None Both The number of jstack thread dump iterations to collect. |
envs
Defines an array of environments to which you can deploy your API proxies. Each environmentprovides an isolated context orsandbox for running API proxies.
Your hybrid-enabled organization must have at least one environment.
For more information, seeAbout environments.
The following table describes the properties of theenvs object:
| Property | Description |
|---|---|
envs[].cacheEncryptionKey | Introduced in version: 1.0.0 Default value: None One of either A base64-encoded encryption key. SeeData encryption. |
envs[].cacheEncryptionPath | Introduced in version: 1.2.0 Default value: None One of either The path to a file containing a base64-encoded encryption key. SeeData encryption. |
envs[].cacheEncryptionSecret.key | Introduced in version: 1.2.0 Default value: None One of either The key of aKubernetes secret containing a base64-encoded encryption key. SeeData encryption. |
envs[].cacheEncryptionSecret.name | Introduced in version: 1.2.0 Default value: None One of either The name of aKubernetes secret containing a base64-encoded encryption key. SeeData encryption. |
envs[].hostAliases[] | Introduced in version: 1.2.0 Default value: None Deprecated: Starting in Hybrid version 1.4 the runtime plane receives this information from the management plane. SeeAbout environments and environment groups. |
envs[].httpProxy.host | Introduced in version: 1.2.0 Default value: None Specifies the host name or IP address where the HTTP proxy is running. List envs: - name: test httpProxy: scheme: HTTP host: 10.12.0.47 port: 3128 ... |
envs[].httpProxy.port | Introduced in version: 1.2.0 Default value: None Specifies the port on which the HTTP proxy is running. If this property is omitted, by default it uses port |
envs[].httpProxy.scheme | Introduced in version: 1.2.0 Default value: None Specifies the type of the HTTP proxy as HTTP or HTTPS. By default, it uses "HTTP". |
envs[].httpProxy.username | Introduced in version: 1.2.0 Default value: None If the HTTP proxy requires basic authentication, then use this property to provide a username. |
envs[].httpProxy.password | Introduced in version: 1.2.0 Default value: None If the HTTP proxy requires basic authentication, then use this property to provide a password. |
envs[].name | Introduced in version: 1.0.0 Default value: None Required Apigee environment name to be synchronized. |
envs[].pollInterval | Introduced in version: 1.0.0 Default value: None Interval used for polling organization and environment synchronization changes, in seconds. |
envs[].port | Introduced in version: 1.0.0 Default value: None TCP port number for HTTPS traffic. |
envs[].serviceAccountPaths.runtime | Introduced in version: 1.4.0 Default value: None Path to file on local system to a Google Service Account key with theCloud Trace Agent role, usually the |
envs[].serviceAccountPaths.synchronizer | Introduced in version: 1.0 Default value: None Path to file on local system to a Google Service Account key with theApigee Synchronizer Manager role. |
envs[].serviceAccountPaths.udca | Introduced in version: 1.0 Default value: None Path to file on local system to a Google Service Account key with theApigee Analytic Agent role. Only set this property if |
envs[].serviceAccountSecretRefs.runtime | Introduced in version: 1.4.0 Default value: None The name of aKubernetes secret. You mustcreate the secret using a Google Service Account key with theCloud Trace Agent role as its input. |
envs[].serviceAccountSecretRefs.synchronizer | Introduced in version: 1.2.0 Default value: None The name of aKubernetes secret. You mustcreate the secret using a Google Service Account key with theApigee Synchronizer Manager role as its input. |
envs[].serviceAccountSecretRefs.udca | Introduced in version: 1.2.0 Default value: None The name of aKubernetes secret. You mustcreate the secret using a Google Service Account key with theApigee Analytic Agent role as its input. Only set this property if |
envs[].sslCertPath | Introduced in version: 1.2.0 Default value: None Either The path on your system to a TLS certificate file. Note: For each configured environment, the Common Name (CN) in the cert must match the domain in thehostAliases[] property. For example, if the CN is*.example.com, thehostAliases[] could befoo.example.com orbar.example.com. |
envs[].sslKeyPath | Introduced in version: 1.2.0 Default value: None Either The path on your system to the TLS private key file. |
envs[].sslSecret | Introduced in version: 1.2.0 Default value: None Either The name of a file stored in a Kubernetes secret that contains the TLS certificate and private key. You must create the secret using the TLS certificate and key data as its input. See also:
|
gcp
Identifies the Google Cloud project ID and region where theapigee-logger and theapigee-metrics push their data.
The following table describes the properties of thegcp object:
| Property | Description |
|---|---|
gcp.region | Introduced in version: 1.2.0 Default value: None Required Identifies the Google Cloudregion where the |
gcp.projectID | Introduced in version: 1.2.0 Default value: None Required Identifies the Google Cloud project where |
gcp.projectIDRuntime | Introduced in version: 1.2.0 Default value: None Identifies the runtime Kubernetes cluster project. The |
gcp.workloadIdentityEnabled | Introduced in version: 1.4.0 Default value: Enables using Workload Identity. Workload Identity allows workloads in your GKE clusters to impersonate Identity and Access Management (IAM) service accounts to access Google Cloud services. When When
|
httpProxy
httpProxy provides configuration parameters for an HTTP forward proxy server. When configured inoverrides.yaml, all internet communication for the MART, Synchronizer, and UDCA components pass through the proxy server.
See also:logger,mart,metrics,synchronizer, andudca.
The following table describes the properties of thehttpProxy object:
| Property | Description |
|---|---|
httpProxy.host | Introduced in version: 1.1.1 Default value: None The hostname of the HTTP Proxy. |
httpProxy.port | Introduced in version: 1.1.1 Default value: None The port of the HTTP Proxy. |
httpProxy.scheme | Introduced in version: 1.1.1 Default value: The scheme used by the proxy. Values can be |
ingressGateways
Configures the Apigee ingress gateway for Apigee Hybrid.
The following table describes the properties of theingressGateways object:
| Property | Description |
|---|---|
ingressGateways[].image.pullPolicy | Introduced in version: 1.8.0 Default value: Determines when kubelet pulls the pod's Docker image. Possible values include:
For more information, seeUpdating images. |
ingressGateways[].image.tag | Introduced in version: 1.8.0 Default value: The version label for this service's Docker image. |
ingressGateways[].image.url | Introduced in version: 1.8.0 Default value: The location of the Docker image for this service. |
ingressGateways[].name | Introduced in version: 1.8.0 Default value: None Required The name of ingress gateway. Other services will use this name to address traffic to the gateway. The name must meet the following requirements:
For more information, seeDNS Subdomain Names in the Kubernetes documentation. |
ingressGateways[].resources.limits.cpu | Introduced in version: 1.8.0 Default value: The CPU limit for the resource, in millicores. |
ingressGateways[].resources.limits.memory | Introduced in version: 1.8.0 Default value: The memory limit for the resource, in mebibytes. |
ingressGateways[].resources.requests.cpu | Introduced in version: 1.8.0 Default value: The CPU needed for normal operation of the resource, in millicores. |
ingressGateways[].resources.requests.memory | Introduced in version: 1.8.0 Default value: The memory needed for normal operation of the resource, in mebibytes. |
ingressGateways[].replicaCountMax | Introduced in version: 1.8.0 Default value: The maximum number of pods that hybrid can automatically add for the ingress gateway available for autoscaling. |
ingressGateways[].replicaCountMin | Introduced in version: 1.8.0 Default value: The minimum number of pods for the ingress gateway available for autoscaling. |
ingressGateways[].svcAnnotations | Introduced in version: 1.8.0 Default value: None Optional key/value map used to annotate the ingress gateway on platforms that support annotation. For example: intressGateways: svcAnnotations: networking.gke.io/load-balancer-type: "Internal" |
ingressGateways[].svcLoadBalancerIP | Introduced in version: 1.8.0 Default value: None On platforms that support specifying the load balancer IP address, the load balancer will be created with this IP address. On platforms that do not allow you to specify the load balancer IP address, this property is ignored. |
ingressGateways[].svcType | Introduced in version: 1.8.1 Default value: LoadBalancer Used to change the type of the default k8s service for ingress deployment. Set the value to
|
istiod
Configures the Apigee ingress.
The following table describes the properties of theistiod object:
| Property | Description | |
|---|---|---|
istiod.forwardClientCertDetails | Advanced | Introduced in version: 1.8.7 Default value: Determines how the Envoy proxy (for the Apigee ingress gateway) handles the Possible values are:
For more information on these values, see the Envoy documentation forEnum extensions.filters.network.http_connection_manager.v3.HttpConnectionManager.ForwardClientCertDetails. If you change this setting after installing Hybrid, apply it with |
istiod.image.pullPolicy | Introduced in version: 1.8.0 Default value: Determines when kubelet pulls the pod's Docker image. Possible values include:
For more information, seeUpdating images. | |
istiod.image.tag | Introduced in version: 1.8.0 Default value: The version label for this service's Docker image. | |
istiod.image.url | Introduced in version: 1.8.0 Default value: The location of the Docker image for this service. |
k8sCluster
Identifies Kubernetes cluster where the hybrid runtime is installed.
The following table describes the properties of thek8sCluster object:
| Property | Description |
|---|---|
k8sCluster.name | Introduced in version: 1.2.0 Default value: None The name of the Kubernetes cluster where the hybrid runtime is installed. |
k8sCluster.region | Introduced in version: 1.2.0 Default value: None Identifies the Google Cloudregion in which your Kubernetes cluster was created. |
kubeRBACProxy
Identifies where Apigee should look for Kubernetes role-based access controls.
The following table describes the properties of thekubeRBACProxy object:
| Property | Description |
|---|---|
kubeRBACProxy.image.pullPolicy | Introduced in version: 1.2.0 Default value: Determines when kubelet pulls the pod's Docker image. Possible values include:
For more information, seeUpdating images. |
kubeRBACProxy.image.tag | Introduced in version:1.2.0Default value: The version label for this service's Docker image. |
kubeRBACProxy.image.url | Introduced in version: 1.2.0 Default value: The location of the Docker image for this service. If you do not want to use the Google Docker Hub, download the images and use the address where your docker images are hosted internally. |
logger
Defines the service that manages operational logs. All of the Apigee hybrid servicesthat run in your Kubernetes cluster output this information.
For more information, seeLogging overview.
The following table describes the properties of thelogger object:
| Property | Description | |
|---|---|---|
logger.annotations | Advanced | Introduced in version: 1.5.0 Default value: None Optional key/value map used to annotate pods. For more information, seeCustom annotations. |
logger.enabled | Basic | Introduced in version: 1.0.0 Default value: Enables or disables logging on the cluster. For non-GKE set to |
logger.EnvVars | Basic | Introduced in version: 1.8.5 Default value: None Allows you to include the logger:...EnvVars: NO_PROXY: '<comma-separated-values>' for example: EnvVars: NO_PROXY: 'kubernetes.default.svc,oauth2.googleapis.com,logging.googleapis.com' Use SeeNO_PROXY in the Fluent Bit documentation. |
logger.fluentd.buffer_chunk_limit | Advanced | Introduced in version: 1.0.0 Default value: The maximum size of a buffer chunk allowed, in kilobytes. Chunks exceeding the limit will be flushed to the output queue automatically. |
logger.fluentd.buffer_queue_limit | Advanced | Introduced in version: 1.0.0 Default value: The maximum length of the output queue. The default limit is 256 chunks. |
logger.fluentd.flush_interval | Advanced | Introduced in version: 1.0.0 Default value: The interval to wait before invoking the next buffer flush, in seconds. |
logger.fluentd.max_retry_wait | Advanced | Introduced in version: 1.0.0 Default value: The maximum interval between write retries, in seconds. |
logger.fluentd.num_threads | Advanced | Introduced in version: 1.0.0 Default value: The number of threads used to flush the buffer. The default is 1. |
logger.image.pullPolicy | Advanced | Introduced in version: 1.0.0 Default value: Determines when kubelet pulls the pod's Docker image. Possible values include:
For more information, seeUpdating images. |
logger.image.tag | Advanced | Introduced in version: 1.0.0 Default value: The version label for this service's Docker image. |
logger.image.url | Advanced | Introduced in version: 1.0.0 Default value: The location of the Docker image for this service. |
logger.livenessProbe.failureThreshold | Advanced | Introduced in version: 1.0.0 Default value: The number of times Kubernetes will verify that liveness probes have failed before restarting the container. The minimum value is 1. |
logger.livenessProbe.initialDelaySeconds | Advanced | Introduced in version: 1.0.0 Default value: The number of seconds after a container is started before a liveness probe is initiated. |
logger.livenessProbe.periodSeconds | Advanced | Introduced in version: 1.0.0 Default value: Determines how often to perform a liveness probe, in seconds. The minimum value is 1. |
logger.livenessProbe.successThreshold | Advanced | Introduced in version: 1.0.0 Default value: The minimum consecutive successes needed for a liveness probe to be considered successful after a failure. The minimum value is 1. |
logger.livenessProbe.timeoutSeconds | Advanced | Introduced in version: 1.0.0 Default value: The number of seconds after which a liveness probe times out. The minimum value is 1. |
logger.nodeSelector.key | Basic | Introduced in version: 1.0.0 Default value: Required Node selector label key used to target dedicated Kubernetes nodes for |
logger.nodeSelector.value | Basic | Introduced in version: 1.0.0 Default value: Required Node selector label value used to target dedicated Kubernetes nodes for |
logger.proxyURL | Basic | Introduced in version: 1.0.0 Default value: None URL of the customer's proxy server. |
logger.resources.limits.cpu | Advanced | Introduced in version: 1.0.0 Default value: The CPU limit for the resource in a Kubernetes container, in millicores. |
logger.resources.limits.memory | Advanced | Introduced in version: 1.0.0 Default value: The memory limit for the resource in a Kubernetes container, in mebibytes. |
logger.resources.requests.cpu | Advanced | Introduced in version: 1.0.0 Default value: The CPU needed for normal operation of the resource in a Kubernetes container, in millicores. |
logger.resources.requests.memory | Advanced | Introduced in version: 1.0.0 Default value: The memory needed for normal operation of the resource in a Kubernetes container, in mebibytes. |
logger.serviceAccountPath | Basic | Introduced in version: 1.0.0 Default value: None One of either Path to Google Service Account key file withLogs Writer role. |
logger.serviceAccountRef | Basic | Introduced in version: 1.2.0 Default value: None One of either |
logger.terminationGracePeriodSeconds | Advanced | Introduced in version: 1.0.0 Default value: The time between a request for pod deletion and when the pod is killed, in seconds. During this period, any prestop hooks will be executed and any running process should terminate gracefully. |
mart
Defines the MART (Management API for RunTime data) service, which acts as an API provider forpublic Apigee APIs so that you can access and manage runtime data entities such as KMS (API Keys andOAuth tokens), KVM, Quota, and API products.
The following table describes the properties of themart object:
| Property | Description |
|---|---|
mart.annotations | Introduced in version: 1.5.0 Default value: None Optional key/value map used to annotate pods. For more information, seeCustom annotations. |
mart.hostAlias | Introduced in version: 1.0.0 Default value: None The host alias pointing to theMART object. You can set this property to |
mart.image.pullPolicy | Introduced in version: 1.0.0 Default value: Determines when kubelet pulls the pod's Docker image. Possible values include:
For more information, seeUpdating images. |
mart.image.tag | Introduced in version: 1.0.0 Default value: The version label for this service's Docker image. |
mart.image.url | Introduced in version: 1.0.0 Default value: The location of the Docker image for this service. Check the |
mart.initCheckCF.resources.requests.cpu | Introduced in version: 1.0.0 Default value: The amount of CPU resources allocated to the initialization check of the Cloud Foundry process. |
mart.livenessProbe.failureThreshold | Introduced in version: 1.0.0 Default value: The number of times Kubernetes will verify that liveness probes have failed before restarting the container. The minimum value is 1. |
mart.livenessProbe.initialDelaySeconds | Introduced in version: 1.0.0 Default value: The number of seconds after a container is started before a liveness probe is initiated. |
mart.livenessProbe.periodSeconds | Introduced in version: 1.0.0 Default value: Determines how often to perform a liveness probe, in seconds. The minimum value is 1. |
mart.livenessProbe.timeoutSeconds | Introduced in version: 1.0.0 Default value: The number of seconds after which a liveness probe times out. The minimum value is 1. |
mart.metricsURL | Introduced in version: 1.0.0 Default value: |
mart.nodeSelector.key | Introduced in version: 1.0.0 Default value: None Optional node selector label key for targeting Kubernetes nodes for |
mart.nodeSelector.value | Introduced in version: 1.0.0 Default value: None Optional node selector label value for targeting Kubernetes nodes for |
mart.readinessProbe.failureThreshold | Introduced in version: 1.0.0 Default value: The number of times Kubernetes will verify that readiness probes have failed before marking the podunready. The minimum value is 1. |
mart.readinessProbe.initialDelaySeconds | Introduced in version: 1.0.0 Default value: The number of seconds after a container is started before a readiness probe is initiated. |
mart.readinessProbe.periodSeconds | Introduced in version: 1.0.0 Default value: Determines how often to perform a readiness probe, in seconds. The minimum value is 1. |
mart.readinessProbe.successThreshold | Introduced in version: 1.0.0 Default value: The minimum consecutive successes needed for a readiness probe to be considered successful after a failure. The minimum value is 1. |
mart.readinessProbe.timeoutSeconds | Introduced in version: 1.0.0 Default value: The number of seconds after which a liveness probe times out. The minimum value is 1. |
mart.replicaCountMax | Introduced in version: 1.0.0 Default value: Maximum number of replicas available for autoscaling. |
mart.replicaCountMin | Introduced in version: 1.0.0 Default value: Minimum number of replicas available for autoscaling. |
mart.resources.requests.cpu | Introduced in version: 1.0.0 Default value: The CPU needed for normal operation of the resource in a Kubernetes container, in millicores. |
mart.resources.requests.memory | Introduced in version: 1.0.0 Default value: The memory needed for normal operation of the resource in a Kubernetes container, in mebibytes. |
mart.serviceAccountPath | Introduced in version: 1.1.1 Default value: None One of either Path to Google Service Account key file withno role. |
mart.serviceAccountRef | Introduced in version: 1.2.0 Default value: None One of either |
mart.sslCertPath | Introduced in version: 1.0.0 Default value: None Either Local file system path for loading and encoding the SSL cert to a Secret. |
mart.sslKeyPath | Introduced in version: 1.0.0 Default value: None Either Local file system path for loading and encoding the SSL key to a Secret. |
mart.sslSecret | Introduced in version: 1.2.0 Default value: None Either The name of a file stored in a Kubernetes secret that contains the TLS certificate and private key. You must create the secret using the TLS certificate and key data as its input. See also:
|
mart.targetCPUUtilizationPercentage | Introduced in version: 1.0.0 Default value: Target CPU utilization for the MART process on the pod. The value of this field enables MART to auto-scale when CPU utilization reaches this value, up to |
mart.terminationGracePeriodSeconds | Introduced in version: 1.0.0 Default value: The time between a request for pod deletion and when the pod is killed, in seconds. During this period, any prestop hooks will be executed and any running process should terminate gracefully. |
metrics
Defines the service that collects operations metrics. You can use metrics data to monitor thehealth of Hybrid services, to set up alerts, and so on.
For more information, seeMetrics collection overview.
The following table describes the properties of themetrics object:
| Property | Description |
|---|---|
metrics.adapter.pullPolicy | Introduced in version: 1.8.1 Default value: Determines when kubelet pulls the pod's Docker image. Possible values include:
For more information, seeUpdating images. |
metrics.adapter.tag | Introduced in version: 1.8.1 Default value: The version label for this service's Docker image. |
metrics.adapter.url | Introduced in version: 1.8.1 Default value: The location of the Docker image for this service. |
metrics.aggregator.resources.requests.cpu | Introduced in version: 1.4.0 Default value: The CPU needed for normal operation of the aggregator in a Kubernetes container, in millicores. |
metrics.aggregator.resources.requests.memory | Introduced in version: 1.4.0 Default value: The memory needed for normal operation of the aggregator in a Kubernetes container, in mebibytes. |
metrics.aggregator.resources.limits.cpu | Introduced in version: 1.4.0 Default value: The CPU limit for the aggregator resource in a Kubernetes container, in millicores. |
metrics.aggregator.resources.limits.memory | Introduced in version: 1.4.0 Default value: The memory limit for the aggregator resource in a Kubernetes container, in gibibytes. |
metrics.annotations | Introduced in version: 1.5.0 Default value: None Optional key/value map used to annotate pods. For more information, seeCustom annotations. |
metrics.app.resources.requests.cpu | Introduced in version: 1.4.0 Default value: The CPU needed for normal operation of the app in a Kubernetes container, in millicores. |
metrics.app.resources.requests.memory | Introduced in version: 1.4.0 Default value: The memory needed for normal operation of the app in a Kubernetes container, in mebibytes. |
metrics.app.resources.limits.cpu | Introduced in version: 1.4.0 Default value: The CPU limit for the app resource in a Kubernetes container, in millicores. |
metrics.app.resources.limits.memory | Introduced in version: 1.4.0 Default value: The memory limit for the app resource in a Kubernetes container, in gibibytes. |
metrics.appStackdriverExporter.resources.requests.cpu | Introduced in version: 1.7.0 Default value: The CPU needed for normal operation of the stackdriverExporter in a Kubernetes container, in millicores. |
metrics.appStackdriverExporter.resources.requests.memory | Introduced in version: 1.7.0 Default value: The memory needed for normal operation of the stackdriverExporter in a Kubernetes container, in mebibytes. |
metrics.appStackdriverExporter.resources.limits.cpu | Introduced in version: 1.7.0 Default value: The CPU limit for the stackdriverExporter resource in a Kubernetes container, in millicores. |
metrics.appStackdriverExporter.resources.limits.memory | Introduced in version: 1.7.0 Default value: The memory limit for the stackdriverExporter resource in a Kubernetes container, in gibibytes. |
metrics.enabled | Introduced in version: 1.0.0 Default value: Enables Apigee metrics. Set to |
metrics.nodeSelector.key | Introduced in version: 1.0.0 Default value: None Required Node selector label key used to target dedicated Kubernetes nodes for |
metrics.nodeSelector.value | Introduced in version: 1.0.0 Default value: None Required Node selector label value used to target dedicated Kubernetes nodes for |
metrics.prometheus.args.storage_tsdb_retention | Introduced in version: 1.0.0 Default value: The amount of time Prometheus waits before removing old data from local storage, in hours. |
metrics.prometheus.containerPort | Introduced in version: 1.0.0 Default value: The port to connect to the Prometheus metrics service. |
metrics.prometheus.image.pullPolicy | Introduced in version: 1.0.0 Default value: Determines when kubelet pulls the pod's Docker image. Possible values include:
For more information, seeUpdating images. |
metrics.prometheus.image.tag | Introduced in version: 1.0.0 Default value: The version label for this service's Docker image. |
metrics.prometheus.image.url | Introduced in version: 1.0.0 Default value: The location of the Docker image for this service. |
metrics.prometheus.livenessProbe.failureThreshold | Introduced in version: 1.0.0 Default value: The number of times Kubernetes will verify that liveness probes have failed before restarting the container. The minimum value is 1. |
metrics.prometheus.livenessProbe.periodSeconds | Introduced in version: 1.0.0 Default value: Determines how often to perform a liveness probe, in seconds. The minimum value is 1. |
metrics.prometheus.livenessProbe.timeoutSeconds | Introduced in version: 1.0.0 Default value: The number of seconds after which a liveness probe times out. The minimum value is 1. |
metrics.prometheus.readinessProbe.failureThreshold | Introduced in version: 1.0.0 Default value: The number of times Kubernetes will verify that readiness probes have failed before marking the podunready. The minimum value is 1. |
metrics.prometheus.readinessProbe.periodSeconds | Introduced in version: 1.0.0 Default value: Determines how often to perform a readiness probe, in seconds. The minimum value is 1. |
metrics.prometheus.readinessProbe.timeoutSeconds | Introduced in version: 1.0.0 Default value: The number of seconds after which a liveness probe times out. The minimum value is 1. |
metrics.prometheus.sslCertPath | Introduced in version: 1.0.0 Default value: None Required Path to the SSL cert for the Prometheus metrics collection process. Prometheus is a tool Apigee can use for collecting and processing metrics. See:
|
metrics.prometheus.sslKeyPath | Introduced in version: 1.0.0 Default value: None Required Path to the SSL Key for the Prometheus metrics collection process. Prometheus is a tool Apigee can use for collecting and processing metrics. See:
|
metrics.proxy.resources.requests.cpu | Introduced in version: 1.4.0 Default value: The CPU needed for normal operation of the proxy in a Kubernetes container, in millicores. |
metrics.proxy.resources.requests.memory | Introduced in version: 1.4.0 Default value: The memory needed for normal operation of the proxy in a Kubernetes container, in mebibytes. |
metrics.proxy.resources.limits.cpu | Introduced in version: 1.4.0 Default value: The CPU limit for the proxy resource in a Kubernetes container, in millicores. |
metrics.proxy.resources.limits.memory | Introduced in version: 1.4.0 Default value: The memory limit for the proxy resource in a Kubernetes container, in gibibytes. |
metrics.proxyStackdriverExporter.resources.requests.cpu | Introduced in version: 1.7.0 Default value: The CPU needed for normal operation of the stackdriverExporter in a Kubernetes container, in millicores. |
metrics.proxyStackdriverExporter.resources.requests.memory | Introduced in version: 1.7.0 Default value: The memory needed for normal operation of the stackdriverExporter in a Kubernetes container, in mebibytes. |
metrics.proxyStackdriverExporter.resources.limits.cpu | Introduced in version: 1.7.0 Default value: The CPU limit for the stackdriverExporter resource in a Kubernetes container, in millicores. |
metrics.proxyStackdriverExporter.resources.limits.memory | Introduced in version: 1.7.0 Default value: The memory limit for the stackdriverExporter resource in a Kubernetes container, in gibibytes. |
metrics.proxyURL | Introduced in version: 1.0.0 Default value: None URL for the metrics process sidecar proxy in the Kubernetes cluster. |
metrics.sdSidecar.containerPort | Introduced in version: 1.0.0 Default value: The port for connecting to the Cloud Monitoring metrics service. |
metrics.sdSidecar.image.pullPolicy | Introduced in version: 1.0.0 Default value: Determines when Kubelet pulls this service's Docker image. Possible values include:
|
metrics.sdSidecar.image.tag | Introduced in version: 1.0.0 Default value: The version label for this service's Docker image. |
metrics.sdSidecar.image.url | Introduced in version: 1.0.0 Default value: The location of the Docker image for this service. |
metrics.serviceAccountPath | Introduced in version: 1.0.0 Default value: None One of either Path to Google Service Account key file withMonitoring Metric Writer role. |
metrics.serviceAccountRef | Introduced in version: 1.2.0 Default value: None One of either |
metrics.stackdriverExporter.resources.requests.cpu | Introduced in version: 1.4.0 Deprecated: Starting in Hybrid version 1.8, |
metrics.stackdriverExporter.resources.requests.memory | Introduced in version: 1.4.0 Deprecated: Starting in Hybrid version 1.8, |
metrics.stackdriverExporter.resources.limits.cpu | Introduced in version: 1.4.0 Deprecated: Starting in Hybrid version 1.8, |
metrics.stackdriverExporter.resources.limits.memory | Introduced in version: 1.4.0 Deprecated: Starting in Hybrid version 1.8, |
metrics.terminationGracePeriodSeconds | Introduced in version: 1.0.0 Default value: The time between a request for pod deletion and when the pod is killed, in seconds. During this period, any prestop hooks will be executed and any running process should terminate gracefully. |
mintTaskScheduler
mintTaskScheduler is the cron job to schedule monetization tasks, like recurring fee calculation on a periodic basis.
The following table describes the properties of themintTaskScheduler object:
| Property | Description |
|---|---|
mintTaskScheduler.image.pullPolicy | Introduced in version: 1.7.0 Default value: Determines when kubelet pulls the pod's Docker image. Possible values include:
For more information, seeUpdating images. |
mintTaskScheduler.image.tag | Introduced in version: 1.7.0 Default value: The version label for this service's Docker image. |
mintTaskScheduler.image.url | Introduced in version: 1.7.0 Default value: The location of the Docker image for this service. |
nodeSelector
ThenodeSelector object defines the node for your Apigee instance. Behind the scenes whenapigeectl runs, it is taking care to map the label key/value forapigeeRuntime andapigeeData to the individual Istio and MART components. You can override this for individual objects in themart:nodeSelector property.
The following table describes the properties of thenodeSelector object:
| Property | Description |
|---|---|
nodeSelector.apigeeData.key | Introduced in version: 1.0.0 Default value: ApigeeData is the node for the Cassandra database. Node selector label key for targeting Kubernetes nodes for working with Apigee services data. |
nodeSelector.apigeeData.value | Introduced in version: 1.0.0 Default value: apigee-data is the node for the Cassandra database. Node selector label value for targeting Kubernetes nodes for working with Apigee services data. |
nodeSelector.apigeeRuntime.key | Introduced in version: 1.0.0 Default value: Apigee Runtime is the node for the runtime environment for the project. Node selector label key for targeting Kubernetes nodes for Apigee runtime services. |
nodeSelector.apigeeRuntime.value | Introduced in version: 1.0.0 Default value:
|
nodeSelector.requiredForScheduling | Introduced in version: 1.0.0 Default value: false The For production, |
redis
The following table describes the properties of theredis object:
| Property | Description |
|---|---|
redis.auth.password | Introduced in version: 1.6.0 Default value: Required Password for the Redis administrator. The admin user is used for any administrative activities performed on the Redis cluster. |
redis.envoy.pullPolicy | Introduced in version: 1.6.0 Default value: Determines when kubelet pulls the pod's Docker image. Possible values include:
For more information, seeUpdating images. |
redis.envoy.tag | Introduced in version: 1.6.0 Default value: The version label for this service's Docker image. |
redis.envoy.url | Introduced in version: 1.6.0 Default value: The location of the Docker image for this service. |
redis.image.pullPolicy | Introduced in version: 1.6.0 Default value: Determines when kubelet pulls the pod's Docker image. Possible values include:
For more information, seeUpdating images. |
redis.image.tag | Introduced in version: 1.6.0 Default value: The version label for this service's Docker image. |
redis.image.url | Introduced in version: 1.6.0 Default value: The location of the Docker image for this service. |
redis.replicaCount | Introduced in version: 1.6.0 Default value: Redis is a replicated storage. This property specifies the number of Redis nodes employed as aStatefulSet. |
redis.resources.requests.cpu | Introduced in version: 1.6.0 Default value: The CPU needed for normal operation of the resource in a Kubernetes container, in millicores. Apigee recommends a value from500m to1000m. With 0.5 cores, a Redis node can typically handle 10K QPS. With 1.0 core, it can typically handle 20K QPS. CPU request resources above 1000m are not helpful in most cases. |
runtime
The following table describes the properties of theruntime object:
| Property | Description |
|---|---|
runtime.annotations | Introduced in version: 1.5.0 Default value: None Optional key/value map used to annotate pods. For more information, seeCustom annotations. |
runtime.image.pullPolicy | Introduced in version: 1.0.0 Default value: Determines when kubelet pulls the pod's Docker image. Possible values include:
For more information, seeUpdating images. |
runtime.image.tag | Introduced in version: 1.0.0 Default value: The version label for this service's Docker image. |
runtime.image.url | Introduced in version: 1.0.0 Default value:URL to your installation's image resource, for example: The location of the Docker image for this service. |
runtime.livenessProbe.failureThreshold | Introduced in version: 1.0.0 Default value: The number of times Kubernetes will verify that liveness probes have failed before restarting the container. The minimum value is 1. |
runtime.livenessProbe.initialDelaySeconds | Introduced in version: 1.0.0 Default value: The number of seconds after a container is started before a liveness probe is initiated. |
runtime.livenessProbe.periodSeconds | Introduced in version: 1.0.0 Default value: Determines how often to perform a liveness probe, in seconds. The minimum value is 1. |
runtime.livenessProbe.timeoutSeconds | Introduced in version: 1.0.0 Default value: The number of seconds after which a liveness probe times out. The minimum value is 1. |
runtime.nodeSelector.key | Introduced in version: 1.0.0 Default value: None Optional Node selector label key for targeting Kubernetes nodes for |
runtime.nodeSelector.value | Introduced in version: 1.0.0 Default value: None Node selector label value for targeting Kubernetes nodes for |
runtime.readinessProbe.failureThreshold | Introduced in version: 1.0.0 Default value: The number of times Kubernetes will verify that readiness probes have failed before marking the podunready. The minimum value is 1. |
runtime.readinessProbe.initialDelaySeconds | Introduced in version: 1.0.0 Default value: The number of seconds after a container is started before a readiness probe is initiated. |
runtime.readinessProbe.periodSeconds | Introduced in version: 1.0.0 Default value: Determines how often to perform a readiness probe, in seconds. The minimum value is 1. |
runtime.readinessProbe.successThreshold | Introduced in version: 1.0.0 Default value: The minimum consecutive successes needed for a readiness probe to be considered successful after a failure. The minimum value is 1. |
runtime.readinessProbe.timeoutSeconds | Introduced in version: 1.0.0 Default value: The number of seconds after which a liveness probe times out. The minimum value is 1. |
runtime.replicaCountMax | Introduced in version: 1.0.0 Default value: Maximum number of replicas available for autoscaling. |
runtime.replicaCountMin | Introduced in version: 1.0.0 Default value: Minimum number of replicas available for autoscaling. |
runtime.resources.requests.cpu | Introduced in version: 1.0.0 Default value: The CPU needed for normal operation of the resource in a Kubernetes container, in millicores. Note:To achieve smooth autoscaling of the message processors to accommodate traffic increases, we recommend that you do not exceed two cores (2000 millicores) if you decide to override the default.Apigee runtime components are bounded by I/O, and adding more CPU capacity does not always help with traffic increases. When there are high CPU requests, message processors may not autoscale and liveliness probes may fail with high traffic. |
runtime.resources.requests.memory | Introduced in version: 1.0.0 Default value: The memory needed for normal operation of the resource in a Kubernetes container, in mebibytes ( runtime.resources.requests.memory to at least1Gi in youroverrides.yaml. The default of512Mi is enough for initial operation and configuration, but should be raised for production.To achieve smooth autoscaling of the message processors to accommodate traffic increases, we recommend that you do not exceed 2.5Gi (2560Mi) if you decide to override the default. |
runtime.service.type | Introduced in version: 1.0.0 Default value: The type of service. You can set this to a service other than ClusterIP; for example, |
runtime.targetCPUUtilizationPercentage | Introduced in version: 1.0.0 Default value: Target CPU utilization for the runtime process on the pod. The value of this field enables the runtime to auto-scale when CPU utilization reaches this value, up to |
runtime.terminationGracePeriodSeconds | Introduced in version: 1.0.0 Default value: The time between a request for pod deletion and when the pod is killed, in seconds. During this period, any prestop hooks will be executed and any running process should terminate gracefully. |
synchronizer
Ensures that the Message Processors are kept up to date with the latest deployed API proxy bundles. To do this, the Synchronizer polls the management plane; when a new contract is detected, the Synchronizer sends it to the runtime plane. By default, Synchronizer stores environment configuration data in Cassandra.
For more information, seeConfigure the Synchronizer.
The following table describes the properties of thesynchronizer object:
| Property | Description |
|---|---|
synchronizer.annotations | Introduced in version: 1.5.0 Default value: None Optional key/value map used to annotate pods. For more information, seeCustom annotations. |
synchronizer.image.pullPolicy | Introduced in version: 1.0.0 Default value: Determines when kubelet pulls the pod's Docker image. Possible values include:
For more information, seeUpdating images. |
synchronizer.image.tag | Introduced in version: 1.0.0 Default value: The version label for this service's Docker image. |
synchronizer.image.url | Introduced in version: 1.0.0 Default value: The location of the Docker image for this service. |
synchronizer.livenessProbe.failureThreshold | Introduced in version: 1.0.0 Default value: The number of times Kubernetes will verify that liveness probes have failed before restarting the container. The minimum value is 1. |
synchronizer.livenessProbe.initialDelaySeconds | Introduced in version: 1.0.0 Default value: The number of seconds after a container is started before a liveness probe is initiated. |
synchronizer.livenessProbe.periodSeconds | Introduced in version: 1.0.0 Default value: Determines how often to perform a liveness probe, in seconds. The minimum value is 1. |
synchronizer.livenessProbe.timeoutSeconds | Introduced in version: 1.0.0 Default value: The number of seconds after which a liveness probe times out. The minimum value is 1. |
synchronizer.nodeSelector.key | Introduced in version: 1.0.0 Default value: None Required Optional node selector label key for targeting Kubernetes nodes for SeenodeSelector. |
synchronizer.nodeSelector.value | Introduced in version: 1.0.0 Default value: None Optional node selector label value used for targeting Kubernetes nodes for SeenodeSelector. |
synchronizer.pollInterval | Introduced in version: 1.0.0 Default value: The length of time that Synchronizer waits between polling operations. Synchronizer polls Apigee control plane services to detect and pull new runtime contracts. |
synchronizer.readinessProbe.failureThreshold | Introduced in version: 1.0.0 Default value: The number of times Kubernetes will verify that readiness probes have failed before marking the podunready. The minimum value is 1. |
synchronizer.readinessProbe.initialDelaySeconds | Introduced in version: 1.0.0 Default value: The number of seconds after a container is started before a readiness probe is initiated. |
synchronizer.readinessProbe.periodSeconds | Introduced in version: 1.0.0 Default value: Determines how often to perform a readiness probe, in seconds. The minimum value is 1. |
synchronizer.readinessProbe.successThreshold | Introduced in version: 1.0.0 Default value: The minimum consecutive successes needed for a readiness probe to be considered successful after a failure. The minimum value is 1. |
synchronizer.readinessProbe.timeoutSeconds | Introduced in version: 1.0.0 Default value: The number of seconds after which a liveness probe times out. The minimum value is 1. |
synchronizer.replicaCount | Introduced in version: 1.0.0 Deprecated: Starting in Hybrid version 1.2, manage the Synchronizer replica count with: |
synchronizer.replicaCountMax | Introduced in version: 1.2.0 Default value: Maximum number of replicas for autoscaling. |
synchronizer.replicaCountMin | Introduced in version: 1.2.0 Default value: Minimum number of replicas for autoscaling. |
synchronizer.resources.requests.cpu | Introduced in version: 1.0.0 Default value: The CPU needed for normal operation of the resource in a Kubernetes container, in millicores. |
synchronizer.resources.requests.memory | Introduced in version: 1.0.0 Default value: The memory needed for normal operation of the resource in a Kubernetes container, in gigabytes. |
synchronizer.serviceAccountPath | Introduced in version: 1.0.0 Default value: None One of either Path to Google Service Account key file withApigee Synchronizer Manager role. |
synchronizer.serviceAccountRef | Introduced in version: 1.2.0 Default value: None One of either |
synchronizer.targetCPUUtilizationPercentage | Introduced in version: 1.0.0 Default value: Target CPU utilization for the Synchronizer process on the pod. The value of this field enables Synchronizer to auto-scale when CPU utilization reaches this value, up to |
synchronizer.terminationGracePeriodSeconds | Introduced in version: 1.0.0 Default value: The time between a request for pod deletion and when the pod is killed, in seconds. During this period, any prestop hooks will be executed and any running process should terminate gracefully. |
udca
(Universal Data Collection Agent) Defines the service that runs within the data collection podin the runtime plane. This service extracts analytics and deployment status data and sends it to theUnified Analytics Platform (UAP).
For more information, seeAnalytics and deployment status datacollection.
The following table describes the properties of theudca object:
| Property | Description | |
|---|---|---|
udca.annotations | Introduced in version: 1.5.0 Default value: None Optional key/value map used to annotate pods. For more information, seeCustom annotations. | |
udca.fluentd.image.pullPolicy | Introduced in version: 1.0.0 Default value: Determines when kubelet pulls the pod's Docker image. Possible values include:
For more information, seeUpdating images. | |
udca.fluentd.image.tag | Introduced in version: 1.0.0 Default value: The version label for this service's Docker image. | |
udca.fluentd.image.url | Introduced in version: 1.0.0 Default value: The location of the Docker image for this service. | |
udca.fluentd.resources.limits.cpu | Advanced | Introduced in version: 1.0.0 Default value: The memory limit for the resource in a Kubernetes container, in mebibytes. |
udca.fluentd.resources.limits.memory | Advanced | Introduced in version: 1.0.0 Default value: The memory limit for the resource in a Kubernetes container, in mebibytes. |
udca.fluentd.resources.requests.cpu | Advanced | Introduced in version: 1.0.0 Default value: The CPU needed for normal operation of the resource in a Kubernetes container, in millicores. |
udca.fluentd.resources.requests.memory | Advanced | Introduced in version: 1.0.0 Default value: The memory needed for normal operation of the resource in a Kubernetes container, in mebibytes. |
udca.image.pullPolicy | Advanced | Introduced in version: 1.0.0 Default value: IfNotPresent Determines when kubelet pulls the pod's Docker image. Possible values include:
For more information, seeUpdating images. |
udca.image.tag | Advanced | Introduced in version: 1.0.0 Default value: The version label for this service's Docker image. |
udca.image.url | Advanced | Introduced in version: 1.0.0 Default value: The location of the Docker image for this service. |
udca.jvmXms | Advanced | Introduced in version: 1.0.0 Deprecated: Starting in Hybrid version 1.8, |
udca.jvmXmx | Advanced | Introduced in version: 1.0.0 Deprecated: Starting in Hybrid version 1.8, |
udca.livenessProbe.failureThreshold | Advanced | Introduced in version: 1.0.0 Default value: The number of times Kubernetes will verify that liveness probes have failed before restarting the container. The minimum value is 1. |
udca.livenessProbe.initialDelaySeconds | Advanced | Introduced in version: 1.0.0 Default value: The number of seconds after a container is started before a liveness probe is initiated. |
udca.livenessProbe.periodSeconds | Advanced | Introduced in version: 1.0.0 Default value: Determines how often to perform a liveness probe, in seconds. The minimum value is 1. |
udca.livenessProbe.timeoutSeconds | Advanced | Introduced in version: 1.0.0 Default value: The number of seconds after which a liveness probe times out. The minimum value is 1. |
udca.nodeSelector.key | Basic | Introduced in version: 1.0.0 Default value: None Required Node selector label key used to target dedicated Kubernetes nodes for |
udca.nodeSelector.value | Basic | Introduced in version: 1.0.0 Default value: None Required Node selector label value used to target dedicated Kubernetes nodes for |
udca.pollingIntervalInSec | Advanced | Introduced in version: 1.0.0 Default value: The length of time, in seconds, that UDCA waits between polling operations. UDCA polls the data directory on the data collection pod's file system to detect new files to be uploaded. |
udca.replicaCountMax | Basic | Introduced in version: 1.0.0 Default value: The maximum number of pods that hybrid can automatically add for the UDCA deployment. Because UDCA is implemented as a ReplicaSet, the pods are replicas. It is recommended to set udca.replicaCountMax to the maximum number of replicas for a single environment. SeeorgScopedUDCA. |
udca.replicaCountMin | Basic | Introduced in version: 1.0.0 Default value: The minimum number of pods for the UDCA deployment. Because UDCA is implemented as a ReplicaSet, the pods are replicas. If the CPU usage goes above |
udca.resources.limits.cpu | Advanced | Introduced in version: 1.0.0 Default value: The memory limit for the resource in a Kubernetes container, in mebibytes. |
udca.resources.limits.memory | Advanced | Introduced in version: 1.0.0 Default value: The memory limit for the resource in a Kubernetes container, in mebibytes. |
udca.resources.requests.cpu | Advanced | Introduced in version: 1.0.0 Default value: The CPU needed for normal operation of the resource in a Kubernetes container, in millicores. |
udca.resources.requests.memory | Advanced | Introduced in version: 1.0.0 Default value: The memory needed for normal operation of the resource in a Kubernetes container, in mebibytes. |
udca.revision | Introduced in version: 1.0.0 Default value: A static value that is populated in a label to enable canary deployments. | |
udca.serviceAccountPath | Introduced in version: 1.0.0 Default value: None One of either Path to Google Service Account key file withApigee Analytics Agent role. | |
udca.serviceAccountRef | Introduced in version: 1.2.0 Default value: None One of either | |
udca.targetCPUUtilizationPercentage | Introduced in version: 1.0.0 Default value: The threshold of CPU usage for scaling the number of pods in the ReplicaSet, as a percentage of total available CPU resources. Hybrid uses the combined utilization of all containers in the data collection pod (both fluentd and UDCA) to calculate the current utilization. When CPU usage goes above this value, then hybrid will gradually increase the number of pods in the ReplicaSet, up to | |
udca.terminationGracePeriodSeconds | Introduced in version: 1.0.0 Default value: The time between a request for pod deletion and when the pod is killed, in seconds. During this period, any prestop hooks will be executed and any running process should terminate gracefully. |
virtualhosts
Thevirtualhosts property is a required configuration property. Virtual hosts allow Apigee hybrid to handle API requests to a specified environment group..
For more information, seeConfigure virtual hosts.
The following table describes the properties of thevirtualhosts object:
| Property | Description | |
|---|---|---|
virtualhosts[].additionalGateways | Introduced in version: 1.2.0 Default value: None A list of Istio Gateways to route traffic to. | |
virtualhosts[].cipherSuites[] | Advanced | Introduced in version: 1.8.7 Default value: None The list of TLS ciphers. You can find the full list of supported ciphers in the documentation for theBoring FIPS build of Envoy. A blank value defaults to the cipher suites supported by the Boring FIPS build of Envoy. For example, to support TLS v.1.1: virtualhosts:- name: ENV_GROUP_NAME minTLSProtocolVersion: "1.1" cipherSuites: - "ECDHE-ECDSA-AES128-GCM-SHA256" - "ECDHE-RSA-AES128-GCM-SHA256" - "ECDHE-ECDSA-AES256-GCM-SHA384" - "ECDHE-RSA-AES256-GCM-SHA384" - "ECDHE-ECDSA-CHACHA20-POLY1305" - "ECDHE-RSA-CHACHA20-POLY1305" - "ECDHE-ECDSA-AES128-SHA" - "ECDHE-RSA-AES128-SHA" - "ECDHE-ECDSA-AES256-SHA" - "ECDHE-RSA-AES256-SHA" ... |
virtualhosts[].name | Introduced in version: 1.2.0 Default value: None Required The name of the virtual host. | |
virtualhosts[].hostAliases[] | Introduced in version: 1.2.0 Default value: None Required Deprecated: Starting in Hybrid version 1.4 the runtime plane receives this information from the management plane. SeeAbout environments and environment groups. | |
virtualhosts[].maxTLSProtocolVersion | Introduced in version: 1.3.0 Default value: None The maximum version of the TLS protocol Envoy can select. Envoy automatically uses the optimal TLS protocol version between The value must be in the form of a number. For example: virtualhosts: - name: default maxTLSProtocolVersion: "1.3" Where the number represents the TLS version number in the form See also | |
virtualhosts[].minTLSProtocolVersion | Introduced in version: 1.3.0 Default value: None The minimum version of the TLS protocol Envoy can select. Envoy automatically uses the optimal TLS protocol version between The value must be in the form of a number. For example: virtualhosts: - name: default minTLSProtocolVersion: "1.2" Where the number represents the TLS version number in the form See also | |
virtualhosts[].selector | Introduced in version: 1.2.0 Default value: Required A key-value selector-value pair for pointing to different ingress selectors.
If no selector label is supplied, the configuration is supplied to both Apigee ingress gateway and customer-installed Anthos Service Mesh. | |
virtualhosts[].sslCertPath | Introduced in version: 1.2.0 Default value: None Either The path on your system to a TLS certificate file. Note: For each configured environment, the Common Name (CN) in the cert must match the domain in thehostAliases[] property. For example, if the CN is*.example.com, thehostAliases[] could befoo.example.com orbar.example.com. | |
virtualhosts[].sslKeyPath | Introduced in version: 1.2.0 Default value: None Either The path on your system to the TLS private key file. | |
virtualhosts[].sslSecret | Introduced in version: 1.2.0 Default value: None Either The name of a file stored in a Kubernetes secret that contains the TLS certificate and private key. You must create the secret using the TLS certificate and key data as its input. See also:
|
watcher
Thewatcher property is a required configuration property. The watcher is a process that watches for configuration changes and triggers their application to the runtime plane..
The following table describes the properties of thewatcher object:
| Property | Description |
|---|---|
watcher.annotations | Introduced in version: 1.5.0 Default value: None Optional key/value map used to annotate pods. For more information, seeCustom annotations. |
watcher.image.pullPolicy | Introduced in version: 1.4.0 Default value: Determines when kubelet pulls the pod's Docker image. Possible values include:
For more information, seeUpdating images. |
watcher.image.tag | Introduced in version: 1.4.0 Default value: The version label for this service's Docker image. |
watcher.image.url | Introduced in version: 1.4.0 Default value: he location of the Docker image for this service. |
watcher.replicaCountMax | Introduced in version: 1.3.0 Default value: The maximum number of watcher replicas. This should be kept at |
watcher.replicaCountMin | Introduced in version: 1.3.0 Default value: The minimum number of watcher replicas. |
watcher.serviceAccountPath | Introduced in version: 1.3.0 Default value: None Required. Path to Google Service Account key file withApigee Runtime Agent role. |
watcher.serviceAccountRef | Introduced in version: 1.3.0 Default value: None One of either serviceAccountPath or serviceAccountRef is required. |
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2026-02-18 UTC.