A Helm chart for Confluent Kafka REST on Kubernetes
This chart bootstraps a Kafka REST using the Confluent stable version.
The Confluent REST Proxy provides a RESTful interface to a Kafka cluster.
| component | version |
|---|---|
| Podman | v4.3.1 |
| Minikube | v1.28.0 |
| Kubernetes | v1.25.3 |
| Helm | v3.10.2 |
| Confluent Platform | v7.3.0 |
Add the chart repository, if not done before:
helm repo add rhcharts https://ricardo-aires.github.io/helm-charts/By default this chart is set to use the umbrella chart kstack, but can be run against an external Kafka and Schema Registry by passing:
helm install --set kafka.enabled=false --set kafka.bootstrapServers=PLAINTEXT://kstack-kafka-headless.default:9092 --set schema-registry.enabled=false --set schema-registry.url=kstack-schema-registry.default:8081 ktool rhcharts/kafka-rest
NAME: ktool
LAST DEPLOYED: Tue Mar 23 18:35:37 2021
NAMESPACE: default
STATUS: deployed
REVISION: 1
NOTES:
** Please be patient while the kafka-rest chart is being deployed in release ktool **
This chart bootstraps a Confluent Kafka REST that can be accessed from within your cluster:
ktool-kafka-rest.default:8082
$These commands deploy Kafka REST on the Kubernetes cluster in the default configuration. The Parameters section lists the parameters that can be configured during installation.
One can run the:
- helm list command to list releases installed
- helm status to display the status of the named release
- helm test to run tests for a release
To uninstall the ktool deployment run:
helm uninstall ktoolThe command removes all the Kubernetes components associated with the chart and deletes the release.
You can specify each parameter using the --set key=value[,key=value] argument to helm install.
Alternatively, a YAML file that specifies the values for the parameters can be provided while installing the chart. For example,
helm install ktool -f my-values.yaml rhcharts/kafka-restA default values.yaml is available and should be checked for more advanced usage.
By default the confluentinc/cp-kafka-rest is in use.
| Parameter | Description | Default |
|---|---|---|
image.registry |
Registry used to distribute the Docker Image. | docker.io |
image.repository |
Docker Image of Confluent Kafka Connect. | confluentinc/cp-kafka-rest |
image.tag |
Docker Image Tag of Confluent Kafka Connect . | 7.3.0 |
One can easily change the image.tag to use another version. When using a local/proxy docker registry we must change image.registry as well.
By default the Service will expose the pods in the port 8082, port.
This chart is prepared to enable Kerberos authentication in Kafka
| Parameter | Description | Default |
|---|---|---|
kerberos.enabled |
Boolean to control if Kerberos is enabled. | false |
kerberos.krb5Conf |
Name of the ConfigMap that stores the krb5.conf, Kerberos Configuration file |
nil¹ |
kerberos.keyTabSecret |
Name of the Secret that stores the Keytab | nil¹ |
serviceName |
Primary of the Principal (user, service, host) | |
domain |
REALM of the Principal | `` |
¹ When
kerberos.enabledthese parameters are required, and the ConfigMap and Secret need to exist beforehand.
Regarding the management of Resources for Containers the next defaults regarding requests and limits are set:
| Parameter | Description | Default |
|---|---|---|
resources.limits.cpu |
a container cannot use more CPU than the configured limit | 200m |
resources.limits.memory |
a container cannot use more Memory than the configured limit | 660Mi |
resources.requests.cpu |
a container is guaranteed to be allocated as much CPU as it requests | 100m |
resources.requests.memory |
a container is guaranteed to be allocated as much Memory as it requests | 200Mi |
In terms of the JVM the next default is set:
| Parameter | Description | Default |
|---|---|---|
heapOpts |
The JVM Heap Options for Kafka Rest. | "-XX:MaxRAMPercentage=75.0 -XX:InitialRAMPercentage=50.0" |
Check the values.yaml for more advance configuration such as: