Skip to content

Commit

Permalink
helm docs
Browse files Browse the repository at this point in the history
  • Loading branch information
philkjacobs-nextdoor committed Sep 30, 2024
1 parent 52ad7bf commit e3f70a4
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions charts/local-kafka/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ project's development namespace.
| kafka.interBrokerProtocolVersion | `str` | `nil` | Optional value for the inter.broker.protocol.version property (eg. `2.8`) |
| kafka.logMessageFormatVersion | `str` | `nil` | Optional value for the log.message.format.version property (eg, `2.7`) |
| kafka.priorityClassName | `str` | `nil` | Optional value for the kafka cluster pod priority class name |
| kafka.resources | object | `{"limits":{"cpu":null,"memory":null},"requests":{"cpu":null,"memory":null}}` | Optional resource requirements for the Kafka cluster |
| kafka.resources | string | `nil` | Optional resource requirements for the Kafka cluster |
| listeners | list | `[{"configuration":{"brokers":[{"advertisedHost":"127.0.0.1","broker":0,"nodePort":32000}]},"name":"external","port":9094,"tls":false,"type":"nodeport"}]` | Additional configurable listeners for connecting to brokers. |
| namespaceOverride | string | `nil` | Optionally force the namespace that the resources in this stack are launched in. Without this, the default namespace that the Helm chart is being put into is used. It is recommended to keep this empty. |
| strimzi-kafka-operator.enabled | bool | `true` | Set to `false` to intentionally disable installation of the Operator. This is useful if you are running this stack in a local dev environment where you might have multiple Kafka environments, and are already running the Strimzi operator. |
Expand All @@ -59,7 +59,7 @@ project's development namespace.
| strimzi-kafka-operator.resources | object | `{"limits":{"memory":"1Gi"},"requests":{"cpu":"250m","memory":"512Mi"}}` | Reconfigure the default resource requirements here so that the "requests" are as low as possible for memory (so we're not allocating any more memory than we absolutely must). |
| strimzi-kafka-operator.watchAnyNamespace | bool | `true` | Because you can only install one Strimzi Operator helm chart in a cluster, we might as well set this to True. This allows the chart to be re-used (with `strimzi-kafka-operator.enabled: false`) by other local development projects. |
| userName | string | `"user"` | Set the name of the KafkaUser that is created for local development |
| zookeeper.resources | object | `{"limits":{"cpu":null,"memory":null},"requests":{"cpu":null,"memory":null}}` | Optional resource requirements for the Zookeeper cluster |
| zookeeper.resources | string | `nil` | Optional resource requirements for the Zookeeper cluster |

----------------------------------------------
Autogenerated from chart metadata using [helm-docs v1.11.0](https://github.com/norwoodj/helm-docs/releases/v1.11.0)

0 comments on commit e3f70a4

Please sign in to comment.