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
apigeeGroupId Version: Beta

Default value: 998 (set during image build)

Your Group ID for giving access to host volume and container mounts for Apigee apps.

apigeeUserId Version: Beta

Default value: 999

Your Apigee user ID.

cpsSetup.serviceType Version: Beta

Default value: all

The Apigee CPS service type to provision. (kvm, quota, kms, cache, all)

imagePullSecrets.0.name Version: Beta

Default value:

Name of Secret configured as docker-registry type; used to pull images from private repo.

k8s_cluster_location Version: Beta

Default value: us-central1

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

k8s_cluster_name

Type:

Version: Beta

Default value: none

The name of your Kubernetes cluster.

mountPathControlPlaneData Version: Beta

Default value: /opt/apigee/repomnt

Path to mount for Apigee's synchronized management plane data.

mountPathCWC Version: Beta

Default value: /opt/apigee/customer

Path to mount for Apigee's app configuration override properties.

mountPathSignalsData Version: Beta

Default value: /opt/apigee/repomnt/signals

namespace Version: Beta

Default value: apigee

The namespace of your Kubernetes cluster.

project_id Version: Beta

Default value:

Your Google CLoud Platform project ID.

sharedHostPathForControlPlaneData Version: Beta

Default value: /var/apigee/repomnt

A shared path to use between Apigee applications for management plane configuration.

authz

The following table describes the properties of the authz object:

Property Description
authz.controlPlaneEndpoint Version: Beta

Default value: https://api.enterprise.apigee.com

The URL endpoint to the Apigee management plane.

authz.image.pullPolicy Version: Beta

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.

authz.image.tag Version: Beta

Default value: "1.0.0-beta"

The version label for this service's Docker image.

authz.image.url Version: Beta

Default value: "us.gcr.io/apigee-hybrid-237023/apigee/apigee-hybrid-authn-authz"

The location of the Docker image for this service.

authz.livenessProbe.failureThreshold Version: Beta

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: Beta

Default value: 60

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

authz.livenessProbe.periodSeconds Version: Beta

Default value: 5

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

authz.livenessProbe.timeoutSeconds Version: Beta

Default value: 1

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

authz.readinessProbe.failureThreshold Version: Beta

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: Beta

Default value: 60

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

authz.readinessProbe.periodSeconds Version: Beta

Default value: 5

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

authz.readinessProbe.successThreshold Version: Beta

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: Beta

Default value: 1

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

authz.svcAccountPath Version: Beta

Default value: None

Path to file on local system for loading and encoding the Google Service Account for tokens.

busyBoxInit

The following table describes the properties of the busyBoxInit object:

Property Description
busyBoxInit.image.pullPolicy Version: Beta

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.

busyBoxInit.image.tag Version: Beta

Default value: "1.27"

The version label for this service's Docker image.

busyBoxInit.image.url Version: Beta

Default value: "gcr.io/google-containers/busybox"

The location of the Docker image for this service.

cassandra

The following table describes the properties of the cassandra object:

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

Default value: none

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

cassandra.auth.admin.user Version: Beta

Default value: none

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

cassandra.auth.ddl.password Version: Beta

Default value: none

Password for the Cassandra Data Definition Language user. Used by MART for any of the data definition tasks like keyspace creation, update, and deletion.

cassandra.auth.ddl.user Version: Beta

Default value: none

Username for the Cassandra Data Definition Language user. Used by MART for any of the data definition tasks like keyspace creation, update, and deletion.

cassandra.auth.default.password Version: Beta

Default value: cassandra

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: Beta

Default value: none

Password for the Cassandra Data Manipulation Language user. The DML user is used by the client communication to read and write data to Cassandra.

cassandra.auth.dml.user Version: Beta

Default value: none

Username for the Cassandra Data Manipulation Language user. The DML user is used by the client communication to read and write data to Cassandra.

cassandra.auth.image.pullPolicy Version: Beta

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.

cassandra.auth.image.tag Version: Beta

Default value: "1.0.0-beta"

The version label for this service's Docker image.

cassandra.auth.image.url Version: Beta

Default value: "us.gcr.io/apigee-hybrid-237023/apigee/apigee-cassandra-client"

password for the Cassandra administrator.

cassandra.backup.cloudProvider Version: Beta

