Updated README

mjdoherty · May 23, 2018 · 1a2af9a · 1a2af9a
1 parent db2b5d3
commit 1a2af9a
Show file tree

Hide file tree

Showing 11 changed files with 2,786 additions and 2,731 deletions.
diff --git a/README.md b/README.md
@@ -147,3 +147,57 @@ kubectl delete pvc --selector=release=<release name>
 ````
 
 ## Operations
+### Scale In/Out
+> NOTE: All Scale In/Out operations should be done offline with no producer/consumer connection
+####Zookeeper
+Install co-helm-charts with default 3 nodes zookeeper ensemble
+```
+helm install cp-helm-charts
+```
+Scale zookeeper nodes out to 5, change `servers` under `cp-zookeeper` to 5 in [values.yaml](values.yaml)
+```
+helm upgrade <release name> cp-helm-charts
+```
+Scale zookeeper nodes out to 5, change `servers` under `cp-zookeeper` to 3 in [values.yaml](values.yaml)
+```
+helm upgrade <release name> cp-helm-charts
+```
+####Kafka
+> NOTE: Scaling in/out Kafka brokers without doing Partition Reassignment will cause data loss!!   
+Be sure to reassign partitions correctly before scaling in/out Kafka cluster.
+Please refer: https://kafka.apache.org/documentation/#basic_ops_cluster_expansion 
+
+Install co-helm-charts with default 3 brokers kafka cluster
+```
+helm install cp-helm-charts
+```
+Scale kafka brokers out to 5, change `brokers` under `cp-kafka` to 5 in [values.yaml](values.yaml)
+```
+helm upgrade <release name> cp-helm-charts
+```
+Scale kafka brokers out to 5, change `brokers` under `cp-kafka` to 3 in [values.yaml](values.yaml)
+```
+helm upgrade <release name> cp-helm-charts
+```
+### Monitoring
+JMX Metrics are enabled by default for all components, Prometheus JMX Exporter is installed as a sidecar container along with all Pods.
+
+1. Install Prometheus and Grafana in same Kubernetes cluster using helm
+    ```
+    helm install stable/prometheus
+    helm install stable/grafana
+    ```
+2. Add Prometheus as Data Source in Grafana, url should be something like:
+   `http://illmannered-marmot-prometheus-server:80`
+
+3. Import dashboard under [grafana-dashboard](grafana-dashboard) into Grafana
+    ![Kafka Dashboard](screenshots/kafka.png "Kafka")
+    
+    ![Zookeeper Dashboard](screenshots/zookeeper.png "Zookeeper")
+    
+##Work In Progress
+### External Access
+
+### Security
+
+### Logging
diff --git a/charts/cp-kafka/README.md b/charts/cp-kafka/README.md
@@ -108,8 +108,8 @@ The configuration parameters in this section control the resources requested and
 ### StatefulSet Configurations
 | Parameter | Description | Default |
 | --------- | ----------- | ------- |
-| `podManagementPolicy` | The Kafka StatefulSet Pod Management Policy: `Parallel` or `OrderedReady`. | `Parallel` |
-| `updateStrategy` | The ZooKeeper StatefulSet update strategy: `RollingUpdate` or `OnDelete`. | `OnDelete` |
+| `podManagementPolicy` | The Kafka StatefulSet Pod Management Policy: `Parallel` or `OrderedReady`. | `OrderedReady` |
+| `updateStrategy` | The Kafka StatefulSet update strategy: `RollingUpdate` or `OnDelete`. | `OnDelete` |
 
 ### Liveness and Readiness Probe Configuration
 | Parameter | Description | Default |

diff --git a/charts/cp-kafka/values.yaml b/charts/cp-kafka/values.yaml
@@ -21,11 +21,11 @@ imagePullPolicy: IfNotPresent
 ## StatefulSet Config
 ## Start and stop pods in Parallel or OrderedReady (one-by-one.)
 ## ref: https://kubernetes.io/docs/tutorials/stateful-application/basic-stateful-set/#pod-management-policy
-podManagementPolicy: Parallel
+podManagementPolicy: OrderedReady
 
-## The StatefulSet Update Strategy which Kafka will use when changes are applied.
+## The StatefulSet Update Strategy which Kafka will use when changes are applied: OnDelete or RollingUpdate
 ## ref: https://kubernetes.io/docs/concepts/workloads/controllers/statefulset/#update-strategies
-updateStrategy: OnDelete
+updateStrategy: RollingUpdate
 
 ## Liveness and Readiness Probe Configuration
 livenessProbe:

diff --git a/charts/cp-zookeeper/README.md b/charts/cp-zookeeper/README.md
@@ -99,8 +99,8 @@ The configuration parameters in this section control the resources requested and
 ### StatefulSet Configurations
 | Parameter | Description | Default |
 | --------- | ----------- | ------- |
-| `podManagementPolicy` | The Zookeeper StatefulSet Pod Management Policy: `Parallel` or `OrderedReady`. | `Parallel` |
-| `updateStrategy` | The ZooKeeper StatefulSet update strategy: `RollingUpdate` or `OnDelete`. | `OnDelete` |
+| `podManagementPolicy` | The Zookeeper StatefulSet Pod Management Policy: `Parallel` or `OrderedReady`. | `OrderedReady` |
+| `updateStrategy` | The ZooKeeper StatefulSet update strategy: `RollingUpdate` or `OnDelete`. | `RollingUpdate` |
 
 ### Liveness and Readiness Probe Configuration
 | Parameter | Description | Default |

diff --git a/charts/cp-zookeeper/values.yaml b/charts/cp-zookeeper/values.yaml
@@ -24,11 +24,11 @@ imagePullPolicy: IfNotPresent
 ## StatefulSet Config
 ## Start and stop pods in Parallel or OrderedReady (one-by-one.)
 ## ref: https://kubernetes.io/docs/tutorials/stateful-application/basic-stateful-set/#pod-management-policy
-podManagementPolicy: Parallel
+podManagementPolicy: OrderedReady
 
-## The StatefulSet Update Strategy which Zookeeper will use when changes are applied.
+## The StatefulSet Update Strategy which Zookeeper will use when changes are applied: OnDelete or RollingUpdate
 ## ref: https://kubernetes.io/docs/concepts/workloads/controllers/statefulset/#update-strategies
-updateStrategy: OnDelete
+updateStrategy: RollingUpdate
 
 ## Liveness and Readiness Probe Configuration
 ## ref: https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-probes/