diff --git a/README.md b/README.md index a9c2896d9..350d78094 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/doc/user/op_guide.md b/doc/user/op_guide.md new file mode 100644 index 000000000..92abf3aaa --- /dev/null +++ b/doc/user/op_guide.md @@ -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 + +Delete deployment: + +```bash +$ kubectl delete -f example/deployment.yaml +``` + +Delete leader election endpoint +```bash +$ kubectl delete endpoints etcd-operator +``` + +Note that the etcd clusters managed by etcd operator will **NOT** be deleted if the operator fails or 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.