MySQL Operator for Kubernetes Manual  /  MySQL Operator Custom Resource Properties

Chapter 8 MySQL Operator Custom Resource Properties

Resource Types

InnoDBCluster

Table 8.1 Spec table for InnoDBCluster

Name Type Description Required
apiVersion string mysql.oracle.com/v2 true
kind string InnoDBCluster true
metadata object Refer to the Kubernetes API documentation true
spec object true
status object false

InnoDBCluster.spec

Parent

Table 8.2 Spec table for InnoDBCluster.spec

Name Type Description Required
secretName string

Name of a generic type Secret containing root/default account password

true
backupProfiles []object

Backup profile specifications for the cluster, which can be referenced from backup schedules and one-off backup jobs

false
backupSchedules []object

Schedules for periodically executed backups

false
baseServerId integer

Base value for MySQL server_id for instances in the cluster

  • Default: 1000

  • Minimum: 0

  • Maximum: 4294967195

false
datadirPermissions object false
datadirVolumeClaimTemplate object

Template for a PersistentVolumeClaim, to be used as datadir

false
edition string

MySQL Server Edition (community or enterprise)

false
imagePullPolicy string

Defaults to Always, but set to IfNotPresent in deploy-operator.yaml when deploying Operator

false
imagePullSecrets []object false
imageRepository string

Repository where images are pulled from; defaults to container-registry.oracle.com/mysql

false
initDB object false
instances integer

Number of MySQL replica instances for the cluster

  • Default: 1

  • Minimum: 1

  • Maximum: 9

false
keyring object

Keyring specification

false
logs object Functionality added in MySQL Operator for Kubernetes 8.2.0-2.1.1. false
metrics object

Configuration of a Prometheus-style metrics provider; functionality added in MySQL Operator for Kubernetes 8.1.0-2.1.0.

false
mycnf string

Custom configuration additions for my.cnf

false
podAnnotations object false
podLabels object false
podSpec object false
readReplicas []object false
router object

MySQL Router specification

false
service object

Configuration of the Service used by applications connecting to the InnoDB Cluster

false
serviceAccountName string false
serviceFqdnTemplate string

Template for a FQDN resolving to the cluster's headless instance Service and individual Pods; functionality added in MySQL Operator for Kubernetes 8.4.0-2.1.3.

false
tlsCASecretName string

Name of a generic type Secret containing CA (ca.pem) and optional CRL (crl.pem) for SSL

false
tlsSecretName string

Name of a TLS type Secret containing Server certificate and private key for SSL

false
tlsUseSelfSigned boolean

Enables use of self-signed TLS certificates, reducing or disabling TLS based security verifications

  • Default: false

false
version string

MySQL Server version

false
Name Type Description Required

InnoDBCluster.spec.backupProfiles[index]

Parent

Table 8.3 Spec table for InnoDBCluster.spec.backupProfiles[index]

Name Type Description Required
name string

Embedded backup profile, referenced as backupProfileName elsewhere

true
dumpInstance object false
podAnnotations object false
podLabels object false
snapshot object false

InnoDBCluster.spec.backupProfiles[index].dumpInstance

Parent

Table 8.4 Spec table for InnoDBCluster.spec.backupProfiles[index].dumpInstance

Name Type Description Required
dumpOptions object

A dictionary of key-value pairs passed directly to MySQL Shell's DumpInstance()

false
storage object false

InnoDBCluster.spec.backupProfiles[index].dumpInstance.storage

Parent

Table 8.5 Spec table for InnoDBCluster.spec.backupProfiles[index].dumpInstance.storage

Name Type Description Required
azure object false
ociObjectStorage object false
persistentVolumeClaim object

Specification of the PVC to be used. Used 'as is' in pod executing the backup.

false
s3 object false

InnoDBCluster.spec.backupProfiles[index].dumpInstance.storage.azure

Parent

