Add helmchart generation and release (#29)

Author: GrigoryPervakov

.github/workflows/ci.yaml

@@ -31,7 +31,7 @@ jobs:
       - name: Lint with golangci-lint
         uses: golangci/golangci-lint-action@v7
         with:
-          version: v2.3.1
+          version: v2.4.0
   bundle:
     runs-on: ubuntu-latest
     steps:
@@ -88,6 +88,48 @@ jobs:
           go list ./... | grep -v /e2e
           make test-ci
 
+  helm:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+      - name: Set up Go
+        uses: actions/setup-go@v5
+        with:
+          go-version-file: 'go.mod'
+      - name: Check helmchart generated
+        run: make generate-helmchart && git diff --exit-code
+      - name: Install Helm
+        run: |
+          curl https://raw.githubusercontent.com/helm/helm/main/scripts/get-helm-3 | bash
+      - name: Verify Helm installation
+        run: helm version
+      - name: Lint Helm Chart
+        run: |
+          helm lint ./dist/chart
+      - name: Create k8s Kind Cluster
+        uses: helm/kind-action@v1
+        with:
+          cluster_name: helm-test
+          version: ${{ env.kind-version }}
+          config: ci/kind-cluster.config
+      - name: Install cert-manager via Helm
+        run: |
+          helm repo add jetstack https://charts.jetstack.io
+          helm repo update
+          helm install cert-manager jetstack/cert-manager --namespace cert-manager --create-namespace --set crds.enabled=true
+      - name: Wait for cert-manager to be ready
+        run: |
+          kubectl wait --namespace cert-manager --for=condition=available --timeout=300s deployment/cert-manager
+          kubectl wait --namespace cert-manager --for=condition=available --timeout=300s deployment/cert-manager-cainjector
+          kubectl wait --namespace cert-manager --for=condition=available --timeout=300s deployment/cert-manager-webhook
+      - name: Install Helm chart for project
+        run: |
+          helm install my-release ./dist/chart --create-namespace --namespace clickhouse-operator-system
+      - name: Check Helm release status
+        run: |
+          helm status my-release --namespace clickhouse-operator-system
+
   e2e-test:
     strategy:
       matrix:

.github/workflows/release.yaml

@@ -38,29 +38,38 @@ jobs:
       - name: Build operator bundle image
         run: make bundle bundle-buildx
 
-      - name: 'Kustomize Build'
+      - name: Kustomize Build
         uses: karancode/kustomize-github-action@master
         with:
           token: ${{ github.token }}
           kustomize_version: 5.7.1
           kustomize_build_dir: "config/default"
-          kustomize_output_file: "release/clickhouse-operator.yaml"
+          kustomize_output_file: "dist/clickhouse-operator.yaml"
+      - name: Run chart-releaser
+        uses: helm/chart-releaser-action@v1.7.0
+        env:
+          CR_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
+        with:
+          charts_dir: dist/chart
+          packages_with_index: true
+          mark_as_latest: true
+          pages_branch: helm-releases
       - name: Create GitHub Release
         uses: softprops/action-gh-release@v1
         with:
           draft: true
           tag_name: ${{ github.ref_name }}
-          name: release-${{github.ref_name }}
+          name: ${{github.ref_name }}
           body: |
-            Release ${{github.ref_name }}
+            Pull latest operator images:
             ```
             docker pull ghcr.io/clickhouse/clickhouse-operator/clickhouse-operator:${{ github.ref_name }}
             docker pull ghcr.io/clickhouse/clickhouse-operator/clickhouse-operator-bundle:${{ github.ref_name }}
             ```
             To deploy this release use
             ```
-            kubectl apply -f https://raw.githubusercontent.com/clickhouse/clickhouse-operator/releases/releases/${{github.ref_name }}/clickhouse-operator.yaml
+            kubectl apply -f https://github.com/ClickHouse/clickhouse-operator/releases/download/${{github.ref_name}}/clickhouse-operator.yaml
             ```
           generate_release_notes: true
           append_body: true
-          files: release/clickhouse-operator.yaml
+          files: dist/clickhouse-operator.yaml

Dockerfile

@@ -1,5 +1,5 @@
 # Build the manager binary
-FROM golang:1.24.2 AS builder
+FROM golang:1.25 AS builder
 ARG TARGETOS
 ARG TARGETARCH
 

Makefile

@@ -128,11 +128,11 @@ test-ci: manifests generate fmt vet envtest ## Run tests.
 test-e2e:
 	go test ./test/e2e/ -v -ginkgo.v -test.timeout 30m
 
-.PHONY: test-e2e  # Run the e2e tests against a Kind k8s instance that is spun up.
+.PHONY: test-keeper-e2e  # Run the e2e tests against a Kind k8s instance that is spun up.
 test-keeper-e2e:
 	go test ./test/e2e/ -v -ginkgo.v --ginkgo.label-filter keeper -test.timeout 30m
 
-.PHONY: test-e2e  # Run the e2e tests against a Kind k8s instance that is spun up.
+.PHONY: test-clickhouse-e2e  # Run the e2e tests against a Kind k8s instance that is spun up.
 test-clickhouse-e2e:
 	go test ./test/e2e/ -v -ginkgo.v --ginkgo.label-filter clickhouse -test.timeout 30m
 
@@ -148,6 +148,11 @@ golangci-fmt: golangci-lint ## Run golangci-lint fmt
 lint-fix: golangci-lint ## Run golangci-lint linter and perform fixes
 	$(GOLANGCI_LINT) run --fix
 
+.PHONY: generate-helmchart
+generate-helmchart: kubebuilder ## Generate helm charts
+	$(KUBEBUILDER) edit --plugins=helm/v1-alpha
+	rm .github/workflows/test-chart.yml
+
 ##@ Build
 
 .PHONY: build
@@ -232,12 +237,13 @@ KUSTOMIZE ?= $(LOCALBIN)/kustomize
 CONTROLLER_GEN ?= $(LOCALBIN)/controller-gen
 ENVTEST ?= $(LOCALBIN)/setup-envtest
 GOLANGCI_LINT = $(LOCALBIN)/golangci-lint
+KUBEBUILDER ?= $(LOCALBIN)/kubebuilder
 
 ## Tool Versions
-KUSTOMIZE_VERSION ?= v5.4.3
-CONTROLLER_TOOLS_VERSION ?= v0.16.1
-ENVTEST_VERSION ?= release-0.19
-GOLANGCI_LINT_VERSION ?= v2.3.1
+KUSTOMIZE_VERSION ?= v5.7.1
+CONTROLLER_TOOLS_VERSION ?= v0.19.0
+ENVTEST_VERSION ?= release-0.22
+GOLANGCI_LINT_VERSION ?= v2.4.0
 
 .PHONY: kustomize
 kustomize: $(KUSTOMIZE) ## Download kustomize locally if necessary.
@@ -259,6 +265,12 @@ golangci-lint: $(GOLANGCI_LINT) ## Download golangci-lint locally if necessary.
 $(GOLANGCI_LINT): $(LOCALBIN)
 	$(call go-install-tool,$(GOLANGCI_LINT),github.com/golangci/golangci-lint/v2/cmd/golangci-lint,$(GOLANGCI_LINT_VERSION))
 
+.PHONY: kubebuilder
+kubebuilder: $(KUBEBUILDER) ## Download kubebuilder locally if necessary.
+$(KUBEBUILDER): $(LOCALBIN)
+	curl -L -o $(KUBEBUILDER) "https://go.kubebuilder.io/dl/latest/$(shell go env GOOS)/$(shell rgo env GOARCH)"
+	chmod +x $(KUBEBUILDER)
+
 # go-install-tool will 'go install' any package with custom target and name of binary, if it doesn't exist
 # $1 - target path with name of binary
 # $2 - package url which can be installed

PROJECT

@@ -6,6 +6,7 @@ domain: clickhouse.com
 layout:
 - go.kubebuilder.io/v4
 plugins:
+  helm.kubebuilder.io/v1-alpha: {}
   manifests.sdk.operatorframework.io/v2: {}
   scorecard.sdk.operatorframework.io/v2: {}
 projectName: clickhouse-operator

api/v1alpha1/clickhousecluster_types.go

@@ -172,6 +172,7 @@ type ClickHouseClusterStatus struct {
 // ClickHouseCluster is the Schema for the clickhouseclusters API.
 // +kubebuilder:object:root=true
 // +kubebuilder:subresource:status
+// +kubebuilder:resource:shortName=chc;clickhouse
 // +kubebuilder:printcolumn:name="Ready",type="string",JSONPath=".status.conditions[?(@.type==\"Ready\")].status"
 // +kubebuilder:printcolumn:name="Status",type="string",JSONPath=".status.conditions[?(@.type==\"Ready\")].message"
 // +kubebuilder:printcolumn:name="ReadyReplicas",type="number",JSONPath=".status.readyReplicas"

api/v1alpha1/keepercluster_types.go

@@ -144,11 +144,10 @@ type KeeperClusterStatus struct {
 	ObservedGeneration int64 `json:"observedGeneration,omitempty"`
 }
 
-// +genclient
+// KeeperCluster is the Schema for the keeperclusters API.
 // +kubebuilder:object:root=true
 // +kubebuilder:subresource:status
-
-// KeeperCluster is the Schema for the keeperclusters API.
+// +kubebuilder:resource:shortName=chk;keeper
 // +kubebuilder:printcolumn:name="Ready",type="string",JSONPath=".status.conditions[?(@.type==\"Ready\")].status"
 // +kubebuilder:printcolumn:name="Status",type="string",JSONPath=".status.conditions[?(@.type==\"Ready\")].message"
 // +kubebuilder:printcolumn:name="ReadyReplicas",type="number",JSONPath=".status.readyReplicas"

bundle/manifests/clickhouse-operator-controller-manager-metrics-service_v1_service.yaml

@@ -14,6 +14,7 @@ spec:
     protocol: TCP
     targetPort: 8443
   selector:
+    app.kubernetes.io/name: clickhouse-operator
     control-plane: controller-manager
 status:
   loadBalancer: {}

bundle/manifests/clickhouse-operator-keepercluster-admin-role_rbac.authorization.k8s.io_v1_clusterrole.yaml

@@ -0,0 +1,21 @@
+apiVersion: rbac.authorization.k8s.io/v1
+kind: ClusterRole
+metadata:
+  creationTimestamp: null
+  labels:
+    app.kubernetes.io/managed-by: kustomize
+    app.kubernetes.io/name: clickhouse-operator
+  name: clickhouse-operator-keepercluster-admin-role
+rules:
+- apiGroups:
+  - clickhouse.com
+  resources:
+  - keeperclusters
+  verbs:
+  - '*'
+- apiGroups:
+  - clickhouse.com
+  resources:
+  - keeperclusters/status
+  verbs:
+  - get

bundle/manifests/clickhouse-operator-webhook-service_v1_service.yaml

@@ -12,6 +12,7 @@ spec:
     protocol: TCP
     targetPort: 9443
   selector:
+    app.kubernetes.io/name: clickhouse-operator
     control-plane: controller-manager
 status:
   loadBalancer: {}