Skip to content
This repository has been archived by the owner on Mar 28, 2020. It is now read-only.

Commit

Permalink
Merge pull request #1650 from fanminshi/doc_cleanup
Browse files Browse the repository at this point in the history
doc: remove reference to backup/restore
  • Loading branch information
hongchaodeng committed Nov 10, 2017
2 parents fb182c7 + 1a1a698 commit 50e246c
Show file tree
Hide file tree
Showing 2 changed files with 1 addition and 147 deletions.
4 changes: 1 addition & 3 deletions doc/user/resource_labels.md
Original file line number Diff line number Diff line change
@@ -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`
Expand Down
144 changes: 0 additions & 144 deletions doc/user/spec_examples.md
Original file line number Diff line number Diff line change
Expand Up @@ -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: <S3-bucket-name>
awsSecret: <aws-secret-name>
prefix: <S3-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: <S3-bucket-name>
awsSecret: <aws-secret-name>
prefix: <S3-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: <S3-bucket-name>
awsSecret: <aws-secret-name>
prefix: <S3-prefix>
```

```yaml
metadata:
name: "cluster-b"
spec:
size: 3
backup:
backupIntervalInSecond: 300
maxBackups: 5
storageType: "S3"
s3:
s3Bucket: <S3-bucket-name>
awsSecret: <aws-secret-name>
prefix: <S3-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: <abs-container-name>
absSecret: <abs-secret-name>
```

### TLS

See [cluster TLS docs](./cluster_tls.md).

0 comments on commit 50e246c

Please sign in to comment.