Skip to content
This repository was archived by the owner on Feb 20, 2024. It is now read-only.

Commit 1a2af9a

Browse files
committed
Updated README
1 parent db2b5d3 commit 1a2af9a

11 files changed

+2786
-2731
lines changed

README.md

+54
Original file line numberDiff line numberDiff line change
@@ -147,3 +147,57 @@ kubectl delete pvc --selector=release=<release name>
147147
````
148148
149149
## Operations
150+
### Scale In/Out
151+
> NOTE: All Scale In/Out operations should be done offline with no producer/consumer connection
152+
####Zookeeper
153+
Install co-helm-charts with default 3 nodes zookeeper ensemble
154+
```
155+
helm install cp-helm-charts
156+
```
157+
Scale zookeeper nodes out to 5, change `servers` under `cp-zookeeper` to 5 in [values.yaml](values.yaml)
158+
```
159+
helm upgrade <release name> cp-helm-charts
160+
```
161+
Scale zookeeper nodes out to 5, change `servers` under `cp-zookeeper` to 3 in [values.yaml](values.yaml)
162+
```
163+
helm upgrade <release name> cp-helm-charts
164+
```
165+
####Kafka
166+
> NOTE: Scaling in/out Kafka brokers without doing Partition Reassignment will cause data loss!!
167+
Be sure to reassign partitions correctly before scaling in/out Kafka cluster.
168+
Please refer: https://kafka.apache.org/documentation/#basic_ops_cluster_expansion
169+
170+
Install co-helm-charts with default 3 brokers kafka cluster
171+
```
172+
helm install cp-helm-charts
173+
```
174+
Scale kafka brokers out to 5, change `brokers` under `cp-kafka` to 5 in [values.yaml](values.yaml)
175+
```
176+
helm upgrade <release name> cp-helm-charts
177+
```
178+
Scale kafka brokers out to 5, change `brokers` under `cp-kafka` to 3 in [values.yaml](values.yaml)
179+
```
180+
helm upgrade <release name> cp-helm-charts
181+
```
182+
### Monitoring
183+
JMX Metrics are enabled by default for all components, Prometheus JMX Exporter is installed as a sidecar container along with all Pods.
184+
185+
1. Install Prometheus and Grafana in same Kubernetes cluster using helm
186+
```
187+
helm install stable/prometheus
188+
helm install stable/grafana
189+
```
190+
2. Add Prometheus as Data Source in Grafana, url should be something like:
191+
`http://illmannered-marmot-prometheus-server:80`
192+
193+
3. Import dashboard under [grafana-dashboard](grafana-dashboard) into Grafana
194+
![Kafka Dashboard](screenshots/kafka.png "Kafka")
195+
196+
![Zookeeper Dashboard](screenshots/zookeeper.png "Zookeeper")
197+
198+
##Work In Progress
199+
### External Access
200+
201+
### Security
202+
203+
### Logging

charts/cp-kafka/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -108,8 +108,8 @@ The configuration parameters in this section control the resources requested and
108108
### StatefulSet Configurations
109109
| Parameter | Description | Default |
110110
| --------- | ----------- | ------- |
111-
| `podManagementPolicy` | The Kafka StatefulSet Pod Management Policy: `Parallel` or `OrderedReady`. | `Parallel` |
112-
| `updateStrategy` | The ZooKeeper StatefulSet update strategy: `RollingUpdate` or `OnDelete`. | `OnDelete` |
111+
| `podManagementPolicy` | The Kafka StatefulSet Pod Management Policy: `Parallel` or `OrderedReady`. | `OrderedReady` |
112+
| `updateStrategy` | The Kafka StatefulSet update strategy: `RollingUpdate` or `OnDelete`. | `OnDelete` |
113113

114114
### Liveness and Readiness Probe Configuration
115115
| Parameter | Description | Default |

charts/cp-kafka/values.yaml

+3-3
Original file line numberDiff line numberDiff line change
@@ -21,11 +21,11 @@ imagePullPolicy: IfNotPresent
2121
## StatefulSet Config
2222
## Start and stop pods in Parallel or OrderedReady (one-by-one.)
2323
## ref: https://kubernetes.io/docs/tutorials/stateful-application/basic-stateful-set/#pod-management-policy
24-
podManagementPolicy: Parallel
24+
podManagementPolicy: OrderedReady
2525

26-
## The StatefulSet Update Strategy which Kafka will use when changes are applied.
26+
## The StatefulSet Update Strategy which Kafka will use when changes are applied: OnDelete or RollingUpdate
2727
## ref: https://kubernetes.io/docs/concepts/workloads/controllers/statefulset/#update-strategies
28-
updateStrategy: OnDelete
28+
updateStrategy: RollingUpdate
2929

3030
## Liveness and Readiness Probe Configuration
3131
livenessProbe:

charts/cp-zookeeper/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -99,8 +99,8 @@ The configuration parameters in this section control the resources requested and
9999
### StatefulSet Configurations
100100
| Parameter | Description | Default |
101101
| --------- | ----------- | ------- |
102-
| `podManagementPolicy` | The Zookeeper StatefulSet Pod Management Policy: `Parallel` or `OrderedReady`. | `Parallel` |
103-
| `updateStrategy` | The ZooKeeper StatefulSet update strategy: `RollingUpdate` or `OnDelete`. | `OnDelete` |
102+
| `podManagementPolicy` | The Zookeeper StatefulSet Pod Management Policy: `Parallel` or `OrderedReady`. | `OrderedReady` |
103+
| `updateStrategy` | The ZooKeeper StatefulSet update strategy: `RollingUpdate` or `OnDelete`. | `RollingUpdate` |
104104

105105
### Liveness and Readiness Probe Configuration
106106
| Parameter | Description | Default |

charts/cp-zookeeper/values.yaml

+3-3
Original file line numberDiff line numberDiff line change
@@ -24,11 +24,11 @@ imagePullPolicy: IfNotPresent
2424
## StatefulSet Config
2525
## Start and stop pods in Parallel or OrderedReady (one-by-one.)
2626
## ref: https://kubernetes.io/docs/tutorials/stateful-application/basic-stateful-set/#pod-management-policy
27-
podManagementPolicy: Parallel
27+
podManagementPolicy: OrderedReady
2828

29-
## The StatefulSet Update Strategy which Zookeeper will use when changes are applied.
29+
## The StatefulSet Update Strategy which Zookeeper will use when changes are applied: OnDelete or RollingUpdate
3030
## ref: https://kubernetes.io/docs/concepts/workloads/controllers/statefulset/#update-strategies
31-
updateStrategy: OnDelete
31+
updateStrategy: RollingUpdate
3232

3333
## Liveness and Readiness Probe Configuration
3434
## ref: https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-probes/

0 commit comments

Comments
 (0)