Skip to content

Commit 5b67c75

Browse files
committed
update kpow hourly readme
1 parent 1689d75 commit 5b67c75

File tree

3 files changed

+52
-34
lines changed

3 files changed

+52
-34
lines changed
Lines changed: 7 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,11 @@
1-
Download and extract the Helm chart from the Marketplace listing repository.
1+
Add the Factor House Helm Repository in order to use the Kpow Helm Chart.
22

33
```bash
4-
export HELM_EXPERIMENTAL_OCI=1
5-
aws ecr get-login-password \
6-
--region us-east-1 | helm registry login \
7-
--username AWS \
8-
--password-stdin 709825985650.dkr.ecr.us-east-1.amazonaws.com
4+
helm repo add factorhouse https://charts.factorhouse.io
5+
```
6+
7+
Update Helm repositories to ensure you install the latest version of Kpow.
98

10-
mkdir awsmp-chart && cd awsmp-chart
11-
helm pull oci://709825985650.dkr.ecr.us-east-1.amazonaws.com/factor-house/kpow-aws-hourly \
12-
--version <VERSION_NUMBER>
13-
tar xf $(pwd)/* && find $(pwd) -maxdepth 1 -type f -delete
9+
```bash
10+
helm repo update
1411
```

_readme_gen/kpow/templates/kpow-aws-hourly.template.md

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ You can now deploy Kpow to EKS using this Service Account, which includes an IAM
4949

5050
## Run Kpow in Kubernetes
5151

52-
### Download the Kpow Helm chart
52+
### Configure the Kpow Helm Repository
5353

5454
@@include(\_partials/\_configure-helm-kpow-aws-hourly.md)
5555

@@ -64,7 +64,7 @@ Some fields, particularly integers and strings containing quotation marks, requi
6464
The following example shows how to install Kpow from the command line, highlighting how to handle escaped commas and quotes:
6565

6666
```bash
67-
helm install kpow ./kpow-aws-hourly/ \
67+
helm install kpow factorhouse/kpow-aws-hourly \
6868
--set serviceAccount.create=false \
6969
--set serviceAccount.name=kpow \
7070
--set env.BOOTSTRAP="b-1.<cluster-name>.<cluster-identifier>.c8.kafka.us-east-1.amazonaws.com:9096" \
@@ -90,7 +90,7 @@ NOTES:
9090
You can configure Kpow with a ConfigMap of environment variables as follows:
9191

9292
```bash
93-
helm install kpow ./kpow-aws-hourly/ \
93+
helm install kpow factorhouse/kpow-aws-hourly \
9494
--set envFromConfigMap=kpow-config \
9595
--create-namespace --namespace factorhouse
9696
```
@@ -107,10 +107,26 @@ For general guidance, see the Kubernetes documentation on [configuring all key-v
107107

108108
You can run Kpow with local edits to chart files to provide custom configuration.
109109

110+
#### Pull and Untar the Kpow Charts
111+
112+
```bash
113+
helm pull factorhouse/kpow-aws-hourly --untar --untardir .
114+
```
115+
110116
#### Make Local Edits
111117

112118
Make any edits required to `kpow-aws-hourly/Chart.yaml` or `kpow-aws-hourly/values.yaml` (adding volume mounts, etc).
113119

120+
#### Run Local Charts
121+
122+
The command to run local charts is slightly different, see `./kpow-aws-hourly` rather than `factorhouse/kpow-aws-hourly`.
123+
124+
```bash
125+
helm install kpow ./kpow-aws-hourly \
126+
<.. --set configuration, etc ..> \
127+
--create-namespace -namespace factorhouse
128+
```
129+
114130
#### Configuring with an Existing ConfigMap
115131

116132
This is the recommended method for managing configuration separately from the Helm chart.

charts/kpow-aws-hourly/README.md

Lines changed: 26 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -67,26 +67,21 @@ ip-192-168-...-21.ec2.internal Ready <none> 2m15s v1.32.9-eks-113cf36
6767
...
6868
```
6969

70-
7170
## Run Kpow in Kubernetes
7271

73-
### Download the Kpow Helm chart
72+
### Configure the Kpow Helm Repository
7473

75-
Download and extract the Helm chart from the Marketplace listing repository.
74+
Add the Factor House Helm Repository in order to use the Kpow Helm Chart.
7675

7776
```bash
78-
export HELM_EXPERIMENTAL_OCI=1
79-
aws ecr get-login-password \
80-
--region us-east-1 | helm registry login \
81-
--username AWS \
82-
--password-stdin 709825985650.dkr.ecr.us-east-1.amazonaws.com
83-
84-
mkdir awsmp-chart && cd awsmp-chart
85-
helm pull oci://709825985650.dkr.ecr.us-east-1.amazonaws.com/factor-house/kpow-aws-hourly \
86-
--version <VERSION_NUMBER>
87-
tar xf $(pwd)/* && find $(pwd) -maxdepth 1 -type f -delete
77+
helm repo add factorhouse https://charts.factorhouse.io
8878
```
8979

80+
Update Helm repositories to ensure you install the latest version of Kpow.
81+
82+
```bash
83+
helm repo update
84+
```
9085

9186
### Start a Kpow Instance
9287

@@ -99,7 +94,7 @@ Some fields, particularly integers and strings containing quotation marks, requi
9994
The following example shows how to install Kpow from the command line, highlighting how to handle escaped commas and quotes:
10095

10196
```bash
102-
helm install kpow ./kpow-aws-hourly/ \
97+
helm install kpow factorhouse/kpow-aws-hourly \
10398
--set serviceAccount.create=false \
10499
--set serviceAccount.name=kpow \
105100
--set env.BOOTSTRAP="b-1.<cluster-name>.<cluster-identifier>.c8.kafka.us-east-1.amazonaws.com:9096" \
@@ -125,7 +120,7 @@ NOTES:
125120
You can configure Kpow with a ConfigMap of environment variables as follows:
126121

127122
```bash
128-
helm install kpow ./kpow-aws-hourly/ \
123+
helm install kpow factorhouse/kpow-aws-hourly \
129124
--set envFromConfigMap=kpow-config \
130125
--create-namespace --namespace factorhouse
131126
```
@@ -180,15 +175,30 @@ kubectl logs $POD_NAME --namespace factorhouse
180175
helm delete kpow --namespace factorhouse
181176
```
182177

183-
184178
### Start Kpow with Local Changes
185179

186180
You can run Kpow with local edits to chart files to provide custom configuration.
187181

182+
#### Pull and Untar the Kpow Charts
183+
184+
```bash
185+
helm pull factorhouse/kpow-aws-hourly --untar --untardir .
186+
```
187+
188188
#### Make Local Edits
189189

190190
Make any edits required to `kpow-aws-hourly/Chart.yaml` or `kpow-aws-hourly/values.yaml` (adding volume mounts, etc).
191191

192+
#### Run Local Charts
193+
194+
The command to run local charts is slightly different, see `./kpow-aws-hourly` rather than `factorhouse/kpow-aws-hourly`.
195+
196+
```bash
197+
helm install kpow ./kpow-aws-hourly \
198+
<.. --set configuration, etc ..> \
199+
--create-namespace -namespace factorhouse
200+
```
201+
192202
#### Configuring with an Existing ConfigMap
193203

194204
This is the recommended method for managing configuration separately from the Helm chart.
@@ -250,7 +260,6 @@ See the Kubernetes documentation
250260
on [configuring all key value pairs in a secret as environment variables](https://kubernetes.io/docs/tasks/inject-data-application/distribute-credentials-secure/#configure-all-key-value-pairs-in-a-secret-as-container-environment-variables)
251261
for more information.
252262

253-
254263
```bash
255264
helm install kpow ./kpow-aws-hourly/ \
256265
--set envFromSecret=kpow-secrets \
@@ -271,7 +280,6 @@ regard.
271280

272281
You may find the Kubernetes documentation on [injecting data into applications](https://kubernetes.io/docs/tasks/inject-data-application/distribute-credentials-secure/#create-a-pod-that-has-access-to-the-secret-data-through-a-volume) useful.
273282

274-
275283
### Kpow Memory and CPU Requirements
276284

277285
The chart runs Kpow with Guaranteed QoS, having resource request and limit set to these values by default:
@@ -302,7 +310,6 @@ resources:
302310
memory: 2Gi
303311
```
304312
305-
306313
Adjust these values from the command line like so:
307314
308315
```bash
@@ -330,7 +337,6 @@ ephemeralTmp:
330337
sizeLimit: "100Mi" # Configurable size
331338
```
332339
333-
334340
---
335341
336342
### Get Help!
@@ -340,4 +346,3 @@ If you have any issues or errors, please contact [email protected].
340346
### Licensing and Modifications
341347
342348
This repository is Apache 2.0 licensed, you are welcome to clone and modify as required.
343-

0 commit comments

Comments
 (0)