[bitnami/clickhouse-operator] docs: improve examples on READMEs (#33020)

* [bitnami/clickhouse-operator] docs: improve examples on READMEs Signed-off-by: juan131 <juan.ariza@broadcom.com> * Update CHANGELOG.md Signed-off-by: Bitnami Bot <bitnami.bot@broadcom.com> * bugfix: proper svc name Signed-off-by: juan131 <juan.ariza@broadcom.com> * bugfix: proper svc labels Signed-off-by: juan131 <juan.ariza@broadcom.com> --------- Signed-off-by: juan131 <juan.ariza@broadcom.com> Signed-off-by: Bitnami Bot <bitnami.bot@broadcom.com> Co-authored-by: Bitnami Bot <bitnami.bot@broadcom.com>
2026-04-02 15:27:08 +08:00 · 2025-04-16 17:15:18 +02:00
parent c4f32e0aa2
commit c2c81e8b6f
5 changed files with 114 additions and 86 deletions
--- a/.vib/clickhouse-operator/goss/goss.yaml
+++ b/.vib/clickhouse-operator/goss/goss.yaml
@@ -12,17 +12,11 @@ file:
    contents:
      - /listen_host>::</
      - /listen_host>0.0.0.0</
-  /opt/bitnami/clickhouse/etc/conf.d/chop-generated-hostname-ports.xml:
-    exists: true
-    filetype: symlink
-    contents:
-      - /tcp_port>9001</
-      - /http_port>8124</
  /opt/bitnami/clickhouse/etc/conf.d/chop-generated-zookeeper.xml:
    exists: true
    filetype: symlink
    contents:
-      - /chk-vib-vib-0-0/
+      - /chk-vib-vib/
  /opt/bitnami/clickhouse/etc/users.d/chop-generated-users.xml:
    exists: true
    filetype: symlink
@@ -30,11 +24,11 @@ file:
      - /<{{ .Vars.auth.username }}>/
 # Host and ports are hardcoded in the ClickHouseInstallationTemplate
 http:
-  http://127.0.0.1:8124/replicas_status:
+  http://127.0.0.1:8123/replicas_status:
    status: 200
    body:
      - Ok
-  http://chi-vib-vib-0-0:8124/replicas_status:
+  http://chi-vib-vib-0-0:8123/replicas_status:
    status: 200
    body:
      - Ok
@@ -46,7 +40,7 @@ addr:
 command:
  check-cluster-status:
    # Hardcoded port based on the ClickHouseInstallationTemplate spec
-    exec: clickhouse-client --port 9001 --user '{{ .Vars.auth.username }}' --password '{{ .Vars.auth.password }}' --query='SELECT COUNT(*) FROM system.clusters;'
+    exec: clickhouse-client --port 9000 --user '{{ .Vars.auth.username }}' --password '{{ .Vars.auth.password }}' --query='SELECT COUNT(*) FROM system.clusters;'
    exit-status: 0
    stdout:
      - "4"
@@ -55,7 +49,7 @@ command:
    {{- $database := printf "test_goss_%s" (randAlpha 5) }}
    {{- $table := printf "%s.table_%s" $database (randAlpha 5) }}
    {{- $insertValue := 23 }}
-    exec: clickhouse-client --host chi-vib-vib-0-0 --port 9001 --user '{{ .Vars.auth.username }}' --password '{{ .Vars.auth.password }}' --multiquery --query='CREATE DATABASE {{ $database }} ON CLUSTER vib ENGINE = Memory; CREATE TABLE {{ $table }} (a UInt8) ENGINE = Memory;  INSERT INTO {{ $table }} VALUES({{ $insertValue }}); SELECT * FROM {{ $table }};'
+    exec: clickhouse-client --host chi-vib-vib-0-0 --port 9000 --user '{{ .Vars.auth.username }}' --password '{{ .Vars.auth.password }}' --multiquery --query='CREATE DATABASE {{ $database }} ON CLUSTER vib ENGINE = Memory; CREATE TABLE {{ $table }} (a UInt8) ENGINE = Memory;  INSERT INTO {{ $table }} VALUES({{ $insertValue }}); SELECT * FROM {{ $table }};'
    exit-status: 0
    stdout:
      - "{{ $insertValue }}"
--- a/.vib/clickhouse-operator/runtime-parameters.yaml
+++ b/.vib/clickhouse-operator/runtime-parameters.yaml
@@ -50,19 +50,6 @@ extraDeploy:
                env:
                  - name: BITNAMI_DEBUG
                    value: "true"
-                  - name: CLICKHOUSE_HTTP_PORT
-                    value: "8124"
-                  - name: CLICKHOUSE_TCP_PORT
-                    value: "9001"
-                  - name: CLICKHOUSE_INTERSERVER_HTTP_PORT
-                    value: "9010"
-                ports:
-                  - name: http
-                    containerPort: 8124
-                  - name: tcp
-                    containerPort: 9001
-                  - name: interserver
-                    containerPort: 9010
                resources:
                  requests:
                    memory: "256M"
@@ -117,16 +104,16 @@ extraDeploy:
        dataVolumeClaimTemplate: default-volume-claim
    configuration:
      settings:
-        http_port: 8124
-        tcp_port: 9001
-        interserver_http_port: 9010
+        http_port: 8123
+        tcp_port: 9000
+        interserver_http_port: 9009
      users:
        test_user/networks/ip:
          - 0.0.0.0/0
          - '::/0'
      zookeeper:
        nodes:
-          - host: chk-vib-vib-0-0
+          - host: chk-vib-vib
            port: 2181
      clusters:
        - name: vib
@@ -186,10 +173,6 @@ extraDeploy:
                    value: "true"
                  - name: CLICKHOUSE_KEEPER_SERVER_ID
                    value: "1"
-                  - name: CLICKHOUSE_KEEPER_TCP_PORT
-                    value: "2181"
-                  - name: CLICKHOUSE_KEEPER_RAFT_PORT
-                    value: "9444"
                resources:
                  requests:
                    memory: "256M"
@@ -231,3 +214,18 @@ extraDeploy:
            resources:
              requests:
                storage: 8Gi
+- apiVersion: v1
+  kind: Service
+  metadata:
+    name: chk-vib-vib
+    labels:
+      clickhouse-keeper.altinity.com/chk: vib
+      clickhouse-keeper.altinity.com/cluster: vib
+  spec:
+    ports:
+      - port: 2181
+        name: client
+    selector:
+      clickhouse-keeper.altinity.com/chk: vib
+      clickhouse-keeper.altinity.com/cluster: vib
+      clickhouse-keeper.altinity.com/ready: "yes"
--- a/bitnami/clickhouse-operator/CHANGELOG.md
+++ b/bitnami/clickhouse-operator/CHANGELOG.md
@@ -1,8 +1,12 @@
 # Changelog

-## 0.1.4 (2025-04-09)
+## 0.1.5 (2025-04-16)

-* [bitnami/clickhouse-operator] Release 0.1.4 ([#32926](https://github.com/bitnami/charts/pull/32926))
+* [bitnami/clickhouse-operator] docs: improve examples on READMEs ([#33020](https://github.com/bitnami/charts/pull/33020))
+
+## <small>0.1.4 (2025-04-09)</small>
+
+* [bitnami/clickhouse-operator] Release 0.1.4 (#32926) ([d73815c](https://github.com/bitnami/charts/commit/d73815c4dad41a121572b0940b78aea96e00e270)), closes [#32926](https://github.com/bitnami/charts/issues/32926)

 ## <small>0.1.3 (2025-04-09)</small>

--- a/bitnami/clickhouse-operator/Chart.yaml
+++ b/bitnami/clickhouse-operator/Chart.yaml
@@ -36,4 +36,4 @@ name: clickhouse-operator
 sources:
 - https://github.com/bitnami/charts/tree/main/bitnami/clickhouse-operator
 - https://github.com/bitnami/containers/tree/main/bitnami/clickhouse-operator
-version: 0.1.4
+version: 0.1.5
--- a/bitnami/clickhouse-operator/README.md
+++ b/bitnami/clickhouse-operator/README.md
@@ -147,7 +147,7 @@ Install the [Bitnami Kube Prometheus helm chart](https://github.com/bitnami/char

 ### Deploying extra resources

-Apart from the Operator, you may want to deploy ClickHouse Installation or ClickHouse Keeper Installation objects. For covering this case, the chart allows adding the full specification of other objects using the `extraDeploy` parameter. The following example creates a ClickHouse Installation using the `default-clickhouse` pod template:
+Apart from the Operator, you may want to deploy ClickHouse Installation or ClickHouse Keeper Installation objects. For covering this case, the chart allows adding the full specification of other objects using the `extraDeploy` parameter. The following examples creates a ClickHouse Installation using the `default-clickhouse` pod template and a ClickHouse Keeper Installation using the `default-keeper` pod template:

 ```yaml
 extraDeploy:
@@ -162,62 +162,94 @@ extraDeploy:
        dataVolumeClaimTemplate: default-volume-claim
    configuration:
      settings:
-        http_port: 8124
-        tcp_port: 9001
-        interserver_http_port: 9010
+        http_port: 8123
+        tcp_port: 9000
+        interserver_http_port: 9009
      users:
-        test_user/networks/ip:
-          - 0.0.0.0/0
-          - '::/0'
+        default/networks/ip:
+        - 0.0.0.0/0
+        - '::/0'
      clusters:
-        - name: test
+      - name: cluster
+        layout:
+          replicasCount: 1
+      zookeeper:
+        nodes:
+          - host: chk-test-cluster
+            port: 2181
+    templates:
+      podTemplates:
+      - name: default-clickhouse
+        distribution: Unspecified
+        spec:
+          containers:
+          - name: clickhouse
+            image: docker.io/bitnami/clickhouse
+            volumeMounts:
+            - name: default-volume-claim
+              mountPath: /bitnami/clickhouse
+      volumeClaimTemplates:
+      - name: default-volume-claim
+        spec:
+          accessModes:
+          - ReadWriteOnce
+          resources:
+            requests:
+              storage: 8Gi
+- apiVersion: clickhouse-keeper.altinity.com/v1
+  kind: ClickHouseKeeperInstallation
+  metadata:
+    name: test
+  spec:
+    defaults:
+      templates:
+        podTemplate: default-keeper
+        dataVolumeClaimTemplate: default-volume-claim
+    configuration:
+      clusters:
+        - name: cluster
          layout:
            replicasCount: 1
    templates:
      podTemplates:
-        - name: default-clickhouse
-          distribution: Unspecified
-          spec:
-            containers:
-              - name: clickhouse
-                image: docker.io/bitnami/clickhouse
-                env:
-                  - name: CLICKHOUSE_HTTP_PORT
-                    value: "8124"
-                  - name: CLICKHOUSE_TCP_PORT
-                    value: "9001"
-                  - name: CLICKHOUSE_INTERSERVER_HTTP_PORT
-                    value: "9010"
-                ports:
-                  - name: http
-                    containerPort: 8124
-                  - name: tcp
-                    containerPort: 9001
-                  - name: interserver
-                    containerPort: 9010
-                volumeMounts:
-                  - name: default-volume-claim
-                    mountPath: /bitnami/clickhouse
-                  - name: empty-dir
-                    mountPath: /opt/bitnami/clickhouse/logs
-                    subPath: app-logs-dir
-                  - name: empty-dir
-                    mountPath: /opt/bitnami/clickhouse/tmp
-                    subPath: app-tmp-dir
-                  - name: empty-dir
-                    mountPath: /tmp
-                    subPath: tmp-dir
-            volumes:
-              - name: empty-dir
-                emptyDir: {}
+      - name: default-keeper
+        distribution: Unspecified
+        spec:
+          containers:
+          - name: clickhouse-keeper
+            image: docker.io/bitnami/clickhouse-keeper
+            workingDir: /var/lib/clickhouse-keeper
+            env:
+            - name: CLICKHOUSE_KEEPER_SERVER_ID
+              valueFrom:
+                fieldRef:
+                  fieldPath: metadata.name
+            volumeMounts:
+            - name: default-volume-claim
+              mountPath: /bitnami/clickhouse-keeper
      volumeClaimTemplates:
-        - name: default-volume-claim
-          spec:
-            accessModes:
-            - ReadWriteOnce
-            resources:
-              requests:
-                storage: 8Gi
+      - name: default-volume-claim
+        spec:
+          accessModes:
+          - ReadWriteOnce
+          resources:
+            requests:
+              storage: 8Gi
+- apiVersion: v1
+  kind: Service
+  metadata:
+    name: chk-test-cluster
+    labels:
+      clickhouse-keeper.altinity.com/chk: test
+      clickhouse-keeper.altinity.com/cluster: cluster
+  spec:
+    ports:
+      - port: 2181
+        name: client
+    selector:
+      clickhouse-keeper.altinity.com/chk: test
+      clickhouse-keeper.altinity.com/cluster: cluster
+      clickhouse-keeper.altinity.com/ready: "yes"
 ```

 Check the [official quickstart guide](https://docs.altinity.com/altinitykubernetesoperator/kubernetesquickstartguide/quickcluster/) for more examples of how to deploy ClickHouse Installations.
@@ -503,4 +535,4 @@ Unless required by applicable law or agreed to in writing, software
 distributed under the License is distributed on an "AS IS" BASIS,
 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 See the License for the specific language governing permissions and
-limitations under the License.
+limitations under the License.