Merge pull request #140 from jumpstarter-dev/add-hooks

Add pre/post lease hooks

Author: mangelajo

.github/workflows/controller-tests.yaml

@@ -16,6 +16,14 @@ jobs:
         with:
           fetch-depth: 0
 
+      - name: Cache controller bin directory
+        uses: actions/cache@v4
+        with:
+          path: controller/bin/
+          key: ${{ runner.os }}-controller-bin-${{ hashFiles('controller/go.mod') }}
+          restore-keys: |
+            ${{ runner.os }}-controller-bin-
+
       - name: Run controller tests
         working-directory: controller
         run: make test

.github/workflows/e2e.yaml

@@ -50,23 +50,84 @@ jobs:
     steps:
       - name: Checkout repository
         uses: actions/checkout@v4
-      
+
       - name: Install uv
         uses: astral-sh/setup-uv@v7
-      
+
       - name: Install Go
         uses: actions/setup-go@v5
         with:
-          go-version: '1.22'
-      
+          go-version: "1.22"
+
       - name: Setup e2e test environment
         run: make e2e-setup
         env:
           CI: true
           METHOD: ${{ matrix.method }}
-      
+
       - name: Run e2e tests
         run: make e2e-run
         env:
           CI: true
           METHOD: ${{ matrix.method }}
+
+  # ============================================================================
+  # Compatibility tests: cross-version interop between controller and client/exporter
+  # These jobs can be removed once 0.7.x controller support is no longer needed.
+  # ============================================================================
+
+  e2e-compat-old-controller:
+    needs: changes
+    if: needs.changes.outputs.should_run == 'true' || github.event_name == 'workflow_dispatch'
+    runs-on: ubuntu-24.04
+    timeout-minutes: 60
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v7
+
+      - name: Install Go
+        uses: actions/setup-go@v5
+        with:
+          go-version: "1.22"
+
+      - name: Setup compat environment (old controller v0.7.0)
+        run: make e2e-compat-setup COMPAT_SCENARIO=old-controller
+        env:
+          CI: true
+          COMPAT_CONTROLLER_TAG: v0.7.0
+
+      - name: Run compat tests (old controller + new client/exporter)
+        run: make e2e-compat-run COMPAT_TEST=old-controller
+        env:
+          CI: true
+
+  e2e-compat-old-client:
+    needs: changes
+    if: needs.changes.outputs.should_run == 'true' || github.event_name == 'workflow_dispatch'
+    runs-on: ubuntu-24.04
+    timeout-minutes: 60
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v7
+
+      - name: Install Go
+        uses: actions/setup-go@v5
+        with:
+          go-version: "1.22"
+
+      - name: Setup compat environment (old client v0.7.0)
+        run: make e2e-compat-setup COMPAT_SCENARIO=old-client
+        env:
+          CI: true
+          COMPAT_CLIENT_VERSION: "0.7.1"
+
+      - name: Run compat tests (new controller + old client/exporter)
+        run: make e2e-compat-run COMPAT_TEST=old-client
+        env:
+          CI: true

Makefile

@@ -169,6 +169,23 @@ e2e-clean:
 .PHONY: test-e2e
 test-e2e: e2e-run
 
+# Compatibility E2E testing (cross-version tests, separate from main e2e)
+COMPAT_SCENARIO ?= old-controller
+COMPAT_TEST ?= old-controller
+COMPAT_CONTROLLER_TAG ?= v0.7.0
+COMPAT_CLIENT_VERSION ?= 0.7.1
+
+.PHONY: e2e-compat-setup
+e2e-compat-setup:
+	@echo "Setting up compat e2e (scenario: $(COMPAT_SCENARIO))..."
+	@COMPAT_SCENARIO=$(COMPAT_SCENARIO) COMPAT_CONTROLLER_TAG=$(COMPAT_CONTROLLER_TAG) \
+	 COMPAT_CLIENT_VERSION=$(COMPAT_CLIENT_VERSION) bash e2e/compat/setup.sh
+
+.PHONY: e2e-compat-run
+e2e-compat-run:
+	@echo "Running compat e2e (test: $(COMPAT_TEST))..."
+	@COMPAT_TEST=$(COMPAT_TEST) bash e2e/compat/run.sh
+
 # Per-project clean targets
 .PHONY: clean-python clean-protocol clean-controller clean-e2e
 clean-python:

controller/.gitignore