Default value: "GCP"

Cloud provider for backup storage.

cassandra.backup.dbStorageBucket Version: Beta

Default value: none

Cloud storage bucket for the backup data.

cassandra.backup.image.pullPolicy Version: Beta

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 image, even if it already exists

    For more information, see Updating images.

cassandra.backup.image.tag Version: Beta

Default value: "1.0.0-beta"

The version label for this service's Docker image.

cassandra.backup.image.url Version: Beta

Default value: "us.gcr.io/apigee-hybrid-237023/apigee/apigee-cassandra-backup-utility"

The location of the Docker image for this service.

cassandra.backup.password Version: Beta

Default value: none

The Cassandra password used for schema backup. If not provided, the admin password is used.

cassandra.backup.schedule Version: Beta

Default value: "0 2 * * *"

The schedule for the chron job.

See Cassandra backup and recovery.

cassandra.backup.serviceAccountPath Version: Beta

Default value: none

The path to your GCP account JSON file.

cassandra.backup.user Version: Beta

Default value: none

The Cassandra username used for schema backup. If not provided, the admin username is used.

cassandra.clusterName Version: Beta

Default value: "apigeecluster"

Specifies the name of the Cassandra cluster

cassandra.datacenter Version: Beta

Default value: "dc1"

Specifies the datacenter of the Cassandra node.

cassandra.enableBackup Version: Beta

Default value: false

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

See Cassandra backup and recovery.

cassandra.externalSeedHost Version: Beta

Default value: None

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

cassandra.heapNewSize Version: Beta

Default value: 100M

cassandra.image.pullPolicy Version: Beta

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.

cassandra.image.tag Version: Beta

Default value: "1.0.0-beta"

The version label for this service's Docker image.

cassandra.image.url Version: Beta

Default value: "us.gcr.io/apigee-hybrid-237023/apigee/apigee-cassandra-3.11.3"

The location of the Docker image for this service.

cassandra.maxHeapSize Version: Beta

Default value: 512M

cassandra.multiRegionSeedHost Version: Beta

Default value: none

cassandra.nodeSelector.key Version: Beta

Default value: none

Node selector label key used to target dedicated Kubernetes nodes for Cassandra data components. Use of this property ensures that non-Cassandra applications are not scheduled on nodes from the dedicated Cassandra nodepool.

cassandra.nodeSelector.value Version: Beta

Default value: none

Node selector label value used to target dedicated Kubernetes nodes for Cassandra data components. Use of this property ensures that non-Cassandra applications are not scheduled on nodes from the dedicated Cassandra nodepool.

cassandra.port Version: Beta

Default value: 9042

Port number used to connect to cassandra.

cassandra.rack Version: Beta

Default value: "ra-1"

Specifies the rack of the Cassandra node.

cassandra.readinessProbe.failureThreshold Version: Beta

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: Beta

Default value: 60

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

cassandra.readinessProbe.periodSeconds Version: Beta

Default value: 10

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

cassandra.readinessProbe.successThreshold Version: Beta

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: Beta

Default value: 5

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

cassandra.replicaCount Version: Beta

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: Beta

Default value: 500m

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

cassandra.resources.requests.memory Version: Beta

Default value: 1Gi

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

cassandra.sslCertPath Version: Beta

Default value: none

Path to the SSL cert for the Cassandra server.

cassandra.sslKeyPath Version: Beta

Default value: none

The SSL key for the Cassandra server.

cassandra.sslRootCAPath Version: Beta

Default value: none

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

cassandra.storage.awsebs.diskType Version: Beta

Default value: gp2

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

cassandra.storage.awsebs.encrypted Version: Beta

Default value: "true"

Specifies whether the Amazon EBS volume should be encrypted.

cassandra.storage.awsebs.fsType Version: Beta

Default value: ext4

The Amazon EBS file system time supported by Kubernetes.

cassandra.storage.awsebs.iopsPerGB Version: Beta

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: Beta

Default value: ebs-storage

The name of the Amazon EBS persistent storage volume.

cassandra.storage.capacity Version: Beta

Default value: 50Gi

Specifies the disk size required, in mebibytes.

cassandra.storage.gcepd.diskType Version: Beta

Default value: pd-ssd

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

