MySQL Operator for Kubernetes Manual  /  MySQL Operator Custom Resource Properties

Chapter 7 MySQL Operator Custom Resource Properties

Resource Types

InnoDBCluster

Table 7.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 7.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
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 from where images must be pulled from; defaults to mysql for community and container-registry.oracle.com/mysql for enterprise

false
initDB object

false
instances integer

Number of MySQL replica instances for the cluster

  • Default: 1

  • Minimum: 1

  • Maximum: 9

false
mycnf string

Custom configuration additions for my.cnf

false
podSpec object

false
router object

MySQL Router specification

false
serviceAccountName string

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

InnoDBCluster.spec.backupProfiles[index]

Parent

Table 7.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
snapshot object

false

InnoDBCluster.spec.backupProfiles[index].dumpInstance

Parent

Table 7.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 7.5 Spec table for InnoDBCluster.spec.backupProfiles[index].dumpInstance.storage

Name Type Description Required
ociObjectStorage object

false
persistentVolumeClaim object

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

false

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

Parent

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

Name Type Description Required
bucketName string

Bucket name where backup is stored

true
credentials string

Secret name with data for accessing the bucket

true
prefix string

Path in bucket where backup is stored

true

InnoDBCluster.spec.backupProfiles[index].snapshot

Parent

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

Name Type Description Required
storage object

false

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

Parent

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

Name Type Description Required
ociObjectStorage object

false
persistentVolumeClaim object

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

false

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

Parent

Table 7.9 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

Secret name with data for accessing the bucket

true
prefix string

Path in bucket where backup is stored

true

InnoDBCluster.spec.backupSchedules[index]

Parent

Table 7.10 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

InnoDBCluster.spec.imagePullSecrets[index]

Parent

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

Name Type Description Required
name string

false

InnoDBCluster.spec.initDB

Parent

Table 7.12 Spec table for InnoDBCluster.spec.initDB

Name Type Description Required
clone object

false
dump object

false

InnoDBCluster.spec.initDB.clone

Parent

Table 7.13 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 7.14 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 7.15 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
path string

Path to the dump in the PVC. Use when specifying persistentVolumeClaim. Omit for ociObjectStorage.

false

InnoDBCluster.spec.initDB.dump.storage

Parent

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

Name Type Description Required
ociObjectStorage object

false
persistentVolumeClaim object

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

false

InnoDBCluster.spec.initDB.dump.storage.ociObjectStorage

Parent

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

Name Type Description Required
bucketName string

Name of the bucket where the dump is stored

true
credentials string

Secret name with data for accessing the bucket

true
prefix string

Path in the bucket where the dump files are stored

true

InnoDBCluster.spec.router

Parent

MySQL Router specification

Table 7.18 Spec table for InnoDBCluster.spec.router

Name Type Description Required
instances integer

Number of MySQL Router instances to deploy

  • Default: 1

  • Minimum: 0

false
podSpec object

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

MySQLBackup

Table 7.19 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 7.20 Spec table for MySQLBackup.spec

Name Type Description Required
clusterName string

true
addTimestampToBackupDirectory boolean

  • Default: true

false
backupProfile object

false
backupProfileName string

false
deleteBackupData boolean

  • Default: false

false

MySQLBackup.status

Parent

Table 7.21 Spec table for MySQLBackup.status

Name Type Description Required
bucket string

false
completionTime string

false
elapsedTime 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

Resource Types

ClusterKopfPeering

Table 7.22 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 7.23 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