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.

Top-level properties

The following table describes the top-level properties in the overrides.yaml file:

Property Description
gcpProjectID Version: Beta2

Default value: none

Required

Your GCP project ID. This ID determines where logger and metrics data will be pushed.

gcpRegion Version: Beta2

Default value: us-central1

Required

The region or zone in which your Kubernetes cluster is located.

imagePullSecrets.0.name Version: Beta

Default value: none

Kubernetes secret name configured as docker-registry type; used to pull images from private repo.

k8sClusterName

Type:

Version: Beta2

Default value: none

The name of your Kubernetes cluster.

namespace Version: Beta2

Default value: apigee

The namespace of your Kubernetes cluster.

org Required

Version: Beta2

Default value: none

Required

The Hybrid-enabled organization that was provisioned for you by Apigee during the Hybrid installation.

authz

The following table describes the properties of the authz object:

Property Description
authz.image.pullPolicy Version: Beta2

Default value: IfNotPresent

Determines when kubelet pulls the pod's Docker image. Possible values include:

  • IfNotPresent: Do not pull a new image if it already exists.
  • Always: Always pull the image, regardless of whether it exists already.

For more information, see Updating images.

authz.image.tag Version: Beta2

Default value: "1.0.0-beta2"

The version label for this service's Docker image.

authz.image.url Version: Beta2

Default value: "google/apigee-authn-authz"

The location of the Docker image for this service.

authz.livenessProbe.failureThreshold Version: Beta2

Default value: 2

The number of times Kubernetes will verify that liveness probes have failed before restarting the container. The minimum value is 1.

authz.livenessProbe.initialDelaySeconds Version: Beta2

Default value: 0

The number of seconds after a container is started before a liveness probe is initiated.

authz.livenessProbe.periodSeconds Version: Beta2

Default value: 5

Determines how often to perform a liveness probe, in seconds. The minimum value is 1.

authz.livenessProbe.timeoutSeconds Version: Beta2

Default value: 1

The number of seconds after which a liveness probe times out. The minimum value is 1.

authz.readinessProbe.failureThreshold Version: Beta2

Default value: 2

The number of times Kubernetes will verify that readiness probes have failed before marking the pod "unready". The minimum value is 1.

authz.readinessProbe.initialDelaySeconds Version: Beta2

Default value: 0

The number of seconds after a container is started before a readiness probe is initiated.

authz.readinessProbe.periodSeconds Version: Beta2

Default value: 5

Determines how often to perform a readiness probe, in seconds. The minimum value is 1.

authz.readinessProbe.successThreshold Version: Beta2

Default value: 1

The minimum consecutive successes needed for a readiness probe to be considered successful after a failure. The minimum value is 1.

authz.readinessProbe.timeoutSeconds Version: Beta2

Default value: 1

The number of seconds after which a liveness probe times out. The minimum value is 1.

authz.serviceAccountPath Version: Beta2

Default value: none

Required

Path to Google Service Account key file with "Apigee Read Only Admin" role.

cassandra

Defines the Hybrid service that manages the runtime data repository. This repository stores application configurations, distributed quota counters, API keys, and OAuth tokens for applications running on the gateway.

For more information, see Configure Cassandra.

The following table describes the properties of the cassandra object:

Property Description
cassandra.auth.admin.password Version: Beta2

Default value: none

Required

Password for the Cassandra administrator. The admin user is used for any administrative activities performed on the Cassandra cluster.

cassandra.auth.ddl.password Version: Beta2

Default value: none

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 Version: Beta2

Default value: cassandra

Required

The password for the default Cassandra user created when Authentication is enabled. This password must be reset when configuring Cassandra authentication. See Configuring TLS for Cassandra.

cassandra.auth.dml.password Version: Beta2

Default value: none

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 Version: Beta2

Default value: IfNotPresent

Determines when kubelet pulls the pod's Docker image. Possible values include:

  • IfNotPresent: Do not pull a new image if it already exists.
  • Always: Always pull the image, regardless of whether it exists already.

For more information, see Updating images.

cassandra.auth.image.tag Version: Beta2

Default value: "1.0.0-beta2"

The version label for this service's Docker image.

cassandra.auth.image.url Version: Beta2

Default value: "google/apigee-cassandra-client"

The location of the Docker image for this service.

cassandra.backup.cloudProvider Version: Beta2

Default value: "GCP"

Required if backup is enabled.

Cloud provider for backup storage.

cassandra.backup.dbStorageBucket Version: Beta2

Default value: none