cassandra.storage.gcepd.name Version: Beta

Default value: gce-storage

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

cassandra.storage.gcepd.replicationType Version: Beta

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: Beta

Default value: local-storage

The name of the local storage persistent volume.

cassandra.storage.local.nodes Version: Beta

Default value: node1

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

cassandra.storage.local.path Version: Beta

Default value: /apigee/data

The path to the local storage persistent volume.

cassandra.storage.type Version: Beta

Default value: gcepd

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

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

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.

config

The following table describes the properties of the config object:

Property Description
config.base64Credentials Version: Beta

Default value: none

Your Apigee username and password as a base64-encoded string. Apigee recommends that you encode your credentials using the following command:

printf 'username:password' | base64

For example:

printf 'anitas@apigee.com:abc123' | base64
YW5pdGFAYXBpZ2VlLmNvbTphYmMxMjM=
config.contractProvider Version: Beta

Default value:https://api.enterprise.apigee.com

Apigee management API endpoint.

config.envs Version: Beta

Default value: none

A list of Apigee environments to be synchronized.

config.envs[].base64Credentials Version: Beta

Default value: none

Credentials for accessing this organization and environment.

config.envs[].cacheEncryptionKeyPath Version: Beta

Default value: none

Path to file on local system for loading and encoding encryption key for Apigee cache data.

config.envs[].envName Version: Beta

Default value: none

Apigee environment name to be synchronized.

config.envs[].hostAlias Version: Beta

Default value: none

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

This property is required when configuring a host alias.

config.envs[].kmsEncryptionKeyPath Version: Beta

Default value: none

Path to file on local system for loading and encoding encryption key for Apigee KMS data.

config.envs[].orgName Version: Beta

Default value: none

Apigee organization name to be synchronized.

config.envs[].pollInterval Version: Beta

Default value: none

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

config.envs[].port Version: Beta

Default value: none

TCP port number for HTTPS traffic.

config.envs[].serviceType Version: Beta

Default value: none

Configure a different type of Service, such as a LoadBalancer.

config.envs[].sslCertPath Version: Beta

Default value: none

The path on your system to a TLS certificate file.

This property is required when configuring a host alias.

config.envs[].sslKeyPath Version: Beta

Default value: none

The path on your system to a TLS key file.

This property is required when configuring a host alias.

ingress

The following table describes the properties of the ingress object:

Property Description
ingress.serviceType Version: Beta

Default value: LoadBalancer

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

ingress.enableAccesslog Version: Beta

Default value: true

Enable or disable the Ingress access log.

istio

The following table describes the properties of the istio object:

Property Description
istio.nodeSelector.key Version: Beta

Default value: none

Node selector label key for targeting Kubernetes nodes for Istio components. Use of this property ensures that Istio applications are not scheduled on nodes from the dedicated Cassandra nodepool.

istio.nodeSelector.value Version: Beta

Default value: none

Node selector label value for targeting Kubernetes nodes for Istio components. Use of this property ensures that Istio applications are not scheduled on nodes from the dedicated Cassandra nodepool.

logger

The following table describes the properties of the logger object:

Property Description
logger.enableLogging Version: Beta

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: Beta

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: Beta

Default value: 6

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

logger.fluentd.flush_interval Version: Beta

Default value: 5s

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

logger.fluentd.max_retry_wait Version: Beta

Default value: 30

The maximum interval between write retries, in seconds.

logger.fluentd.num_threads Version: Beta

Default value: 2

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

logger.image.pullPolicy Version: Beta

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 image, even if it already exists

    For more information, see Updating images.

logger.image.tag Version: Beta

Default value: "2.0.18"

The version label for this service's Docker image.

logger.image.url Version: Beta

Default value: "gcr.io/google-containers/fluentd-gcp"

The location of the Docker image for this service.

logger.livenessProbe.failureThreshold Version: Beta

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: Beta

Default value: 600

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

logger.livenessProbe.periodSeconds Version: Beta

Default value: 60

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

logger.livenessProbe.successThreshold Version: Beta

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: Beta

Default value: 1

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

logger.resource.limits.memory Version: Beta

Default value: 500Mi

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

logger.resource.limits.cpu Version: Beta

Default value: 200m

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

logger.resource.requests.cpu Version: Beta

