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
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
|
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
|
false |
keyring |
object | Keyring specification |
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 | |
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
|
false |
version |
string | MySQL Server version |
false |
InnoDBCluster.spec.backupProfiles[index]
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
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
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
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
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
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
|
false |
InnoDBCluster.spec.backupProfiles[index].snapshot
Table 8.9 Spec table for InnoDBCluster.spec.backupProfiles[index].snapshot
Name | Type | Description | Required |
---|---|---|---|
storage |
object | false |
InnoDBCluster.spec.backupProfiles[index].snapshot.storage
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
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
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
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
|
false |
InnoDBCluster.spec.backupSchedules[index]
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
|
false |
enabled |
boolean |
Whether the schedule is enabled or not
|
false |
InnoDBCluster.spec.backupSchedules[index].backupProfile
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
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
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
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
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
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
|
false |
InnoDBCluster.spec.imagePullSecrets[index]
Table 8.21 Spec table for InnoDBCluster.spec.imagePullSecrets[index]
Name | Type | Description | Required |
---|---|---|---|
name |
string | false |
InnoDBCluster.spec.initDB
InnoDBCluster.spec.initDB.clone
Table 8.23 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
|
false |
InnoDBCluster.spec.initDB.clone.secretKeyRef
Table 8.24 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
Table 8.25 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
Table 8.26 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
Table 8.27 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
Table 8.28 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
Table 8.29 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
|
false |
InnoDBCluster.spec.keyring
Description: Keyring specification
Table 8.30 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
Description: Keyring 'Encrypted File' specification
Table 8.31 Spec table for InnoDBCluster.spec.keyring.encryptedFile
Name | Type | Description | Required |
---|---|---|---|
fileName |
string | Full path to the keyring file name inside the storage volume |
true |
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 |
readOnly |
boolean |
Whether to open the keyring file in read-only mode
|
false |
InnoDBCluster.spec.keyring.file
Description: Keyring 'File' specification
Table 8.32 Spec table for InnoDBCluster.spec.keyring.file
Name | Type | Description | Required |
---|---|---|---|
fileName |
string | Full path to the keyring file name inside the storage volume |
true |
storage |
object | Specification of the volume to be mounted where the keyring file resides |
true |
readOnly |
boolean |
Whether to open the keyring file in read-only mode
|
false |
InnoDBCluster.spec.keyring.oci
Description: Keyring 'OCI' specification
Table 8.33 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
Table 8.34 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.metrics
Description: Configuration of a Prometheus-style metrics provider; functionality added in MySQL Operator for Kubernetes 8.1.0-2.1.0.
Table 8.35 Spec table for InnoDBCluster.spec.metrics
Name | Type | Description | Required |
---|---|---|---|
enable |
boolean |
Toggle to enable or disable the metrics sidecar
|
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
|
false |
monitorSpec |
object |
Custom configuration for the ServiceMonitor object
|
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.router
Description: MySQL Router specification
Table 8.36 Spec table for InnoDBCluster.spec.router
Name | Type | Description | Required |
---|---|---|---|
instances |
integer |
Number of MySQL Router instances to deploy
|
false |
podAnnotations |
object | false | |
podLabels |
object | 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
MySQLBackup.spec
Table 8.38 Spec table for MySQLBackup.spec
Name | Type | Description | Required |
---|---|---|---|
clusterName |
string | true | |
addTimestampToBackupDirectory |
boolean |
|
false |
backupProfile |
object | backupProfile specification if backupProfileName is not specified |
false |
backupProfileName |
string | false | |
deleteBackupData |
boolean |
|
false |
MySQLBackup.spec.backupProfile
Description: backupProfile specification if backupProfileName is not specified
Table 8.39 Spec table for MySQLBackup.spec.backupProfile
Name | Type | Description | Required |
---|---|---|---|
dumpInstance |
object | false | |
podAnnotations |
object | false | |
podLabels |
object | false |
MySQLBackup.spec.backupProfile.dumpInstance
Table 8.40 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
Table 8.41 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
Table 8.42 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
Table 8.43 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
Table 8.44 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
|
false |
MySQLBackup.status
Table 8.45 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 |
Resource Types
ClusterKopfPeering
Table 8.46 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.47 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 |