From 1a1a6980582df557b5e792e5fdc6b737f976022e Mon Sep 17 00:00:00 2001 From: fanmin shi Date: Fri, 10 Nov 2017 10:07:02 -0800 Subject: [PATCH] doc: remove reference to backup/restore from resource_labels.md and spec_examples.md --- doc/user/resource_labels.md | 4 +- doc/user/spec_examples.md | 144 ------------------------------------ 2 files changed, 1 insertion(+), 147 deletions(-) diff --git a/doc/user/resource_labels.md b/doc/user/resource_labels.md index 54946c446..444906642 100644 --- a/doc/user/resource_labels.md +++ b/doc/user/resource_labels.md @@ -1,9 +1,7 @@ ## Resource Labels The etcd-operator creates the following Kubernetes resources for each etcd cluster: - Pods for the etcd nodes -- Services for the etcd client, peer, and (optional) backup service -- (Optional) Deployment for the backup sidecar, if backup spec is defined -- (Optional) Persistent Volume Claim, if backup sidecar is enabled with the storage type as PersistentVolume +- Services for the etcd client and peer where each resource has the following labels: - `app=etcd` diff --git a/doc/user/spec_examples.md b/doc/user/spec_examples.md index 572de6f4d..10875920e 100644 --- a/doc/user/spec_examples.md +++ b/doc/user/spec_examples.md @@ -42,150 +42,6 @@ spec: cpu: 200m memory: 100Mi ``` - -### Three members cluster with PV backup - -See [example backup spec](../../example/example-etcd-cluster-with-backup.yaml) that uses the [storage class](../../example/example-storage-class-gce-pd.yaml). - -### S3 backup and cluster specific S3 configuration - -```yaml -spec: - size: 3 - backup: - backupIntervalInSecond: 1800 - maxBackups: 5 - storageType: "S3" - s3: - s3Bucket: - awsSecret: - prefix: -``` - -See [backup config](./backup_config.md) for how to set up S3 related configurations. - -### Three members cluster that restores from previous PV backup - -If a cluster `cluster-a` was created with backup, but deleted or failed later on, -we can recover the cluster as long as the PV still exists. -Note that delete `cluster-a` Cluster resource first if it still exists. - -Here's an example: - -```yaml -metadata: - name: "cluster-a" -spec: - size: 3 - backup: - backupIntervalInSecond: 300 - maxBackups: 5 - storageType: "PersistentVolume" - pv: - volumeSizeInMB: 512 - restore: - backupClusterName: "cluster-a" - storageType: "PersistentVolume" -``` - -### Three members cluster that restores from previous S3 backup - -Same as above but using "S3" as backup storage. The previous s3 backup must exist -in order for the restore to work; otherwise, the new cluster doesn't boot. - -```yaml -metadata: - name: "cluster-a" -spec: - size: 3 - backup: - backupIntervalInSecond: 300 - maxBackups: 5 - storageType: "S3" - s3: - s3Bucket: - awsSecret: - prefix: - restore: - backupClusterName: "cluster-a" - storageType: "S3" -``` - -### Three members cluster that restores from different cluster's S3 backup - -etcd-operator can create a new cluster `cluster-b` from the backup of another cluster `cluster-a`. If backup exists, make sure the backup policy of `cluster-b` has the same S3 configuration as those of `cluster-a`; etcd operator would also use that config to access snapshots of `cluster-a`. - -```yaml -metadata: - name: "cluster-a" -spec: - size: 3 - backup: - backupIntervalInSecond: 300 - maxBackups: 5 - storageType: "S3" - s3: - s3Bucket: - awsSecret: - prefix: -``` - -```yaml -metadata: - name: "cluster-b" -spec: - size: 3 - backup: - backupIntervalInSecond: 300 - maxBackups: 5 - storageType: "S3" - s3: - s3Bucket: - awsSecret: - prefix: - restore: - backupClusterName: "cluster-a" - storageType: "S3" -``` - - -### Three members cluster that restores from different cluster's PV backup - -If user wants to clone a new cluster `cluster-b` from an existing cluster `cluster-a`, -as long as backup exists, use the following example spec: - -```yaml -metadata: - name: "cluster-b" -spec: - size: 3 - backup: - backupIntervalInSecond: 300 - maxBackups: 5 - storageType: "PersistentVolume" - pv: - volumeSizeInMB: 512 - restore: - backupClusterName: "cluster-a" - storageType: "PersistentVolume" -``` - -## ABS spec examples - -### Three member cluster with ABS backup - -```yaml -spec: - size: 3 - backup: - backupIntervalInSecond: 1800 - maxBackups: 5 - storageType: "ABS" - abs: - absContainer: - absSecret: -``` - ### TLS See [cluster TLS docs](./cluster_tls.md).