Table 8.6 Spec table for InnoDBCluster.spec.backupProfiles[index].dumpInstance.storage.azure

Name Type Description Required
config string

Name of a Secret with Azure BLOB Storage configuration and credentials

true
containerName string

Name of the Azure BLOB Storage container where the dump is stored

true
prefix string

Path in the container where the dump files are stored

false

InnoDBCluster.spec.backupProfiles[index].dumpInstance.storage.ociObjectStorage

Parent

Table 8.7 Spec table for InnoDBCluster.spec.backupProfiles[index].dumpInstance.storage.ociObjectStorage

Name Type Description Required
bucketName string

Name of the OCI bucket where backup is stored

true
credentials string

Name of a Secret with data for accessing the bucket

true
prefix string

Path in bucket where backup is stored

false

InnoDBCluster.spec.backupProfiles[index].dumpInstance.storage.s3

Parent

Table 8.8 Spec table for InnoDBCluster.spec.backupProfiles[index].dumpInstance.storage.s3

Name Type Description Required
bucketName string

Name of the S3 bucket where the dump is stored

true
config string

Name of a Secret with S3 configuration and credentials

true
endpoint string

Override endpoint URL

false
prefix string

Path in the bucket where the dump files are stored

false
profile string

Profile being used in configuration files

  • Default:

false

InnoDBCluster.spec.backupProfiles[index].snapshot

Parent

Table 8.9 Spec table for InnoDBCluster.spec.backupProfiles[index].snapshot

Name Type Description Required
storage object false

InnoDBCluster.spec.backupProfiles[index].snapshot.storage

Parent

Table 8.10 Spec table for InnoDBCluster.spec.backupProfiles[index].snapshot.storage

Name Type Description Required
azure object false
ociObjectStorage object false
persistentVolumeClaim object

Specification of the PVC to be used. Used 'as is' in pod executing the backup.

false
s3 object false

InnoDBCluster.spec.backupProfiles[index].snapshot.storage.azure

Parent

Table 8.11 Spec table for InnoDBCluster.spec.backupProfiles[index].snapshot.storage.azure

Name Type Description Required
config string

Name of a Secret with Azure BLOB Storage configuration and credentials

true
containerName string

Name of the Azure BLOB Storage container where the dump is stored

true
prefix string

Path in the container where the dump files are stored

false

InnoDBCluster.spec.backupProfiles[index].snapshot.storage.ociObjectStorage

Parent

Table 8.12 Spec table for InnoDBCluster.spec.backupProfiles[index].snapshot.storage.ociObjectStorage

Name Type Description Required
bucketName string

Bucket name where backup is stored

true
credentials string

Name of a Secret with data for accessing the bucket

true
prefix string

Path in bucket where backup is stored

false

InnoDBCluster.spec.backupProfiles[index].snapshot.storage.s3

Parent

Table 8.13 Spec table for InnoDBCluster.spec.backupProfiles[index].snapshot.storage.s3

Name Type Description Required
bucketName string

Name of the S3 bucket where the dump is stored

true
config string

Name of a Secret with S3 configuration and credentials

true
endpoint string

Override endpoint URL

false
prefix string

Path in the bucket where the dump files are stored

false
profile string

Profile being used in configuration files

  • Default:

false

InnoDBCluster.spec.backupSchedules[index]

Parent

Table 8.14 Spec table for InnoDBCluster.spec.backupSchedules[index]

Name Type Description Required
name string

Name of the backup schedule

true
schedule string

The schedule of the job, syntax as a cron expression

true
backupProfile object

backupProfile specification if backupProfileName is not specified

false
backupProfileName string

Name of the backupProfile to be used

false
deleteBackupData boolean

Whether to delete the backup data in case the MySQLBackup object created by the job is deleted

  • Default: false

false
enabled boolean

Whether the schedule is enabled or not

  • Default: true

false
timeZone string

