diff --git a/products/kubernetes-operator/guides/configuration.mdx b/products/kubernetes-operator/guides/configuration.mdx index 3bddcd89..aeccca74 100644 --- a/products/kubernetes-operator/guides/configuration.mdx +++ b/products/kubernetes-operator/guides/configuration.mdx @@ -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} @@ -383,7 +383,7 @@ spec: The `extraUsersConfig` is stored in k8s ConfigMap object. Avoid plain text secrets there. -#### 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} diff --git a/products/kubernetes-operator/guides/introduction.mdx b/products/kubernetes-operator/guides/introduction.mdx index 6c08a0fd..ab530d16 100644 --- a/products/kubernetes-operator/guides/introduction.mdx +++ b/products/kubernetes-operator/guides/introduction.mdx @@ -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: @@ -114,7 +114,7 @@ The operator does **not** synchronize: **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. Benefits: diff --git a/products/kubernetes-operator/install/olm.mdx b/products/kubernetes-operator/install/olm.mdx index 25051f35..8ff3cb14 100644 --- a/products/kubernetes-operator/install/olm.mdx +++ b/products/kubernetes-operator/install/olm.mdx @@ -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) + diff --git a/products/kubernetes-operator/reference/api-reference.mdx b/products/kubernetes-operator/reference/api-reference.mdx index 43e59de8..2872ead1 100644 --- a/products/kubernetes-operator/reference/api-reference.mdx +++ b/products/kubernetes-operator/reference/api-reference.mdx @@ -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.
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. @@ -65,6 +76,7 @@ ClickHouseClusterSpec defines the desired state of ClickHouseCluster. | `upgradeChannel` | string | UpgradeChannel specifies the release channel for major version upgrade checks.
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.
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.
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)