Default value: 100m

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

logger.resource.requests.memory Version: Beta

Default value: 250Mi

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

logger.serviceAccountPath Version: Beta

Default value:

Path to your GCP service account JSON file.

logger.terminationGracePeriodSeconds Version: Beta

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

The following table describes the properties of the mart object:

Property Description
mart.cwcAppend Version: Beta

Default value: | /p>

Append application configurations (Java property key-value pairs).

mart.hostAlias Version: Beta

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: Beta

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 image, even if it already exists

    For more information, see Updating images.

mart.image.tag Version: Beta

Default value: "1.0.0-beta"

The version label for this service's Docker image.

mart.image.url Version: Beta

Default value: "us.gcr.io/apigee-hybrid-237023/apigee/edge-hybrid-mart"

The location of the Docker image for this service.

mart.livenessProbe.failureThreshold Version: Beta

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: Beta

Default value: 60

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

mart.livenessProbe.periodSeconds Version: Beta

Default value: 5

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

mart.livenessProbe.timeoutSeconds Version: Beta

Default value: 1

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

mart.metricsURL Version: Beta

Default value: "/v1/server/metrics"

mart.nodeSelector.key Version: Beta

Default value: none

Node selector label key for targeting Kubernetes nodes for MART runtime components. Use of this property ensures that MART applications are not scheduled on nodes from the dedicated Cassandra nodepool.

mart.nodeSelector.value Version: Beta

Default value: none

Node selector label value for targeting Kubernetes nodes for MART runtime components. Use of this property ensures that MART applications are not scheduled on nodes from the dedicated Cassandra nodepool.

mart.port Version: Beta

Default value: 443

TCP port for HTTPS traffic.

mart.readinessProbe.failureThreshold Version: Beta

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: Beta

Default value: 60

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

mart.readinessProbe.periodSeconds Version: Beta

Default value: 5

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

mart.readinessProbe.successThreshold Version: Beta

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: Beta

Default value: 1

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

mart.replicaCountMax Version: Beta

Default value: 4

Maximum number of replicas available for autoscaling.

mart.replicaCountMin Version: Beta

Default value: 2

Minimum number of replicas available for autoscaling.

mart.resources.requests.cpu Version: Beta

Default value: 500m

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

mart.resources.requests.memory Version: Beta

Default value: 512Mi

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

mart.revision Version: Beta

Default value: blue

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

mart.serviceType Version: Beta

Default value: ClusterIP

Configure a different type of Service, such as a LoadBalancer.

mart.sslCertPath Version: Beta

Default value: none

Path to file on local system for loading and encoding the SSL cert to a Secret.

mart.sslKeyPath Version: Beta

Default value: none

Path to file on local system for loading and encoding the SSL key to a Secret.

mart.targetCPUUtilizationPercentage Version: Beta

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: Beta

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

The following table describes the properties of the metrics object:

Property Description
metrics.containerPort Version: Beta

Default value: 9090

The port to connect to the metrics service.

metrics.enableMetrics Version: Beta

Default value: true

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

metrics.prometheus.args.storage_tsdb_retention Version: Beta

Default value: 48h

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

metrics.prometheus.containerPort Version: Beta

Default value: 9090

The port to connect to the Prometheus metrics service.

metrics.prometheus.image Version: Beta

Default value: "prom/prometheus"

metrics.prometheus.image.pullPolicy Version: Beta

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.prometheus.image.tag Version: Beta

Default value: "v2.6.1"

The version label for this service's Docker image.

metrics.prometheus.image.url Version: Beta

Default value: "prom/prometheus"

The location of the Docker image for this service.

metrics.prometheus.livenessProbe.failureThreshold Version: Beta

Default value: 6

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

metrics.prometheus.livenessProbe.periodSeconds Version: Beta

Default value: 5

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

metrics.prometheus.livenessProbe.timeoutSeconds Version: Beta

Default value: 3

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

metrics.prometheus.readinessProbe.failureThreshold Version: Beta

Default value: 120

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

metrics.prometheus.readinessProbe.periodSeconds Version: Beta

Default value: 5

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

metrics.prometheus.readinessProbe.timeoutSeconds Version: Beta

Default value: 3

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

metrics.resources.limits.cpu Version: Beta

