Custom Resource options reference¶

Value type	Example
string	`mycustom-scheduler`

`pxc.annotations`¶

The Kubernetes annotations .

Value type	Example
label	`iam.amazonaws.com/role: role-arn`

`pxc.labels`¶

Value type	Example
label	`rack: rack-22`

`pxc.readinessProbes.initialDelaySeconds`¶

Number of seconds to wait before performing the first readiness probe .

Value type	Example
int	`15`

`pxc.readinessProbes.timeoutSeconds`¶

Number of seconds after which the readiness probe times out.

Value type	Example
int	`15`

`pxc.readinessProbes.periodSeconds`¶

How often (in seconds) to perform the readiness probe .

Value type	Example
int	`30`

`pxc.readinessProbes.successThreshold`¶

Minimum consecutive successes for the readiness probe to be considered successful after having failed.

Value type	Example
int	`1`

`pxc.readinessProbes.failureThreshold`¶

When the readiness probe fails, Kubernetes will try this number of times before marking the Pod Unready.

Value type	Example
int	`5`

`pxc.livenessProbes.initialDelaySeconds`¶

Number of seconds to wait before performing the first liveness probe .

Value type	Example
int	`300`

`pxc.livenessProbes.timeoutSeconds`¶

Number of seconds after which the liveness probe times out.

Value type	Example
int	`5`

`pxc.livenessProbes.periodSeconds`¶

How often (in seconds) to perform the liveness probe .

Value type	Example
int	`10`

`pxc.livenessProbes.successThreshold`¶

Minimum consecutive successes for the liveness probe to be considered successful after having failed.

Value type	Example
int	`1`

`pxc.livenessProbes.failureThreshold`¶

When the liveness probe fails, Kubernetes will try this number of times before restarting the container.

Value type	Example
int	`3`

`pxc.envVarsSecret`¶

A secret with environment variables, see Define environment variables for details.

Value type	Example
string	`my-env-var-secrets`

`pxc.resources.requests.memory`¶

The Kubernetes memory requests for a Percona XtraDB Cluster container.

Value type	Example
string	`1G`

`pxc.resources.requests.cpu`¶

Kubernetes CPU requests for a Percona XtraDB Cluster container.

Value type	Example
string	`600m`

`pxc.resources.requests.ephemeral-storage`¶

Kubernetes Ephemeral Storage requests for a Percona XtraDB Cluster container.

Value type	Example
string	`1G`

`pxc.resources.limits.memory`¶

Kubernetes memory limits for a Percona XtraDB Cluster container.

Value type	Example
string	`1G`

`pxc.resources.limits.cpu`¶

Kubernetes CPU limits for a Percona XtraDB Cluster container.

Value type	Example
string	`1`

`pxc.resources.limits.ephemeral-storage`¶

Kubernetes Ephemeral Storage limits for a Percona XtraDB Cluster container.

Value type	Example
string	`1G`

`pxc.nodeSelector`¶

Value type	Example
label	`disktype: ssd`

`pxc.topologySpreadConstraints.labelSelector.matchLabels`¶

The Label selector for the Kubernetes Pod Topology Spread Constraints .

Value type	Example
label	`app.kubernetes.io/name: percona-xtradb-cluster-operator`

`pxc.topologySpreadConstraints.maxSkew`¶

The degree to which Pods may be unevenly distributed under the Kubernetes Pod Topology Spread Constraints .

Value type	Example
int	1

`pxc.topologySpreadConstraints.topologyKey`¶

The key of node labels for the Kubernetes Pod Topology Spread Constraints .

Value type	Example
string	`kubernetes.io/hostname`

`pxc.topologySpreadConstraints.whenUnsatisfiable`¶

What to do with a Pod if it doesn’t satisfy the Kubernetes Pod Topology Spread Constraints .

Value type	Example
string	`DoNotSchedule`

`pxc.affinity.topologyKey`¶

The Operator topology key node anti-affinity constraint.

Value type	Example
string	`kubernetes.io/hostname`

`pxc.affinity.advanced`¶

In cases where the Pods require complex tuning the advanced option turns off the topologyKey effect. This setting allows the standard Kubernetes affinity constraints of any complexity to be used.

Value type	Example
subdoc

`pxc.tolerations`¶

Value type	Example
subdoc	`node.alpha.kubernetes.io/unreachable`

`pxc.podDisruptionBudget.maxUnavailable`¶

The Kubernetes podDisruptionBudget specifies the number of Pods from the set unavailable after the eviction.

Value type	Example
int	`1`

`pxc.podDisruptionBudget.minAvailable`¶

The Kubernetes podDisruptionBudget Pods that must be available after an eviction.

Value type	Example
int	`0`

`pxc.volumeSpec.emptyDir`¶

The Kubernetes emptyDir volume The directory created on a node and accessible to the Percona XtraDB Cluster Pod containers.

Value type	Example
string	`{}`

`pxc.volumeSpec.hostPath.path`¶

Kubernetes hostPath The volume that mounts a directory from the host node’s filesystem into your Pod. The path property is required.

Value type	Example
string	`/data`

`pxc.volumeSpec.hostPath.type`¶

The Kubernetes hostPath . An optional property for the hostPath.

Value type	Example
string	`Directory`

`pxc.volumeSpec.persistentVolumeClaim.storageClassName`¶

Set the Kubernetes storage class to use with the Percona XtraDB Cluster PersistentVolumeClaim .

Value type	Example
string	`standard`