Timezone for the backup schedule, example: 'America/New_York' -- functionality added in MySQL Operator for Kubernetes 8.3.0-2.1.2.

false

InnoDBCluster.spec.backupSchedules[index].backupProfile

Parent

Description: backupProfile specification if backupProfileName is not specified

Table 8.15 Spec table for InnoDBCluster.spec.backupSchedules[index].backupProfile

Name Type Description Required
dumpInstance object false
podAnnotations object false
podLabels object false

InnoDBCluster.spec.backupSchedules[index].backupProfile.dumpInstance

Parent

Table 8.16 Spec table for InnoDBCluster.spec.backupSchedules[index].backupProfile.dumpInstance

Name Type Description Required
dumpOptions object

A dictionary of key-value pairs passed directly to MySQL Shell's DumpInstance()

false
storage object false

InnoDBCluster.spec.backupSchedules[index].backupProfile.dumpInstance.storage

Parent

Table 8.17 Spec table for InnoDBCluster.spec.backupSchedules[index].backupProfile.dumpInstance.storage

Name Type Description Required
azure object false
ociObjectStorage object false
persistentVolumeClaim object

Specification of the PVC to be used. Used 'as is' in pod executing the backup.

false
s3 object false

InnoDBCluster.spec.backupSchedules[index].backupProfile.dumpInstance.storage.azure

Parent

Table 8.18 Spec table for InnoDBCluster.spec.backupSchedules[index].backupProfile.dumpInstance.storage.azure

Name Type Description Required
config string

Name of a Secret with Azure BLOB Storage configuration and credentials

true
containerName string

Name of the Azure BLOB Storage container where the dump is stored

true
prefix string

Path in the container where the dump files are stored

false

InnoDBCluster.spec.backupSchedules[index].backupProfile.dumpInstance.storage.ociObjectStorage

Parent

Table 8.19 Spec table for InnoDBCluster.spec.backupSchedules[index].backupProfile.dumpInstance.storage.ociObjectStorage

Name Type Description Required
bucketName string

Name of the OCI Bucket where backup is stored

true
credentials string

Name of a Secret with data for accessing the bucket

true
prefix string

Path in bucket where backup is stored

false

InnoDBCluster.spec.backupSchedules[index].backupProfile.dumpInstance.storage.s3

Parent

Table 8.20 Spec table for InnoDBCluster.spec.backupSchedules[index].backupProfile.dumpInstance.storage.s3

Name Type Description Required
bucketName string

Name of the S3 bucket where the dump is stored

true
config string

Name of a Secret with S3 configuration and credentials

true
endpoint string

Override endpoint URL

false
prefix string

Path in the bucket where the dump files are stored

false
profile string

Profile being used in configuration files

  • Default:

false

InnoDBCluster.spec.datadirPermissions

Functionality added in MySQL Operator for Kubernetes 9.1.0-2.2.2.

Parent

Table 8.21 Spec table for InnoDBCluster.spec.datadirPermissions

Name Type Description Required
fsGroupChangePolicy string

Optional fsGroupChangePolicy value to be set in the pod security context. Some possible values are OnRootMismatch and Always. For more information check the official Kubernetes documentation

  • Default:

false
setRightsUsingInitContainer boolean

Whether to use an init container to set at start the DataDir permissions

  • Default: true

false

InnoDBCluster.spec.imagePullSecrets[index]

Parent

Table 8.22 Spec table for InnoDBCluster.spec.imagePullSecrets[index]

Name Type Description Required
name string false

InnoDBCluster.spec.initDB

Parent

Table 8.23 Spec table for InnoDBCluster.spec.initDB

Name Type Description Required
clone object false
dump object false

InnoDBCluster.spec.initDB.clone

Parent

Table 8.24 Spec table for InnoDBCluster.spec.initDB.clone

Name Type Description Required
donorUrl string

URL of the cluster to clone from

true
secretKeyRef object true
rootUser string

User name used for cloning

  • Default: root

