Skip to content

Docs: sync upstream clickhouse-operator docs updates #77

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
mintlify wants to merge 1 commit into from
Closed

Docs: sync upstream clickhouse-operator docs updates #77

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions products/kubernetes-operator/guides/configuration.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -350,8 +350,8 @@ spec:
```

#### Useful links:
* [YAML configuration examples](/core/concepts/features/configuration/server-config/configuration-files#example-1)
* [All server settings](/core/reference/settings/server-settings/settings)
* [YAML configuration examples](/concepts/features/configuration/server-config/configuration-files#example-1)
* [All server settings](/reference/settings/server-settings/settings)

### Embedded extra users configuration {#embedded-extra-users-configuration}

Expand Down Expand Up @@ -383,7 +383,7 @@ spec:
The `extraUsersConfig` is stored in k8s ConfigMap object. Avoid plain text secrets there.
</Note>

#### See [documentation](/core/concepts/features/configuration/settings/settings-users) for all supported ClickHouse users configuration options.
#### See [documentation](/concepts/features/configuration/settings/settings-users) for all supported ClickHouse users configuration options.

### Configuration example {#configuration-example}

Expand Down
4 changes: 2 additions & 2 deletions products/kubernetes-operator/guides/introduction.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ The ClickHouse Operator automatically replicates database definitions across all
### What Gets Replicated {#what-gets-replicated}

The operator synchronizes:
- [Replicated](/core/reference/engines/database-engines/replicated) database definitions
- [Replicated](/reference/engines/database-engines/replicated) database definitions
- Integration database engines (PostgreSQL, MySQL, etc.)

The operator does **not** synchronize:
Expand All @@ -114,7 +114,7 @@ The operator does **not** synchronize:
<Tip>
**Best practice**

Always use the [Replicated](/core/reference/engines/database-engines/replicated) database engine for production deployments.
Always use the [Replicated](/reference/engines/database-engines/replicated) database engine for production deployments.
</Tip>

Benefits:
Expand Down
1 change: 1 addition & 0 deletions products/kubernetes-operator/install/olm.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,3 +97,4 @@ More info about uninstalling can be found in the [OLM documentation](https://olm
## Additional Resources {#additional-resources}

- [Operator Lifecycle Manager Documentation](https://olm.operatorframework.io/docs)

14 changes: 13 additions & 1 deletion products/kubernetes-operator/reference/api-reference.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,20 @@ doc_type: 'reference'
sidebarTitle: 'API reference'
---


This document provides detailed API reference for the ClickHouse Operator custom resources.

## AdditionalPort {#additionalport}

AdditionalPort declares one extra TCP port to expose on the ClickHouse Pod and the operator-managed headless Service.

| Field | Type | Description | Required | Default |
|-------|------|-------------|----------|---------|
| `name` | string | Name uniquely identifies the port within the list. Used as both the container port name and the Service port name.<br />This must be a DNS_LABEL. | true | |
| `port` | integer | Port is the TCP port number to expose. | true | |

Appears in:
- [ClickHouseClusterSpec](#clickhouseclusterspec)

## ClickHouseCluster {#clickhousecluster}

ClickHouseCluster is the Schema for the `clickhouseclusters` API.
Expand Down Expand Up @@ -65,6 +76,7 @@ ClickHouseClusterSpec defines the desired state of ClickHouseCluster.
| `upgradeChannel` | string | UpgradeChannel specifies the release channel for major version upgrade checks.<br />When empty, only minor updates will be proposed. Allowed values are: stable, lts or specific major.minor version (e.g. 25.8). | false | |
| `versionProbeTemplate` | [VersionProbeTemplate](#versionprobetemplate) | VersionProbeTemplate overrides for the version detection Job. | false | |
| `externalSecret` | [ExternalSecret](#externalsecret) | ExternalSecret is an optional reference to an externally-managed Secret containing cluster secrets.<br />The secret must reside in the same namespace as the cluster. | false | |
| `additionalPorts` | [AdditionalPort](#additionalport) array | AdditionalPorts declares extra TCP ports to expose on the ClickHouse Pod and the operator-managed headless Service.<br />The operator only adds the ports to the Kubernetes resources, it does not configure the ClickHouse server to listen on them. | false | |

Appears in:
- [ClickHouseCluster](#clickhousecluster)
Expand Down