@@ -5,6 +5,7 @@
 *.so
 *.dylib
 bin/*
+deploy/operator/bin/
 Dockerfile.cross
 
 # Test binary, built with `go test -c`

controller/Makefile

@@ -63,10 +63,20 @@ help: ## Display this help.
 .PHONY: manifests
 manifests: controller-gen ## Generate WebhookConfiguration, ClusterRole and CustomResourceDefinition objects.
 	$(CONTROLLER_GEN) 	rbac:roleName=jumpstarter-manager-role crd webhook paths="./api/..." paths="./internal/..." \
-						output:crd:artifacts:config=deploy/helm/jumpstarter/crds/ \
+						output:crd:artifacts:config=deploy/helm/jumpstarter/charts/jumpstarter-controller/templates/crds/ \
 						output:rbac:artifacts:config=deploy/helm/jumpstarter/charts/jumpstarter-controller/templates/rbac/
 
-	cp deploy/helm/jumpstarter/crds/* deploy/operator/config/crd/bases/
+	# Add ArgoCD sync-wave annotation to RBAC role for proper deployment ordering (PR #207)
+	@awk '/^  name: jumpstarter-manager-role$$/{print; print "  annotations:"; print "    argocd.argoproj.io/sync-wave: \"-1\""; next}1' \
+		deploy/helm/jumpstarter/charts/jumpstarter-controller/templates/rbac/role.yaml > \
+		deploy/helm/jumpstarter/charts/jumpstarter-controller/templates/rbac/role.yaml.tmp && \
+		mv deploy/helm/jumpstarter/charts/jumpstarter-controller/templates/rbac/role.yaml.tmp \
+		deploy/helm/jumpstarter/charts/jumpstarter-controller/templates/rbac/role.yaml
+
+	cp deploy/helm/jumpstarter/charts/jumpstarter-controller/templates/crds/* deploy/operator/config/crd/bases/
+
+	# Regenerate operator install.yaml to include updated CRDs
+	$(MAKE) -C deploy/operator build-installer
 
 .PHONY: generate
 generate: controller-gen ## Generate code containing DeepCopy, DeepCopyInto, and DeepCopyObject method implementations.
@@ -236,7 +246,7 @@ GRPCURL = $(LOCALBIN)/grpcurl
 ## Tool Versions
 KUSTOMIZE_VERSION ?= v5.4.1
 CONTROLLER_TOOLS_VERSION ?= v0.16.3
-ENVTEST_VERSION ?= release-0.18
+ENVTEST_VERSION ?= $(shell go list -m -f "{{ .Version }}" sigs.k8s.io/controller-runtime | awk -F'[v.]' '{printf "release-%d.%d", $$2, $$3}')
 GOLANGCI_LINT_VERSION ?= v2.5.0
 KIND_VERSION ?= v0.27.0
 GRPCURL_VERSION ?= v1.9.2

controller/api/v1alpha1/exporter_helpers.go

@@ -4,6 +4,7 @@ import (
 	"strings"
 
 	cpb "github.com/jumpstarter-dev/jumpstarter-controller/internal/protocol/jumpstarter/client/v1"
+	pb "github.com/jumpstarter-dev/jumpstarter-controller/internal/protocol/jumpstarter/v1"
 	"github.com/jumpstarter-dev/jumpstarter-controller/internal/service/utils"
 	"k8s.io/apimachinery/pkg/api/meta"
 	kclient "sigs.k8s.io/controller-runtime/pkg/client"
@@ -25,13 +26,37 @@ func (e *Exporter) Usernames(prefix string) []string {
 }
 
 func (e *Exporter) ToProtobuf() *cpb.Exporter {
-	// get online status from conditions
+	// get online status from conditions (deprecated, kept for backward compatibility)
 	isOnline := meta.IsStatusConditionTrue(e.Status.Conditions, string(ExporterConditionTypeOnline))
 
 	return &cpb.Exporter{
-		Name:   utils.UnparseExporterIdentifier(kclient.ObjectKeyFromObject(e)),
-		Labels: e.Labels,
-		Online: isOnline,
+		Name:          utils.UnparseExporterIdentifier(kclient.ObjectKeyFromObject(e)),
+		Labels:        e.Labels,
+		Online:        isOnline,
+		Status:        stringToProtoStatus(e.Status.ExporterStatusValue),
+		StatusMessage: e.Status.StatusMessage,
+	}
+}
+
+// stringToProtoStatus converts the CRD string value to the proto ExporterStatus enum
+func stringToProtoStatus(state string) pb.ExporterStatus {
+	switch state {
+	case ExporterStatusOffline:
+		return pb.ExporterStatus_EXPORTER_STATUS_OFFLINE
+	case ExporterStatusAvailable:
+		return pb.ExporterStatus_EXPORTER_STATUS_AVAILABLE
+	case ExporterStatusBeforeLeaseHook:
+		return pb.ExporterStatus_EXPORTER_STATUS_BEFORE_LEASE_HOOK
+	case ExporterStatusLeaseReady:
+		return pb.ExporterStatus_EXPORTER_STATUS_LEASE_READY
+	case ExporterStatusAfterLeaseHook:
+		return pb.ExporterStatus_EXPORTER_STATUS_AFTER_LEASE_HOOK
+	case ExporterStatusBeforeLeaseHookFailed:
+		return pb.ExporterStatus_EXPORTER_STATUS_BEFORE_LEASE_HOOK_FAILED
+	case ExporterStatusAfterLeaseHookFailed:
+		return pb.ExporterStatus_EXPORTER_STATUS_AFTER_LEASE_HOOK_FAILED
+	default:
+		return pb.ExporterStatus_EXPORTER_STATUS_UNSPECIFIED
 	}
 }
 

controller/api/v1alpha1/exporter_types.go

@@ -38,6 +38,11 @@ type ExporterStatus struct {
 	LeaseRef   *corev1.LocalObjectReference `json:"leaseRef,omitempty"`
 	LastSeen   metav1.Time                  `json:"lastSeen,omitempty"`
 	Endpoint   string                       `json:"endpoint,omitempty"`
+	// ExporterStatusValue is the current operational status reported by the exporter
+	// +kubebuilder:validation:Enum=Unspecified;Offline;Available;BeforeLeaseHook;LeaseReady;AfterLeaseHook;BeforeLeaseHookFailed;AfterLeaseHookFailed
+	ExporterStatusValue string `json:"exporterStatus,omitempty"`
+	// StatusMessage is an optional human-readable message describing the current state
+	StatusMessage string `json:"statusMessage,omitempty"`
 }
 
 type ExporterConditionType string
@@ -47,8 +52,22 @@ const (
 	ExporterConditionTypeOnline     ExporterConditionType = "Online"
 )
 
+// ExporterStatus values - PascalCase for Kubernetes, converted from proto ALL_CAPS
+const (
+	ExporterStatusUnspecified           = "Unspecified"
+	ExporterStatusOffline               = "Offline"
+	ExporterStatusAvailable             = "Available"
+	ExporterStatusBeforeLeaseHook       = "BeforeLeaseHook"
+	ExporterStatusLeaseReady            = "LeaseReady"
+	ExporterStatusAfterLeaseHook        = "AfterLeaseHook"
+	ExporterStatusBeforeLeaseHookFailed = "BeforeLeaseHookFailed"
+	ExporterStatusAfterLeaseHookFailed  = "AfterLeaseHookFailed"
+)
+
 // +kubebuilder:object:root=true
 // +kubebuilder:subresource:status
+// +kubebuilder:printcolumn:name="Status",type="string",JSONPath=".status.exporterStatus"
+// +kubebuilder:printcolumn:name="Message",type="string",JSONPath=".status.statusMessage",priority=1
 
 // Exporter is the Schema for the exporters API
 type Exporter struct {

…tarter/crds/jumpstarter.dev_clients.yaml …plates/crds/jumpstarter.dev_clients.yamlcontroller/deploy/helm/jumpstarter/crds/jumpstarter.dev_clients.yaml renamed to controller/deploy/helm/jumpstarter/charts/jumpstarter-controller/templates/crds/jumpstarter.dev_clients.yaml controller/deploy/helm/jumpstarter/crds/jumpstarter.dev_clients.yaml renamed to controller/deploy/helm/jumpstarter/charts/jumpstarter-controller/templates/crds/jumpstarter.dev_clients.yaml

@@ -14,7 +14,15 @@ spec:
     singular: exporter
   scope: Namespaced
   versions:
-  - name: v1alpha1
+  - additionalPrinterColumns:
+    - jsonPath: .status.exporterStatus
+      name: Status
+      type: string
+    - jsonPath: .status.statusMessage
+      name: Message
+      priority: 1
+      type: string
+    name: v1alpha1
     schema:
       openAPIV3Schema:
         description: Exporter is the Schema for the exporters API
@@ -133,6 +141,19 @@ spec:
                 type: array
               endpoint:
                 type: string
+              exporterStatus:
+                description: ExporterStatusValue is the current operational status
+                  reported by the exporter
+                enum:
+                - Unspecified
+                - Offline
+                - Available
+                - BeforeLeaseHook
+                - LeaseReady
+                - AfterLeaseHook
+                - BeforeLeaseHookFailed
+                - AfterLeaseHookFailed
+                type: string
               lastSeen:
                 format: date-time
                 type: string
@@ -152,6 +173,10 @@ spec:
                     type: string
                 type: object
                 x-kubernetes-map-type: atomic
+              statusMessage:
+                description: StatusMessage is an optional human-readable message describing
+                  the current state
+                type: string
             type: object
         type: object
     served: true