✨feat: add informers, listers, and codegen for tenancy APIs

.gitignore

@@ -25,6 +25,9 @@ dist/
 
 /kubeflex/
 
+# Code generator tools (repo-local)
+hack/tools/bin/
+
 # Ignore generated CRDs for the chart
 chart/crds/controlplanes.yaml
 chart/crds/postcreatehooks.yaml

Makefile

@@ -104,6 +104,14 @@ manifests: controller-gen ## Generate WebhookConfiguration, ClusterRole and Cust
 generate: controller-gen ## Generate code containing DeepCopy, DeepCopyInto, and DeepCopyObject method implementations.
 	$(CONTROLLER_GEN) object:headerFile="hack/boilerplate.go.txt" paths="./..."
 
+.PHONY: generate-clients
+generate-clients: ## Generate typed clientset, informers, and listers using Kubernetes code-generator.
+	./hack/update-codegen.sh
+
+.PHONY: verify-codegen
+verify-codegen: ## Verify that generated code is up-to-date.
+	./hack/verify-codegen.sh
+
 .PHONY: fmt
 fmt: ## Run go fmt against code.
 	go fmt ./...

api/v1alpha1/controlplane_types.go

@@ -76,6 +76,8 @@ type ControlPlaneStatus struct {
 }
 
 // ControlPlane is the Schema for the controlplanes API
+// +genclient
+// +genclient:nonNamespaced
 // +kubebuilder:object:root=true
 // +kubebuilder:subresource:status
 // +kubebuilder:printcolumn:name="SYNCED",type="string",JSONPath=".status.conditions[?(@.type=='Synced')].status"

api/v1alpha1/doc.go