Required if backup is enabled.

Cloud storage bucket for the backup data.

cassandra.backup.enabled Version: Beta2

Default value: false

Data backup is not enabled by default. To enable, set to true.

See Cassandra backup and recovery.

cassandra.backup.image.pullPolicy Version: Beta2

Default value: IfNotPresent

Determines when kubelet pulls the pod's Docker image. Possible values include:

  • IfNotPresent: Do not pull a new image if it already exists.
  • Always: Always pull the image, regardless of whether it exists already.

For more information, see Updating images.

cassandra.backup.image.tag Version: Beta2

Default value: "1.0.0-beta2"

The version label for this service's Docker image.

cassandra.backup.image.url Version: Beta2

Default value: "google/apigee-cassandra-backup-utility"

The location of the Docker image for this service.

cassandra.backup.schedule Version: Beta2

Default value: "0 2 * * *"

The schedule for the chron job.

See Cassandra backup and recovery.

cassandra.backup.serviceAccountPath Version: Beta2

Default value: none

Required if backup is enabled.

Path to Google Service Account key file with "Apigee Read Only Admin" role.

cassandra.clusterName Version: Beta2

Default value: "apigeecluster"

Specifies the name of the Cassandra cluster.

cassandra.datacenter Version: Beta2

Default value: "dc1"

Specifies the datacenter of the Cassandra node.

cassandra.externalSeedHost Version: Beta2

Default value: none

Hostname or IP of a Cassandra cluster node. If not set, the Kubernetes local service is used.

cassandra.heapNewSize Version: Beta2

Default value: 100M

The amount of JVM system memory allocated to newer objects, in megabytes.

cassandra.image.pullPolicy Version: Beta2

Default value: IfNotPresent

Determines when kubelet pulls the pod's Docker image. Possible values include:

  • IfNotPresent: Do not pull a new image if it already exists.
  • Always: Always pull the image, regardless of whether it exists already.

For more information, see Updating images.

cassandra.image.tag Version: Beta2

Default value: "1.0.0-beta2"

The version label for this service's Docker image.

cassandra.image.url Version: Beta2

Default value: "google/apigee-cassandra"

The location of the Docker image for this service.

cassandra.maxHeapSize Version: Beta2

Default value: 512M

The upper limit of JVM system memory available fo Cassandra operations, in megabytes.

cassandra.multiRegionSeedHost Version: Beta2

Default value: none

IP address of an existing Cassandra cluster used to expand the existing cluster to a new region. See Configure the multi-region seed host.

cassandra.nodeSelector.key Version: Beta2

Default value: none

Required

Node selector label key used to target dedicated Kubernetes nodes for cassandra data services.

See Add node selectors.

cassandra.nodeSelector.value Version: Beta2

Default value: none

Required

Node selector label value used to target dedicated Kubernetes nodes for cassandra data services

See Add node selectors.

cassandra.port Version: Beta2

Default value: 9042

Port number used to connect to cassandra.

cassandra.rack Version: Beta2

Default value: "ra-1"

Specifies the rack of the Cassandra node.

cassandra.readinessProbe.failureThreshold Version: Beta2

Default value: 2

The number of times Kubernetes will verify that readiness probes have failed before marking the pod "unready". The minimum value is 1.

cassandra.readinessProbe.initialDelaySeconds Version: Beta2

Default value: 0

The number of seconds after a container is started before a readiness probe is initiated.

cassandra.readinessProbe.periodSeconds Version: Beta2

Default value: 10

Determines how often to perform a readiness probe, in seconds. The minimum value is 1.

cassandra.readinessProbe.successThreshold Version: Beta2

Default value: 1

The minimum consecutive successes needed for a readiness probe to be considered successful after a failure. The minimum value is 1.

cassandra.readinessProbe.timeoutSeconds Version: Beta2

Default value: 5

The number of seconds after which a liveness probe times out. The minimum value is 1.

cassandra.replicaCount Version: Beta2

Default value: 3

Cassandra is a replicated database. It is configured to have at least 3 copies of the data in each region or data center. This property specifies the number of Cassandra nodes employed as a StatefulSet.

cassandra.resources.requests.cpu Version: Beta2

Default value: 500m

The CPU needed for normal operation of the resource in a Kubernetes container, in millicores.

cassandra.resources.requests.memory Version: Beta2

Default value: 1Gi

The memory needed for normal operation of the resource in a Kubernetes container, in mebibytes.

cassandra.restore.cloudProvider Version: Beta2

Default value: "GCP"

