Use kubebuilder and start refactoring out into lib and api packages

Author: PhilippMatthes

.dockerignore

@@ -21,3 +21,5 @@
 /report.html
 /shell.nix
 /testing/
+
+bin/

.github/workflows/push-charts.yaml

@@ -62,3 +62,21 @@ jobs:
             CHART_PACKAGE=$(ls $CHART_DIR/*.tgz)
             helm push $CHART_PACKAGE oci://${{ env.REGISTRY }}/${{ github.repository }}/charts/
           done
+      - name: Get all changed reservations Chart.yaml files
+        id: changed-chart-yaml-files-reservations
+        uses: tj-actions/changed-files@v46
+        with:
+          files: |
+            reservations/dist/chart/Chart.yaml
+      - name: Push reservations charts to registry
+        if: steps.changed-chart-yaml-files-reservations.outputs.all_changed_files != ''
+        shell: bash
+        env:
+          ALL_CHANGED_FILES: ${{ steps.changed-chart-yaml-files-reservations.outputs.all_changed_files }}
+        run: |
+          for CHART_FILE in ${ALL_CHANGED_FILES}; do
+            CHART_DIR=$(dirname $CHART_FILE)
+            helm package $CHART_DIR --dependency-update --destination $CHART_DIR
+            CHART_PACKAGE=$(ls $CHART_DIR/*.tgz)
+            helm push $CHART_PACKAGE oci://${{ env.REGISTRY }}/${{ github.repository }}/charts/
+          done

.github/workflows/push-images.yaml

@@ -98,3 +98,44 @@ jobs:
           subject-name: ${{ env.REGISTRY }}/${{ github.repository }}
           subject-digest: ${{ steps.push_cortex.outputs.digest }}
           push-to-registry: true
+      # Only build and push the reservations operator image if there are changes
+      # in the reservations directory.
+      - name: Get all changed reservations/ files
+        id: changed_reservations_files
+        uses: tj-actions/changed-files@v46
+        with:
+          files: |
+            reservations/**
+      - name: Docker Meta (Cortex Reservations)
+        if: steps.changed_reservations_files.outputs.all_changed_files != ''
+        id: meta_cortex_reservations
+        uses: docker/metadata-action@v5
+        with:
+          images: ${{ env.REGISTRY }}/${{ github.repository }}-reservations-operator
+          tags: |
+            type=semver,pattern={{version}}
+            type=semver,pattern={{major}}.{{minor}}
+            type=sha
+            latest
+      - name: Build and Push Cortex Reservations Operator
+        if: steps.changed_reservations_files.outputs.all_changed_files != ''
+        id: push_cortex_reservations
+        uses: docker/build-push-action@v6
+        with:
+          context: .
+          file: Dockerfile.kubebuilder
+          platforms: linux/amd64,linux/arm64
+          push: true
+          tags: ${{ steps.meta_cortex_reservations.outputs.tags }}
+          labels: ${{ steps.meta_cortex_reservations.outputs.labels }}
+          build-args: |
+            GO_MOD_PATH=reservations
+            GIT_TAG=${{ github.ref_name }}
+            GIT_COMMIT=${{ github.sha }}
+      - name: Generate Artifact Attestation for Cortex Reservations
+        if: steps.changed_reservations_files.outputs.all_changed_files != ''
+        uses: actions/attest-build-provenance@v2
+        with:
+          subject-name: ${{ env.REGISTRY }}/${{ github.repository }}-reservations-operator
+          subject-digest: ${{ steps.push_cortex_reservations.outputs.digest }}
+          push-to-registry: true

.github/workflows/reservations-test-e2e.yml

@@ -0,0 +1,44 @@
+name: Reservations E2E Tests
+
+on:
+  push:
+  pull_request:
+
+jobs:
+  test-e2e:
+    name: Run on Ubuntu
+    runs-on: ubuntu-latest
+    steps:
+      - name: Clone the code
+        uses: actions/checkout@v5
+        path: reservations
+
+      - name: Get all changed files
+        id: changed-files
+        uses: tj-actions/changed-files@v46
+        with:
+          files: |
+            **/*
+
+      - name: Setup Go
+        if: steps.changed-files.outputs.files != ''
+        uses: actions/setup-go@v5
+        with:
+          go-version-file: go.mod
+
+      - name: Install the latest version of kind
+        if: steps.changed-files.outputs.files != ''
+        run: |
+          curl -Lo ./kind https://kind.sigs.k8s.io/dl/latest/kind-linux-amd64
+          chmod +x ./kind
+          sudo mv ./kind /usr/local/bin/kind
+
+      - name: Verify kind installation
+        if: steps.changed-files.outputs.files != ''
+        run: kind version
+
+      - name: Running Test e2e
+        if: steps.changed-files.outputs.files != ''
+        run: |
+          go mod tidy
+          make test-e2e

.github/workflows/reservations-test.yml

@@ -0,0 +1,33 @@
+name: Reservations Tests
+
+on:
+  push:
+  pull_request:
+
+jobs:
+  test:
+    name: Run on Ubuntu
+    runs-on: ubuntu-latest
+    steps:
+      - name: Clone the code
+        uses: actions/checkout@v5
+        path: reservations
+
+      - name: Get all changed files
+        id: changed-files
+        uses: tj-actions/changed-files@v46
+        with:
+          files: |
+            **/*
+
+      - name: Setup Go
+        if: steps.changed-files.outputs.files != ''
+        uses: actions/setup-go@v5
+        with:
+          go-version-file: go.mod
+
+      - name: Running Tests
+        if: steps.changed-files.outputs.files != ''
+        run: |
+          go mod tidy
+          make test

.github/workflows/update-appversion.yml

@@ -55,3 +55,17 @@ jobs:
           git add helm/library/cortex-postgres/Chart.yaml
           git commit -m "Bump cortex-postgres chart appVersions to ${{ steps.vars.outputs.sha }} [skip ci]" || echo "No changes to commit"
           git push origin HEAD:main
+
+      # Only bumped if there are changes in the reservations directory.
+      - name: Update appVersion in cortex-reservations Chart.yaml
+        if: steps.changed_reservations_files.outputs.all_changed_files != ''
+        run: |
+          sed -i 's/^\([ ]*appVersion:[ ]*\).*/\1"${{ steps.vars.outputs.sha }}"/' reservations/dist/chart/Chart.yaml
+      - name: Commit and push changes for cortex-reservations
+        if: steps.changed_reservations_files.outputs.all_changed_files != ''
+        run: |
+          git config user.name "github-actions[bot]"
+          git config user.email "github-actions[bot]@users.noreply.github.com"
+          git add reservations/dist/chart/Chart.yaml
+          git commit -m "Bump cortex-reservations chart appVersions to ${{ steps.vars.outputs.sha }} [skip ci]" || echo "No changes to commit"
+          git push origin HEAD:main

.gitignore

@@ -9,6 +9,8 @@ build/**
 # Test binary, built with `go test -c`
 *.test
 
+bin/
+
 # Output of the go coverage tool, specifically when used with LiteIDE
 *.out
 

Dockerfile.kubebuilder

@@ -0,0 +1,32 @@
+# Build the manager binary
+FROM golang:1.24 AS builder
+ARG TARGETOS
+ARG TARGETARCH
+# Path of our go.mod
+ARG GO_MOD_PATH=.
+
+WORKDIR /workspace
+# Copy shared library and api
+COPY api /api
+COPY lib /lib
+# Copy the Go Modules manifests
+COPY ${GO_MOD_PATH} .
+# cache deps before building and copying source so that we don't need to re-download as much
+# and so that source changes don't invalidate our downloaded layer
+RUN go mod download
+
+# Build
+# the GOARCH has not a default value to allow the binary be built according to the host where the command
+# was called. For example, if we call make docker-build in a local env which has the Apple Silicon M1 SO
+# the docker BUILDPLATFORM arg will be linux/arm64 when for Apple x86 it will be linux/amd64. Therefore,
+# by leaving it empty we can ensure that the container and binary shipped on it will have the same platform.
+RUN CGO_ENABLED=0 GOOS=${TARGETOS:-linux} GOARCH=${TARGETARCH} go build -a -o manager cmd/main.go
+
+# Use distroless as minimal base image to package the manager binary
+# Refer to https://github.com/GoogleContainerTools/distroless for more details
+FROM gcr.io/distroless/static:nonroot
+WORKDIR /
+COPY --from=builder /workspace/manager .
+USER 65532:65532
+
+ENTRYPOINT ["/manager"]

Tiltfile

@@ -22,9 +22,14 @@ helm_repo(
     labels=['Repositories'],
 )
 
-########### CRDs
-local('sh helm/sync.sh helm/library/cortex-crds')
-k8s_yaml(helm('./helm/library/cortex-crds', name='cortex-crds'))
+########### Reservations Operator & CRDs
+docker_build('ghcr.io/cobaltcore-dev/cortex-reservations-operator', '.',
+    dockerfile='Dockerfile.kubebuilder',
+    build_args={'GO_MOD_PATH': 'reservations'},
+    only=['reservations/', 'lib/', 'api/'],
+)
+local('sh helm/sync.sh reservations/dist/chart')
+k8s_yaml(helm('reservations/dist/chart', name='cortex-reservations'))
 
 ########### Dev Dependencies
 local('sh helm/sync.sh helm/dev/cortex-prometheus-operator')
@@ -65,6 +70,7 @@ k8s_resource('cortex-plutono', port_forwards=[
 tilt_values = os.getenv('TILT_VALUES_PATH')
 docker_build('ghcr.io/cobaltcore-dev/cortex', '.', only=[
     'internal/', 'commands/', 'main.go', 'go.mod', 'go.sum', 'Makefile',
+    'lib/', 'api/', 'reservations/api/',
 ])
 docker_build('ghcr.io/cobaltcore-dev/cortex-postgres', 'postgres')
 
@@ -127,7 +133,6 @@ resources = [
             'cortex-nova-kpis',
             'cortex-nova-scheduler',
             'cortex-nova-descheduler',
-            'cortex-nova-reservations-operator',
         ],
         [(2112, 'metrics'), (8080, 'api')],
     ),