Skip to content

Add Zookeeper compression support to ClickHouseInstallation CRD #1809

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

Merged
sunsingerus merged 1 commit into from
Sep 11, 2025
+26 −7
Merged

Add Zookeeper compression support to ClickHouseInstallation CRD #1809

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
3 changes: 3 additions & 0 deletions ...-install-bundle/clickhouse-operator-install-yaml-template-01-section-crd-01-chi-chit.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -620,6 +620,9 @@ spec:
identity:
type: string
description: "optional access credentials string with `user:password` format used when use digest authorization in Zookeeper"
use_compression:
!!merge <<: *TypeStringBool
description: "Enables compression in Keeper protocol if set to true"
users:
type: object
description: |
Expand Down
3 changes: 3 additions & 0 deletions ...erator/crds/CustomResourceDefinition-clickhouseinstallations.clickhouse.altinity.com.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -620,6 +620,9 @@ spec:
identity:
type: string
description: "optional access credentials string with `user:password` format used when use digest authorization in Zookeeper"
use_compression:
!!merge <<: *TypeStringBool
description: "Enables compression in Keeper protocol if set to true"
users:
type: object
description: |
Expand Down
3 changes: 3 additions & 0 deletions ...rds/CustomResourceDefinition-clickhouseinstallationtemplates.clickhouse.altinity.com.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -620,6 +620,9 @@ spec:
identity:
type: string
description: "optional access credentials string with `user:password` format used when use digest authorization in Zookeeper"
use_compression:
!!merge <<: *TypeStringBool
description: "Enables compression in Keeper protocol if set to true"
users:
type: object
description: |
Expand Down
19 changes: 12 additions & 7 deletions pkg/apis/clickhouse.altinity.com/v1/type_zookeeper.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,19 +15,23 @@
package v1

import (
"gopkg.in/d4l3k/messagediff.v1"
"strings"

"gopkg.in/d4l3k/messagediff.v1"

"github.com/altinity/clickhouse-operator/pkg/apis/common/types"
)

// ZookeeperConfig defines zookeeper section of .spec.configuration
// Refers to
// https://clickhouse.yandex/docs/en/single/index.html?#server-settings_zookeeper
// https://clickhouse.com/docs/operations/server-configuration-parameters/settings#zookeeper
type ZookeeperConfig struct {
Nodes ZookeeperNodes `json:"nodes,omitempty" yaml:"nodes,omitempty"`
SessionTimeoutMs int `json:"session_timeout_ms,omitempty" yaml:"session_timeout_ms,omitempty"`
OperationTimeoutMs int `json:"operation_timeout_ms,omitempty" yaml:"operation_timeout_ms,omitempty"`
Root string `json:"root,omitempty" yaml:"root,omitempty"`
Identity string `json:"identity,omitempty" yaml:"identity,omitempty"`
Nodes ZookeeperNodes `json:"nodes,omitempty" yaml:"nodes,omitempty"`
SessionTimeoutMs int `json:"session_timeout_ms,omitempty" yaml:"session_timeout_ms,omitempty"`
OperationTimeoutMs int `json:"operation_timeout_ms,omitempty" yaml:"operation_timeout_ms,omitempty"`
Root string `json:"root,omitempty" yaml:"root,omitempty"`
Identity string `json:"identity,omitempty" yaml:"identity,omitempty"`
UseCompression *types.StringBool `json:"use_compression,omitempty" yaml:"use_compression,omitempty"`
}

type ZookeeperNodes []ZookeeperNode
Expand Down Expand Up @@ -114,6 +118,7 @@ func (zkc *ZookeeperConfig) MergeFrom(from *ZookeeperConfig, _type MergeType) *Z
if from.Identity != "" {
zkc.Identity = from.Identity
}
zkc.UseCompression = zkc.UseCompression.MergeFrom(from.UseCompression)

return zkc
}
Expand Down
5 changes: 5 additions & 0 deletions pkg/model/chi/config/generator.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -165,6 +165,11 @@ func (c *Generator) getHostZookeeper(host *chi.Host) string {
util.Iline(b, 8, "<identity>%s</identity>", zk.Identity)
}

// Append use_compression
if zk.UseCompression != nil && zk.UseCompression.IsValid() {
util.Iline(b, 8, "<use_compression>%s</use_compression>", zk.UseCompression.String())
}

// </zookeeper>
util.Iline(b, 4, "</zookeeper>")

Expand Down
Loading