Skip to content

Commit

Permalink
fix groupId usage, upd docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@salkrr
salkrr committed Dec 10, 2024
1 parent afedc71 commit 0fdae21
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 23 deletions.
38 changes: 19 additions & 19 deletions charts/keys/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -253,25 +253,25 @@ See the [documentation](https://docs.2gis.com/en/on-premise/keys) to learn about

### Kafka settings

| Name | Description | Value |
| --------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ |
| `kafka.bootstrapServers` | Comma-separated list of host and port pairs that are the addresses of the Kafka brokers (e.g. 'localhost:9092,localhost:9093'). **Required** | `""` |
| `kafka.securityProtocol` | Protocol used to communicate with brokers. Valid values are: PLAINTEXT, SSL, SASL_PLAINTEXT, SASL_SSL. Default: PLAINTEXT. | `PLAINTEXT` |
| `kafka.saslMechanism` | Authentication mechanism when security_protocol is configured for SASL_PLAINTEXT or SASL_SSL. Valid values are: PLAIN, SCRAM-SHA-256, SCRAM-SHA-512. | `PLAIN` |
| `kafka.username` | Username for authorization (SASL). | `""` |
| `kafka.password` | Password for authorization (SASL). | `""` |
| `kafka.tls.skipServerCertificateVerify` | Controls whether a client verifies the server's certificate chain and host name. | `false` |
| `kafka.tls.rootCert` | Root certificate. | `""` |
| `kafka.tls.cert` | Client certificate. | `""` |
| `kafka.tls.key` | Client key. | `""` |
| `kafka.stats` | **Settings for consuming key's usage statistics messages.** | |
| `kafka.stats.topic` | Topic to consume stat messages from. **Required** | `""` |
| `kafka.stats.clientPrefix` | Prefix for client name. | `production` |
| `kafka.stats.clientId` | Client id. If empty hostname will be used. | `""` |
| `kafka.audit` | **Settings for sending audit messages.** | |
| `kafka.audit.topic` | Topic to produce audit messages. **Required** | `""` |
| `kafka.audit.produce.retryCount` | Number of retries to produce a message. | `5` |
| `kafka.audit.produce.idempotentWrite` | Flag to enable/disable [idempotent write](https://docs.confluent.io/platform/current/installation/configuration/producer-configs.html#enable-idempotence). | `true` |
| Name | Description | Value |
| --------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- |
| `kafka.bootstrapServers` | Comma-separated list of host and port pairs that are the addresses of the Kafka brokers (e.g. 'localhost:9092,localhost:9093'). **Required** | `""` |
| `kafka.securityProtocol` | Protocol used to communicate with brokers. Valid values are: PLAINTEXT, SSL, SASL_PLAINTEXT, SASL_SSL. Default: PLAINTEXT. | `PLAINTEXT` |
| `kafka.saslMechanism` | Authentication mechanism when security_protocol is configured for SASL_PLAINTEXT or SASL_SSL. Valid values are: PLAIN, SCRAM-SHA-256, SCRAM-SHA-512. | `PLAIN` |
| `kafka.username` | Username for authorization (SASL). | `""` |
| `kafka.password` | Password for authorization (SASL). | `""` |
| `kafka.tls.skipServerCertificateVerify` | Controls whether a client verifies the server's certificate chain and host name. | `false` |
| `kafka.tls.rootCert` | Root certificate. | `""` |
| `kafka.tls.cert` | Client certificate. | `""` |
| `kafka.tls.key` | Client key. | `""` |
| `kafka.stats` | **Settings for consuming key's usage statistics messages.** | |
| `kafka.stats.topic` | Topic to consume stat messages from. **Required** | `""` |
| `kafka.stats.groupId` | Name of the consumer group to use. **Required** | `""` |
| `kafka.stats.clientId` | Client id. If empty hostname will be used. | `""` |
| `kafka.audit` | **Settings for sending audit messages.** | |
| `kafka.audit.topic` | Topic to produce audit messages. **Required** | `""` |
| `kafka.audit.produce.retryCount` | Number of retries to produce a message. | `5` |
| `kafka.audit.produce.idempotentWrite` | Flag to enable/disable [idempotent write](https://docs.confluent.io/platform/current/installation/configuration/producer-configs.html#enable-idempotence). | `true` |

### LDAP connection settings

Expand Down
4 changes: 2 additions & 2 deletions charts/keys/templates/helpers.tpl
View file
Original file line number Diff line number Diff line change
Expand Up @@ -351,8 +351,8 @@ app.kubernetes.io/version: {{ .Chart.AppVersion | quote }}
value: "{{ .Values.counter.updateStatusQueryTimeout }}"
- name: KEYS_KAFKA_MAIN_BROKERS
value: "{{ required "A valid .Values.kafka.bootstrapServers entry required" .Values.kafka.bootstrapServers }}"
- name: KEYS_KAFKA_MAIN_CLIENT_PREFIX
value: "{{ .Values.kafka.stats.clientPrefix }}"
- name: KEYS_KAFKA_MAIN_GROUP_ID
value: "{{ required "A valid .Values.kafka.stats.groupId entry required" .Values.kafka.stats.groupId }}"
- name: KEYS_KAFKA_MAIN_CLIENT_ID
value: "{{ .Values.kafka.stats.clientId }}"
- name: KEYS_KAFKA_MAIN_STATS_TOPIC
Expand Down
4 changes: 2 additions & 2 deletions charts/keys/values.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -637,12 +637,12 @@ kafka:
# @extra kafka.stats **Settings for consuming key's usage statistics messages.**

# @param kafka.stats.topic Topic to consume stat messages from. **Required**
# @param kafka.stats.clientPrefix Prefix for client name.
# @param kafka.stats.groupId Name of the consumer group to use. **Required**
# @param kafka.stats.clientId Client id. If empty hostname will be used.

stats:
topic: ''
groupId: production-keys-counter
groupId: ''
clientId: ''

# @extra kafka.audit **Settings for sending audit messages.**
Expand Down

0 comments on commit 0fdae21

Please sign in to comment.