@@ -0,0 +1,21 @@
+/*
+Copyright 2023 The KubeStellar Authors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+// +k8s:deepcopy-gen=package
+// +groupName=tenancy.kflex.kubestellar.org
+
+// Package v1alpha1 contains API Schema definitions for the tenancy v1alpha1 API group
+package v1alpha1

api/v1alpha1/postcreatehook_types.go

@@ -41,7 +41,9 @@ type PostCreateHookStatus struct {
 	SecretRef *SecretReference `json:"secretRef,omitempty"`
 }
 
-// PostCreateHook is the Schema for the controlplanes API
+// PostCreateHook is the Schema for the postcreatehooks API
+// +genclient
+// +genclient:nonNamespaced
 // +kubebuilder:object:root=true
 // +kubebuilder:subresource:status
 // +kubebuilder:printcolumn:name="SYNCED",type="string",JSONPath=".status.conditions[?(@.type=='Synced')].status"

api/v1alpha1/register.go

@@ -0,0 +1,51 @@
+/*
+Copyright 2023 The KubeStellar Authors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package v1alpha1
+
+import (
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+	"k8s.io/apimachinery/pkg/runtime"
+	"k8s.io/apimachinery/pkg/runtime/schema"
+)
+
+// SchemeGroupVersion is group version used to register these objects
+var SchemeGroupVersion = schema.GroupVersion{Group: "tenancy.kflex.kubestellar.org", Version: "v1alpha1"}
+
+// Resource takes an unqualified resource and returns a Group qualified GroupResource
+func Resource(resource string) schema.GroupResource {
+	return SchemeGroupVersion.WithResource(resource).GroupResource()
+}
+
+var (
+	// localSchemeBuilder and AddToScheme will stay in k8s.io/kubernetes.
+	localSchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes)
+
+	// AddToSchemeInCore is a common registration function for mapping types to the scheme
+	AddToSchemeInCore = localSchemeBuilder.AddToScheme
+)
+
+// Adds the list of known types to the given scheme.
+func addKnownTypes(scheme *runtime.Scheme) error {
+	scheme.AddKnownTypes(SchemeGroupVersion,
+		&ControlPlane{},
+		&ControlPlaneList{},
+		&PostCreateHook{},
+		&PostCreateHookList{},
+	)
+	metav1.AddToGroupVersion(scheme, SchemeGroupVersion)
+	return nil
+}

docs/code-generation.md

@@ -0,0 +1,54 @@
+# Code Generation Guide
+
+This document describes how to generate and maintain typed Kubernetes clients for the kubeflex CRDs.
+
+## Overview
+
+kubeflex uses the standard Kubernetes code-generator tools to generate:
+
+- **Typed Clientsets**: Strongly-typed clients for interacting with CRDs via the Kubernetes API
+- **Informers**: SharedInformerFactory for watching CRD resources with local caching
+- **Listers**: Typed listers for reading CRD resources from informer caches
+
+## Prerequisites
+
+- Go 1.24+ installed
+- Access to `k8s.io/code-generator` (automatically fetched during generation)
+
+## Generating Code
+
+To regenerate all typed clients, informers, and listers:
+
+```bash
+make generate-clients
+```
+
+This runs `hack/update-codegen.sh`, which invokes the Kubernetes code-generator tools.
+
+## Verifying Generated Code
+
+To verify that generated code is up-to-date:
+
+```bash
+make verify-codegen
+```
+
+This is useful in CI pipelines to ensure generated code is committed after API changes.
+
+## When to Regenerate
+
+Regenerate typed clients when API types in `api/v1alpha1/` are modified.
+
+## Troubleshooting
+
+### Code generation fails
+
+Ensure you have the correct version of Go installed and that `k8s.io/code-generator` is accessible.
+
+### Generated code doesn't compile
+
+Check that:
+1. API types have proper markers (`+k8s:deepcopy-gen=package`, `+groupName=...`, `+genclient`)
+2. Types are registered with the scheme in `register.go`
+3. All required `init()` functions are present
+

hack/update-codegen.sh

@@ -0,0 +1,78 @@
+#!/usr/bin/env bash
+
+# Copyright 2023 The KubeStellar Authors.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# This script generates typed clients, informers, and listers for the
+# kubeflex CRDs using the Kubernetes code-generator.
+
+set -o errexit
+set -o nounset
+set -o pipefail
+
+REPO_ROOT=$(dirname "${BASH_SOURCE[0]}")/..
+cd "${REPO_ROOT}"
+
+# Module and package configuration
+MODULE="github.com/kubestellar/kubeflex"
+API_PKG="api"
+OUTPUT_PKG="pkg/generated"
+
+# Determine code-generator version from go.mod
+CODEGEN_VERSION=$(go list -m -f '{{.Version}}' k8s.io/code-generator)
+
+# Tools directory (repo-local, not GOPATH)
+TOOLS_BIN_DIR="${REPO_ROOT}/hack/tools/bin"
+mkdir -p "${TOOLS_BIN_DIR}"
+TOOLS_BIN_DIR="$(cd "${TOOLS_BIN_DIR}" && pwd)"
+
+# Install code generators to repo-local directory
+echo "Installing code-generator tools to ${TOOLS_BIN_DIR}..."
+GOBIN="${TOOLS_BIN_DIR}" go install "k8s.io/code-generator/cmd/client-gen@${CODEGEN_VERSION}"
+GOBIN="${TOOLS_BIN_DIR}" go install "k8s.io/code-generator/cmd/lister-gen@${CODEGEN_VERSION}"
+GOBIN="${TOOLS_BIN_DIR}" go install "k8s.io/code-generator/cmd/informer-gen@${CODEGEN_VERSION}"
+
+# Header file for generated code
+BOILERPLATE="${REPO_ROOT}/hack/boilerplate.go.txt"
+
+# Delete entire generated code tree for reproducibility
+echo "Clearing ${OUTPUT_PKG}..."
+rm -rf "${REPO_ROOT}/${OUTPUT_PKG}"
+
+echo "Generating clientset..."
+"${TOOLS_BIN_DIR}/client-gen" \
+    --clientset-name "versioned" \
+    --input-base "" \
+    --input "${MODULE}/${API_PKG}/v1alpha1" \
+    --output-dir "${REPO_ROOT}/${OUTPUT_PKG}/clientset" \
+    --output-pkg "${MODULE}/${OUTPUT_PKG}/clientset" \
+    --go-header-file "${BOILERPLATE}"
+
+echo "Generating listers..."
+"${TOOLS_BIN_DIR}/lister-gen" \
+    --output-dir "${REPO_ROOT}/${OUTPUT_PKG}/listers" \
+    --output-pkg "${MODULE}/${OUTPUT_PKG}/listers" \
+    --go-header-file "${BOILERPLATE}" \
+    "${MODULE}/${API_PKG}/v1alpha1"
+
+echo "Generating informers..."
+"${TOOLS_BIN_DIR}/informer-gen" \
+    --versioned-clientset-package "${MODULE}/${OUTPUT_PKG}/clientset/versioned" \
+    --listers-package "${MODULE}/${OUTPUT_PKG}/listers" \
+    --output-dir "${REPO_ROOT}/${OUTPUT_PKG}/informers" \
+    --output-pkg "${MODULE}/${OUTPUT_PKG}/informers" \
+    --go-header-file "${BOILERPLATE}" \
+    "${MODULE}/${API_PKG}/v1alpha1"
+
+echo "Code generation complete."

hack/verify-codegen.sh

@@ -0,0 +1,98 @@
+#!/usr/bin/env bash
+
+# Copyright 2023 The KubeStellar Authors.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# This script verifies that the generated code is up-to-date.
+
+set -o errexit
+set -o nounset
+set -o pipefail
+
+REPO_ROOT=$(dirname "${BASH_SOURCE[0]}")/..
+cd "${REPO_ROOT}"
+
+# Create temporary directory for generated code
+DIFFROOT="${REPO_ROOT}/pkg/generated"
+TMP_DIFFROOT="$(mktemp -d)"
+trap 'rm -rf "${TMP_DIFFROOT}"' EXIT
+
+# Copy current generated code to temp
+if [[ -d "${DIFFROOT}" ]]; then
+    cp -a "${DIFFROOT}/." "${TMP_DIFFROOT}"
+fi
+
+# Module and package configuration
+MODULE="github.com/kubestellar/kubeflex"
+API_PKG="api"
+OUTPUT_PKG="pkg/generated"
+
+# Determine code-generator version from go.mod
+CODEGEN_VERSION=$(go list -m -f '{{.Version}}' k8s.io/code-generator)
+
+# Tools directory (repo-local, not GOPATH)
+TOOLS_BIN_DIR="${REPO_ROOT}/hack/tools/bin"
+mkdir -p "${TOOLS_BIN_DIR}"
+TOOLS_BIN_DIR="$(cd "${TOOLS_BIN_DIR}" && pwd)"
+
+# Install code generators to repo-local directory
+echo "Installing code-generator tools to ${TOOLS_BIN_DIR}..."
+GOBIN="${TOOLS_BIN_DIR}" go install "k8s.io/code-generator/cmd/client-gen@${CODEGEN_VERSION}"
+GOBIN="${TOOLS_BIN_DIR}" go install "k8s.io/code-generator/cmd/lister-gen@${CODEGEN_VERSION}"
+GOBIN="${TOOLS_BIN_DIR}" go install "k8s.io/code-generator/cmd/informer-gen@${CODEGEN_VERSION}"
+
+# Header file for generated code
+BOILERPLATE="${REPO_ROOT}/hack/boilerplate.go.txt"
+
+# Delete entire generated code tree for reproducibility
+echo "Clearing ${OUTPUT_PKG}..."
+rm -rf "${REPO_ROOT}/${OUTPUT_PKG}"
+
+echo "Generating clientset..."
+"${TOOLS_BIN_DIR}/client-gen" \
+    --clientset-name "versioned" \
+    --input-base "" \
+    --input "${MODULE}/${API_PKG}/v1alpha1" \
+    --output-dir "${REPO_ROOT}/${OUTPUT_PKG}/clientset" \
+    --output-pkg "${MODULE}/${OUTPUT_PKG}/clientset" \
+    --go-header-file "${BOILERPLATE}"
+
+echo "Generating listers..."
+"${TOOLS_BIN_DIR}/lister-gen" \
+    --output-dir "${REPO_ROOT}/${OUTPUT_PKG}/listers" \
+    --output-pkg "${MODULE}/${OUTPUT_PKG}/listers" \
+    --go-header-file "${BOILERPLATE}" \
+    "${MODULE}/${API_PKG}/v1alpha1"
+
+echo "Generating informers..."
+"${TOOLS_BIN_DIR}/informer-gen" \
+    --versioned-clientset-package "${MODULE}/${OUTPUT_PKG}/clientset/versioned" \
+    --listers-package "${MODULE}/${OUTPUT_PKG}/listers" \
+    --output-dir "${REPO_ROOT}/${OUTPUT_PKG}/informers" \
+    --output-pkg "${MODULE}/${OUTPUT_PKG}/informers" \
+    --go-header-file "${BOILERPLATE}" \
+    "${MODULE}/${API_PKG}/v1alpha1"
+
+echo "Verifying generated code is up-to-date..."
+
+# Check for differences
+if ! diff -Naupr "${TMP_DIFFROOT}" "${DIFFROOT}"; then
+    echo ""
+    echo "Generated code is out of date. Please run:"
+    echo "    hack/update-codegen.sh"
+    echo ""
+    exit 1
+fi
+
+echo "Generated code is up-to-date."