Skip to content

Commit 4bf5755

Browse files
Fix formatting in README.md and udpate documentation link (#60)
1 parent 74d68a9 commit 4bf5755

1 file changed

Lines changed: 25 additions & 22 deletions

File tree

README.md

Lines changed: 25 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -5,22 +5,24 @@
55

66
<picture>
77
<source media="(prefers-color-scheme: light)" srcset="https://clickhouse.com/docs/img/clickhouse-operator-logo-black.svg">
8-
<img align="left" width="300" style="margin-right: 20px;" src="https://clickhouse.com/docs/img/clickhouse-operator-logo.svg" alt="The ClickHouse Operator logo.">
8+
<img align="left" width="200" style="margin-right: 20px;" src="https://clickhouse.com/docs/img/clickhouse-operator-logo.svg" alt="The ClickHouse Operator logo.">
99
</picture>
1010

1111
### ClickHouse Operator
1212

1313
The ClickHouse Operator is a Kubernetes operator that automates the deployment, configuration, and management of ClickHouse clusters and ClickHouse Keeper clusters on Kubernetes.
1414
It provides declarative cluster management through custom resources, enabling users to easily create highly-available ClickHouse deployments.
1515

16-
The Operator handles the full lifecycle of ClickHouse clusters including scaling, upgrades, and configuration management.
16+
The Operator handles the full lifecycle of ClickHouse clusters, including scaling, upgrades, and configuration management.
17+
18+
<br clear="left">
1719

1820
## Features
1921

2022
- **ClickHouse Cluster Management**: Create and manage ClickHouse clusters
2123
- **ClickHouse Keeper Integration**: Built-in support for ClickHouse Keeper clusters for distributed coordination
2224
- **Storage Provisioning**: Customizable persistent volume claims with storage class selection
23-
- **High Availability**: Fault tolerant installations for ClickHouse and Keeper clusters
25+
- **High Availability**: Fault-tolerant installations for ClickHouse and Keeper clusters
2426
- **Security**: Built-in security features TLS/SSL support for secure cluster communication
2527
- **Monitoring**: Prometheus metrics integration for observability
2628

@@ -31,34 +33,35 @@ The Operator handles the full lifecycle of ClickHouse clusters including scaling
3133
- docker version 17.03+
3234
- `kubectl` version v1.33.0+
3335
- Access to a Kubernetes v1.33.0+ cluster
36+
- cert-manager installed in the cluster (for webhook certificates)
3437

3538
### Quick Start
3639

3740
For users who want to quickly try the operator:
3841

3942
1. Install the Custom Resource Definitions(CRD) and operator (Requires cert-manager to issue webhook certificates):
40-
1. Using pre-built manifests:
41-
```sh
42-
kubectl apply -f https://github.com/ClickHouse/clickhouse-operator/releases/download/<release>/clickhouse-operator.yaml
43-
```
44-
2. Using helm chart
45-
```sh
46-
helm install clickhouse-operator oci://ghcr.io/clickhouse/clickhouse-operator-helm \
47-
--create-namespace \
48-
-n clickhouse-operator-system
49-
```
43+
- Using pre-built manifests:
44+
```sh
45+
kubectl apply -f https://github.com/ClickHouse/clickhouse-operator/releases/download/latest/clickhouse-operator.yaml
46+
```
47+
- Using helm chart
48+
```sh
49+
helm install clickhouse-operator oci://ghcr.io/clickhouse/clickhouse-operator-helm \
50+
--create-namespace \
51+
-n clickhouse-operator-system
52+
```
5053

5154
2. Deploy a sample cluster:
52-
```sh
53-
kubectl apply -f https://raw.githubusercontent.com/ClickHouse/clickhouse-operator/refs/heads/main/examples/minimal.yaml
54-
```
55+
```sh
56+
kubectl apply -f https://raw.githubusercontent.com/ClickHouse/clickhouse-operator/refs/heads/main/examples/minimal.yaml
57+
```
5558

5659
3. Verify the deployment:
57-
```sh
58-
kubectl get clickhouseclusters
59-
kubectl get keeperclusters
60-
kubectl get pods
61-
```
60+
```sh
61+
kubectl get clickhouseclusters
62+
kubectl get keeperclusters
63+
kubectl get pods
64+
```
6265

6366
### Deploy from the sources
6467
**Build and push your image to the location specified by `IMG`:**
@@ -118,7 +121,7 @@ make undeploy
118121

119122
## Documentation
120123

121-
For more detailed information, see the [documentation](./docs/README.md):
124+
For more detailed information, see the [documentation](https://clickhouse.com/docs/clickhouse-operator/overview).
122125

123126
## Contributing
124127

0 commit comments

Comments
 (0)