Merge pull request #116 from MrFreezeex/add-version-crd

crd: add label with CRD version

Author: k8s-ci-robot

config/crd-base/multicluster.x-k8s.io_serviceexports.yaml

@@ -15,6 +15,12 @@ apiVersion: apiextensions.k8s.io/v1
 kind: CustomResourceDefinition
 metadata:
   name: serviceexports.multicluster.x-k8s.io
+  labels:
+    multicluster.x-k8s.io/release-version: "v0.3.0"
+    # The revision is updated on each CRD change and reset back to 0 on every new version.
+    # It can be used together with the version label when installing those CRDs
+    # and prevent any downgrades.
+    multicluster.x-k8s.io/crd-schema-revision: "0"
 spec:
   group: multicluster.x-k8s.io
   scope: Namespaced

config/crd-base/multicluster.x-k8s.io_serviceimports.yaml

@@ -15,6 +15,12 @@ apiVersion: apiextensions.k8s.io/v1
 kind: CustomResourceDefinition
 metadata:
   name: serviceimports.multicluster.x-k8s.io
+  labels:
+    multicluster.x-k8s.io/release-version: "v0.3.0"
+    # The revision is updated on each CRD change and reset back to 0 on every new version.
+    # It can be used together with the version label when installing those CRDs
+    # and prevent any downgrades.
+    multicluster.x-k8s.io/crd-schema-revision: "0"
 spec:
   group: multicluster.x-k8s.io
   scope: Namespaced

config/crd/embed.go

@@ -26,3 +26,10 @@ var (
 	//go:embed multicluster.x-k8s.io_serviceimports.yaml
 	ServiceImportCRD []byte
 )
+
+const (
+	// ReleaseVersionLabel is the label which indicate the release version
+	ReleaseVersionLabel = "multicluster.x-k8s.io/release-version"
+	// CustomResourceDefinitionSchemaRevisionLabel is the label which holds the CRD schema revision
+	CustomResourceDefinitionSchemaRevisionLabel = "multicluster.x-k8s.io/crd-schema-revision"
+)

config/crd/multicluster.x-k8s.io_serviceexports.yaml

@@ -15,6 +15,12 @@ apiVersion: apiextensions.k8s.io/v1
 kind: CustomResourceDefinition
 metadata:
   name: serviceexports.multicluster.x-k8s.io
+  labels:
+    multicluster.x-k8s.io/release-version: "v0.3.0"
+    # The revision is updated on each CRD change and reset back to 0 on every new version.
+    # It can be used together with the version label when installing those CRDs
+    # and prevent any downgrades.
+    multicluster.x-k8s.io/crd-schema-revision: "0"
 spec:
   group: multicluster.x-k8s.io
   scope: Namespaced

config/crd/multicluster.x-k8s.io_serviceimports.yaml

@@ -15,6 +15,12 @@ apiVersion: apiextensions.k8s.io/v1
 kind: CustomResourceDefinition
 metadata:
   name: serviceimports.multicluster.x-k8s.io
+  labels:
+    multicluster.x-k8s.io/release-version: "v0.3.0"
+    # The revision is updated on each CRD change and reset back to 0 on every new version.
+    # It can be used together with the version label when installing those CRDs
+    # and prevent any downgrades.
+    multicluster.x-k8s.io/crd-schema-revision: "0"
 spec:
   group: multicluster.x-k8s.io
   scope: Namespaced

hack/verify-crd-bump-revision.sh

@@ -0,0 +1,26 @@
+#!/bin/bash
+
+# Copyright 2025 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.
+
+# Check against master if PULL_BASE_SHA is not defined by prow
+BASE_REF="${PULL_BASE_SHA:-master}"
+
+crd_changed="$(git diff --name-only "${BASE_REF}" | grep -c "^config/crd/.*\.yaml$")"
+version_label_changed="$(git diff -U0 "${BASE_REF}" -- "config/crd-base/" | grep -c "multicluster.x-k8s.io/crd-schema-revision")"
+
+if [ "${crd_changed}" -gt 0 ] && [ "${version_label_changed}" -ne 2 ]; then
+	echo "❌ CRDs were modified, but the CRD revision labels were not changed in 'config/crd-base/'. Please bump the CRDs revision."
+	exit 1
+fi