`pxc.volumeSpec.persistentVolumeClaim.accessModes`¶

The Kubernetes PersistentVolumeClaim access modes for the Percona XtraDB cluster.

Value type	Example
array	`[ReadWriteOnce]`

`pxc.volumeSpec.persistentVolumeClaim.dataSource.name`¶

The name of PVC used as a data source to create the Percona XtraDB Cluster Volumes by cloning .

Value type	Example
string	`new-snapshot-test`

`pxc.volumeSpec.persistentVolumeClaim.dataSource.kind`¶

The Kubernetes DataSource type .

Value type	Example
string	`VolumeSnapshot`

`pxc.volumeSpec.persistentVolumeClaim.dataSource.apiGroup`¶

The Kubernetes API group to use for PVC Data Source .

Value type	Example
string	`snapshot.storage.k8s.io`

`pxc.gracePeriod`¶

The Kubernetes grace period when terminating a Pod .

Value type	Example
int	`600`

`pxc.containerSecurityContext`¶

A custom Kubernetes Security Context for a Container to be used instead of the default one.

Value type	Example
subdoc	`privileged: true`

`pxc.podSecurityContext`¶

A custom Kubernetes Security Context for a Pod to be used instead of the default one.

Value type	Example
subdoc	fsGroup: 1001 supplementalGroups: [1001, 1002, 1003]

`pxc.serviceAccountName`¶

The Kubernetes Service Account for Percona XtraDB Cluster Pods.

Value type	Example
string	`percona-xtradb-cluster-operator-workload`

`pxc.imagePullPolicy`¶

The policy used to update images .

Value type	Example
string	`Always`

`pxc.runtimeClassName`¶

Name of the Kubernetes Runtime Class for Percona XtraDB Cluster Pods.

Value type	Example
string	`image-rc`

`pxc.sidecars.image`¶

Image for the custom sidecar container for Percona XtraDB Cluster Pods.

Value type	Example
string	`busybox`

`pxc.sidecars.command`¶

Command for the custom sidecar container for Percona XtraDB Cluster Pods.

Value type	Example
array	`["/bin/sh"]`

`pxc.sidecars.args`¶

Command arguments for the custom sidecar container for Percona XtraDB Cluster Pods.

Value type	Example
array	`["-c", "while true; do trap 'exit 0' SIGINT SIGTERM SIGQUIT SIGKILL; done;"]`

`pxc.sidecars.name`¶

Name of the custom sidecar container for Percona XtraDB Cluster Pods.

Value type	Example
string	`my-sidecar-1`

`pxc.sidecars.resources.requests.memory`¶

The Kubernetes memory requests for a Percona XtraDB Cluster sidecar container.

Value type	Example
string	`1G`

`pxc.sidecars.resources.requests.cpu`¶

Kubernetes CPU requests for a Percona XtraDB Cluster sidecar container.

Value type	Example
string	`500m`

`pxc.sidecars.resources.limits.memory`¶

Kubernetes memory limits for a Percona XtraDB Cluster sidecar container.

Value type	Example
string	`2G`

`pxc.sidecars.resources.limits.cpu`¶

Kubernetes CPU limits for a Percona XtraDB Cluster sidecar container.

Value type	Example
string	`600m`

`pxc.lifecycle.preStop.exec.command`¶

Command for the preStop lifecycle hook for Percona XtraDB Cluster Pods.

Value type	Example
array	`["/bin/true"]`

`pxc.lifecycle.postStart.exec.command`¶

Command for the postStart lifecycle hook for Percona XtraDB Cluster Pods.

Value type	Example
array	`["/bin/true"]`

HAProxy section¶

The haproxy section in the deploy/cr.yaml file contains configuration options for the HAProxy service.

`haproxy.enabled`¶

Enables or disables load balancing with HAProxy Services .

Value type	Example
boolean	`true`

`haproxy.size`¶

The number of the HAProxy Pods to provide load balancing . It should be 2 or more unless the spec.unsafeFlags.proxySize key is set to true.

Value type	Example
int	`2`

`haproxy.image`¶

HAProxy Docker image to use.

Value type	Example
string	`percona/percona-xtradb-cluster-operator:1.16.0-haproxy`

`haproxy.imagePullPolicy`¶

The policy used to update images .

Value type	Example
string	`Always`

`haproxy.imagePullSecrets.name`¶

The Kubernetes imagePullSecrets for the HAProxy image.

Value type	Example
string	`private-registry-credentials`

`haproxy.readinessDelaySec`¶

Adds a delay before a run check to verify the application is ready to process traffic.

Value type	Example
int	`15`

`haproxy.livenessDelaySec`¶

Adds a delay before the run check ensures the application is healthy and capable of processing requests.

Value type	Example
int	`300`

`haproxy.configuration`¶

The custom HAProxy configuration file contents.

Value type	Example
string

`haproxy.annotations`¶

The Kubernetes annotations metadata.

Value type	Example
label	`iam.amazonaws.com/role: role-arn`

`haproxy.labels`¶

Value type	Example
label	`rack: rack-22`

`haproxy.readinessProbes.initialDelaySeconds`¶

Number of seconds to wait before performing the first readiness probe .

Value type	Example
int	`15`

`haproxy.readinessProbes.timeoutSeconds`¶

Number of seconds after which the readiness probe times out.

Value type	Example
int	`1`

`haproxy.readinessProbes.periodSeconds`¶

How often (in seconds) to perform the readiness probe .

