Skip to content

Commit

Permalink
docs(clickhouse-keeper): add README.md (#162)
Browse files Browse the repository at this point in the history
* fix(clickhouse-keeper): fix deployment, update NOTES.txt

* docs(clickhouse-keeper): add README.md
  • Loading branch information
duyet authored Mar 29, 2024
1 parent 37658d0 commit af0c955
Showing 1 changed file with 51 additions and 0 deletions.
51 changes: 51 additions & 0 deletions clickhouse-keeper/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
# clickhouse-keeper

![Version: 0.1.2](https://img.shields.io/badge/Version-0.1.2-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 1.16.0](https://img.shields.io/badge/AppVersion-1.16.0-informational?style=flat-square)

A ClickHouse Keeper chart for Kubernetes

## Values

| Key | Type | Default | Description |
|-----|------|---------|-------------|
| affinity | object | `{}` | |
| command | string | `"HOST=`hostname -s` &&\nDOMAIN=`hostname -d` &&\nif [[ $HOST =~ (.*)-([0-9]+)$ ]]; then\n NAME=${BASH_REMATCH[1]}\n ORD=${BASH_REMATCH[2]}\nelse\n echo \"Failed to parse name and ordinal of Pod\"\n exit 1\nfi &&\nexport MY_ID=$((ORD+1)) &&\nmkdir -p /tmp/clickhouse-keeper/config.d/ &&\n{\n echo \"<yandex><keeper_server>\"\n echo \"<server_id>${MY_ID}</server_id>\"\n echo \"<raft_configuration>\"\n for (( i=1; i<=$SERVERS; i++ )); do\n echo \"<server><id>${i}</id><hostname>$NAME-$((i-1)).${DOMAIN}</hostname><port>${RAFT_PORT}</port></server>\"\n done\n echo \"</raft_configuration>\"\n echo \"</keeper_server></yandex>\"\n} > /tmp/clickhouse-keeper/config.d/generated-keeper-settings.xml &&\ncat /tmp/clickhouse-keeper/config.d/generated-keeper-settings.xml &&\nif [[ \"1\" == \"$MY_ID\" ]]; then\n clickhouse-keeper --config-file=/etc/clickhouse-keeper/keeper_config.xml --force-recovery\nelse\n clickhouse-keeper --config-file=/etc/clickhouse-keeper/keeper_config.xml\nfi\n"` | |
| fullnameOverride | string | `""` | |
| image.pullPolicy | string | `"IfNotPresent"` | |
| image.repository | string | `"clickhouse/clickhouse-keeper"` | |
| image.tag | string | `"head-alpine"` | |
| imagePullSecrets | list | `[]` | |
| ingress.annotations | object | `{}` | |
| ingress.className | string | `""` | |
| ingress.enabled | bool | `false` | |
| ingress.hosts[0].host | string | `"chart-example.local"` | |
| ingress.hosts[0].paths[0].path | string | `"/"` | |
| ingress.hosts[0].paths[0].pathType | string | `"ImplementationSpecific"` | |
| ingress.tls | list | `[]` | |
| keeperConfig | string | `"<clickhouse>\n <include_from>/tmp/clickhouse-keeper/config.d/generated-keeper-settings.xml</include_from>\n <logger>\n <level>trace</level>\n <console>true</console>\n </logger>\n <listen_host>0.0.0.0</listen_host>\n <keeper_server incl=\"keeper_server\">\n <path>/var/lib/clickhouse-keeper</path>\n <tcp_port>2181</tcp_port>\n <four_letter_word_white_list>*</four_letter_word_white_list>\n <coordination_settings>\n <!-- <raft_logs_level>trace</raft_logs_level> -->\n <raft_logs_level>information</raft_logs_level>\n </coordination_settings>\n </keeper_server>\n <prometheus>\n <endpoint>/metrics</endpoint>\n <port>7000</port>\n <metrics>true</metrics>\n <events>true</events>\n <asynchronous_metrics>true</asynchronous_metrics>\n <!-- https://github.com/ClickHouse/ClickHouse/issues/46136 -->\n <status_info>false</status_info>\n </prometheus>\n</clickhouse>\n"` | |
| livenessProbe.exec.command[0] | string | `"bash"` | |
| livenessProbe.exec.command[1] | string | `"-xc"` | |
| livenessProbe.exec.command[2] | string | `"date && OK=$(exec 3<>/dev/tcp/127.0.0.1/2181 ; printf \"ruok\" >&3 ; IFS=; tee <&3; exec 3<&- ;); if [[ \"$OK\" == \"imok\" ]]; then exit 0; else exit 1; fi"` | |
| livenessProbe.initialDelaySeconds | int | `20` | |
| livenessProbe.timeoutSeconds | int | `15` | |
| nameOverride | string | `""` | |
| nodeSelector | object | `{}` | |
| persistence.accessMode | string | `"ReadWriteOnce"` | |
| persistence.enabled | bool | `true` | |
| persistence.existingClaim | string | `""` | |
| persistence.size | string | `"10Gi"` | |
| persistence.storageClass | string | `""` | |
| podAnnotations | object | `{}` | |
| podLabels | object | `{}` | |
| podSecurityContext | object | `{}` | |
| replicaCount | int | `3` | |
| resources | object | `{}` | |
| securityContext | object | `{}` | |
| service.port | int | `7000` | |
| service.type | string | `"ClusterIP"` | |
| tolerations | list | `[]` | |
| volumeMounts | list | `[]` | |
| volumes | list | `[]` | |

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

0 comments on commit af0c955

Please sign in to comment.