From 9892fac13aa807208cba684ee2a1ef1f512184e5 Mon Sep 17 00:00:00 2001 From: Marcin Ciszak Date: Mon, 17 Sep 2018 12:35:16 +0100 Subject: [PATCH] Docs fixes Signed-off-by: Marcin Ciszak --- docs/user/backup.md | 6 +++--- docs/user/clusters.md | 15 +++++++++++++++ docs/user/restore.md | 8 ++++---- 3 files changed, 22 insertions(+), 7 deletions(-) diff --git a/docs/user/backup.md b/docs/user/backup.md index 49a4478c4..d0f574ccf 100644 --- a/docs/user/backup.md +++ b/docs/user/backup.md @@ -156,9 +156,9 @@ spec: schedule: '*/30 * * * *' backupTemplate: executor: - provider: mysqldump - databases: - - test + mysqldump: + databases: + - test storageProvider: s3: endpoint: ocitenancy.compat.objectstorage.ociregion.oraclecloud.com diff --git a/docs/user/clusters.md b/docs/user/clusters.md index 0cb80df2b..75f2a33c5 100644 --- a/docs/user/clusters.md +++ b/docs/user/clusters.md @@ -183,6 +183,7 @@ apiVersion: mysql.oracle.com/v1alpha1 kind: Cluster metadata: name: mysql-cluster-with-config +spec: members: 3 config: name: mycnf @@ -198,6 +199,20 @@ apiVersion: mysql.oracle.com/v1alpha1 kind: Cluster metadata: name: mysql-cluster-with-custom-serverid +spec: members: 3 baseServerId: 42 ``` + +### Create a cluster with specific version of MySQL Server + +By default, the MySQL Operator starts a cluster with MySQL Server version set to minimum supported version defined by the Operator. This can be overriden in the cluster spec given the version used is equal to or higher than minimum supported version. + +```yaml +apiVersion: mysql.oracle.com/v1alpha1 +kind: Cluster +metadata: + name: mysql-cluster-with-custom-server-version +spec: + version: 8.0.12 +``` diff --git a/docs/user/restore.md b/docs/user/restore.md index 6f440040d..c3bdbaae6 100644 --- a/docs/user/restore.md +++ b/docs/user/restore.md @@ -5,8 +5,8 @@ The MySQL Operator supports the notion of restoring a cluster from an existing b ## On-demand restores You can request a restore from a previous backup at any time by submitting a -Restore custom resource to the operator. The backupRef is the name of the -backup that you wish to restore, and the clusterRef is the name of the +Restore custom resource to the operator. The backup is the name of the +backup that you wish to restore, and the cluster is the name of the destination cluster of the restore operation. ```yaml @@ -15,8 +15,8 @@ kind: Restore metadata: name: example-restore spec: - clusterRef: + cluster: name: mycluster - backupRef: + backup: name: mysql-backup ```