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

doc: op guide for install, uninstall etcd operator #855

Merged
merged 1 commit into from
Mar 3, 2017
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
doc: op guide for install, uninstall operator
  • Loading branch information
hongchaodeng committed Mar 3, 2017
commit 8830126ed6b81e63f392830e4e5d153dfd115e3f
15 changes: 1 addition & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,20 +37,7 @@ Read [Developer Guide](./doc/dev/developer_guide.md) for setting up development

## Deploy etcd operator

```bash
$ kubectl create -f example/deployment.yaml
deployment "etcd-operator" created
```

etcd operator will automatically create a Kubernetes *Third-Party Resource* (TPR) as followed:

```bash
$ kubectl get thirdpartyresources
NAME DESCRIPTION VERSION(S)
cluster.etcd.coreos.com Managed etcd clusters v1beta1
```

Note that the etcd clusters managed by the etcd operator will not be deleted if the operator fails or the deployment of the operator is deleted. This is an intentional design to prevent accidental operator failure from killing all the etcd clusters.
See [instructions on how to install/uninstall etcd operator](doc/user/op_guide.md) .

## Create and destroy an etcd cluster

Expand Down
34 changes: 34 additions & 0 deletions doc/user/op_guide.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# Operation Guide

## Install etcd operator

Create deployment:

```bash
$ kubectl create -f example/deployment.yaml
```

etcd operator will automatically creates a Kubernetes Third-Party Resource (TPR):

```bash
$ kubectl get thirdpartyresources
NAME DESCRIPTION VERSION(S)
cluster.etcd.coreos.com Managed etcd clusters v1beta1
```

## Uninstall etcd operator

Note that the etcd clusters managed by etcd operator will **NOT** be deleted even if the operator is uninstalled.
This is an intentional design to prevent accidental operator failure from killing all the etcd clusters.
In order to delete all clusters, delete all cluster TPR objects before uninstall the operator.

Delete deployment:

```bash
$ kubectl delete -f example/deployment.yaml
```

Delete leader election endpoint
```bash
$ kubectl delete endpoints etcd-operator
```