Required if restore is enabled.

Cloud provider for backup storage.

cassandra.restore.dbStorageBucket Version: Beta2

Default value: none

Required if restore is enabled.

Cloud storage bucket for the backup data to restore.

cassandra.restore.enabled Version: Beta2

Default value: false

cassandra.restore.image.pullPolicy Version: Beta2

Default value: IfNotPresent

Determines when kubelet pulls the pod's Docker image. Possible values include:

  • IfNotPresent: Do not pull a new image if it already exists.
  • Always: Always pull the image, regardless of whether it exists already.

For more information, see Updating images.

cassandra.restore.image.tag Version: Beta2

Default value: "1.0.0-beta2"

The version label for this service's Docker image.

cassandra.restore.image.url Version: Beta2

Default value: "google/apigee-cassandra-backup-utility"

The location of the Docker image for this service.

cassandra.restore.serviceAccountPath Version: Beta2

Default value: none

Required if restore is enabled.

Path to Google Service Account key file with "Apigee Read Only Admin" role.

cassandra.restore.snapshotTimestamp Version: Beta2

Default value: none

Required if restore is enabled.

Timestamp of the backup that should be restored.

cassandra.sslCertPath Version: Beta2

Default value: none

Required

Path to the SSL cert for the Cassandra server.

cassandra.sslKeyPath Version: Beta2

Default value: none

Required

Path to the SSL key for the Cassandra server.

cassandra.sslRootCAPath Version: Beta2

Default value: none

Required

Path to the SSL Root Certificate Authority for the Cassandra server.

cassandra.storage.awsebs.diskType Version: Beta2

Default value: gp2

The Amazon Elastic Block Store (EBS) volume type for data storage.

cassandra.storage.awsebs.encrypted Version: Beta2

Default value: "true"

Specifies whether the Amazon EBS volume should be encrypted.

cassandra.storage.awsebs.fsType Version: Beta2

Default value: ext4

The Amazon EBS file system time supported by Kubernetes.

cassandra.storage.awsebs.iopsPerGB Version: Beta2

Default value: 10

Input/Output (I/O) operations per second per GiB. This value is multiplied with the size of the requested volume to compute input/output operations per second (IOPS).

cassandra.storage.awsebs.name Version: Beta2

Default value: ebs-storage

The name of the Amazon EBS persistent storage volume.

cassandra.storage.capacity Version: Beta2

Default value: 50Gi

Required

Specifies the disk size required, in mebibytes.

cassandra.storage.gcepd.diskType Version: Beta2

Default value: pd-ssd

Required

The Google Compute Engine persistent disk (GCEPD) type to consume.

cassandra.storage.gcepd.name Version: Beta2

Default value: gce-storage

Required

The name of the GCE persistent disk used for persistent volume storage.

cassandra.storage.gcepd.replicationType Version: Beta2

Default value: none

If you are using a GKE cluster, check this property. If you set up a Zonal location, set replicationType to none. If you set up a Regional location (recommended), the value must be regional-pd.

cassandra.storage.local.name Version: Beta2

Default value: local-storage

Required

The name of the local storage persistent volume.

cassandra.storage.local.nodes Version: Beta2

Default value: node1

Required

An array of Kubernetes hostnames to use for creating local storage persistent volumes on each node.

cassandra.storage.local.path Version: Beta2

Default value: /apigee/data

Required

The path to the local storage persistent volume.

cassandra.storage.type Version: Beta2

Default value: gcepd

Required

The storage type to use for cassandra data. Possible values include:

  • local
  • gcepd
  • awsebs
cassandra.terminationGracePeriodSeconds Version: Beta2

Default value: 300

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.

envs

Defines an array of environments to which you can deploy your API proxies. Each environment provides an isolated context or "sandbox" for running API proxies.

Your Hybrid-enabled organization must have at least one environment.

For more information, see Configure environments.

The following table describes the properties of the envs object:

Property Description
envs[].cacheEncryptionKeyPath Version: Beta2

Default value: none

Required

Local file system path for the cache Apigee cache data's encryption key.

envs[].hostAlias Version: Beta2

Default value: none

Required

The DNS name for your server. For example, foo-test.mydomain.com. If you don't have a DNS name, you can use a wildcard ('*'). If you use a wildcard, then you can use the EXTERNAL IP of the istio-ingressgateway, which you can obtain by calling kubectl get services -n namespace after you complete the installation.

If you have multiple environments, you must use a unique host alias name for each one. For example, foo-test.mydomain.com and foo-prod.mydomain.com.