Value type	Example
int	`5`

`haproxy.readinessProbes.successThreshold`¶

Minimum consecutive successes for the readiness probe to be considered successful after having failed.

Value type	Example
int	`1`

`haproxy.readinessProbes.failureThreshold`¶

When the readiness probe fails, Kubernetes will try this number of times before marking the Pod Unready.

Value type	Example
int	`3`

`haproxy.serviceType`¶

Specifies the type of Kubernetes Service to be used for HAProxy. This option is deprecated and will be removed in future releases. Use haproxy.exposePrimary.type instead.

Value type	Example
string	`ClusterIP`

`haproxy.externalTrafficPolicy`¶

Specifies whether Service for HAProxy should route external traffic to cluster-wide or to node-local endpoints (it can influence the load balancing effectiveness). This option is deprecated and will be removed in future releases. Use haproxy.exposePrimary.externalTrafficPolicy instead.

Value type	Example
string	`Cluster`

`haproxy.livenessProbes.initialDelaySeconds`¶

Number of seconds to wait before performing the first liveness probe .

Value type	Example
int	`60`

`haproxy.livenessProbes.timeoutSeconds`¶

Number of seconds after which the liveness probe times out.

Value type	Example
int	`5`

`haproxy.livenessProbes.periodSeconds`¶

How often (in seconds) to perform the liveness probe .

Value type	Example
int	`30`

`haproxy.livenessProbes.successThreshold`¶

Minimum consecutive successes for the liveness probe to be considered successful after having failed.

Value type	Example
int	`1`

`haproxy.readinessProbes.failureThreshold`¶

When the liveness probe fails, Kubernetes will try this number of times before marking the Pod Unready.

Value type	Example
int	`4`

`haproxy.resources.requests.memory`¶

The Kubernetes memory requests for the main HAProxy container.

Value type	Example
string	`1G`

`haproxy.resources.requests.cpu`¶

Kubernetes CPU requests for the main HAProxy container.

Value type	Example
string	`600m`

`haproxy.resources.limits.memory`¶

Kubernetes memory limits for the main HAProxy container.

Value type	Example
string	`1G`

`haproxy.resources.limits.cpu`¶

Kubernetes CPU limits for the main HAProxy container.

Value type	Example
string	`700m`

`haproxy.envVarsSecret`¶

A secret with environment variables, see Define environment variables for details.

Value type	Example
string	`my-env-var-secrets`

`haproxy.priorityClassName`¶

The Kubernetes Pod Priority class for HAProxy.

Value type	Example
string	`high-priority`

`haproxy.schedulerName`¶

Value type	Example
string	`mycustom-scheduler`

`haproxy.nodeSelector`¶

Value type	Example
label	`disktype: ssd`

`haproxy.topologySpreadConstraints.labelSelector.matchLabels`¶

The Label selector for the Kubernetes Pod Topology Spread Constraints .

Value type	Example
label	`app.kubernetes.io/name: percona-xtradb-cluster-operator`

`haproxy.topologySpreadConstraints.maxSkew`¶

The degree to which Pods may be unevenly distributed under the Kubernetes Pod Topology Spread Constraints .

Value type	Example
int	1

`haproxy.topologySpreadConstraints.topologyKey`¶

The key of node labels for the Kubernetes Pod Topology Spread Constraints .

Value type	Example
string	`kubernetes.io/hostname`

`haproxy.topologySpreadConstraints.whenUnsatisfiable`¶

What to do with a Pod if it doesn’t satisfy the Kubernetes Pod Topology Spread Constraints .

Value type	Example
string	`DoNotSchedule`

`haproxy.affinity.topologyKey`¶

The Operator topology key node anti-affinity constraint.

Value type	Example
string	`kubernetes.io/hostname`

`haproxy.affinity.advanced`¶

If available it makes a topologyKey node affinity constraint to be ignored.

Value type	Example
subdoc

`haproxy.tolerations`¶

Value type	Example
subdoc	`node.alpha.kubernetes.io/unreachable`

`haproxy.podDisruptionBudget.maxUnavailable`¶

The Kubernetes podDisruptionBudget specifies the number of Pods from the set unavailable after the eviction.

Value type	Example
int	`1`

`haproxy.podDisruptionBudget.minAvailable`¶

The Kubernetes podDisruptionBudget Pods that must be available after an eviction.

Value type	Example
int	`0`

`haproxy.gracePeriod`¶

The Kubernetes grace period when terminating a Pod .

Value type	Example
int	`30`

`haproxy.exposePrimary.enabled`¶

Enables or disables the HAProxy primary instance Service.

Value type	Example
boolean	`false`

`haproxy.exposePrimary.type`¶

Specifies the type of Kubernetes Service to be used for HAProxy primary instance Service.

Value type	Example
string	`ClusterIP`

`haproxy.exposePrimary.externalTrafficPolicy`¶

Specifies whether Service for HAProxy should route external traffic to cluster-wide or to node-local endpoints (it can influence the load balancing effectiveness).

Value type	Example
string	`Cluster`

`haproxy.exposePrimary.internalTrafficPolicy`¶

Specifies whether Service for HAProxy primary instance should route internal traffic to cluster-wide or to node-local endpoints (it can influence the load balancing effectiveness).

Value type	Example
string	`Cluster`

`haproxy.exposePrimary.loadBalancerSourceRanges`¶

The range of client IP addresses from which the load balancer should be reachable (if not set, there is no limitations).