false

InnoDBCluster.spec.initDB.clone.secretKeyRef

Parent

Table 8.25 Spec table for InnoDBCluster.spec.initDB.clone.secretKeyRef

Name Type Description Required
name string

Secret name with key 'rootPassword' storing the password for the user specified in rootUser

true

InnoDBCluster.spec.initDB.dump

Parent

Table 8.26 Spec table for InnoDBCluster.spec.initDB.dump

Name Type Description Required
storage object true
name string

Name of the dump. Not used by the operator, but a descriptive hint for the cluster administrator

false
options object

A dictionary of key-value pairs passed directly to MySQL Shell's loadDump()

false
path string

Path to the dump in the PVC. Use when specifying persistentVolumeClaim. Omit for ociObjectStorage, S3, or azure.

false

InnoDBCluster.spec.initDB.dump.storage

Parent

Table 8.27 Spec table for InnoDBCluster.spec.initDB.dump.storage

Name Type Description Required
azure object false
ociObjectStorage object false
persistentVolumeClaim object

Specification of the PVC to be used. Used 'as is' in the cloning pod.

false
s3 object false

InnoDBCluster.spec.initDB.dump.storage.azure

Parent

Table 8.28 Spec table for InnoDBCluster.spec.initDB.dump.storage.azure

Name Type Description Required
config string

Name of a Secret with Azure BLOB Storage configuration and credentials

true
containerName string

Name of the Azure BLOB Storage container where the dump is stored

true
prefix string

Path in the container where the dump files are stored

true

InnoDBCluster.spec.initDB.dump.storage.ociObjectStorage

Parent

Table 8.29 Spec table for InnoDBCluster.spec.initDB.dump.storage.ociObjectStorage

Name Type Description Required
bucketName string

Name of the OCI bucket where the dump is stored

true
credentials string

Name of a Secret with data for accessing the bucket

true
prefix string

Path in the bucket where the dump files are stored

true

InnoDBCluster.spec.initDB.dump.storage.s3

Parent

Table 8.30 Spec table for InnoDBCluster.spec.initDB.dump.storage.s3

Name Type Description Required
bucketName string

Name of the S3 bucket where the dump is stored

true
config string

Name of a Secret with S3 configuration and credentials

true
prefix string

Path in the bucket where the dump files are stored

true
endpoint string

Override endpoint URL

false
profile string

Profile being used in configuration files

  • Default:

false

InnoDBCluster.spec.keyring

Parent

Description: Keyring specification

Table 8.31 Spec table for InnoDBCluster.spec.keyring

Name Type Description Required
encryptedFile object

Keyring 'Encrypted File' specification

false
file object

Keyring 'File' specification

false
oci object

Keyring 'OCI' specification

false

InnoDBCluster.spec.keyring.encryptedFile

Parent

Description: Keyring 'Encrypted File' specification

Table 8.32 Spec table for InnoDBCluster.spec.keyring.encryptedFile

Name Type Description Required
password string

Name of a secret that contains password for the keyring in the key 'keyring_password'

true
storage object

Specification of the volume to be mounted where the keyring file resides

true
fileName string

Path to the keyring file name inside the storage volume (will be prefixed by mount path)

  • Default: mysql_keyring

false
readOnly boolean

Whether to open the keyring file in read-only mode

  • Default: false

false

InnoDBCluster.spec.keyring.file

Parent

Description: Keyring 'File' specification

Table 8.33 Spec table for InnoDBCluster.spec.keyring.file

Name Type Description Required
storage object

Specification of the volume to be mounted where the keyring file resides

true
fileName string

Path to the keyring file name inside the storage volume (will be prefixed by mount path)

  • Default: mysql_keyring

false
readOnly boolean

Whether to open the keyring file in read-only mode

  • Default: false

false

InnoDBCluster.spec.keyring.oci

Parent

Description: Keyring 'OCI' specification