Default value: 250m

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

metrics.resources.limits.memory Version: Beta

Default value: 2000Mi

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

metrics.resources.requests.cpu Version: Beta

Default value: 250m

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

metrics.resources.requests.memory Version: Beta

Default value: 2000Mi

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

metrics.sdSidecar.containerPort Version: Beta

Default value: 9091

The port for connecting to the StackDriver metrics service.

metrics.sdSidecar.image.pullPolicy Version: Beta

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: Beta

Default value: "release-0.4.0"

The version label for this service's Docker image.

metrics.sdSidecar.image.url Version: Beta

Default value: "gcr.io/stackdriver-prometheus/stackdriver-prometheus-sidecar"

The location of the Docker image for this service.

metrics.serviceAccountPath Version: Beta

Default value: none

Path to your GCP service account JSON file.

metrics.terminationGracePeriodSeconds Version: Beta

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.

mp

The following table describes the properties of the mp object:

Property Description
mp.cwcAppend Version: Beta

Default value: |

Append application configurations (Java property key-value pairs).

mp.image.pullPolicy Version: Beta

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.

mp.image.tag Version: Beta

Default value: "1.0.0-beta"

The version label for this service's Docker image.

mp.image.url Version: Beta

Default value: "us.gcr.io/apigee-hybrid-237023/apigee/edge-hybrid-runtime"

The location of the Docker image for this service.

mp.livenessProbe.failureThreshold Version: Beta

Default value: 2

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

mp.livenessProbe.initialDelaySeconds Version: Beta

Default value: 60

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

mp.livenessProbe.periodSeconds Version: Beta

Default value: 5

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

mp.livenessProbe.timeoutSeconds Version: Beta

Default value: 1

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

mp.nodeSelector.key Version: Beta

Default value: none

Node selector label key for targeting Kubernetes nodes for MP runtime components. Use of this property ensures that MP applications are not scheduled on nodes from the dedicated Cassandra nodepool.

mp.nodeSelector.value Version: Beta

Default value: none

Node selector label value for targeting Kubernetes nodes for MP runtime components. Use of this property ensures that Synchronizer applications are not scheduled on nodes from the dedicated Cassandra nodepool.

mp.readinessProbe.failureThreshold Version: Beta

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.

mp.readinessProbe.initialDelaySeconds Version: Beta

Default value: 60

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

mp.readinessProbe.periodSeconds Version: Beta

Default value: 5

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

mp.readinessProbe.successThreshold Version: Beta

Default value: 1

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

mp.readinessProbe.timeoutSeconds Version: Beta

Default value: 1

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

mp.replicaCountMax Version: Beta

Default value: 4

Maximum number of replicas available for autoscaling.

mp.replicaCountMin Version: Beta

Default value: 2

Minimum number of replicas available for autoscaling.

mp.resources.requests.cpu Version: Beta

Default value: 500m

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

mp.resources.requests.memory Version: Beta

Default value: 1Gi

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

mp.revision Version: Beta

Default value: blue

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

mp.service.type Version: Beta

Default value: ClusterIP

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

mp.targetCPUUtilizationPercentage Version: Beta

Default value: 75

Target CPU utilization for the Deployment. It will scale out if exceeded.

mp.terminationGracePeriodSeconds Version: Beta

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.

sync

The following table describes the properties of the sync object:

Property Description
sync.cwcAppend Version: Beta

Default value: |

Append application configurations (Java property key-value pairs).

sync.image.pullPolicy Version: Beta

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.

sync.image.tag Version: Beta

Default value: "1.0.0-beta"

The version label for this service's Docker image.

sync.image.url Version: Beta

Default value: "us.gcr.io/apigee-hybrid-237023/apigee/edge-hybrid-sync"

The location of the Docker image for this service.

sync.livenessProbe.failureThreshold Version: Beta

Default value: 2

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

sync.livenessProbe.initialDelaySeconds Version: Beta

Default value: 60

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

sync.livenessProbe.periodSeconds Version: Beta

Default value: 5

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

sync.livenessProbe.timeoutSeconds Version: Beta

Default value: 1

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

sync.nodeSelector.key Version: Beta

Default value: none