Value type	Example
string	`10.0.0.0/8`

`haproxy.exposePrimary.loadBalancerIP`¶

The static IP-address for the load balancer.

Value type	Example
string	`127.0.0.1`

`haproxy.serviceLabels`¶

The Kubernetes labels for the load balancer Service. This option is deprecated and will be removed in future releases. Use haproxy.exposePrimary.labels instead.

Value type	Example
label	`rack: rack-22`

`haproxy.exposePrimary.labels`¶

The Kubernetes labels for the load balancer Service.

Value type	Example
label	`rack: rack-22`

`haproxy.serviceAnnotations`¶

The Kubernetes annotations metadata for the load balancer Service. This option is deprecated and will be removed in future releases. Use haproxy.exposePrimary.annotations instead.

Value type	Example
string	`service.beta.kubernetes.io/aws-load-balancer-backend-protocol: tcp`

`haproxy.exposePrimary.annotations`¶

The Kubernetes annotations metadata for the load balancer Service.

Value type	Example
string	`service.beta.kubernetes.io/aws-load-balancer-backend-protocol: tcp`

`haproxy.replicasServiceEnabled`¶

Enables or disables haproxy-replicas Service. This Service (on by default) forwards requests to all Percona XtraDB Cluster instances, and it should not be used for write requests! This option is deprecated and will be removed in future releases. Use haproxy.exposeReplicas.enabled instead.

Value type	Example
boolean	`false`

`haproxy.exposeReplicas.enabled`¶

Enables or disables haproxy-replicas Service. This Service default forwards requests to all Percona XtraDB Cluster instances, and it should not be used for write requests!

Value type	Example
boolean	`true`

`haproxy.exposeReplicas.onlyReaders`¶

Setting it to true excludes current MySQL primary instance (writer) from the list of Pods, to which haproxy-replicas Service directs connections, leaving only the reader instances.

Value type	Example
boolean	`false`

`haproxy.replicasLoadBalancerSourceRanges`¶

The range of client IP addresses from which the load balancer should be reachable (if not set, no limitations). This option is deprecated and will be removed in future releases. Use haproxy.exposeReplicas.loadBalancerSourceRanges instead.

Value type	Example
string	`10.0.0.0/8`

`haproxy.exposeReplicas.loadBalancerSourceRanges`¶

The range of client IP addresses from which the load balancer should be reachable (if not set, no limitations).

Value type	Example
string	`10.0.0.0/8`

`haproxy.replicasLoadBalancerIP`¶

The static IP-address for the replicas load balancer. This option is deprecated and will be removed in future releases. Use haproxy.exposeReplicas.loadBalancerIP instead.

Value type	Example
string	`127.0.0.1`

`haproxy.exposeReplicas.loadBalancerIP`¶

The static IP-address for the replicas load balancer.

Value type	Example
string	`127.0.0.1`

`haproxy.replicasServiceType`¶

Specifies the type of Kubernetes Service to be used for HAProxy replicas. This option is deprecated and will be removed in future releases. Use haproxy.exposeReplicas.serviceType instead.

Value type	Example
string	`ClusterIP`

`haproxy.exposeReplicas.serviceType`¶

Specifies the type of Kubernetes Service to be used for HAProxy replicas.

Value type	Example
string	`ClusterIP`

`haproxy.replicasExternalTrafficPolicy`¶

Specifies whether Service for HAProxy replicas should route external traffic to cluster-wide or to node-local endpoints (it can influence the load balancing effectiveness). This option is deprecated and will be removed in future releases. Use haproxy.exposeReplicas.externalTrafficPolicy instead.

Value type	Example
string	`Cluster`

`haproxy.exposeReplicas.externalTrafficPolicy`¶

Specifies whether Service for HAProxy replicas should route external traffic to cluster-wide or to node-local endpoints (it can influence the load balancing effectiveness).

Value type	Example
string	`Cluster`

`haproxy.exposeReplicas.internalTrafficPolicy`¶

Specifies whether Service for HAProxy replicas should route internal traffic to cluster-wide or to node-local endpoints (it can influence the load balancing effectiveness).

Value type	Example
string	`Cluster`

`haproxy.replicasServiceLabels`¶

The Kubernetes labels for the haproxy-replicas Service. This option is deprecated and will be removed in future releases. Use haproxy.exposeReplicas.labels instead.

Value type	Example
label	`rack: rack-22`

`haproxy.exposeReplicas.labels`¶

The Kubernetes labels for the haproxy-replicas Service.

Value type	Example
label	`rack: rack-22`

`haproxy.replicasServiceAnnotations`¶

The Kubernetes annotations metadata for the haproxy-replicas Service. This option is deprecated and will be removed in future releases. Use haproxy.exposeReplicas.annotations instead.

Value type	Example
string	`service.beta.kubernetes.io/aws-load-balancer-backend-protocol: tcp`

`haproxy.exposeReplicas.annotations`¶

The Kubernetes annotations metadata for the haproxy-replicas Service.

Value type	Example
string	`service.beta.kubernetes.io/aws-load-balancer-backend-protocol: tcp`

`haproxy.containerSecurityContext`¶

A custom Kubernetes Security Context for a Container to be used instead of the default one.

Value type	Example
subdoc	`privileged: true`

`haproxy.podSecurityContext`¶

A custom Kubernetes Security Context for a Pod to be used instead of the default one.

Value type	Example
subdoc	fsGroup: 1001 supplementalGroups: [1001, 1002, 1003]

