Skip to content

Commit

Permalink
Merge pull request #1767 from ClickHouse/revert-1749-revert-1743-keep…
Browse files Browse the repository at this point in the history
…er-http-readiness-endpoint

Revert "Revert "Add docs on Keeper HTTP control port""
  • Loading branch information
thevar1able authored Dec 14, 2023
2 parents a9a607f + f0b30c8 commit 4f7a550
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions docs/en/guides/sre/keeper/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@ ClickHouse Keeper can be used as a standalone replacement for ZooKeeper or as an
`False` by default.
- `max_memory_usage_soft_limit` — Soft limit in bytes of keeper max memory usage. Default value is `max_memory_usage_soft_limit_ratio` * `physical_memory_amount`.
- `max_memory_usage_soft_limit_ratio` — If `max_memory_usage_soft_limit` is not set or set to zero, we use this value to define the default soft limit. The default value is 0.9.
- `http_control` — Configuration of [HTTP control](#http-control) interface.

Other common parameters are inherited from the ClickHouse server config (`listen_host`, `logger`, and so on).

Expand Down Expand Up @@ -359,6 +360,25 @@ multi_read 1
check_not_exists 0
```

### HTTP Control {#http-control}

ClickHouse Keeper provides an HTTP interface to check if a replica is ready to receive traffic. It may be used in cloud environments, such as [Kubernetes](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/#define-readiness-probes).

Example of configuration that enables `/ready` endpoint:

```xml
<clickhouse>
<keeper_server>
<http_control>
<port>9182</port>
<readiness>
<endpoint>/ready</endpoint>
</readiness>
</http_control>
</keeper_server>
</clickhouse>
```

### Feature flags

Keeper is fully compatible with ZooKeeper and its clients, but it also introduces some unique features and request types that can be used by ClickHouse client.
Expand Down

0 comments on commit 4f7a550

Please sign in to comment.