[backport][rancher 2.9] ci/build: Fix Rancher Project Monitoring Compatibility Issues (#280) (#284)

* ci/build: Fix Rancher Project Monitoring Compatibility Issues (#280)

* Fix for local e2e testing

* Add kuberlr target version to build constants

* Add kuberlr version to Version script

* Add util scripts to help set proper Kuberlr image versions

* Add missing deps

(cherry picked from commit e1c084c)

* Update build.yaml to Rancher 2.9 kuberlr version

* temp disable Kuberlr patch on 2.9 branch - enable after backporting Monitoring

Author: mallardduck

.github/workflows/e2e/scripts/entry

@@ -2,7 +2,11 @@
 set -e
 set -x
 
-cd $(dirname $0)/../../../..
+E2E_SCRIPTS_ROOT=$(realpath $(dirname $0))
+GIT_ROOT=$(realpath "$E2E_SCRIPTS_ROOT/../../../..")
+
+cd $GIT_ROOT
+source "$GIT_ROOT/scripts/version"
 
 DEFAULT_SLEEP_TIMEOUT_SECONDS=${DEFAULT_SLEEP_TIMEOUT_SECONDS:-10}
 KUBECTL_WAIT_TIMEOUT=${KUBECTL_WAIT_TIMEOUT:-120s}

.github/workflows/e2e/scripts/install-monitoring.sh

@@ -4,13 +4,19 @@ set -x
 
 source $(dirname $0)/entry
 
-HELM_REPO="rancher-charts"
+# Use a non-default name for making local E2E testing not clobber things
+HELM_REPO="e2e-rancher-charts"
 HELM_REPO_URL="https://charts.rancher.io"
 
 cd $(dirname $0)/../../../..
 
 helm version
 
+# Fix for local e2e testing, remove repo before adding it to fix testing across branches
+set +x
+helm repo remove ${HELM_REPO} > /dev/null 2>&1 || true
+set -x
+
 helm repo add ${HELM_REPO} $HELM_REPO_URL
 helm repo update
 

build.yaml

@@ -2,6 +2,7 @@ rancherProjectMonitoringVersion: 0.3.4
 rancherMonitoringVersion : 104.1.4+up57.0.3
 k3sTestingMaxVersion: v1.30.11-k3s1
 k3sTestingMinVersion: v1.27.16-k3s1
+kuberlrVersion: v1
 
 # Dev use only
 # devChartsSource: https://github.com/{Dev}/ob-team-charts

package/Dockerfile-prometheus-federator

@@ -5,13 +5,17 @@ FROM registry.suse.com/bci/golang:1.23 AS builder
 
 # Allow chart version config
 ARG TARGETPLATFORM
+ARG TARGETARCH
 ARG RANCHER_PROJECT_MONITORING=''
 ARG TAG=''
 ARG REPO=''
+ARG YQ_VERSION='v4.25.1'
 ENV RANCHER_PROJECT_MONITORING=$RANCHER_PROJECT_MONITORING TAG=$TAG REPO=$REPO
 
 WORKDIR /usr/src/app
-RUN zypper -n install git vim less file curl wget patch helm
+RUN zypper -n install git vim less file curl wget patch helm jq
+RUN wget https://github.com/mikefarah/yq/releases/download/${YQ_VERSION}/yq_linux_${TARGETARCH} -O /usr/bin/yq \
+    && chmod +x /usr/bin/yq
 COPY go.mod go.sum ./
 RUN go mod download
 COPY . .

pkg/buildconfig/constants.go

@@ -6,6 +6,8 @@ set -e
 
 source $(dirname $0)/version
 source $(dirname $0)/util-chart
+source $(dirname $0)/util-rpm-chart
+source $(dirname $0)/util-kuberlr
 source $(dirname $0)/util-team-charts
 
 # We don't do this for helm-locker
@@ -30,6 +32,14 @@ if [ "$BUILD_TARGET" == "prometheus-federator" ]; then
   fetch-team-chart "rancher-project-monitoring" "$RANCHER_PROJECT_MONITORING"
   CHART_DESTINATION="./build/charts/${CHART}-${CHART_VERSION}.tgz"
 
+  echo "RPM Chart fetched, now preparing for PromFed..."
+  KUBERLR_STABLE=$(find_latest_kuberlr_release $KUBERLR_TARGET)
+  echo "Kuberlr Stable Target: $KUBERLR_STABLE"
+  echo "Will modify Project Monitoring to use desired kuberlr version."
+  expression=".global.kubectl.tag = \"${KUBERLR_STABLE}\""
+  # TODO: Enable this when 2.9 gets the backported Monitoring version that uses Kuberlr
+  #modify_helm_chart_values $CHART_DESTINATION "$expression"
+
   # Prepare chart for embedding location
   base64 -i $CHART_DESTINATION > "cmd/prometheus-federator/fs/${CHART}.tgz.base64"
 elif [ "$BUILD_TARGET" == "helm-project-operator" ]; then

scripts/build-chart

@@ -0,0 +1,63 @@
+#!/bin/bash
+
+GIT_ROOT=$(realpath $(dirname $0)/..)
+
+# Set DEBUG=true to enable Bash trace mode
+DEBUG="${DEBUG:-false}"
+if [[ "$DEBUG" == "true" ]]; then
+  set -x
+fi
+
+GITHUB_REPO="rancher/kuberlr-kubectl"
+GITHUB_API="https://api.github.com/repos/$GITHUB_REPO/releases"
+
+# Fetch tag names, optionally including prereleases
+function fetch_kuberlr_releases() {
+  local include_prerelease="$1"
+
+  if [[ "$include_prerelease" == "true" ]]; then
+    curl -s "$GITHUB_API" | jq -r '.[].tag_name'
+  else
+    curl -s "$GITHUB_API" | jq -r '.[] | select(.prerelease == false) | .tag_name'
+  fi
+}
+
+# Finds the latest release matching prefix, with optional prereleases
+# Usage: find_latest_release <version-prefix> [include_prerelease]
+function find_latest_kuberlr_release() {
+  local prefix="$1"
+  local include_prerelease="${2:-false}"
+
+  if [[ -z "$prefix" ]]; then
+    echo "Usage: find_latest_release <version-prefix> [include_prerelease]" >&2
+    return 1
+  fi
+
+  fetch_kuberlr_releases "$include_prerelease" | \
+    grep -E "^$prefix(\.|$)" | \
+    sed 's/^v//' | \
+    sort -Vr | \
+    head -n1 | \
+    sed 's/^/v/'
+}
+
+# CLI interface - mainly for testing
+if [[ "${BASH_SOURCE[0]}" == "${0}" ]]; then
+  prefix="$1"
+  include_prerelease="${2:-false}"
+
+  if [[ -z "$prefix" ]]; then
+    echo "Usage: $0 <version-prefix> [include_prerelease]" >&2
+    echo "  Example: $0 v5          # Latest stable v5 release" >&2
+    echo "  Example: $0 v3.4 true   # Latest v3.4 including prereleases" >&2
+    exit 1
+  fi
+
+  latest=$(find_latest_kuberlr_release "$prefix" "$include_prerelease")
+  if [[ -n "$latest" ]]; then
+    echo "$latest"
+  else
+    echo "No matching releases found for prefix '$prefix'" >&2
+    exit 2
+  fi
+fi

scripts/util-kuberlr

@@ -0,0 +1,54 @@
+#!/usr/bin/env bash
+
+source $(dirname "$0")/util-chart
+
+CHART_NAME="rancher-project-monitoring"
+CHART_VALUES_PATH="$CHART_NAME/values.yaml"
+
+# unpacks the chart to provided temp dir
+function unpack_chart() {
+  local chart_file="$1"
+  local temp_dir="$2"
+
+  mkdir -p "$temp_dir"
+  tar -xzf "$chart_file" -C "$temp_dir"
+}
+
+# modify the chart's values file via yq expression
+function modify_values_yaml() {
+  local chart_dir="$1"
+  local yq_expression="$2"
+
+  local values_file="$chart_dir/$CHART_VALUES_PATH"
+
+  if [[ ! -f "$values_file" ]]; then
+    echo "Error: $CHART_VALUES_PATH not found." >&2
+    return 1
+  fi
+
+  yq -i "$yq_expression" "$values_file"
+}
+
+# warps the modification process into a single function
+function modify_helm_chart_values() {
+  local chart_file="$1"
+  local yq_expression="$2"
+
+  if [[ ! -f "$chart_file" || -z "$yq_expression" ]]; then
+    echo "Usage: modify_helm_chart_values <chart.tgz> <yq_expression>" >&2
+    return 1
+  fi
+
+  local temp_dir
+  temp_dir=$(mktemp -d)
+
+  unpack_chart "$chart_file" "$temp_dir"
+  modify_values_yaml "$temp_dir" "$yq_expression"
+
+  # Extracted chart dir (e.g., /tmp/tmp.XYZ/rancher-project-monitoring)
+  local chart_dir="$temp_dir/$CHART_NAME"
+
+  package-chart "$chart_dir" "$(dirname "$chart_file")"
+
+  rm -rf "$temp_dir"
+}

scripts/util-rpm-chart

@@ -1,6 +1,4 @@
 #!/usr/bin/env bash
-set -x
-
 
 CHARTS_REPO="https://raw.githubusercontent.com/rancher/ob-team-charts"
 CHARTS_BRANCH="main"

scripts/util-team-charts

@@ -46,6 +46,7 @@ ROOT_DIR=$(dirname "$(realpath "$(dirname "${BASH_SOURCE[0]}")")")
 BUILD_YAML_PATH="$ROOT_DIR/build.yaml"
 RANCHER_PROJECT_MONITORING=${RANCHER_PROJECT_MONITORING:-$(grep 'rancherProjectMonitoringVersion' "$BUILD_YAML_PATH"|cut -d: -f2|tr -d ' ')}
 RANCHER_MONITORING=${RANCHER_MONITORING:-$(grep 'rancherMonitoringVersion' "$BUILD_YAML_PATH"|cut -d: -f2|tr -d ' ')}
+KUBERLR_TARGET=${KUBERLR_TARGET:-$(grep 'kuberlrVersion' "$BUILD_YAML_PATH"|cut -d: -f2|tr -d ' ')}
 
 function print_version_debug() {
     echo "DIRTY: $DIRTY"
@@ -58,5 +59,6 @@ function print_version_debug() {
     echo "BUILD_YAML_PATH: $BUILD_YAML_PATH"
     echo "RANCHER PROJECT MONITORING: $RANCHER_PROJECT_MONITORING"
     echo "RANCHER MONITORING: $RANCHER_MONITORING"
+    echo "KUBERLR TARGET: $KUBERLR_TARGET"
 }
 if [[ "${BASH_SOURCE[0]}" == "${0}" ]]; then print_version_debug "$1"; fi