Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 15 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,24 @@
# Factor House Helm Charts
# Factor House Helm Charts for Kpow and Flex

[![Release Charts](https://github.com/factorhouse/helm-charts/actions/workflows/release.yml/badge.svg?branch=main)](https://github.com/factorhouse/helm-charts/actions/workflows/release.yml)
[![Artifact Hub](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/factorhouse)](https://artifacthub.io/packages/search?org=factorhouse)

Official Helm Charts for Factor House products. Currently supported:
Official Helm Charts for Factor House products, including the Kpow Helm Chart and Flex Helm Chart.

- [Kpow](charts/kpow/README.md) (`factorhouse/kpow`)
### Kpow Helm Charts

Deploy Kpow for Apache Kafka® on Kubernetes.

- [Kpow Helm Chart](charts/kpow/README.md) (`factorhouse/kpow`)
- [Kpow Community Edition](charts/kpow-ce/README.md) (`factorhouse/kpow-ce`)
- [Kpow AWS Annual (AWS Marketplace)](charts/kpow-aws-annual/README.md)(`factorhouse/kpow-aws-annual`)
- [Kpow AWS Hourly (AWS Marketplace)](charts/kpow-aws-hourly/README.md)(`factorhouse/kpow-aws-hourly`)
- [Flex](charts/flex/README.md) (`factorhouse/flex`)
- [Kpow AWS Annual (AWS Marketplace)](charts/kpow-aws-annual/README.md) (`factorhouse/kpow-aws-annual`)
- [Kpow AWS Hourly (AWS Marketplace)](charts/kpow-aws-hourly/README.md) (`factorhouse/kpow-aws-hourly`)

### Flex Helm Charts

Deploy Flex for Apache Flink® on Kubernetes.

- [Flex Helm Chart](charts/flex/README.md) (`factorhouse/flex`)
- [Flex Community Edition](charts/flex-ce/README.md) (`factorhouse/flex-ce`)

# Installation
Expand Down
17 changes: 6 additions & 11 deletions charts/flex/README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,14 @@
# Run Flex for Apache Flink in Kubernetes
# Flex Helm Chart

[Flex](https://factorhouse.io/flex) is the all-in-one toolkit to manage, monitor, and learn about your Flink resources.
This is the official **Flex Helm Chart** for deploying Flex for Apache Flink® on Kubernetes.

This Helm chart uses the [factorhouse/flex](https://hub.docker.com/r/factorhouse/flex) container from Dockerhub.
[Flex](https://factorhouse.io/products/flex) is an all-in-one toolkit to manage, monitor, and learn about your Flink resources.

The Flex Helm Chart is maintained by Factor House and uses the [factorhouse/flex](https://hub.docker.com/r/factorhouse/flex) container from Docker Hub.

# Helm Charts

This repository contains a single Helm chart that uses the [factorhouse/flex](https://hub.docker.com/r/factorhouse/flex)
This repository contains a single Helm Chart that uses the [factorhouse/flex](https://hub.docker.com/r/factorhouse/flex)
container on Dockerhub.

- [Prerequisites](#prerequisites)
Expand Down Expand Up @@ -53,7 +55,6 @@ ip-192-168-...-21.ec2.internal Ready <none> 2m15s v1.32.9-eks-113cf36
...
```


## Run Flex in Kubernetes

### Configure the Flex Helm Repository
Expand All @@ -70,7 +71,6 @@ Update Helm repositories to ensure you install the latest version of Flex.
helm repo update
```


### Start a Flex Instance

#### Start Flex with config from '--set env.XYZ'
Expand Down Expand Up @@ -163,7 +163,6 @@ kubectl logs --namespace factorhouse $POD_NAME
helm delete --namespace factorhouse flex
```


### Start Flex with Local Changes

You can run Flex with local edits to these charts and provide local configuration when running Flex.
Expand Down Expand Up @@ -249,7 +248,6 @@ See the Kubernetes documentation
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)
for more information.


```bash
helm install flex ./flex \
--set envFromSecret=flex-secrets \
Expand All @@ -272,7 +270,6 @@ 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.


### Flex Memory and CPU Requirements

The chart runs Flex with Guaranteed QoS, having resource request and limit set to these values by default:
Expand Down Expand Up @@ -305,7 +302,6 @@ resources:
memory: 2Gi
```


Adjust these values from the command line like so:

```bash
Expand All @@ -329,4 +325,3 @@ If you have any issues or errors, please contact support@factorhouse.io.
### Licensing and Modifications

This repository is Apache 2.0 licensed, you are welcome to clone and modify as required.

26 changes: 10 additions & 16 deletions charts/kpow/README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,14 @@
# Run Kpow for Apache Kafka with Kubernetes
# Kpow Helm Chart

[Kpow](https://factorhouse.io/kpow/) is the all-in-one toolkit to manage, monitor, and learn about your Kafka resources.
This is the official **Kpow Helm Chart** for deploying Kpow for Apache Kafka® on Kubernetes.

This Helm chart uses the [factorhouse/kpow](https://hub.docker.com/r/factorhouse/kpow) container from Dockerhub.
[Kpow](https://factorhouse.io/products/kpow/) is the all-in-one toolkit to manage, monitor, and learn about your Kafka resources.

The Kpow Helm Chart is maintained by Factor House and uses the [factorhouse/kpow](https://hub.docker.com/r/factorhouse/kpow) container from Dockerhub.

# Helm Charts

This repository contains a single Helm chart that uses the [factorhouse/kpow](https://hub.docker.com/r/factorhouse/kpow) container on Dockerhub.
This repository contains a single Helm Chart that uses the [factorhouse/kpow](https://hub.docker.com/r/factorhouse/kpow) container on Dockerhub.

- [Prerequisites](#prerequisites)
- [Kubernetes](#kubernetes)
Expand Down Expand Up @@ -53,7 +55,6 @@ ip-192-168-...-21.ec2.internal Ready <none> 2m15s v1.32.9-eks-113cf36
...
```


## Run Kpow in Kubernetes

### Configure the Kpow Helm Repository
Expand All @@ -70,7 +71,6 @@ Update Helm repositories to ensure you install the latest version of Kpow.
helm repo update
```


### Start a Kpow Instance

#### Start Kpow with config from '--set env.XYZ'
Expand Down Expand Up @@ -167,7 +167,6 @@ kubectl logs $POD_NAME --namespace factorhouse
helm delete kpow --namespace factorhouse
```


### Start Kpow with Local Changes

You can run Kpow with local edits to these charts and provide local configuration when running Kpow.
Expand All @@ -194,7 +193,7 @@ helm install kpow ./kpow \

#### Configuring with an Existing ConfigMap

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

**1. Prepare Your ConfigMap Manifest**

Expand All @@ -215,7 +214,7 @@ kubectl apply -f kpow-config.yaml --namespace factorhouse

**3. Install the Chart**

Install the Helm chart, using `--set` to reference the name of the `ConfigMap` you just created. The `--create-namespace` flag will ensure the target namespace exists.
Install the Helm Chart, using `--set` to reference the name of the `ConfigMap` you just created. The `--create-namespace` flag will ensure the target namespace exists.

```bash
helm install kpow ./kpow \
Expand All @@ -231,7 +230,7 @@ See the Kubernetes documentation on [configuring all key-value pairs in a config

### Manage Sensitive Environment Variables

This helm chart accepts the name of a secret containing sensitive parameters, e.g.
This Helm Chart accepts the name of a secret containing sensitive parameters, e.g.

```yaml
apiVersion: v1
Expand All @@ -247,13 +246,12 @@ data:
kubectl apply -f ./kpow-secrets.yaml --namespace factorhouse
```

Then run the helm chart (this can be used in conjunction with `envFromConfigMap`)
Then run the Helm Chart (this can be used in conjunction with `envFromConfigMap`)

See the Kubernetes documentation
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)
for more information.


```bash
helm install kpow ./kpow \
--set envFromSecret=kpow-secrets \
Expand All @@ -274,7 +272,6 @@ regard.

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.


### Kpow Memory and CPU Requirements

The chart runs Kpow with Guaranteed QoS, having resource request and limit set to these values by default:
Expand Down Expand Up @@ -305,7 +302,6 @@ resources:
memory: 2Gi
```


Adjust these values from the command line like so:

```bash
Expand Down Expand Up @@ -333,7 +329,6 @@ ephemeralTmp:
sizeLimit: "100Mi" # Configurable size
```


---

### Get Help!
Expand All @@ -343,4 +338,3 @@ If you have any issues or errors, please contact support@factorhouse.io.
### Licensing and Modifications

This repository is Apache 2.0 licensed, you are welcome to clone and modify as required.