Table 8.34 Spec table for InnoDBCluster.spec.keyring.oci

Name Type Description Required
keyFingerprint string

Private key fingerprint

true
keySecret string

A secret that contains the private key under the field 'privatekey'

true
tenancy string

Tenancy identifier in the form ocid1.tenancy.oc1...

true
user string

User identifier in the form of ocid1.user.oc1...

true
caCertificate string

Secret that contains ca.crt field with CA certificate bundle file that the keyring_oci plugin uses for Oracle Cloud Infrastructure certificate verification

false
compartment string

Compartment identifier in the form ocid1.compartment.oc1...

false
endpoints object false
masterKey string

Master key identified in the form ocid1.key.oc1...

false
virtualVault string

Vault identifier in the form ocid1.vault.oc1...

false

InnoDBCluster.spec.keyring.oci.endpoints

Parent

Table 8.35 Spec table for InnoDBCluster.spec.keyring.oci.endpoints

Name Type Description Required
encryption string

Encryption endpoint URI like {identifier}-crypto.kms.{region}.oraclecloud.com

false
management string

Management endpoint URI like {identifier}-management.kms.{region}.oraclecloud.com

false
secrets string

Secrets endpoint URI like secrets.vaults.{region}.oci.oraclecloud.com

false
vaults string

Vaults endpoint URI like vaults.{region}.oci.oraclecloud.com

false

InnoDBCluster.spec.logs

Functionality added in MySQL Operator for Kubernetes 8.2.0-2.1.1.

Parent

Table 8.36 Spec table for InnoDBCluster.spec.logs

Name Type Description Required
collector object false
error object false
general object false
slowQuery object false

InnoDBCluster.spec.logs.collector

Parent

Table 8.37 Spec table for InnoDBCluster.spec.logs.collector

Name Type Description Required
containerName string

Name of the collector container sidecar

  • Default: logcollector

false
env []object false
fluentd object

Properties of the fluentd log collector

false
image string

Name of an image, including registry and repository, to be used for the log collector sidecar. If provided it needs to be an image for the configured collector type.

false

InnoDBCluster.spec.logs.collector.fluentd

Parent

Description: Properties of the fluentd log collector

Table 8.38 Spec table for InnoDBCluster.spec.logs.collector.fluentd

Name Type Description Required
additionalFilterConfiguration string

Raw configuration of additional Fluentd filters to be added to the configuration file

false
errorLog object false
generalLog object false
recordAugmentation object false
sinks []object false
slowQueryLog object false

InnoDBCluster.spec.logs.collector.fluentd.errorLog

Parent

Table 8.39 Spec table for InnoDBCluster.spec.logs.collector.fluentd.errorLog

Name Type Description Required
options object

fluentd specific options for the error log

false
tag string

Tag for the error log records

  • Default:

false

InnoDBCluster.spec.logs.collector.fluentd.generalLog

Parent

Table 8.40 Spec table for InnoDBCluster.spec.logs.collector.fluentd.generalLog

Name Type Description Required
options object

fluentd specific options for the general log

false
tag string

Tag for the general log records

  • Default:

false

InnoDBCluster.spec.logs.collector.fluentd.recordAugmentation

Parent

Table 8.41 Spec table for InnoDBCluster.spec.logs.collector.fluentd.recordAugmentation

Name Type Description Required
annotations []object false
enabled boolean

Whether to enable record augmentation with additional data

  • Default: false

false
labels []object false
podFields []object false
resourceFields []object false
staticFields []object false

InnoDBCluster.spec.logs.collector.fluentd.recordAugmentation.annotations[index]

Parent

Table 8.42 Spec table for InnoDBCluster.spec.logs.collector.fluentd.recordAugmentation.annotations[index]

Name Type Description Required
annotationName string

Name of the pod label that holds the value to be stored under fieldName in the log record

true
fieldName string

Name of the field added to the log record with value from annotationName

