Add topology crd to the installation (#292)

Author: davidLif

Makefile

@@ -27,6 +27,7 @@ test: envtest-docker-go
 
 .PHONY: build
 build: $(SERVICE_NAMES)
+	$(MAKE) docker-build-crd-upgrader
 
 $(SERVICE_NAMES):
 	$(MAKE) build-go SERVICE_NAME=$@
@@ -57,7 +58,7 @@ gen-license: addlicense
 
 .PHONY: manifests
 manifests: controller-gen kustomize ## Generate ClusterRole and CustomResourceDefinition objects.
-	$(CONTROLLER_GEN) crd:allowDangerousTypes=true,generateEmbeddedObjectMeta=true,headerFile="./hack/boilerplate.yaml.txt" paths="./pkg/apis/..." output:crd:artifacts:config=deployments/kai-scheduler/crds
+	$(CONTROLLER_GEN) crd:allowDangerousTypes=true,generateEmbeddedObjectMeta=true,headerFile="./hack/boilerplate.yaml.txt" paths="./pkg/apis/..." output:crd:artifacts:config=deployments/crds/internal
 	$(CONTROLLER_GEN) rbac:roleName=kai-podgrouper,headerFile="./hack/boilerplate.yaml.txt" paths="./pkg/podgrouper/..." paths="./cmd/podgrouper/..." output:stdout > deployments/kai-scheduler/templates/rbac/podgrouper.yaml
 	$(CONTROLLER_GEN) rbac:roleName=kai-binder,headerFile="./hack/boilerplate.yaml.txt" paths="./pkg/binder/..." paths="./cmd/binder/..." output:stdout > deployments/kai-scheduler/templates/rbac/binder.yaml
 	$(CONTROLLER_GEN) rbac:roleName=kai-resource-reservation,headerFile="./hack/boilerplate.yaml.txt" paths="./pkg/resourcereservation/..." paths="./cmd/resourcereservation/..." output:stdout > deployments/kai-scheduler/templates/rbac/resourcereservation.yaml

NOTICE

@@ -8737,6 +8737,10 @@ This project was originally forked from kube-batch in 2019, therefore it include
 Copyright (c) The Kubernetes Authors.
 This project includes components derived from kube-batch, originally developed by The Kubernetes Authors.
 
+This project includes components from kueue, which is licensed under the Apache License, Version 2.0.
+Copyright (c) The Kubernetes Authors.
+This project includes components derived from kueue, originally developed by The Kubernetes Authors.
+
 pkg/common/k8s_utils/framework_handle.go file was forked from volcano-sh/volcano, which is licensed under the Apache License, Version 2.0.
 Copyright 2020 The Volcano Authors.
 This file was originally developed by the Volcano Authors.

build/makefile/base.mk

@@ -9,6 +9,7 @@ SUCCESS_MESSAGE_HANDLER=(${ECHO_COMMAND} ${GREEN_CONSOLE} "${CONSOLE_PREFIX} Suc
 
 DOCKER_SOCK_PATH=/var/run/docker.sock
 DOCKERFILE_PATH=./Dockerfile
+CRD_UPGRADER_DOCKERFILE_PATH=./deployments/crds/crd-upgrader/Dockerfile
 
 DOCKER_TAG?=0.0.0
 VERSION?=${DOCKER_TAG}
@@ -52,6 +53,10 @@ builder:
 	DOCKER_BUILDKIT=1 docker buildx build -f build/builder/Dockerfile --load -t builder:${GO_IMAGE_VERSION} .
 .PHONY: builder
 
+docker-build-crd-upgrader:
+	$(MAKE) docker-build-generic DOCKERFILE_PATH=${CRD_UPGRADER_DOCKERFILE_PATH} DOCKER_BUILD_ADDITIONAL_ARGS="" SERVICE_NAME="crd-upgrader"
+.PHONY: docker-build-crd-upgrader
+
 docker-build-generic:
 	DOCKER_BUILDKIT=1 docker buildx build ${DOCKER_BUILD_ADDITIONAL_ARGS} --build-arg SERVICE_NAME=${SERVICE_NAME} -f ${DOCKERFILE_PATH} -t ${DOCKER_IMAGE_NAME} ${DOCKER_BUILDX_ADDITIONAL_ARGS} --platform ${DOCKER_BUILD_PLATFORM} .
 .PHONY: docker-build-generic

deployments/crds/crd-upgrader/Dockerfile

@@ -0,0 +1,19 @@
+# Copyright 2025 NVIDIA CORPORATION
+# SPDX-License-Identifier: Apache-2.0
+
+FROM registry.access.redhat.com/ubi9/ubi-minimal
+ARG TARGETARCH
+ENV TARGETARCH=$TARGETARCH
+RUN curl -o kubectl -L "https://dl.k8s.io/release/$(curl -L -s https://dl.k8s.io/release/stable.txt)/bin/linux/$TARGETARCH/kubectl" \
+&& chmod +x kubectl && mv kubectl /usr/bin/kubectl
+
+
+COPY deployments/crds/internal /internal-crds
+COPY deployments/crds/external /external-crds
+COPY NOTICE .
+COPY deployments/crds/crd-upgrader/apply-crds.sh /apply-crds.sh
+RUN chmod +x /apply-crds.sh
+
+USER 65532:65532
+
+CMD ["/apply-crds.sh"]

deployments/crds/crd-upgrader/apply-crds.sh

@@ -0,0 +1,26 @@
+#!/bin/bash
+# Copyright 2025 NVIDIA CORPORATION
+# SPDX-License-Identifier: Apache-2.0
+
+
+# Using --force-conflicts to claim ownership of the CRDs from helm
+kubectl apply --server-side=true --force-conflicts -f /internal-crds
+
+# Check and apply external CRDs only if they don't already exist in the cluster
+for crd_file in /external-crds/*.yaml; do
+    if [ -f "$crd_file" ]; then
+        # Extract CRD name from the file
+        crd_name=$(grep "^  name:" "$crd_file" | head -1 | awk '{print $2}')
+        if [ -n "$crd_name" ]; then
+            # Check if CRD already exists in the cluster
+            if kubectl get crd "$crd_name" >/dev/null 2>&1; then
+                echo "CRD $crd_name already exists in cluster, skipping..."
+            else
+                echo "Applying CRD $crd_name..."
+                kubectl apply --server-side=true -f "$crd_file"
+            fi
+        else
+            echo "Warning: Could not extract CRD name from $crd_file"
+        fi
+    fi
+done

deployments/crds/external/kueue.x-k8s.io_topologies.yaml

@@ -0,0 +1,85 @@
+# Copyright The Kubernetes 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.
+apiVersion: apiextensions.k8s.io/v1
+kind: CustomResourceDefinition
+metadata:
+  annotations:
+    controller-gen.kubebuilder.io/version: v0.18.0
+  name: topologies.kueue.x-k8s.io
+spec:
+  group: kueue.x-k8s.io
+  names:
+    kind: Topology
+    listKind: TopologyList
+    plural: topologies
+    singular: topology
+  scope: Cluster
+  versions:
+    - name: v1alpha1
+      schema:
+        openAPIV3Schema:
+          description: Topology is the Schema for the topology API
+          properties:
+            apiVersion:
+              description: |-
+                APIVersion defines the versioned schema of this representation of an object.
+                Servers should convert recognized schemas to the latest internal value, and
+                may reject unrecognized values.
+                More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
+              type: string
+            kind:
+              description: |-
+                Kind is a string value representing the REST resource this object represents.
+                Servers may infer this from the endpoint the client submits requests to.
+                Cannot be updated.
+                In CamelCase.
+                More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
+              type: string
+            metadata:
+              type: object
+            spec:
+              description: TopologySpec defines the desired state of Topology
+              properties:
+                levels:
+                  description: levels define the levels of topology.
+                  items:
+                    description: TopologyLevel defines the desired state of TopologyLevel
+                    properties:
+                      nodeLabel:
+                        description: |-
+                          nodeLabel indicates the name of the node label for a specific topology
+                          level.
+
+                          Examples:
+                          - cloud.provider.com/topology-block
+                          - cloud.provider.com/topology-rack
+                        maxLength: 316
+                        minLength: 1
+                        pattern: ^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$
+                        type: string
+                    required:
+                      - nodeLabel
+                    type: object
+                  maxItems: 16
+                  minItems: 1
+                  type: array
+                  x-kubernetes-list-type: atomic
+                  x-kubernetes-validations:
+                    - message: field is immutable
+                      rule: self == oldSelf
+                    - message: must be unique
+                      rule: size(self.filter(i, size(self.filter(j, j == i)) > 1)) == 0
+                    - message: the kubernetes.io/hostname label can only be used at the lowest level of topology
+                      rule: size(self.filter(i, i.nodeLabel == 'kubernetes.io/hostname')) == 0 || self[size(self) - 1].nodeLabel == 'kubernetes.io/hostname'
+              required:
+                - levels
+              type: object
+          required:
+            - spec
+          type: object
+      served: true
+      storage: true

deployments/kai-scheduler/crds/scheduling.run.ai_bindrequests.yaml renamed to deployments/crds/internal/scheduling.run.ai_bindrequests.yaml

@@ -0,0 +1,21 @@
+# Copyright 2025 NVIDIA CORPORATION
+# SPDX-License-Identifier: Apache-2.0
+
+apiVersion: batch/v1
+kind: Job
+metadata:
+  name: crd-upgrader
+  namespace: {{ .Release.Namespace }}
+  annotations:
+    "helm.sh/hook": pre-install,pre-upgrade
+    "helm.sh/hook-weight": "2"
+    "helm.sh/hook-delete-policy": hook-succeeded
+spec:
+  template:
+    spec:
+      serviceAccountName: kai-scheduler-crd-manager
+      containers:
+      - name: upgrader
+        image: "{{ .Values.global.registry }}/{{ .Values.crdupgrader.image.name }}:{{ .Chart.Version }}"
+        imagePullPolicy: {{ .Values.crdupgrader.image.pullPolicy }}
+      restartPolicy: OnFailure