Issue 241: Chart changes and CRD refactoring

README.md

@@ -36,19 +36,19 @@ The operator itself is built with the [Operator framework](https://github.com/op
 
 ## Usage
 
-We recommend using our [helm charts](charts) for all installation and upgrades. However there are manual deployment and upgrade options available as well.
+We recommend using our [helm charts](charts) for all installation and upgrades. Since version 0.2.8 onwards, the helm charts for zookeeper operator and zookeeper cluster are published in [https://charts.pravega.io/](https://charts.pravega.io/). To add this repository to your Helm repos, use the following command
+```
+helm repo add pravega https://charts.pravega.io
+```
+However there are manual deployment and upgrade options available as well.
 
 ### Install the operator
 
 > Note: if you are running on Google Kubernetes Engine (GKE), please [check this first](#installation-on-google-kubernetes-engine).
 
 #### Install via helm
 
-Use helm to quickly deploy a zookeeper operator with the release name `zookeeper-operator`.
-
-```
-$ helm install zookeeper-operator charts/zookeeper-operator
-```
+To understand how to deploy the zookeeper operator using helm, refer to [this](charts/zookeeper-operator#installing-the-chart).
 
 #### Manual deployment
 
@@ -92,13 +92,7 @@ zookeeper-operator   1         1         1            1           12m
 
 #### Install via helm
 
-Helm can be used to install a sample zookeeper cluster with the release name `zookeeper`.
-
-```
-$ helm install zookeeper charts/zookeeper
-```
-
-Check out the [zookeeper helm charts](charts/zookeeper) for the complete list of configurable parameters.
+To understand how to deploy a sample zookeeper cluster using helm, refer to [this](charts/zookeeper#installing-the-chart).
 
 #### Manual deployment
 
@@ -213,11 +207,7 @@ $ kubectl create -f zk-with-istio.yaml
 
 #### Trigger the upgrade via helm
 
-The upgrade can be triggered via helm using the following command
-```
-$ helm upgrade zookeeper <location of modified charts> --timeout 600s
-```
-Here `zookeeper` is the release name of the zookeeper cluster.
+To understand how to upgrade the zookeeper cluster using helm, refer to [this](charts/zookeeper#upgrading-the-chart).
 
 #### Trigger the upgrade manually
 
@@ -282,10 +272,7 @@ Status:
 
 #### Uninstall via helm
 
-```
-$ helm uninstall zookeeper
-```
-Here `zookeeper` is the zookeeper cluster release name.
+Refer to [this](charts/zookeeper#uninstalling-the-chart).
 
 #### Manual uninstall
 
@@ -299,10 +286,7 @@ $ kubectl delete -f zk.yaml
 
 #### Uninstall via helm
 
-```
-$ helm uninstall zookeeper-operator
-```
-Here `zookeeper-operator` is the operator release name.
+Refer to [this](charts/zookeeper-operator#uninstalling-the-chart).
 
 #### Manual uninstall
 

charts/zookeeper-operator/README.md

@@ -8,21 +8,24 @@ This chart bootstraps a [Zookeeper Operator](https://github.com/pravega/zookeepe
 
 ## Prerequisites
   - Kubernetes 1.15+ with Beta APIs
-  - Helm 3+
+  - Helm 3.2.1+
 
 ## Installing the Chart
 
 To install the chart with the release name `my-release`:
 
 ```
-$ helm install my-release zookeeper-operator
+$ helm repo add pravega https://charts.pravega.io
+$ helm repo update
+$ helm install my-release pravega/zookeeper-operator --version=`version`
 ```
+Note: `version` can be any stable release version for zookeeper operator from 0.2.8 onwards.
 
-The command deploys zookeeper-operator on the Kubernetes cluster in the default configuration. The [configuration](#configuration) section lists the parameters that can be configured during installation.
+The above command deploys zookeeper-operator on the Kubernetes cluster in the default configuration. The [configuration](#configuration) section lists the parameters that can be configured during installation.
 
 ## Uninstalling the Chart
 
-To uninstall/delete the `my-release` deployment:
+To uninstall/delete the deployment `my-release`:
 
 ```
 $ helm uninstall my-release
@@ -39,7 +42,12 @@ The following table lists the configurable parameters of the Zookeeper operator
 | `image.repository` | Image repository | `pravega/zookeeper-operator` |
 | `image.tag` | Image tag | `0.2.8` |
 | `image.pullPolicy` | Image pull policy | `IfNotPresent` |
+| `crd.create` | Create zookeeper CRD | `true` |
 | `rbac.create` | Create RBAC resources | `true` |
 | `serviceAccount.create` | Create service account | `true` |
 | `serviceAccount.name` | Name for the service account | `zookeeper-operator` |
 | `watchNamespace` | Namespaces to be watched  | `""` |
+| `resources` | Specifies resource requirements for the container | `{}` |
+| `nodeSelector` | Map of key-value pairs to be present as labels in the node in which the pod should run | `{}` |
+| `affinity` | Specifies scheduling constraints on pods | `{}` |
+| `tolerations` | Specifies the pod's tolerations | `[]` |