docs: editorial pass on install_guide.md
-# Operation Guide
+# Installation guide
## Set up RBAC
-Set up basic [RBAC rules](./rbac.md) for etcd operator:
+Set up basic [RBAC rules][rbac-rules] for etcd-operator:
```bash
$ example/rbac/create_role.sh
@@ -10,13 +10,13 @@ $ example/rbac/create_role.sh
## Install etcd operator
-Create a deployment for etcd operator:
+Create a deployment for etcd-operator:
```bash
$ kubectl create -f example/deployment.yaml
```
-etcd operator will automatically create a Kubernetes Custom Resource Definition (CRD):
+etcd-operator will automatically create a Kubernetes Custom Resource Definition (CRD):
```bash
$ kubectl get customresourcedefinitions
@@ -24,13 +24,15 @@ NAME KIND
etcdclusters.etcd.database.coreos.com CustomResourceDefinition.v1beta1.apiextensions.k8s.io
```
-## Uninstall etcd operator
+## Uninstall etcd-operator
+
+Note that the etcd clusters managed by etcd-operator will **NOT** be deleted even if the operator is uninstalled.
-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 CR objects before uninstall the operator.
-Cleanup etcd operator:
+To delete all clusters, delete all cluster CR objects before uninstalling the operator.
+
+Clean up etcd-operator:
```bash
kubectl delete -f example/deployment.yaml
@@ -39,10 +41,12 @@ kubectl delete clusterrole etcd-operator
kubectl delete clusterrolebinding etcd-operator
```
-## Installation via Helm
+## Installation using Helm
+
**Disclaimer:** The following Helm chart is an external project not maintained by the etcd-operator maintainers; so it may not be up to date.
-etcd-operator is available as a [Helm
-chart](https://github.com/kubernetes/charts/tree/master/stable/etcd-operator).
-Follow the instructions on the chart to install etcd-operator on your cluster.
+etcd-operator is available as a [Helm chart][etcd-helm]. Follow the instructions on the chart to install etcd-operator on clusters.
+
+[rbac-rules]: rbac.md
+[etcd-helm]: https://github.com/kubernetes/charts/tree/master/stable/etcd-operator/
