Build olm catalog

Author: GrigoryPervakov

.github/workflows/release.yaml

@@ -32,7 +32,8 @@ jobs:
         run: echo "VERSION=${GITHUB_REF_NAME#v}" >> $GITHUB_ENV
       - name: Build operator image
         run: make docker-buildx
-  release-operator-bundle-image:
+
+  release-operator-olm-images:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout code
@@ -43,10 +44,17 @@ jobs:
           registry: ${{ env.REGISTRY }}
           username: ${{ github.actor }}
           password: ${{ secrets.GITHUB_TOKEN }}
+      - name: Install jq
+        uses: dcarbone/install-jq-action@v3.2.0
       - name: Set VERSION
         run: echo "VERSION=${GITHUB_REF_NAME#v}" >> $GITHUB_ENV
       - name: Build operator bundle image
         run: make bundle bundle-buildx
+      - name: Build catalog
+        run: make catalog-buildx
+      - name: Mark catalog as latest
+        run: make catalog-push-latest
+
   release-operator-helm-chart:
     runs-on: ubuntu-latest
     steps:
@@ -64,11 +72,12 @@ jobs:
         run: |
           helm registry login ghcr.io -u ${{ github.actor }} -p ${{ secrets.GITHUB_TOKEN }}
           make push-helmchart
+
   create-release:
     runs-on: ubuntu-latest
     needs:
       - release-operator-image
-      - release-operator-bundle-image
+      - release-operator-olm-images
       - release-operator-helm-chart
     steps:
       - name: Checkout code
@@ -115,23 +124,21 @@ jobs:
         with:
           tag_name: ${{ github.ref_name }}
           name: ${{github.ref_name }}
+          draft: true
           body: |
