Property Reference for Backup and Restore

Warning: VMware Tanzu™ SQL with MySQL for Kubernetes is currently in beta and is intended for evaluation and test purposes only. Do not use this product in a production environment. If you discover any bugs, contact Support.

Page last updated:

This topic contains property reference tables for the resources that you create for performing backup and restore. For information about backup and restore, see Backing Up and Restoring in Tanzu MySQL for Kubernetes.

Properties for the TanzuMySQLBackupLocation Resource

The table below explains the properties that can be set in the backuplocation.yaml file.

Property Type Default Description Example Req?
metadata.name String None The name of the TanzuMySQLBackupLocation. Must be unique within a namespace. backuplocation-sample Yes
spec.storage.s3.bucket String None The name of an existing S3-compatible bucket for this backup location. s3-bucket-sample Yes
spec.storage.s3.bucketPath String None The name of the path where backup artifacts will be uploaded. If a folder in the path does not already exist, it is created automatically. s3-sample-path/sample-subpath/ No
spec.storage.s3.region String us-east-1 The geographic region of the bucket. Some non-AWS S3 implementations do not require this value. us-west-1 No
spec.storage.s3.endpoint String https://
BUCKET-NAME
.s3.REGION
.amazonaws.com/
The endpoint URL for the configured S3-compatible provider. Leave blank for AWS S3. http://minio.default:9000 No
spec.storage.s3.forcePathStyle booleanfalse true forces the use of path-style S3 URLs for compatibility. May be required for some non-AWS S3 providers.
false uses virtual hosted-style S3 URLs.
For information about AWS S3 Path Deprecation, see the AWS blog site.
false No
spec.storage.s3.disableSSL boolean false For development environments, set to true to disable SSL for S3 operations.
For production environments, set to false.
false No
spec.storage.s3.secret.name String None The name of the Kubernetes secret that contains the credentials for connecting to S3. backuplocation-sample-creds Yes

Properties for the Secret

The table below explains the properties that can be set in the secret for the TanzuMySQLBackupLocation resource.

Property Type Default Description Example Req?
metadata.name String None The name of the Secret. Must match spec.storage.s3.secret.name in a BackupLocation. Must be unique within a namespace. backuplocation-sample-creds Yes
stringData.accessKeyId String None The Access Key ID for an AWS IAM user that has permissions to read/write from the S3 bucket. AKIAIOSFODNN7EXAMPLE Yes
stringData.secretAccessKey String None The Secret Access Key for an AWS IAM user that has permissions to read/write from the S3 bucket wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY Yes

Properties for the TanzuMySQLBackupSchedule Resource

The table below explains the properties that can be set in the backupschedule.yaml file for TanzuMySQLBackupSchedule resource.

Property Type Default Description Example Req?
metadata.name String None The name of the TanzuMySQLBackupSchedule. Must be unique within a namespace. backupschedule-sample Yes
spec.backupTemplate.spec.location.name String None The name of the TanzuMySQLBackupLocation that represents the blobstore where backups will be uploaded. Must be in the same namespace as the TanzuMySQLBackupSchedule. backuplocation-sample Yes
spec.backupTemplate.spec.cluster.name String None The name of the TanzuMySQL instance on which you want scheduled backups for. Must be in the same namespace as the TanzuMySQLBackupSchedule. tanzumysql-sample Yes
spec.schedule String (cron schedule) None The cron schedule for backups. Must be a valid cron schedule. "0 23 * * 6" (every Saturday at 11PM) Yes

Properties for the TanzuMySQLBackup Resource

The table below explains the properties that can be set in the backup.yaml file for the TanzuMySQLBackup resource.

Property Type Default Description Example Req?
metadata.name String None The name of the TanzuMySQLBackup. Must be unique within a namespace. backup-sample Yes
spec.location.name String None The name of the TanzuMySQLBackupLocation that represents the blobstore where the backup will be uploaded. Must be in the same namespace as the TanzuMySQL instance. Yes
spec.cluster.name String None The name of the TanzuMySQL instance on which you want to perform the on-demand backup. Yes

Properties for the TanzuMySQLRestore Resource

The table below explains the properties that can be set in the tanzumysqlrestore.yaml file for the TanzuMySQLRestore resource.

Property Type Default Description Example Req?
metadata.name String None The name of the TanzuMySQLRestore. Must be unique within a namespace. tanzumysqlrestore-sample Yes
spec.tanzuMySQLBackup.name String None The name of the TanzuMySQLBackup that represents the backup artifact to restore. Must be in the same namespace as the TanzuMySQLRestore. Yes
spec.MysqlTemplate The configuration for the TanzuMySQL instance that the backup artifact will be restored to. This TanzuMySQL instance is created automatically as part of the restore, so the name must not already exist in the namespace.
For descriptions of each value in the configuration template, see Create a TanzuMySQL Instance.
Yes