envs[].kmsEncryptionKeyPath Version: Beta2

Default value: none

Required

Local file system path for the Apigee KMS data's encryption key.

envs[].name Version: Beta2

Default value: none

Required

Apigee environment name to be synchronized.

envs[].pollInterval Version: Beta2

Default value: none

Interval used for polling organization and environment synchronization changes, in seconds.

envs[].port Version: Beta2

Default value: none

TCP port number for HTTPS traffic.

envs[].sslCertPath Version: Beta2

Default value: none

Required

The path on your system to a TLS certificate file.

envs[].sslKeyPath Version: Beta2

Default value: none

Required

The path on your system to a TLS key file.

ingress

Defines a containerized app that routes traffic from outside the runtime plane) to services within the runtime plane.

The following table describes the properties of the ingress object:

Property Description
ingress.enableAccesslog Version: Beta2

Default value: false

Enable or disable the Ingress access log. By default, it is disabled.

ingress.serviceType Version: Beta2

Default value: LoadBalancer

The type of service used for routing external traffic to internal services.

Possible values include:

  • ClusterIP (not supported)
  • LoadBalancer
  • NodePort

istio

The following table describes the properties of the istio object:

Property Description
istio.nodeSelector.key Version: Beta2

Default value: none

Required

Node selector label key for targeting Kubernetes nodes for istio services.

See Add node selectors.

istio.nodeSelector.value Version: Beta2

Default value: none

Required

Node selector label value for targeting Kubernetes nodes for istio services.

See Add node selectors.

logger

Defines the service that manages operational logs. All of the Apigee Hybrid services that run in your Kubernetes cluster output this information.

For more information, see Logging.

The following table describes the properties of the logger object:

Property Description
logger.enabled Version: Beta2

Default value: true

Enables or disables logging on the cluster. For non-GKE set to true, GKE set to false.

logger.fluentd.buffer_chunk_limit Version: Beta2

Default value: 512k

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 Version: Beta2

Default value: 6

The maximum length of the output queue. The default limit is 256 chunks.

logger.fluentd.flush_interval Version: Beta2

Default value: 5s

The interval to wait before invoking the next buffer flush, in seconds.

logger.fluentd.max_retry_wait Version: Beta2

Default value: 30

The maximum interval between write retries, in seconds.

logger.fluentd.num_threads Version: Beta2

Default value: 2

The number of threads used to flush the buffer. The default is 1.

logger.image.pullPolicy Version: Beta2

Default value: IfNotPresent

Determines when kubelet pulls the pod's Docker image. Possible values include:

  • IfNotPresent: Do not pull a new image if it already exists.
  • Always: Always pull the image, regardless of whether it exists already.

For more information, see Updating images.

logger.image.tag Version: Beta2

Default value: "1.6.8"

The version label for this service's Docker image.

logger.image.url Version: Beta2

Default value: "google/apigee-stackdriver-logging-agent"

The location of the Docker image for this service.

logger.livenessProbe.failureThreshold Version: Beta2

Default value: 3

The number of times Kubernetes will verify that liveness probes have failed before restarting the container. The minimum value is 1.

logger.livenessProbe.initialDelaySeconds Version: Beta2

Default value: 0

The number of seconds after a container is started before a liveness probe is initiated.

logger.livenessProbe.periodSeconds Version: Beta2

Default value: 60

Determines how often to perform a liveness probe, in seconds. The minimum value is 1.

logger.livenessProbe.successThreshold Version: Beta2

Default value: 1

The minimum consecutive successes needed for a liveness probe to be considered successful after a failure. The minimum value is 1.

logger.livenessProbe.timeoutSeconds Version: Beta2

Default value: 1

The number of seconds after which a liveness probe times out. The minimum value is 1.

logger.nodeSelector.key Version: Beta2

Default value: "apigee.com/apigee-logger-enabled"

Required

Node selector label key used to target dedicated Kubernetes nodes for logger runtime services.

See Add node selectors.

logger.nodeSelector.value Version: Beta2

Default value: "true"

Required

Node selector label value used to target dedicated Kubernetes nodes for logger runtime services.

See Add node selectors.

logger.resource.limits.memory Version: Beta2

Default value: 500Mi

The memory limit for the resource in a Kubernetes container, in mebibytes.

logger.resource.limits.cpu Version: Beta2

Default value: 200m

The CPU limit for the resource in a Kubernetes container, in millicores.

logger.resource.requests.cpu Version: Beta2

Default value: 100m