`haproxy.serviceAccountName`¶

The Kubernetes Service Account for the HAProxy Pod.

Value type	Example
string	`percona-xtradb-cluster-operator-workload`

`haproxy.runtimeClassName`¶

Name of the Kubernetes Runtime Class for the HAProxy Pod.

Value type	Example
string	`image-rc`

`haproxy.sidecars.image`¶

Image for the custom sidecar container for the HAProxy Pod.

Value type	Example
string	`busybox`

`haproxy.sidecars.command`¶

Command for the custom sidecar container for the HAProxy Pod.

Value type	Example
array	`["/bin/sh"]`

`haproxy.sidecars.args`¶

Command arguments for the custom sidecar container for the HAProxy Pod.

Value type	Example
array	`["-c", "while true; do trap 'exit 0' SIGINT SIGTERM SIGQUIT SIGKILL; done;"]`

`haproxy.sidecars.name`¶

Name of the custom sidecar container for the HAProxy Pod.

Value type	Example
string	`my-sidecar-1`

`haproxy.sidecars.resources.requests.memory`¶

The Kubernetes memory requests for the sidecar HAProxy containers.

Value type	Example
string	`1G`

`haproxy.sidecars.resources.requests.cpu`¶

Kubernetes CPU requests for the sidecar HAProxy containers.

Value type	Example
string	`500m`

`haproxy.sidecars.resources.limits.memory`¶

Kubernetes memory limits for the sidecar HAProxy containers.

Value type	Example
string	`2G`

`haproxy.sidecars.resources.limits.cpu`¶

Kubernetes CPU limits for the sidecar HAProxy containers.

Value type	Example
string	`600m`

`haproxy.lifecycle.preStop.exec.command`¶

Command for the preStop lifecycle hook for HAProxy Pods.

Value type	Example
array	`["/bin/true"]`

`haproxy.lifecycle.postStart.exec.command`¶

Command for the postStart lifecycle hook for HAProxy Pods.

Value type	Example
array	`["/bin/true"]`

ProxySQL section¶

The proxysql section in the deploy/cr.yaml file contains configuration options for the ProxySQL daemon.

`proxysql.enabled`¶

Enables or disables load balancing with ProxySQL Services ProxySQL can be enabled only at cluster creation time; otherwise you will be limited to HAProxy load balancing.

Value type	Example
boolean	`false`

`proxysql.size`¶

The number of the ProxySQL daemons to provide load balancing . It should be 2 or more unless the spec.unsafeFlags.proxySize key is set to true.

Value type	Example
int	`2`

`proxysql.image`¶

ProxySQL Docker image to use.

Value type	Example
string	`percona/percona-xtradb-cluster-operator:1.16.0-proxysql`

`proxysql.imagePullPolicy`¶

The policy used to update images .

Value type	Example
string	`Always`

`proxysql.imagePullSecrets.name`¶

The Kubernetes imagePullSecrets for the ProxySQL image.

Value type	Example
string	`private-registry-credentials`

`proxysql.readinessDelaySec`¶

Adds a delay before a run check to verify the application is ready to process traffic.

Value type	Example
int	`15`

`proxysql.livenessDelaySec`¶

Adds a delay before the run check ensures the application is healthy and capable of processing requests.

Value type	Example
int	`300`

`proxysql.configuration`¶

The custom ProxySQL configuration file contents.

Value type	Example
string

`proxysql.annotations`¶

The Kubernetes annotations metadata.

Value type	Example
label	`iam.amazonaws.com/role: role-arn`

`proxysql.labels`¶

Value type	Example
label	`rack: rack-22`

`proxysql.expose.enabled`¶

Enable or disable exposing ProxySQL nodes with dedicated IP addresses.

Value type	Example
boolean	`false`

`proxysql.serviceType`¶

Specifies the type of Kubernetes Service to be used. This option is deprecated and will be removed in future releases. Use proxysql.expose.type instead.

Value type	Example
string	`ClusterIP`

`proxysql.expose.type`¶

Specifies the type of Kubernetes Service to be used.

Value type	Example
string	`ClusterIP`

`proxysql.externalTrafficPolicy`¶

Specifies whether Service for ProxySQL should route external traffic to cluster-wide or to node-local endpoints (it can influence the load balancing effectiveness). This option is deprecated and will be removed in future releases. Use proxysql.expose.externalTrafficPolicy instead.

Value type	Example
string	`Local`

`proxysql.expose.externalTrafficPolicy`¶

Specifies whether Service for ProxySQL should route external traffic to cluster-wide or to node-local endpoints (it can influence the load balancing effectiveness).

Value type	Example
string	`Local`

`proxysql.expose.internalTrafficPolicy`¶

Specifies whether Service for ProxySQL should route internal traffic to cluster-wide or to node-local endpoints (it can influence the load balancing effectiveness).

Value type	Example
string	`Local`

`proxysql.serviceAnnotations`¶

The Kubernetes annotations metadata for the load balancer Service. This option is deprecated and will be removed in future releases. Use proxysql.expose.annotations instead.

Value type	Example
label	`service.beta.kubernetes.io/aws-load-balancer-backend-protocol: tcp`

`proxysql.expose.annotations`¶

The Kubernetes annotations metadata for the load balancer Service.

Value type	Example
label	`service.beta.kubernetes.io/aws-load-balancer-backend-protocol: tcp`

`proxysql.serviceLabels`¶