true

InnoDBCluster.spec.logs.collector.fluentd.recordAugmentation.labels[index]

Parent

Table 8.43 Spec table for InnoDBCluster.spec.logs.collector.fluentd.recordAugmentation.labels[index]

Name Type Description Required
fieldName string

Name of the field added to the log record with value from labelName

true
labelName string

Name of the pod label that holds the value to be stored under fieldName in the log record

true

InnoDBCluster.spec.logs.collector.fluentd.recordAugmentation.podFields[index]

Parent

Table 8.44 Spec table for InnoDBCluster.spec.logs.collector.fluentd.recordAugmentation.podFields[index]

Name Type Description Required
fieldName string

Name of the field added to the log record with value taken from a field with path stored in fieldPath

true
fieldPath string

Value for the field fieldName. The path should be of the same syntax as the one used for mounting environment variables from field reference - valueFrom.fieldRef.fieldPath . The field will be mounted in the pod as a environment variable, prefixed with a prefix and used then added to the log record. Examples for fieldRef are : spec.nodeName, metadata.namespace, status.podIP, etc.

true

InnoDBCluster.spec.logs.collector.fluentd.recordAugmentation.resourceFields[index]

Parent

Table 8.45 Spec table for InnoDBCluster.spec.logs.collector.fluentd.recordAugmentation.resourceFields[index]

Name Type Description Required
containerName string true
fieldName string

Name of the field added to the log record with value taken from a field with path stored in fieldPath

true
resource string

See https://kubernetes.io/docs/tasks/inject-data-application/environment-variable-expose-pod-information/#use-container-fields-as-values-for-environment-variables

true

InnoDBCluster.spec.logs.collector.fluentd.recordAugmentation.staticFields[index]

Parent

Table 8.46 Spec table for InnoDBCluster.spec.logs.collector.fluentd.recordAugmentation.staticFields[index]

Name Type Description Required
fieldName string

Name of the field added to the log record with value from fieldValue

true
fieldValue string

Value for the static field with name taken from fieldName

true

InnoDBCluster.spec.logs.collector.fluentd.sinks[index]

Parent

Table 8.47 Spec table for InnoDBCluster.spec.logs.collector.fluentd.sinks[index]

Name Type Description Required
name string

Name of the sink. Used only for documentation purposes

true
rawConfig string

Raw configuration of the sink

true

InnoDBCluster.spec.logs.collector.fluentd.slowQueryLog

Parent

Table 8.48 Spec table for InnoDBCluster.spec.logs.collector.fluentd.slowQueryLog

Name Type Description Required
options object

fluentd specific options for the slow log

false
tag string

Tag for the slow log records

  • Default:

false

InnoDBCluster.spec.logs.error

Parent

Table 8.49 Spec table for InnoDBCluster.spec.logs.error

Name Type Description Required
collect boolean

Whether error logging data should be collected. Implies that the logging should be enabled. If enabled the error log will be switched to JSON format output

  • Default: false

false
verbosity integer

Log error verbosity. For details, see the MySQL Server --log-error-verbosity documentation.

  • Default: 3

  • Minimum: 1

  • Maximum: 3

false

InnoDBCluster.spec.logs.general

Parent

Table 8.50 Spec table for InnoDBCluster.spec.logs.general

Name Type Description Required
collect boolean

Whether general logging data should be collected. Implies that the logging should be enabled.

  • Default: false

false
enabled boolean

Whether general logging should be enabled

  • Default: false

false

InnoDBCluster.spec.logs.slowQuery

Parent

Table 8.51 Spec table for InnoDBCluster.spec.logs.slowQuery

Name Type Description Required
collect boolean

Whether slow query logging data should be collected. Implies that the logging should be enabled.

  • Default: false

false
enabled boolean

Whether slow query logging should be enabled

  • Default: false

false
longQueryTime number

Long query time threshold

  • Default: 10

  • Minimum: 0

