fix(chart): add more info about backupCredentials (#875)

bitpoke · May 22, 2023 · bd6fa2e · bd6fa2e
1 parent 1eff7e9
commit bd6fa2e
Show file tree

Hide file tree

Showing 3 changed files with 49 additions and 2 deletions.
diff --git a/deploy/charts/mysql-cluster/templates/backup-secret.yaml b/deploy/charts/mysql-cluster/templates/backup-secret.yaml
@@ -19,5 +19,5 @@ type: Opaque
 data:
     {{- range $key, $value := .Values.backupCredentials }}
     {{ $key | upper }}: {{ $value | b64enc | quote }}
-    {{ end }}
+    {{- end }}
 {{- end -}}
diff --git a/deploy/charts/mysql-cluster/values.yaml b/deploy/charts/mysql-cluster/values.yaml
@@ -35,19 +35,36 @@ backupRemoteDeletePolicy:
 # backupSecretLabels: {}
 # backupSecretAnnotations: {}
 backupCredentials:
+  # use s3 https://rclone.org/s3/
+  # S3_PROVIDER: ?             # like: AWS, Minio, Ceph, and so on
+  # S3_ENDPOINT: ?
   # AWS_ACCESS_KEY_ID: ?
   # AWS_SECRET_ACCESS_KEY: ?
-  # AWS_REGION: us-east-1
+  # AWS_REGION: ?
   # AWS_ACL: ?
+  # AWS_STORAGE_CLASS: ?
+  # AWS_SESSION_TOKEN: ?
 
+  # use google cloud storage https://rclone.org/googlecloudstorage/
   # GCS_SERVICE_ACCOUNT_JSON_KEY: ?
   # GCS_PROJECT_ID: ?
   # GCS_OBJECT_ACL: ?
   # GCS_BUCKET_ACL: ?
   # GCS_LOCATION: ?
   # GCS_STORAGE_CLASS: MULTI_REGIONAL
 
+  # use http https://rclone.org/http/
   # HTTP_URL: ?
+
+  # use google drive https://rclone.org/drive/
+  # GDRIVE_CLIENT_ID: ?
+  # GDRIVE_ROOT_FOLDER_ID: ?
+  # GDRIVE_IMPERSONATOR: ?
+
+  # use azure https://rclone.org/azureblob/
+  # AZUREBLOB_ACCOUNT: ?
+  # AZUREBLOB_KEY: ?
+
 ## For enabling and configuring pt-kill: https://www.percona.com/doc/percona-toolkit/LATEST/pt-kill.html
 #queryLimits:
 #  maxIdleTime: ...                # pt-kill --idle-time

diff --git a/examples/example-cluster.yaml b/examples/example-cluster.yaml
@@ -23,6 +23,36 @@ spec:
   # backupSecretName:
   # backupScheduleJobsHistoryLimit:
   # backupRemoteDeletePolicy:
+  # backupCredentials:
+    # use s3 https://rclone.org/s3/
+    # S3_PROVIDER: ?             # like: AWS, Minio, Ceph, and so on
+    # S3_ENDPOINT: ?
+    # AWS_ACCESS_KEY_ID: ?
+    # AWS_SECRET_ACCESS_KEY: ?
+    # AWS_REGION: ?
+    # AWS_ACL: ?
+    # AWS_STORAGE_CLASS: ?
+    # AWS_SESSION_TOKEN: ?
+
+    # use google cloud storage https://rclone.org/googlecloudstorage/
+    # GCS_SERVICE_ACCOUNT_JSON_KEY: ?
+    # GCS_PROJECT_ID: ?
+    # GCS_OBJECT_ACL: ?
+    # GCS_BUCKET_ACL: ?
+    # GCS_LOCATION: ?
+    # GCS_STORAGE_CLASS: MULTI_REGIONAL
+
+    # use http https://rclone.org/http/
+    # HTTP_URL: ?
+
+    # use google drive https://rclone.org/drive/
+    # GDRIVE_CLIENT_ID: ?
+    # GDRIVE_ROOT_FOLDER_ID: ?
+    # GDRIVE_IMPERSONATOR: ?
+
+    # use azure https://rclone.org/azureblob/
+    # AZUREBLOB_ACCOUNT: ?
+    # AZUREBLOB_KEY: ?
 
   ## Custom Server ID Offset for replication
   # serverIDOffset: 100