The Kubernetes labels for the load balancer Service. This option is deprecated and will be removed in future releases. Use proxysql.expose.labels instead.

Value type	Example
label	`rack: rack-22`

`proxysql.expose.labels`¶

The Kubernetes labels for the load balancer Service.

Value type	Example
label	`rack: rack-22`

`proxysql.loadBalancerSourceRanges`¶

The range of client IP addresses from which the load balancer should be reachable (if not set, there is no limitations). This option is deprecated and will be removed in future releases. Use proxysql.expose.loadBalancerSourceRanges instead.

Value type	Example
string	`10.0.0.0/8`

`proxysql.expose.loadBalancerSourceRanges`¶

The range of client IP addresses from which the load balancer should be reachable (if not set, there is no limitations).

Value type	Example
string	`10.0.0.0/8`

`proxysql.expose.loadBalancerIP`¶

The static IP-address for the load balancer.

Value type	Example
string	`127.0.0.1`

`proxysql.resources.requests.memory`¶

The Kubernetes memory requests for the main ProxySQL container.

Value type	Example
string	`1G`

`proxysql.resources.requests.cpu`¶

Kubernetes CPU requests for the main ProxySQL container.

Value type	Example
string	`600m`

`proxysql.resources.limits.memory`¶

Kubernetes memory limits for the main ProxySQL container.

Value type	Example
string	`1G`

`proxysql.resources.limits.cpu`¶

Kubernetes CPU limits for the main ProxySQL container.

Value type	Example
string	`700m`

`proxysql.envVarsSecret`¶

A secret with environment variables, see Define environment variables for details.

Value type	Example
string	`my-env-var-secrets`

`proxysql.priorityClassName`¶

The Kubernetes Pod Priority class for ProxySQL.

Value type	Example
string	`high-priority`

`proxysql.schedulerName`¶

Value type	Example
string	`mycustom-scheduler`

`proxysql.nodeSelector`¶

Value type	Example
label	`disktype: ssd`

`proxysql.topologySpreadConstraints.labelSelector.matchLabels`¶

The Label selector for the Kubernetes Pod Topology Spread Constraints .

Value type	Example
label	`app.kubernetes.io/name: percona-xtradb-cluster-operator`

`proxysql.topologySpreadConstraints.maxSkew`¶

The degree to which Pods may be unevenly distributed under the Kubernetes Pod Topology Spread Constraints .

Value type	Example
int	1

`proxysql.topologySpreadConstraints.topologyKey`¶

The key of node labels for the Kubernetes Pod Topology Spread Constraints .

Value type	Example
string	`kubernetes.io/hostname`

`proxysql.topologySpreadConstraints.whenUnsatisfiable`¶

What to do with a Pod if it doesn’t satisfy the Kubernetes Pod Topology Spread Constraints .

Value type	Example
string	`DoNotSchedule`

`proxysql.affinity.topologyKey`¶

The Operator topology key node anti-affinity constraint.

Value type	Example
string	`kubernetes.io/hostname`

`proxysql.affinity.advanced`¶

If available it makes a topologyKey node affinity constraint to be ignored.

Value type	Example
subdoc

`proxysql.tolerations`¶

Value type	Example
subdoc	`node.alpha.kubernetes.io/unreachable`

`proxysql.volumeSpec.emptyDir`¶

The Kubernetes emptyDir volume The directory created on a node and accessible to the Percona XtraDB Cluster Pod containers.

Value type	Example
string	`{}`

`proxysql.volumeSpec.hostPath.path`¶

Kubernetes hostPath The volume that mounts a directory from the host node’s filesystem into your Pod. The path property is required.

Value type	Example
string	`/data`

`proxysql.volumeSpec.hostPath.type`¶

The Kubernetes hostPath . An optional property for the hostPath.

Value type	Example
string	`Directory`

`proxysql.volumeSpec.persistentVolumeClaim.storageClassName`¶

Set the Kubernetes storage class to use with the Percona XtraDB Cluster PersistentVolumeClaim .

Value type	Example
string	`standard`

`proxysql.volumeSpec.persistentVolumeClaim.accessModes`¶

The Kubernetes PersistentVolumeClaim access modes for the Percona XtraDB cluster.

Value type	Example
array	`[ReadWriteOnce]`

`proxysql.volumeSpec.resources.requests.storage`¶

The Kubernetes PersistentVolumeClaim size for the Percona XtraDB cluster.

Value type	Example
string	`6Gi`

`proxysql.podDisruptionBudget.maxUnavailable`¶

The Kubernetes podDisruptionBudget specifies the number of Pods from the set unavailable after the eviction.

Value type	Example
int	`1`

`proxysql.podDisruptionBudget.minAvailable`¶

The Kubernetes podDisruptionBudget Pods that must be available after an eviction.

Value type	Example
int	`0`

`proxysql.gracePeriod`¶

The Kubernetes grace period when terminating a Pod .

Value type	Example
int	`30`

`proxysql.containerSecurityContext`¶

A custom Kubernetes Security Context for a Container to be used instead of the default one.

Value type	Example
subdoc	`privileged: true`

`proxysql.podSecurityContext`¶

A custom Kubernetes Security Context for a Pod to be used instead of the default one.

Value type	Example
subdoc	fsGroup: 1001 supplementalGroups: [1001, 1002, 1003]

`proxysql.serviceAccountName`¶

The Kubernetes Service Account for the ProxySQL Pod.

Value type	Example
string	`percona-xtradb-cluster-operator-workload`