The CPU needed for normal operation of the resource in a Kubernetes container, in millicores.

logger.resource.requests.memory Version: Beta2

Default value: 250Mi

The memory needed for normal operation of the resource in a Kubernetes container, in mebibytes.

logger.serviceAccountPath Version: Beta2

Default value: none

Required

Path to Google Service Account key file with "Apigee Read Only Admin" role.

logger.terminationGracePeriodSeconds Version: Beta2

Default value: 30

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 for public Apigee APIs so that you can access and manage runtime data entities such as KMS (API Keys and OAuth tokens), KVM, Quota, and API products.

The following table describes the properties of the mart object:

Property Description
mart.hostAlias Version: Beta2

Default value: none

The host alias pointing to the MART object. You can set this property to * or a fully-qualified domain name.

mart.image.pullPolicy Version: Beta2

Default value: IfNotPresent

Determines when kubelet pulls the pod's Docker image. Possible values include:

  • IfNotPresent: Do not pull a new image if it already exists.
  • Always: Always pull the image, regardless of whether it exists already.

For more information, see Updating images.

mart.image.tag Version: Beta2

Default value: "1.0.0-beta2"

The version label for this service's Docker image.

mart.image.url Version: Beta2

Default value: "google/apigee-mart-server"

The location of the Docker image for this service.

mart.livenessProbe.failureThreshold Version: Beta2

Default value: 2

The number of times Kubernetes will verify that liveness probes have failed before restarting the container. The minimum value is 1.

mart.livenessProbe.initialDelaySeconds Version: Beta2

Default value: 15

The number of seconds after a container is started before a liveness probe is initiated.

mart.livenessProbe.periodSeconds Version: Beta2

Default value: 5

Determines how often to perform a liveness probe, in seconds. The minimum value is 1.

mart.livenessProbe.timeoutSeconds Version: Beta2

Default value: 1

The number of seconds after which a liveness probe times out. The minimum value is 1.

mart.metricsURL Version: Beta2

Default value: "/v1/server/metrics"

mart.nodeSelector.key Version: Beta2

Default value: none

Node selector label key for targeting Kubernetes nodes for mart runtime services.

See Add node selectors.

mart.nodeSelector.value Version: Beta2

Default value: none

Node selector label value for targeting Kubernetes nodes for mart runtime services.

See Add node selectors.

mart.readinessProbe.failureThreshold Version: Beta2

Default value: 2

The number of times Kubernetes will verify that readiness probes have failed before marking the pod "unready". The minimum value is 1.

mart.readinessProbe.initialDelaySeconds Version: Beta2

Default value: 15

The number of seconds after a container is started before a readiness probe is initiated.

mart.readinessProbe.periodSeconds Version: Beta2

Default value: 5

Determines how often to perform a readiness probe, in seconds. The minimum value is 1.

mart.readinessProbe.successThreshold Version: Beta2

Default value: 1

The minimum consecutive successes needed for a readiness probe to be considered successful after a failure. The minimum value is 1.

mart.readinessProbe.timeoutSeconds Version: Beta2

Default value: 1

The number of seconds after which a liveness probe times out. The minimum value is 1.

mart.replicaCountMax Version: Beta2

Default value: 4

Maximum number of replicas available for autoscaling.

mart.replicaCountMin Version: Beta2

Default value: 2

Minimum number of replicas available for autoscaling.

mart.resources.requests.cpu Version: Beta2

Default value: 500m

The CPU needed for normal operation of the resource in a Kubernetes container, in millicores.

mart.resources.requests.memory Version: Beta2

Default value: 512Mi

The memory needed for normal operation of the resource in a Kubernetes container, in mebibytes.

mart.revision Version: Beta2

Default value: blue

A static value that is populated in a label to enable canary deployments.

mart.sslCertPath Version: Beta2

Default value: none

Local file system path for loading and encoding the SSL cert to a Secret.

mart.sslKeyPath Version: Beta2

Default value: none

Local file system path for loading and encoding the SSL key to a Secret.

mart.targetCPUUtilizationPercentage Version: Beta2

Default value: 75

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 replicaCountMax.

mart.terminationGracePeriodSeconds Version: Beta2

Default value: 30

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 the health of Hybrid services, to set up alerts, and so on.

For more information, see Metrics collection overview.

The following table describes the properties of the metrics object:

Property Description
metrics.enabled Version: Beta2

Default value: true

Enables Apigee mettics. Set to true (the default) to enable metrics. Set to false to disable metrics.

metrics.nodeSelector.key Version: Beta2