false

InnoDBCluster.spec.metrics

Parent

Description: Configuration of a Prometheus-style metrics provider; functionality added in MySQL Operator for Kubernetes 8.1.0-2.1.0.

Table 8.52 Spec table for InnoDBCluster.spec.metrics

Name Type Description Required
enable boolean

Toggle to enable or disable the metrics sidecar

  • Default: false

true
image string

Name of an image to be used for the metrics sidecar, if provided metrics will be enabled

true
monitor boolean

Create a ServiceMonitor for Prometheus Operator

  • Default: false

false
monitorSpec object

Custom configuration for the ServiceMonitor object

  • Default: map[]

false
options []string

Options passed to the metrics provider as command line arguments

false
tlsSecret string

Name of a Secret with TLS certificate, key and CA, which will be mounted at /tls into the container an can be used from webConfig

false
webConfig string

Name of a ConfigMap with a web.config file, if this option is provided a command line option --web.config.file is added

false

InnoDBCluster.spec.readReplicas[index]

Functionality added in MySQL Operator for Kubernetes 8.2.0-2.1.1.

Parent

Table 8.53 Spec table for InnoDBCluster.spec.readReplicas[index]

Name Type Description Required
baseServerId integer

Base value for MySQL server_id for instances of the readReplica, if 0 it will be assigned automatically

  • Default: 0

  • Minimum: 0

  • Maximum: 4294967195

true
name string true
datadirVolumeClaimTemplate object

Template for a PersistentVolumeClaim, to be used as datadir

false
instances integer

Number of MySQL instances for the set of read replica

  • Default: 1

  • Minimum: 1

  • Maximum: 999

false
mycnf string

Custom configuration additions for my.cnf

false
podAnnotations object false
podLabels object false
podSpec object false
version string

MySQL Server version

false

InnoDBCluster.spec.router

Parent

Description: MySQL Router specification

Table 8.54 Spec table for InnoDBCluster.spec.router

Name Type Description Required
bootstrapOptions []string

Command line options passed to MySQL Router while bootstrapping; functionality added in MySQL Operator for Kubernetes 8.2.0-2.1.1.

false
instances integer

Number of MySQL Router instances to deploy

  • Default: 1

  • Minimum: 0

false
options []string

Command line options passed to MySQL Router while running; functionality added in MySQL Operator for Kubernetes 8.2.0-2.1.1.

false
podAnnotations object false
podLabels object false
podSpec object false
routingOptions object

Set routing options for the cluster

false
tlsSecretName string

Name of a TLS type Secret containing MySQL Router certificate and private key used for SSL

false
version string

Override MySQL Router version

false

InnoDBCluster.spec.router.routingOptions

Parent

Description: Set routing options for the cluster

Table 8.55 Spec table for InnoDBCluster.spec.router.routingOptions

Name Type Description Required
invalidated_cluster_policy enum

  • Enum: drop_all, accept_ro

false
read_only_targets enum

  • Enum: all, read_replicas, secondaries

false
stats_updates_frequency integer

  • Default: 0

  • Minimum: 0

false

InnoDBCluster.spec.service

Parent

Description: Configuration of the Service used by applications connecting to the InnoDB Cluster

Table 8.56 Spec table for InnoDBCluster.spec.service

Name Type Description Required
annotations object

Custom annotations for the Service

false
defaultPort enum

Target for the Service's default (3306) port. If mysql-rw traffic will go to the primary and allow read and write operations, with mysql-ro traffic goes to the replica and allows only read operations, with mysql-rw-split the router's read-write-splitting will be targeted

  • Enum: mysql-rw, mysql-ro, mysql-rw-split

  • Default: mysql-rw

false
labels object

Custom labels for the Service

false
type enum

  • Enum: ClusterIP, NodePort, LoadBalancer

  • Default: ClusterIP

false

MySQLBackup

Table 8.57 Spec table for MySQLBackup