`proxysql.runtimeClassName`¶

Name of the Kubernetes Runtime Class for the ProxySQL Pod.

Value type	Example
string	`image-rc`

`proxysql.sidecars.image`¶

Image for the custom sidecar container for the ProxySQL Pod.

Value type	Example
string	`busybox`

`proxysql.sidecars.command`¶

Command for the custom sidecar container for the ProxySQL Pod.

Value type	Example
array	`["/bin/sh"]`

`proxysql.sidecars.args`¶

Command arguments for the custom sidecar container for the ProxySQL Pod.

Value type	Example
array	`["-c", "while true; do trap 'exit 0' SIGINT SIGTERM SIGQUIT SIGKILL; done;"]`

`proxysql.sidecars.name`¶

Name of the custom sidecar container for the ProxySQL Pod.

Value type	Example
string	`my-sidecar-1`

`proxysql.sidecars.resources.requests.memory`¶

The Kubernetes memory requests for the sidecar ProxySQL containers.

Value type	Example
string	`1G`

`proxysql.sidecars.resources.requests.cpu`¶

Kubernetes CPU requests for the sidecar ProxySQL containers.

Value type	Example
string	`500m`

`proxysql.sidecars.resources.limits.memory`¶

Kubernetes memory limits for the sidecar ProxySQL containers.

Value type	Example
string	`2G`

`proxysql.sidecars.resources.limits.cpu`¶

Kubernetes CPU limits for the sidecar ProxySQL containers.

Value type	Example
string	`600m`

`proxysql.lifecycle.preStop.exec.command`¶

Command for the preStop lifecycle hook for ProxySQL Pods.

Value type	Example
array	`["/bin/true"]`

`proxysql.lifecycle.postStart.exec.command`¶

Command for the postStart lifecycle hook for ProxySQL Pods.

Value type	Example
array	`["/bin/true"]`

Log Collector section¶

The logcollector section in the deploy/cr.yaml file contains configuration options for Fluent Bit Log Collector .

`logcollector.enabled`¶

Enables or disables cluster-level logging with Fluent Bit.

Value type	Example
boolean	`true`

`logcollector.image`¶

Log Collector Docker image to use.

Value type	Example
string	`percona/percona-xtradb-cluster-operator:1.6.0-logcollector`

`logcollector.configuration`¶

Additional configuration options (see Fluent Bit official documentation for details).

Value type	Example
subdoc

`logcollector.resources.requests.memory`¶

The Kubernetes memory requests for a Log Collector sidecar container in a Percona XtraDB Cluster Pod.

Value type	Example
string	`100M`

`logcollector.resources.requests.cpu`¶

Kubernetes CPU requests for a Log collector sidecar container in a Percona XtraDB Cluster Pod.

Value type	Example
string	`200m`

Users section¶

The users section in the deploy/cr.yaml file contains various configuration options to configure custom MySQL users via the Custom Resource.

`users.name`¶

The username of the MySQL user.

Value type	Example
string	`my-user`

`users.dbs`¶

Databases that the user authenticates against. If the specified database is not present, the Operator will create it. When no databases specified, it defaults to all databases (*). If the user sets administrative grants like SHUTDOWN, this field has to be omitted because administrative privileges are set on a global level.

Value type	Example
array	- db1 -db2

`users.hosts`¶

Hosts that the users are supposed to connect from (if not specified, defaults to ‘%’ - similar to what is happening in MySQL).

Value type	Example
array	`- localhost`

`users.passwordSecretRef.name`¶

Name of the secret that contains the user’s password. If not provided, the Operator will create the <cluster-name>-<custom-user-name>-secret secret and generate password automatically.

Value type	Example
string	`my-user-password`

`users.passwordSecretRef.key`¶

Key in the secret that corresponds to the value of the user’s password (password by default).

Value type	Example
string	`password`

`spec.users.withGrantOption`¶

Defines if the user has grant options.

Value type	Example
boolean	`false`

`users.grants`¶

Privileges granted to the user.

Value type	Example
array	- SELECT - DELETE - INSERT

PMM section¶

The pmm section in the deploy/cr.yaml file contains configuration options for Percona Monitoring and Management.

`pmm.enabled`¶

Enables or disables monitoring Percona XtraDB cluster with PMM .

Value type	Example
boolean	`false`

`pmm.image`¶

PMM client Docker image to use.

Value type	Example
string	`percona/pmm-client:2.44.0`

`pmm.serverHost`¶

Address of the PMM Server to collect data from the cluster.

Value type	Example
string	`monitoring-service`

`pmm.serverUser`¶

The PMM Serve_User . The PMM Server password should be configured using Secrets.

Value type	Example
string	`admin`

`pmm.resources.requests.memory`¶

The Kubernetes memory requests for a PMM container.

Value type	Example
string	`150M`

`pmm.resources.requests.cpu`¶

Kubernetes CPU requests for a PMM container.

Value type	Example
string	`300m`

`pmm.pxcParams`¶

Additional parameters which will be passed to the pmm-admin add mysql command for pxc Pods.

Value type	Example
string	`--disable-tablestats-limit=2000`

`pmm.proxysqlParams`¶

Additional parameters which will be passed to the pmm-admin add proxysql command for proxysql Pods.

Value type	Example
string	`--custom-labels=CUSTOM-LABELS`

`pmm.containerSecurityContext`¶

A custom Kubernetes Security Context for a Container to be used instead of the default one.

