Skip to content

Commit

Permalink
Update README for kafka-manager
Browse files Browse the repository at this point in the history
I updated the DOCS gotmpl to conform to the original docs as stated by Joris (overwritten in a recent docs update) and I removed the entry from .helmdocsignore.
  • Loading branch information
pvannierop committed Aug 23, 2024
1 parent 75eef18 commit 1c578fd
Show file tree
Hide file tree
Showing 4 changed files with 101 additions and 17 deletions.
1 change: 0 additions & 1 deletion .helmdocsignore
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
charts/kafka-manager/
charts/radar-backend/
charts/smtp/
external/
Empty file.
61 changes: 45 additions & 16 deletions charts/kafka-manager/README.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,44 @@


# kafka-manager
# Kafka Manager Helm Chart

![Version: 2.2.0](https://img.shields.io/badge/Version-2.2.0-informational?style=flat-square) ![AppVersion: 1.3.3.18](https://img.shields.io/badge/AppVersion-1.3.3.18-informational?style=flat-square)
[Kafka Manager](https://github.com/yahoo/kafka-manager) is a tool for managing [Apache Kafka](http://kafka.apache.org/).

A tool for managing Apache Kafka.
## TL;DR;

**Homepage:** <https://github.com/yahoo/kafka-manager>
```bash
$ helm install stable/kafka-manager
```

## Maintainers
## Prerequisites

| Name | Email | Url |
| ---- | ------ | --- |
| giacomoguiulfo | <giacomoguiulfo@gmail.com> | |
| ssalaues | <salim.salaues@scality.com> | |
- Kubernetes 1.9+ with Beta APIs enabled

## Source Code
## Installing the Chart

* <https://github.com/yahoo/kafka-manager>
To install the chart with the release name `my-release`:

## Requirements
```bash
$ helm install --name my-release stable/kafka-manager
```

Kubernetes: `^1.8.0-0`
The command deploys Kafka Manager on the Kubernetes cluster in the default configuration. The [configuration](#configuration) section lists the parameters that can be configured during installation.

> **Tip**: List all releases using `helm list`
## Uninstalling the Chart

To uninstall/delete the `my-release` deployment:

```bash
$ helm delete my-release
```

The command removes all the Kubernetes components associated with the chart and deletes the release.

## Configuration

The following table lists the configurable parameters of the Kafka Manager chart and their default values.

## Values

Expand All @@ -46,7 +63,7 @@ Kubernetes: `^1.8.0-0`
| zookeeper | object | `{"enabled":false,"env":{"ZK_HEAP_SIZE":"1G"},"persistence":{"enabled":false}}` | ---------------------------------------------------------------------------- |
| zkHosts | string | `"cp-zookeeper:2181"` | |
| image.repository | string | `"radarbase/kafka-manager"` | |
| image.tag | string | `"1.3.3.18"` | |
| image.tag | string | `nil` | Overrides the image tag whose default is the chart appVersion. |
| image.pullPolicy | string | `"IfNotPresent"` | |
| imagePullSecrets | list | `[]` | Docker registry secret names as an array |
| disable_tls | bool | `false` | Disable TLS (reconfigures Ingress and sets URLs to use HTTP) |
Expand All @@ -57,5 +74,17 @@ Kubernetes: `^1.8.0-0`
| ingress.hosts | list | `["localhost"]` | Hosts to accept requests from |
| ingress.tls.secretName | string | `"radar-base-tls"` | TLS Secret Name |

----------------------------------------------
Autogenerated from chart metadata using [helm-docs v1.13.1](https://github.com/norwoodj/helm-docs/releases/v1.13.1)
Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example,

```console
$ helm install stable/kafka-manager --name my-release \
--set ingress.enabled=true
```

Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. For example,

```console
$ helm install stable/kafka-manager --name my-release -f values.yaml
```

> **Tip**: You can use the default [values.yaml](values.yaml)
56 changes: 56 additions & 0 deletions charts/kafka-manager/README.md.gotmpl
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
# Kafka Manager Helm Chart

[Kafka Manager](https://github.com/yahoo/kafka-manager) is a tool for managing [Apache Kafka](http://kafka.apache.org/).

## TL;DR;

```bash
$ helm install stable/kafka-manager
```

## Prerequisites

- Kubernetes 1.9+ with Beta APIs enabled

## Installing the Chart

To install the chart with the release name `my-release`:

```bash
$ helm install --name my-release stable/kafka-manager
```

The command deploys Kafka Manager on the Kubernetes cluster in the default configuration. The [configuration](#configuration) section lists the parameters that can be configured during installation.

> **Tip**: List all releases using `helm list`

## Uninstalling the Chart

To uninstall/delete the `my-release` deployment:

```bash
$ helm delete my-release
```

The command removes all the Kubernetes components associated with the chart and deletes the release.

## Configuration

The following table lists the configurable parameters of the Kafka Manager chart and their default values.

{{ template "chart.valuesSection" . }}

Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example,

```console
$ helm install stable/kafka-manager --name my-release \
--set ingress.enabled=true
```

Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. For example,

```console
$ helm install stable/kafka-manager --name my-release -f values.yaml
```

> **Tip**: You can use the default [values.yaml](values.yaml)

0 comments on commit 1c578fd

Please sign in to comment.