Name Type Description Required
apiVersion string mysql.oracle.com/v2 true
kind string MySQLBackup true
metadata object Refer to the Kubernetes API documentation true
spec object false
status object false

MySQLBackup.spec

Parent

Table 8.58 Spec table for MySQLBackup.spec

Name Type Description Required
clusterName string true
addTimestampToBackupDirectory boolean

  • Default: true

false
backupProfile object

backupProfile specification if backupProfileName is not specified

false
backupProfileName string false
deleteBackupData boolean

  • Default: false

false

MySQLBackup.spec.backupProfile

Parent

Description: backupProfile specification if backupProfileName is not specified

Table 8.59 Spec table for MySQLBackup.spec.backupProfile

Name Type Description Required
dumpInstance object false
podAnnotations object false
podLabels object false

MySQLBackup.spec.backupProfile.dumpInstance

Parent

Table 8.60 Spec table for MySQLBackup.spec.backupProfile.dumpInstance

Name Type Description Required
dumpOptions object

A dictionary of key-value pairs passed directly to MySQL Shell's DumpInstance()

false
storage object false

MySQLBackup.spec.backupProfile.dumpInstance.storage

Parent

Table 8.61 Spec table for MySQLBackup.spec.backupProfile.dumpInstance.storage

Name Type Description Required
azure object false
ociObjectStorage object false
persistentVolumeClaim object

Specification of the PVC to be used. Used 'as is' in pod executing the backup.

false
s3 object false

MySQLBackup.spec.backupProfile.dumpInstance.storage.azure

Parent

Table 8.62 Spec table for MySQLBackup.spec.backupProfile.dumpInstance.storage.azure

Name Type Description Required
config string

Name of a Secret with Azure BLOB Storage configuration and credentials

true
containerName string

Name of the Azure BLOB Storage container where the dump is stored

true
prefix string

Path in the container where the dump files are stored

false

MySQLBackup.spec.backupProfile.dumpInstance.storage.ociObjectStorage

Parent

Table 8.63 Spec table for MySQLBackup.spec.backupProfile.dumpInstance.storage.ociObjectStorage

Name Type Description Required
bucketName string

Name of the OCI bucket where backup is stored

true
credentials string

Name of a Secret with data for accessing the bucket

true
prefix string

Path in bucket where backup is stored

false

MySQLBackup.spec.backupProfile.dumpInstance.storage.s3

Parent

Table 8.64 Spec table for MySQLBackup.spec.backupProfile.dumpInstance.storage.s3

Name Type Description Required
bucketName string

Name of the S3 bucket where the dump is stored

true
config string

Name of a Secret with S3 configuration and credentials

true
endpoint string

Override endpoint URL

false
prefix string

Path in the bucket where the dump files are stored

false
profile string

Profile being used in configuration files

  • Default:

false

MySQLBackup.status

Parent

Table 8.65 Spec table for MySQLBackup.status

Name Type Description Required
bucket string false
completionTime string false
container string false
elapsedTime string false
message string false
method string false
ociTenancy string false
output string false
size string false
source string false
spaceAvailable string false
startTime string false
status string false
Name Type Description Required

Resource Types

ClusterKopfPeering

Table 8.66 Spec table for ClusterKopfPeering

Name Type Description Required
apiVersion string zalando.org/v1 true
kind string ClusterKopfPeering true
metadata object Refer to the Kubernetes API documentation true
status object false

KopfPeering

Table 8.67 Spec table for KopfPeering

Name Type Description Required
apiVersion string zalando.org/v1 true
kind string KopfPeering true
metadata object Refer to the Kubernetes API documentation true
status object false


PREV   HOME   UP  
Related Documentation
MySQL Operator for Kubernetes Release Notes
MySQL Shell
MySQL Router
Download this Manual
PDF (US Ltr) - 341.1Kb
PDF (A4) - 339.2Kb