Default value: none

Required

Node selector label key used to target dedicated Kubernetes nodes for metrics runtime services.

See Add node selectors.

metrics.nodeSelector.value Version: Beta2

Default value: none

Required

Node selector label value used to target dedicated Kubernetes nodes for metrics runtime services.

See Add node selectors.

metrics.prometheus.args.storage_tsdb_retention Version: Beta2

Default value: 48h

The amount of time Prometheus waits before removing old data from local storage, in hours.

metrics.prometheus.containerPort Version: Beta2

Default value: 9090

The port to connect to the Prometheus metrics service.

metrics.prometheus.image.pullPolicy Version: Beta2

Default value: IfNotPresent

Determines when kubelet pulls the pod's Docker image. Possible values include:

  • IfNotPresent: Do not pull a new image if it already exists.
  • Always: Always pull the image, regardless of whether it exists already.

For more information, see Updating images.

metrics.prometheus.image.tag Version: Beta2

Default value: "v2.9.2"

The version label for this service's Docker image.

metrics.prometheus.image.url Version: Beta2

Default value: "google/apigee-prom-prometheus"

The location of the Docker image for this service.

metrics.prometheus.livenessProbe.failureThreshold Version: Beta2

Default value: 6

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 Version: Beta2

Default value: 5

Determines how often to perform a liveness probe, in seconds. The minimum value is 1.

metrics.prometheus.livenessProbe.timeoutSeconds Version: Beta2

Default value: 3

The number of seconds after which a liveness probe times out. The minimum value is 1.

metrics.prometheus.readinessProbe.failureThreshold Version: Beta2

Default value: 120

The number of times Kubernetes will verify that readiness probes have failed before marking the pod "unready". The minimum value is 1.

metrics.prometheus.readinessProbe.periodSeconds Version: Beta2

Default value: 5

Determines how often to perform a readiness probe, in seconds. The minimum value is 1.

metrics.prometheus.readinessProbe.timeoutSeconds Version: Beta2

Default value: 3

The number of seconds after which a liveness probe times out. The minimum value is 1.

metrics.resources.limits.cpu Version: Beta2

Default value: 250m

The CPU limit for the resource in a Kubernetes container, in millicores.

metrics.resources.limits.memory Version: Beta2

Default value: 2000Mi

The memory limit for the resource in a Kubernetes container, in mebibytes.

metrics.resources.requests.cpu Version: Beta2

Default value: 250m

The CPU needed for normal operation of the resource in a Kubernetes container, in millicores.

metrics.resources.requests.memory Version: Beta2

Default value: 2000Mi

The memory needed for normal operation of the resource in a Kubernetes container, in mebibytes.

metrics.sdSidecar.containerPort Version: Beta2

Default value: 9091

The port for connecting to the StackDriver metrics service.

metrics.sdSidecar.image.pullPolicy Version: Beta2

Default value: IfNotPresent

Determines when Kubelet pulls this service's Docker image. Possible values include:

  • IfNotPresent: Do not pull a new image if it already exists
  • Always: Always pull the policy, even if it already exists

    For more information, see Updating images.

metrics.sdSidecar.image.tag Version: Beta2

Default value: "release-0.4.0"

The version label for this service's Docker image.

metrics.sdSidecar.image.url Version: Beta2

Default value: "google/apigee-stackdriver-prometheus-sidecar"

The location of the Docker image for this service.

metrics.serviceAccountPath Version: Beta2

Default value: none

Required

Path to Google Service Account key file with "Apigee Read Only Admin" role.

metrics.terminationGracePeriodSeconds Version: Beta2

Default value: 300

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.

runtime

The following table describes the properties of the runtime object:

Property Description
runtime.image.pullPolicy Version: Beta2

Default value: IfNotPresent

Determines when kubelet pulls the pod's Docker image. Possible values include:

  • IfNotPresent: Do not pull a new image if it already exists.
  • Always: Always pull the image, regardless of whether it exists already.

For more information, see Updating images.

runtime.image.tag Version: Beta2

Default value: "1.0.0-beta2"

The version label for this service's Docker image.

runtime.image.url Version: Beta2

Default value: "google/apigee-runtime"

The location of the Docker image for this service.

runtime.livenessProbe.failureThreshold Version: Beta2

Default value: 2

The number of times Kubernetes will verify that liveness probes have failed before restarting the container. The minimum value is 1.

runtime.livenessProbe.initialDelaySeconds Version: Beta2

Default value: 60

The number of seconds after a container is started before a liveness probe is initiated.