Value type	Example
subdoc	`privileged: false`

Backup section¶

The backup section in the deploy/cr.yaml file contains the following configuration options for the regular Percona XtraDB Cluster backups.

`backup.allowParallel`¶

Enables or disables running backup jobs in parallel. By default, parallel backup jobs are enabled. A user can disable them to prevent the cluster overload.

Value type	Example
string	`true`

`backup.image`¶

The Percona XtraDB cluster Docker image to use for the backup.

Value type	Example
string	`percona/percona-xtradb-cluster-operator:1.16.0-backup`

`backup.backoffLimit`¶

The number of retries to make a backup (by default, 10 retries are made).

Value type	Example
int	`6`

`backup.activeDeadlineSeconds`¶

The timeout value in seconds, after which backup job will automatically fail.

Value type	Example
int	`3600`

`backup.imagePullSecrets.name`¶

The Kubernetes imagePullSecrets for the specified image.

Value type	Example
string	`private-registry-credentials`

`backup.storages.STORAGE-NAME.type`¶

The cloud storage type used for backups. Only s3, azure, and filesystem types are supported.

Value type	Example
string	`s3`

`backup.storages.STORAGE-NAME.verifyTLS`¶

Enable or disable verification of the storage server TLS certificate. Disabling it may be useful e.g. to skip TLS verification for private S3-compatible storage with a self-issued certificate.

Value type	Example
boolean	`true`

`backup.storages.STORAGE-NAME.s3.credentialsSecret`¶

The Kubernetes secret for backups. It should contain AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY keys.

Value type	Example
string	`my-cluster-name-backup-s3`

`backup.storages.STORAGE-NAME.s3.bucket`¶

The Amazon S3 bucket name for backups.

Value type	Example
string

`backup.storages.STORAGE-NAME.s3.region`¶

The AWS region to use. Please note this option is mandatory for Amazon and all S3-compatible storages.

Value type	Example
string	`us-east-1`

`backup.storages.STORAGE-NAME.s3.endpointUrl`¶

The endpoint URL of the S3-compatible storage to be used (not needed for the original Amazon S3 cloud).

Value type	Example
string

`backup.storages.STORAGE-NAME.persistentVolumeClaim.type`¶

The persistent volume claim storage type.

Value type	Example
string	`filesystem`

`backup.storages.STORAGE-NAME.persistentVolumeClaim.storageClassName`¶

Set the Kubernetes Storage Class to use with the Percona XtraDB Cluster backups PersistentVolumeClaims for the filesystem storage type.

Value type	Example
string	`standard`

`backup.storages.STORAGE-NAME.volume.persistentVolumeClaim.accessModes`¶

The Kubernetes PersistentVolume access modes .

Value type	Example
array	`[ReadWriteOne]`

`backup.storages.STORAGE-NAME.volume.persistentVolumeClaim.resources.requests.storage`¶

Storage size for the PersistentVolume.

Value type	Example
string	`6Gi`

`backup.storages.STORAGE-NAME.annotations`¶

The Kubernetes annotations .

Value type	Example
label	`iam.amazonaws.com/role: role-arn`

`backup.storages.STORAGE-NAME.labels`¶

Value type	Example
label	`rack: rack-22`

`backup.storages.STORAGE-NAME.resources.requests.memory`¶

The Kubernetes memory requests for a Percona XtraBackup container.

Value type	Example
string	`1G`

`backup.storages.STORAGE-NAME.resources.requests.cpu`¶

Kubernetes CPU requests for a Percona XtraBackup container.

Value type	Example
string	`600m`

`backup.storages.STORAGE-NAME.resources.limits.memory`¶

Kubernetes memory limits for a Percona XtraBackup container.

Value type	Example
string	`1.5G`

`backup.storages.STORAGE-NAME.resources.limits.cpu`¶

Kubernetes CPU limits for a Percona XtraBackup container.

Value type	Example
string	`700m`

`backup.storages.STORAGE-NAME.nodeSelector`¶

Value type	Example
label	`disktype: ssd`

`backup.storages.STORAGE-NAME.topologySpreadConstraints.labelSelector.matchLabels`¶

The Label selector for the Kubernetes Pod Topology Spread Constraints .

Value type	Example
label	`app.kubernetes.io/name: percona-xtradb-cluster-operator`

`backup.storages.STORAGE-NAME.topologySpreadConstraints.maxSkew`¶

The degree to which Pods may be unevenly distributed under the Kubernetes Pod Topology Spread Constraints .

Value type	Example
int	`1`

`backup.storages.STORAGE-NAME.topologySpreadConstraints.topologyKey`¶

The key of node labels for the Kubernetes Pod Topology Spread Constraints .

Value type	Example
string	`kubernetes.io/hostname`

`backup.storages.STORAGE-NAME.topologySpreadConstraints.whenUnsatisfiable`¶

What to do with a Pod if it doesn’t satisfy the Kubernetes Pod Topology Spread Constraints .

Value type	Example
string	`DoNotSchedule`

`backup.storages.STORAGE-NAME.affinity.nodeAffinity`¶

The Operator node affinity constraint.

Value type	Example
subdoc

`backup.storages.STORAGE-NAME.tolerations`¶

Value type	Example
subdoc	`backupWorker`

`backup.storages.STORAGE-NAME.priorityClassName`¶

The Kubernetes Pod priority class .

Value type	Example
string	`high-priority`

`backup.storages.STORAGE-NAME.schedulerName`¶