Node selector label key for targeting Kubernetes nodes for Synchronizer runtime components. Use of this property ensures that Synchronizer applications are not scheduled on nodes from the dedicated Cassandra nodepool.

sync.nodeSelector.value Version: Beta

Default value: none

Node selector label value used for targeting Kubernetes nodes for Synchronizer runtime components. Use of this property ensures that Synchronizer applications are not scheduled on nodes from the dedicated Cassandra nodepool.

sync.pollInterval Version: Beta

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.

sync.readinessProbe.failureThreshold Version: Beta

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.

sync.readinessProbe.initialDelaySeconds Version: Beta

Default value: 60

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

sync.readinessProbe.periodSeconds Version: Beta

Default value: 5

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

sync.readinessProbe.successThreshold Version: Beta

Default value: 1

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

sync.readinessProbe.timeoutSeconds Version: Beta

Default value: 1

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

sync.replicaCount Version: Beta

Default value: 2

Number of replicas for autoscaling.

sync.terminationGracePeriodSeconds Version: Beta

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

The following table describes the properties of the udca object:

Property Description
udca.dataDir.apiDataSubDir Version: Beta

Default value: "api"

A subdirectory of udca.dataDir.base, where UDCA stores the analytics data files on the data collection pod.

udca.dataDir.base Version: Beta

Default value: "/opt/apigee/data"

The directory on the data collection pod that contains the subdirectories for each type of data.

udca.dataDir.eventDataSubDir Version: Beta

Default value: "event"

A subdirectory of udca.dataDir.base, where UDCA stores API proxy deployment status data files on the data collection pod.

udca.dataDir.traceDataSubDir Version: Beta

Default value: "trace"

A subdirectory of udca.dataDir.base, where UDCA stores trace data files on the data collection pod.

udca.dataLocationEndpoint Version: Beta

Default value: https://api.enterprise.apigee.com

The location that UDCA accesses to get the actual location to which it uploads the new data files.

udca.fluentd.image.pullPolicy Version: Beta

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.

udca.fluentd.image.tag Version: Beta

Default value: "1.0.0-beta"

The version label for this service's Docker image.

udca.fluentd.image.url Version: Beta

Default value: "us.gcr.io/apigee-hybrid-237023/apigee/google-fluentd"

The location of the Docker image for this service.

udca.fluentd.resource.limits.cpu Version: Beta

Default value: 200m

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

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

Default value: 500Mi

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

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

Default value: 100m

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

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

Default value: 250Mi

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

udca.image.pullPolicy Version: Beta

Default: 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.

udca.image.tag Version: Beta

Default value: "1.0.0-beta"

The version label for this service's Docker image.

udca.image.url Version: Beta

Default value: "us.gcr.io/apigee-hybrid-237023/apigee/edge-udca"

The location of the Docker image for this service.

udca.jvmXms Version: Beta

Default value: 256m

The starting amount of memory for the data collection pod's Java Virtual Machine (JVM).

udca.jvmXmx Version: Beta

Default value: 256m

The maximum allocation of memory for the data collection pod's Java Virtual Machine (JVM).

udca.livenessProbe.failureThreshold Version: Beta

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: Beta

Default value: 60

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

udca.livenessProbe.periodSeconds Version: Beta

Default value: 5

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

udca.livenessProbe.timeoutSeconds Version: Beta

Default value: 1

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

udca.nodeSelector.key Version: Beta

Default value: none

Node selector label key used to target dedicated Kubernetes nodes for UDCA runtime components. Use of this property ensures that UDCA applications are not scheduled on nodes from the dedicated Cassandra nodepool.

udca.nodeSelector.value Version: Beta

Default value: none

Node selector label value used to target dedicated Kubernetes nodes for UDCA runtime components. Use of this property ensures that UDCA applications are not scheduled on nodes from the dedicated Cassandra nodepool.

udca.pollingIntervalInSec Version: Beta

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: Beta

Default value: 4

The maximum number of pods that hybrid can automatically add for the UDCA deployment. Since UDCA is implemented as a ReplicaSet, the pods are replicas.

udca.replicaCountMin Version: Beta

Default value: 2

The minimum number of pods for the UDCA deployment. Since 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.revision Version: 1

Default value: "v1"

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

udca.targetCPUUtilizationPercentage Version: Beta

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: Beta

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.