runtime.livenessProbe.periodSeconds Version: Beta2

Default value: 5

Determines how often to perform a liveness probe, in seconds. The minimum value is 1.

runtime.livenessProbe.timeoutSeconds Version: Beta2

Default value: 1

The number of seconds after which a liveness probe times out. The minimum value is 1.

runtime.nodeSelector.key Version: Beta2

Default value: none

Node selector label key for targeting Kubernetes nodes for runtime services.

See Add node selectors.

runtime.nodeSelector.value Version: Beta2

Default value: none

Node selector label value for targeting Kubernetes nodes for runtime services.

See Add node selectors.

runtime.readinessProbe.failureThreshold Version: Beta2

Default value: 2

The number of times Kubernetes will verify that readiness probes have failed before marking the pod "unready". The minimum value is 1.

runtime.readinessProbe.initialDelaySeconds Version: Beta2

Default value: 60

The number of seconds after a container is started before a readiness probe is initiated.

runtime.readinessProbe.periodSeconds Version: Beta2

Default value: 5

Determines how often to perform a readiness probe, in seconds. The minimum value is 1.

runtime.readinessProbe.successThreshold Version: Beta2

Default value: 1

The minimum consecutive successes needed for a readiness probe to be considered successful after a failure. The minimum value is 1.

runtime.readinessProbe.timeoutSeconds Version: Beta2

Default value: 1

The number of seconds after which a liveness probe times out. The minimum value is 1.

runtime.replicaCountMax Version: Beta2

Default value: 4

Maximum number of replicas available for autoscaling.

runtime.replicaCountMin Version: Beta2

Default value: 2

Minimum number of replicas available for autoscaling.

runtime.resources.requests.cpu Version: Beta2

Default value: 500m

The CPU needed for normal operation of the resource in a Kubernetes container, in millicores.

runtime.resources.requests.memory Version: Beta2

Default value: 1Gi

The memory needed for normal operation of the resource in a Kubernetes container, in mebibytes.

runtime.revision Version: Beta2

Default value: blue

Static label used by canary deployments. Not supported in Beta2.

runtime.service.type Version: Beta2

Default value: ClusterIP

The type of service. You can set this to a service other than ClusterIP; for example, LoadBalancer.

runtime.targetCPUUtilizationPercentage Version: Beta2

Default value: 75

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 replicaCountMax.

runtime.terminationGracePeriodSeconds Version: Beta2

Default value: 180

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.

For more information, see Synchronizer.

The following table describes the properties of the synchronizer object:

Property Description
synchronizer.image.pullPolicy Version: Beta2

Default value: IfNotPresent

Determines when kubelet pulls the pod's Docker image. Possible values include:

  • IfNotPresent: Do not pull a new image if it already exists.
  • Always: Always pull the image, regardless of whether it exists already.

For more information, see Updating images.

synchronizer.image.tag Version: Beta2

Default value: "1.0.0-beta2"

The version label for this service's Docker image.

synchronizer.image.url Version: Beta2

Default value: "google/apigee-synchronizer"

The location of the Docker image for this service.

synchronizer.livenessProbe.failureThreshold Version: Beta2

Default value: 2

The number of times Kubernetes will verify that liveness probes have failed before restarting the container. The minimum value is 1.

synchronizer.livenessProbe.initialDelaySeconds Version: Beta2

Default value: 0

The number of seconds after a container is started before a liveness probe is initiated.

synchronizer.livenessProbe.periodSeconds Version: Beta2

Default value: 5

Determines how often to perform a liveness probe, in seconds. The minimum value is 1.

synchronizer.livenessProbe.timeoutSeconds Version: Beta2

Default value: 1

The number of seconds after which a liveness probe times out. The minimum value is 1.

synchronizer.nodeSelector.key Version: Beta2

Default value: none

Required

Node selector label key for targeting Kubernetes nodes for synchronizer runtime services.

See Add node selectors.

synchronizer.nodeSelector.value Version: Beta2

Default value: none

Required

Node selector label value used for targeting Kubernetes nodes for synchronizer runtime services.

See Add node selectors.

synchronizer.pollInterval Version: Beta2

Default value: 60

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 Version: Beta2

Default value: 2

The number of times Kubernetes will verify that readiness probes have failed before marking the pod "unready". The minimum value is 1.

synchronizer.readinessProbe.initialDelaySeconds Version: Beta2

Default value: 0

The number of seconds after a container is started before a readiness probe is initiated.

synchronizer.readinessProbe.periodSeconds Version: Beta2

