Update templated files to rev 6fbe9fa (#369)

Automatically created PR based on commit 6fbe9fa9324e71c0e173b376a05157c9c934aea9 in stackabletech/operator-templating repo.

Triggered by:
Manual run triggered by: adwk67 with message [23.1 release prep: rust-version set to 1.65]

Author: stackable-bot

.github/workflows/build.yml

@@ -9,7 +9,7 @@ on:
       - trying
       - "renovate/**"
     tags:
-      - "*"
+      - '[0-9][0-9].[0-9]+.[0-9]+'
   pull_request:
 
 env:
@@ -19,11 +19,11 @@ env:
   RUSTFLAGS: "-D warnings"
   RUSTDOCFLAGS: "-D warnings"
   RUST_LOG: "info"
-  OPERATOR_NAME: "trino-operator"
-  PRODUCT_NAME: "trino"
   DEV_REPO_HELM_URL: https://repo.stackable.tech/repository/helm-dev
   TEST_REPO_HELM_URL: https://repo.stackable.tech/repository/helm-test
   STABLE_REPO_HELM_URL: https://repo.stackable.tech/repository/helm-stable
+  # TODO remove before final go-live!
+  EXP_REPO_HELM_URL: https://repo.stackable.tech/repository/helm-experimental
 
 jobs:
   # Identify unused dependencies
@@ -56,68 +56,49 @@ jobs:
         with:
           command: udeps
 
-  prerelease_job:
-    name: Returns the pre-release string from the version of the cargo workspace.
-    runs-on: ubuntu-latest
-    outputs:
-      str: ${{ steps.prerelease.outputs.str }}
-    steps:
-      - uses: actions/checkout@2541b1294d2704b0964813337f33b291d3f8596b # tag=v3.0.2
-        with:
-          submodules: recursive
-      - uses: actions/setup-python@b55428b1882923874294fa556849718a1d7f2ca5 # tag=v4
-      - name: Install requirements for version tool
-        run: pip install -r python/requirements.txt
-      - id: prerelease
-        name: Extract the pre-release string. Might be empty.
-        run: |
-          PRERELEASE=$(python/cargo_version.py -o | sed  "s/^[0-9]\+\.[0-9]\+\.[0-9]\+-\?//g")
-          echo "::set-output name=str::$PRERELEASE"
-
   # This job evaluates the github environment to determine why this action is running and selects the appropriate
   # target repository for published Helm charts based on this.
   #
   # The following scenarios are identified:
-  #    - pull request:
+  #    - all pull requests land in the test repository:
   #        condition: github.event_name == "pull_request"
   #        repository: test
   #
-  #    - release (aka a tag was created):
+  #    - all tagged releases land in stable:
   #         condition: github.event_name == 'create' & github.ref.startswith('refs/tags/')
   #         repository: stable
   #
-  #    - merge of pr to main branch and pre release is nightly:
-  #         condition: github.event_name == 'push' & github.ref == 'refs/heads/main' & needs.prerelease_job.outputs.str == 'nightly'
+  #    - all pushes to main (i.e. PR-merges) land in dev:
+  #         condition: github.event_name == 'push' & github.ref == 'refs/heads/main'
   #         repository: dev
   #
-  # Any other scenarios will cause the publish step to be skipped, most commonly this is expected to happen for the
+  # Any other scenarios (e.g. when a branch is created/pushed) will cause the publish step to be skipped, most commonly this is expected to happen for the
   # branches that bors uses internally (staging, trying) for which the checks need to run, but we do not want artifacts
   # to be published.
-  select_repo:
-    name: Select target repository based on action trigger
+  select_helm_repo:
+    name: Select target helm repository based on action trigger
     runs-on: ubuntu-latest
     outputs:
-      repository: ${{ steps.selectrepo.outputs.repo }}
-    needs: prerelease_job
+      helm_repository: ${{ steps.selecthelmrepo.outputs.helm_repo }}
     steps:
-      - id: selectrepo
+      - id: selecthelmrepo
         env:
           TRIGGER: ${{ github.event_name }}
           GITHUB_REF: ${{ github.ref }}
-          PRERELEASE: ${{ needs.prerelease_job.outputs.str }}
         run: |
           if [[ $TRIGGER == "pull_request" ]]; then
-            echo "exporting test as target repo: ${{ env.TEST_REPO_HELM_URL }}"
-            echo "::set-output name=repo::${{ env.TEST_REPO_HELM_URL }}"
-          elif [[ $TRIGGER == "push" && $GITHUB_REF == "refs/heads/main" && $PRERELEASE == 'nightly' ]]; then
-            echo "exporting dev as target repo: ${{ env.DEV_REPO_HELM_URL }}"
-            echo "::set-output name=repo::${{ env.DEV_REPO_HELM_URL }}"
+            echo "exporting test as target helm repo: ${{ env.TEST_REPO_HELM_URL }}"
+            echo "::set-output name=helm_repo::${{ env.TEST_REPO_HELM_URL }}"
+          elif [[ $TRIGGER == "push" && $GITHUB_REF == "refs/heads/main" ]]; then
+            echo "exporting dev as target helm repo: ${{ env.DEV_REPO_HELM_URL }}"
+            echo "::set-output name=helm_repo::${{ env.DEV_REPO_HELM_URL }}"
           elif [[ ( $TRIGGER == "create" || $TRIGGER == "push" ) && $GITHUB_REF == refs/tags/* ]]; then
-            echo "exporting stable as target repo: ${{ env.STABLE_REPO_HELM_URL }}"
-            echo "::set-output name=repo::${{ env.STABLE_REPO_HELM_URL }}"
+            # TODO replace EXP with STABLE repo name
+            echo "exporting stable as target helm repo: ${{ env.EXP_REPO_HELM_URL }}"
+            echo "::set-output name=helm_repo::${{ env.EXP_REPO_HELM_URL }}"
           else
             echo "Unknown trigger and ref combination encountered, skipping publish step: $TRIGGER $GITHUB_REF"
-            echo "::set-output name=repo::skip"
+            echo "::set-output name=helm_repo::skip"
           fi
 
   run_cargodeny:
@@ -219,11 +200,6 @@ jobs:
 
   run_tests:
     name: Run Cargo Tests
-    needs:
-      - run_cargodeny
-      - run_clippy
-      - run_rustfmt
-      - run_rustdoc
     runs-on: ubuntu-latest
     steps:
       - name: Install protoc
@@ -272,23 +248,18 @@ jobs:
           script: |
             core.setFailed('Committed README are not up to date, please make sure to apply them to the templated partials, and re-commit!')
 
-  # This job cleans up the CRDs, Helm charts and Kustomize manifests, followed by rebuilding them
+  # This job cleans up the CRDs and Helm charts, followed by rebuilding them
   # It then runs a `git diff` and fails the entire workflow, if any difference is encountered.
   #
   # Since CRD files are generated during the 'cargo build' process we need to run this once after
   # removing the CRD files to ensure that the checked in versions match what the code expects.
   #
   # The reason for this step is, that developers are expected to check in up-to-date versions of charts
-  # and manifests, as we'd otherwise have to build these in CI and commit them back to the PR, which
+  # as we'd otherwise have to build these in CI and commit them back to the PR, which
   # creates all kinds of problems.
-  # Therefor this failsafe simply aborts anything that has not had charts and manifests rebuilt before pushing.
+  # This failsafe simply aborts anything that has not had charts rebuilt before pushing.
   check_charts:
-    name: Check if committed Helm & Kustomize Charts were up to date
-    needs:
-      - run_cargodeny
-      - run_clippy
-      - run_rustfmt
-      - run_rustdoc
+    name: Check if committed Helm charts are up to date
     runs-on: ubuntu-latest
     steps:
       - name: Install protoc
@@ -324,25 +295,17 @@ jobs:
           script: |
             core.setFailed('Committed charts were not up to date, please regenerate and re-commit!')
 
-  test_charts:
-    name: Run Chart Tests
-    needs:
-      - check_charts
-      - run_tests
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout
-        uses: actions/checkout@2541b1294d2704b0964813337f33b291d3f8596b # tag=v3.0.2
-        with:
-          submodules: recursive
-      - name: placeholder
-        run: echo Tests will go here
-
   tests_passed:
     name: All tests passed
     needs:
-      - test_charts
       - run_udeps
+      - run_cargodeny
+      - run_clippy
+      - run_rustfmt
+      - run_rustdoc
+      - run_tests
+      - check_charts
+      - check_readme
     runs-on: ubuntu-latest
     steps:
       - name: log
@@ -352,12 +315,12 @@ jobs:
     name: Package Charts, Build Docker Image and publish them
     needs:
       - tests_passed
-      - select_repo
+      - select_helm_repo
     runs-on: ubuntu-latest
     env:
       NEXUS_PASSWORD: ${{ secrets.NEXUS_PASSWORD }}
-      REPO: ${{ needs.select_repo.outputs.repository }}
-    if: needs.select_repo.outputs.repository != 'skip'
+      HELM_REPO: ${{ needs.select_helm_repo.outputs.helm_repository }}
+    if: needs.select_helm_repo.outputs.helm_repository != 'skip'
     steps:
       - name: Install protoc
         run: |
@@ -386,22 +349,8 @@ jobs:
         if: ${{ github.event_name == 'pull_request' }}
         run: python/cargo_version.py -m pr${{ github.event.pull_request.number }}
 
-      # Recreate charts with changed version if needed
-      - name: Clean charts
-        if: ${{ github.event_name == 'pull_request' }}
-        run: make chart-clean clean-manifests compile-chart generate-manifests
-
-      # Package and publish charts
-      - name: Package Chart
-        run: mkdir -p target/helm && helm package --destination target/helm deploy/helm/${{ env.OPERATOR_NAME }}
-      - name: Build Docker image
-        if: env.NEXUS_PASSWORD != null # pragma: allowlist secret
-        run: make docker
-      - name: Publish Chart
-        if: env.NEXUS_PASSWORD != null # pragma: allowlist secret
-        run: >-
-          /usr/bin/curl
-          --fail
-          -u 'github:${{ secrets.NEXUS_PASSWORD }}'
-          --upload-file "./$(find  target/helm/ -name '*.tgz')"
-          "${{ env.REPO }}/"
+      # Recreate charts and publish charts and docker image. The "-e" is needed as we want to override the
+      # default value in the makefile if called from this action, but not otherwise (i.e. when called locally).
+      # This is needed for the HELM_REPO variable.
+      - name: Publish Docker image and Helm chart
+        run: make -e publish

.readme/partials/borrowed/links.md.j2

@@ -1,5 +1,5 @@
 
-{% if no_jenkins_job_badge %}{% else %}[![Build Actions Status](https://ci.stackable.tech/job/{{operator_name}}%2doperator%2dit%2dnightly/badge/icon?subject=Integration%20Tests)](https://ci.stackable.tech/job/{{operator_name}}%2doperator%2dit%2dnightly){% endif %}
+{% if no_jenkins_job_badge %}{% else %}![Build Actions Status](https://ci.stackable.tech/buildStatus/icon?job={{operator_name}}%2doperator%2dit%2dnightly&subject=Integration%20Tests){% endif %}
 [![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-green.svg)](https://GitHub.com/stackabletech/{{operator_name}}-operator/graphs/commit-activity)
 [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-green.svg)](https://docs.stackable.tech/home/stable/contributor/index.html)
 [![License OSL3.0](https://img.shields.io/badge/license-OSL3.0-green)](./LICENSE)

Makefile

@@ -7,16 +7,18 @@
 # It is available from Nixpkgs as `yq-go` (`nix shell nixpkgs#yq-go`)
 # This script also requires `jq` https://stedolan.github.io/jq/
 
-.PHONY: docker chart-lint compile-chart
+.PHONY: build publish
 
 TAG    := $(shell git rev-parse --short HEAD)
+OPERATOR_NAME := trino-operator
+VERSION := $(shell cargo metadata --format-version 1 | jq -r '.packages[] | select(.name=="stackable-${OPERATOR_NAME}") | .version')
 
-VERSION := $(shell cargo metadata --format-version 1 | jq -r '.packages[] | select(.name=="stackable-trino-operator") | .version')
-IS_NIGHTLY := $(shell echo "${VERSION}" | grep -- '-nightly$$')
-# When rendering docs we want to simplify the version number slightly, only rendering "nightly" for nightly branches
-# (since we only render nightlies for the active development trunk anyway) and chopping off the semver patch version otherwise
-DOCS_VERSION := $(if ${IS_NIGHTLY},nightly,$(shell echo "${VERSION}" | sed 's/^\([0-9]\+\.[0-9]\+\)\..*$$/\1/'))
-export VERSION IS_NIGHTLY DOCS_VERSION
+DOCKER_REPO := docker.stackable.tech
+# TODO replace this with "stackable" before final-final go-live!
+ORGANIZATION := sandbox/test
+# this will be overwritten by an environmental variable if called from the github action
+HELM_REPO := https://repo.stackable.tech/repository/helm-dev
+HELM_CHART_ARTIFACT := target/helm/${OPERATOR_NAME}-${VERSION}.tgz
 
 SHELL=/usr/bin/env bash -euo pipefail
 
@@ -25,50 +27,50 @@ render-readme:
 
 ## Docker related targets
 docker-build:
-	docker build --force-rm --build-arg VERSION=${VERSION} -t "docker.stackable.tech/stackable/trino-operator:${VERSION}" -f docker/Dockerfile .
-
-docker-build-latest: docker-build
-	docker tag "docker.stackable.tech/stackable/trino-operator:${VERSION}" \
-	           "docker.stackable.tech/stackable/trino-operator:latest"
+	docker build --force-rm --build-arg VERSION=${VERSION} -t "${DOCKER_REPO}/${ORGANIZATION}/${OPERATOR_NAME}:${VERSION}" -f docker/Dockerfile .
 
 docker-publish:
-	echo "${NEXUS_PASSWORD}" | docker login --username github --password-stdin docker.stackable.tech
-	docker push --all-tags docker.stackable.tech/stackable/trino-operator
+	echo "${NEXUS_PASSWORD}" | docker login --username github --password-stdin "${DOCKER_REPO}"
+	docker push --all-tags "${DOCKER_REPO}/${ORGANIZATION}/${OPERATOR_NAME}"
 
+# TODO remove if not used/needed
 docker: docker-build docker-publish
 
-docker-release: docker-build-latest docker-publish
+helm-publish:
+	curl --fail -u "github:${NEXUS_PASSWORD}" --upload-file "${HELM_CHART_ARTIFACT}" "${HELM_REPO}/"
+
+helm-package:
+	mkdir -p target/helm && helm package --destination target/helm deploy/helm/${OPERATOR_NAME}
 
 ## Chart related targets
 compile-chart: version crds config
 
 chart-clean:
-	rm -rf deploy/helm/trino-operator/configs
-	rm -rf deploy/helm/trino-operator/crds
+	rm -rf "deploy/helm/${OPERATOR_NAME}/configs"
+	rm -rf "deploy/helm/${OPERATOR_NAME}/crds"
 
 version:
-	yq eval -i '.version = strenv(VERSION) | .appVersion = strenv(VERSION)' /dev/stdin < deploy/helm/trino-operator/Chart.yaml
-	yq eval -i '.version = strenv(DOCS_VERSION) | .prerelease = strenv(IS_NIGHTLY) != ""' /dev/stdin < docs/antora.yml
+	yq eval -i ".version = \"${VERSION}\" | .appVersion = \"${VERSION}\"" /dev/stdin < "deploy/helm/${OPERATOR_NAME}/Chart.yaml"
 
 config:
 	if [ -d "deploy/config-spec/" ]; then\
-		mkdir -p deploy/helm/trino-operator/configs;\
-		cp -r deploy/config-spec/* deploy/helm/trino-operator/configs;\
+		mkdir -p "deploy/helm/${OPERATOR_NAME}/configs";\
+		cp -r deploy/config-spec/* "deploy/helm/${OPERATOR_NAME}/configs";\
 	fi
 
 crds:
-	mkdir -p deploy/helm/trino-operator/crds
-	cargo run --bin stackable-trino-operator -- crd | yq eval '.metadata.annotations["helm.sh/resource-policy"]="keep"' - > deploy/helm/trino-operator/crds/crds.yaml
+	mkdir -p deploy/helm/"${OPERATOR_NAME}"/crds
+	cargo run --bin stackable-"${OPERATOR_NAME}" -- crd | yq eval '.metadata.annotations["helm.sh/resource-policy"]="keep"' - > "deploy/helm/${OPERATOR_NAME}/crds/crds.yaml"
 
 chart-lint: compile-chart
 	docker run -it -v $(shell pwd):/build/helm-charts -w /build/helm-charts quay.io/helmpack/chart-testing:v3.5.0  ct lint --config deploy/helm/ct.yaml
 
-## Manifest related targets
-clean-manifests:
-	mkdir -p deploy/manifests
-	rm -rf $$(find deploy/manifests -maxdepth 1 -mindepth 1 -not -name Kustomization)
+clean: chart-clean
+	cargo clean
+	docker rmi --force "${DOCKER_REPO}/${ORGANIZATION}/${OPERATOR_NAME}:${VERSION}"
+
+regenerate-charts: chart-clean compile-chart
 
-generate-manifests: clean-manifests compile-chart
-	./scripts/generate-manifests.sh
+build: regenerate-charts helm-package docker-build
 
-regenerate-charts: chart-clean clean-manifests compile-chart generate-manifests
+publish: build docker-publish helm-publish

README.md

@@ -4,7 +4,7 @@
 
 <h1 align="center">Stackable Operator for Trino</h1>
 
-[![Build Actions Status](https://ci.stackable.tech/job/trino%2doperator%2dit%2dnightly/badge/icon?subject=Integration%20Tests)](https://ci.stackable.tech/job/trino%2doperator%2dit%2dnightly)
+![Build Actions Status](https://ci.stackable.tech/buildStatus/icon?job=trino%2doperator%2dit%2dnightly&subject=Integration%20Tests)
 [![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-green.svg)](https://GitHub.com/stackabletech/trino-operator/graphs/commit-activity)
 [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-green.svg)](https://docs.stackable.tech/home/stable/contributor/index.html)
 [![License OSL3.0](https://img.shields.io/badge/license-OSL3.0-green)](./LICENSE)