-            ## Pull the 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 }}
-            ```
             ## Install using the manifest
             ```
             kubectl apply -f https://github.com/ClickHouse/clickhouse-operator/releases/download/${{github.ref_name}}/clickhouse-operator.yaml
             ```
+            
             ## Install using helmchart
             ```
             helm install clickhouse-operator oci://ghcr.io/clickhouse/clickhouse-operator-helm \
                --version=${{env.VERSION}} \
                --create-namespace \
                -n clickhouse-operator-system
             ```
+            
             ## Changelog
             ${{steps.build_changelog.outputs.changelog}}
           generate_release_notes: false

.gitignore

@@ -12,6 +12,11 @@ dist/chart/charts
 clickhouse-operator-helm-*.tgz
 clickhouse-operator_*.tar.gz
 bundle
+*.Dockerfile.cross
+
+# Artidfacts for building OLM catalog
+catalog
+catalog.Dockerfile
 
 # Test binary, built with `go test -c`
 *.test

Makefile

@@ -55,6 +55,7 @@ endif
 # Set the Operator SDK version to use. By default, what is installed on the system is used.
 # This is useful for CI or a project to utilize a specific version of the operator-sdk toolkit.
 OPERATOR_SDK_VERSION ?= v1.42.0
+OPERATOR_MANAGER_VERSION ?= v1.62.0
 # Image URL to use all building/pushing image targets
 IMG ?= ${IMAGE_TAG_BASE}:${FULL_VERSION}
 # ENVTEST_K8S_VERSION refers to the version of kubebuilder assets to be downloaded by envtest binary.
@@ -397,18 +398,14 @@ ifeq (,$(shell which opm 2>/dev/null))
 	set -e ;\
 	mkdir -p $(dir $(OPM)) ;\
 	OS=$(shell go env GOOS) && ARCH=$(shell go env GOARCH) && \
-	curl -sSLo $(OPM) https://github.com/operator-framework/operator-registry/releases/download/v1.23.0/$${OS}-$${ARCH}-opm ;\
+	curl -sSLo $(OPM) https://github.com/operator-framework/operator-registry/releases/download/${OPERATOR_MANAGER_VERSION}/$${OS}-$${ARCH}-opm ;\
 	chmod +x $(OPM) ;\
 	}
 else
 OPM = $(shell which opm)
 endif
 endif
 
-# A comma-separated list of bundle images (e.g. make catalog-build BUNDLE_IMGS=example.com/operator-bundle:v0.1.0,example.com/operator-bundle:v0.2.0).
-# These images MUST exist in a registry and be pull-able.
-BUNDLE_IMGS ?= $(BUNDLE_IMG)
-
 # The image tag given to the resulting catalog image (e.g. make catalog-build CATALOG_IMG=example.com/operator-catalog:v0.2.0).
 CATALOG_IMG ?= $(IMAGE_TAG_BASE)-catalog:$(FULL_VERSION)
 
@@ -417,12 +414,34 @@ ifneq ($(origin CATALOG_BASE_IMG), undefined)
 FROM_INDEX_OPT := --from-index $(CATALOG_BASE_IMG)
 endif
 
-# Build a catalog image by adding bundle images to an empty catalog using the operator package manager tool, 'opm'.
-# This recipe invokes 'opm' in 'semver' bundle add mode. For more information on add modes, see:
-# https://github.com/operator-framework/community-operators/blob/7f1438c/docs/packaging-operator.md#updating-your-existing-operator
+.PHONY: catalog-dockerfile
+catalog-dockerfile: opm ## Generate catalog Dockerfile
+	rm -f catalog.Dockerfile && $(OPM) generate dockerfile catalog
+
+.PHONY: catalog-template
+catalog-template: # Generate catalog template with all bundles from registry
+	./ci/generate-catalog-template.sh $(IMAGE_TAG_BASE)-bundle
+
+catalog-render: opm catalog-template ## Genermrate FBC catalog from template
+	$(OPM) alpha render-template catalog/clickhouse-operator-template.yaml > catalog/catalog.yaml
+	$(OPM) validate catalog
+
 .PHONY: catalog-build
-catalog-build: opm ## Build a catalog image.
-	$(OPM) index add --container-tool docker --mode semver --tag $(CATALOG_IMG) --bundles $(BUNDLE_IMGS) $(FROM_INDEX_OPT)
+catalog-build: catalog-render catalog-dockerfile ## Build a catalog image using FBC
+	$(CONTAINER_TOOL) build -f catalog.Dockerfile -t $(CATALOG_IMG) .
+
+.PHONY: catalog-buildx
+catalog-buildx: catalog-render catalog-dockerfile ## Build and push catalog image for cross-platform support
+	sed -e '1 s/\(^FROM\)/FROM --platform=\$$\{BUILDPLATFORM\}/; t' -e ' 1,// s//FROM --platform=\$$\{BUILDPLATFORM\}/' catalog.Dockerfile > catalog.Dockerfile.cross
+	- $(CONTAINER_TOOL) buildx create --name clickhouse-operator-catalog-builder
+	$(CONTAINER_TOOL) buildx use clickhouse-operator-catalog-builder
+	- $(CONTAINER_TOOL) buildx build --push --platform=$(PLATFORMS) --tag $(CATALOG_IMG) -f catalog.Dockerfile.cross .
+	- $(CONTAINER_TOOL) buildx rm clickhouse-operator-catalog-builder
+	rm -f catalog.Dockerfile.cross
+
+.PHONY: catalog-push-latest
+catalog-push-latest:
+	$(CONTAINER_TOOL) buildx imagetools create -t $(IMAGE_TAG_BASE)-catalog:latest $(CATALOG_IMG)
 
 # Push the catalog image.
 .PHONY: catalog-push

ci/generate-catalog-template.sh

@@ -0,0 +1,60 @@
+#!/usr/bin/env bash
+set -euo pipefail
+
+# Generate OLM catalog template with all available bundles from registry
+# Usage: ./ci/generate-catalog-template.sh [<bundle-image>]
+
+# Image repository
+BUNDLE_IMAGE=${1-ghcr.io/clickhouse/clickhouse-operator-bundle}
+# Output file
+OUTPUT_FILE="catalog/clickhouse-operator-template.yaml"
+
+# Function to get all tags from ghcr.io
+get_bundle_tags() {
+    local owner="clickhouse"
+    local gh_api_url="https://api.github.com/orgs/clickhouse/packages/container/clickhouse-operator-bundle/versions"
+
+    echo "Fetching bundle tags from ${BUNDLE_IMAGE}" >&2
+    curl -sL \
+        -H "Accept: application/vnd.github+json" \
+        -H "X-GitHub-Api-Version: 2022-11-28" \
+        -H "Authorization: Bearer ${GITHUB_TOKEN}" \
+        "${gh_api_url}" 2>/dev/null \
+        | jq -r '.[].metadata.container.tags[]' 2>/dev/null \
+        | grep -E '^v[0-9]+\.[0-9]+\.[0-9]+$' \
+        | sort -V
+}
+
+# Get all bundle tags
+BUNDLE_TAGS=$(get_bundle_tags)
+
+if [ -z "$BUNDLE_TAGS" ]; then
+    echo "Error: No bundle tags found in registry"
+    exit 1
+fi
+
+echo "Found bundle tags:"
+echo "$BUNDLE_TAGS"
+
+# Create catalog directory if it doesn't exist
+mkdir -p catalog
+
+# Generate the template YAML
+cat > "$OUTPUT_FILE" <<EOF
+Schema: olm.semver
+GenerateMajorChannels: true
+GenerateMinorChannels: false
+Stable:
+  Bundles:
+EOF
+
+for tag in $BUNDLE_TAGS; do
+    if [ -n "$tag" ]; then
+        echo "  - Image: ${BUNDLE_IMAGE}:${tag}" >> "$OUTPUT_FILE"
+    fi
+done
+
+echo ""
+echo "Generated catalog template at: $OUTPUT_FILE"
+echo "Contents:"
+cat "$OUTPUT_FILE"