Default value: 5

Determines how often to perform a readiness probe, in seconds. The minimum value is 1.

synchronizer.readinessProbe.successThreshold Version: Beta2

Default value: 1

The minimum consecutive successes needed for a readiness probe to be considered successful after a failure. The minimum value is 1.

synchronizer.readinessProbe.timeoutSeconds Version: Beta2

Default value: 1

The number of seconds after which a liveness probe times out. The minimum value is 1.

synchronizer.replicaCount Version: Beta2

Default value: 2

Number of replicas for autoscaling.

synchronizer.serviceAccountPath Version: Beta2

Default value: none

Required

Path to Google Service Account key file with "Apigee Read Only Admin" role.

synchronizer.terminationGracePeriodSeconds Version: Beta2

Default value: 30

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 pod in the runtime plane. This service extracts analytics and deployment status data and sends it to the Unified Analytics Platform (UAP).

For more information, see Analytics and deployment status data collection.

The following table describes the properties of the udca object:

Property Description
udca.fluentd.image.pullPolicy Version: Beta2

Default value: IfNotPresent

Determines when kubelet pulls the pod's Docker image. Possible values include:

  • IfNotPresent: Do not pull a new image if it already exists.
  • Always: Always pull the image, regardless of whether it exists already.

For more information, see Updating images.

udca.fluentd.image.tag Version: Beta2

Default value: "1.6.8"

The version label for this service's Docker image.

udca.fluentd.image.url Version: Beta2

Default value: "google/apigee-stackdriver-logging-agent"

The location of the Docker image for this service.

udca.fluentd.resource.limits.memory Version: Beta2

Default value: 500Mi

The memory limit for the resource in a Kubernetes container, in mebibytes.

udca.fluentd.resource.requests.cpu Version: Beta2

Default value: 500m

The CPU needed for normal operation of the resource in a Kubernetes container, in millicores.

udca.fluentd.resource.requests.memory Version: Beta2

Default value: 250Mi

The memory needed for normal operation of the resource in a Kubernetes container, in mebibytes.

udca.image.pullPolicy Version: Beta2

Default value: IfNotPresent

Determines when kubelet pulls the pod's Docker image. Possible values include:

  • IfNotPresent: Do not pull a new image if it already exists.
  • Always: Always pull the image, regardless of whether it exists already.

For more information, see Updating images.

udca.image.tag Version: Beta2

Default value: "beta2"

The version label for this service's Docker image.

udca.image.url Version: Beta2

Default value: "google/apigee-udca"

The location of the Docker image for this service.

udca.jvmXms Version: Beta2

Default value: 256m

The starting amount of memory for the data collection pod's JVM.

udca.jvmXmx Version: Beta2

Default value: 256m

The maximum allocation of memory for the data collection pod's JVM.

udca.livenessProbe.failureThreshold Version: Beta2

Default value: 2

The number of times Kubernetes will verify that liveness probes have failed before restarting the container. The minimum value is 1.

udca.livenessProbe.initialDelaySeconds Version: Beta2

Default value: 0

The number of seconds after a container is started before a liveness probe is initiated.

udca.livenessProbe.periodSeconds Version: Beta2

Default value: 5

Determines how often to perform a liveness probe, in seconds. The minimum value is 1.

udca.livenessProbe.timeoutSeconds Version: Beta2

Default value: 1

The number of seconds after which a liveness probe times out. The minimum value is 1.

udca.nodeSelector.key Version: Beta2

Default value: none

Required

Node selector label key used to target dedicated Kubernetes nodes for udca runtime services.

See Add node selectors.

udca.nodeSelector.value Version: Beta2

Default value: none

Required

Node selector label value used to target dedicated Kubernetes nodes for udca runtime services.

See Add node selectors.

udca.pollingIntervalInSec Version: Beta2

Default value: 1

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 Version: Beta2

Default value: 4

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.

udca.replicaCountMin Version: Beta2

Default value: 2

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.targetCPUUtilizationPercentage, then Hybrid will gradually increase the number of pods, up to udca.replicaCountMax.

udca.resource.requests.cpu Version: Beta2

Default value: 250m

The CPU needed for normal operation of the resource in a Kubernetes container, in millicores.

udca.revision Version: 1

Default value: "v1"

A static value that is populated in a label to enable canary deployments.

udca.targetCPUUtilizationPercentage Version: Beta2

Default value: 75

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.replicaCountMax.

udca.terminationGracePeriodSeconds Version: Beta2

Default value: 600

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.