Move CRDs and respective API to be under v1alpha1 (#1026)

unmarshall · web-flow · commit 01b90bd3e8a9 · 2025-03-11T11:28:46.000+05:30
* moved crds to be under v1alpha1

* fixed crd paths for IT tests

* updated crd assets path for ginkgo IT tests

* reorder imports
diff --git a/README.md b/README.md
@@ -2,7 +2,7 @@
 
 [![REUSE status](https://api.reuse.software/badge/github.com/gardener/etcd-druid)](https://api.reuse.software/info/github.com/gardener/etcd-druid) [![CI Build status](https://concourse.ci.gardener.cloud/api/v1/teams/gardener/pipelines/etcd-druid-master/jobs/master-head-update-job/badge)](https://concourse.ci.gardener.cloud/teams/gardener/pipelines/etcd-druid-master/jobs/master-head-update-job) [![Go Report Card](https://goreportcard.com/badge/github.com/gardener/etcd-druid)](https://goreportcard.com/report/github.com/gardener/etcd-druid) [![License: Apache-2.0](https://img.shields.io/badge/License-Apache--2.0-blue.svg)](LICENSE) [![Release](https://img.shields.io/github/v/release/gardener/etcd-druid.svg?style=flat)](https://github.com/gardener/etcd-druid) [![Go Reference](https://pkg.go.dev/badge/github.com/gardener/etcd-druid.svg)](https://pkg.go.dev/github.com/gardener/etcd-druid) [![Docs](https://img.shields.io/badge/Docs-reference-orange)](https://gardener.github.io/etcd-druid/index.html)
 
-`etcd-druid` is an [etcd](https://github.com/etcd-io/etcd) [operator](https://kubernetes.io/docs/concepts/extend-kubernetes/operator/) which makes it easy to configure, provision, reconcile, monitor and delete etcd clusters. It enables management of etcd clusters through [declarative Kubernetes API model](api/core/crds/druid.gardener.cloud_etcds.yaml). 
+`etcd-druid` is an [etcd](https://github.com/etcd-io/etcd) [operator](https://kubernetes.io/docs/concepts/extend-kubernetes/operator/) which makes it easy to configure, provision, reconcile, monitor and delete etcd clusters. It enables management of etcd clusters through [declarative Kubernetes API model](api/core/v1alpha1/crds/druid.gardener.cloud_etcds.yaml). 
 
 In every etcd cluster managed by `etcd-druid`, each etcd member is a two container `Pod` which consists of:
 
diff --git a/api/core/v1alpha1/crds/crd.go b/api/core/v1alpha1/crds/crd.go
diff --git a/api/core/v1alpha1/crds/crd_test.go b/api/core/v1alpha1/crds/crd_test.go
diff --git a/api/core/v1alpha1/crds/druid.gardener.cloud_etcdcopybackupstasks.yaml b/api/core/v1alpha1/crds/druid.gardener.cloud_etcdcopybackupstasks.yaml
diff --git a/api/core/v1alpha1/crds/druid.gardener.cloud_etcds.yaml b/api/core/v1alpha1/crds/druid.gardener.cloud_etcds.yaml
diff --git a/api/core/v1alpha1/crds/druid.gardener.cloud_etcds_without_cel.yaml b/api/core/v1alpha1/crds/druid.gardener.cloud_etcds_without_cel.yaml
diff --git a/api/hack/generate.sh b/api/hack/generate.sh
@@ -38,7 +38,7 @@ function generate_clientset() {
 }
 
 function generate_crds() {
-  local output_dir="${API_GO_MODULE_ROOT}/core/crds"
+  local output_dir="${API_GO_MODULE_ROOT}/core/v1alpha1/crds"
   local package="github.com/gardener/etcd-druid/api/core/v1alpha1"
   local package_path="$(go list -f '{{.Dir}}' "${package}")"
 
@@ -60,7 +60,7 @@ function generate_crds() {
 }
 
 function generate_crd_without_cel_expressions() {
-  local output_dir="${API_GO_MODULE_ROOT}/core/crds"
+  local output_dir="${API_GO_MODULE_ROOT}/core/v1alpha1/crds"
   local source_file="${output_dir}/druid.gardener.cloud_etcds.yaml"
   local target_file="${output_dir}/druid.gardener.cloud_etcds_without_cel.yaml"
   yq 'del(.. | select(has("x-kubernetes-validations")).x-kubernetes-validations)' "${source_file}" > "${target_file}"
@@ -88,10 +88,10 @@ function main() {
   echo "> Generate clientset for Etcd API..."
   generate_clientset
 
-  lastMd5Sum=$(getMd5Sum "${API_GO_MODULE_ROOT}/core/crds/druid.gardener.cloud_etcds.yaml")
+  lastMd5Sum=$(getMd5Sum "${API_GO_MODULE_ROOT}/core/v1alpha1/crds/druid.gardener.cloud_etcds.yaml")
   echo "> Generate CRDs..."
   generate_crds
-  latestMd5Sum=$(getMd5Sum "${API_GO_MODULE_ROOT}/core/crds/druid.gardener.cloud_etcds.yaml")
+  latestMd5Sum=$(getMd5Sum "${API_GO_MODULE_ROOT}/core/v1alpha1/crds/druid.gardener.cloud_etcds.yaml")
   if [[ ${lastMd5Sum} == ${latestMd5Sum} ]]; then
     echo "CRD file has not changed, skipping generation of CRD without CEL-validations"
     exit 0
diff --git a/docs/deployment/getting-started-locally/getting-started-locally.md b/docs/deployment/getting-started-locally/getting-started-locally.md
@@ -44,7 +44,7 @@ Prior to deploying `etcd-druid`, it can be configured via CLI-args and environme
 
 ### Deploying etcd-druid
 
-Any variant of `make deploy-*` command uses [helm](https://helm.sh/) and [skaffold](https://skaffold.dev/) to build and deploy `etcd-druid` to the target Kubernetes cluster. In addition to deploying `etcd-druid` it will also install the [Etcd CRD](https://github.com/gardener/etcd-druid/blob/master/api/core/crds/druid.gardener.cloud_etcds.yaml) and [EtcdCopyBackupTask CRD](https://github.com/gardener/etcd-druid/blob/master/api/core/crds/druid.gardener.cloud_etcdcopybackupstasks.yaml).
+Any variant of `make deploy-*` command uses [helm](https://helm.sh/) and [skaffold](https://skaffold.dev/) to build and deploy `etcd-druid` to the target Kubernetes cluster. In addition to deploying `etcd-druid` it will also install the [Etcd CRD](https://github.com/gardener/etcd-druid/blob/master/api/core/v1alpha1/crds/druid.gardener.cloud_etcds.yaml) and [EtcdCopyBackupTask CRD](https://github.com/gardener/etcd-druid/blob/master/api/core/v1alpha1/crds/druid.gardener.cloud_etcdcopybackupstasks.yaml).
 
 #### Regular mode
 
diff --git a/docs/deployment/prepare-helm-charts.md b/docs/deployment/prepare-helm-charts.md
@@ -34,7 +34,7 @@ To leverage etcd-druid helm charts you need to ensure that the charts contains t
 
 ### CRDs
 
-[Heml-3](https://helm.sh/docs/topics/charts/#custom-resource-definitions-crds) provides special status to CRDs. CRD YAML files should be placed in `crds/` directory inside of a chart. Helm will attempt to load all the files in this directory. We now generate the CRDs and keep these at `etcd-druid/api/core/crds` which serves as a single source of truth for all custom resource specifications under etcd-druid operator. These CRDs needs to be copied to `etcd-druid/charts/crds`. 
+[Heml-3](https://helm.sh/docs/topics/charts/#custom-resource-definitions-crds) provides special status to CRDs. CRD YAML files should be placed in `crds/` directory inside of a chart. Helm will attempt to load all the files in this directory. We now generate the CRDs and keep these at `etcd-druid/api/core/v1alpha1/crds` which serves as a single source of truth for all custom resource specifications under etcd-druid operator. These CRDs needs to be copied to `etcd-druid/charts/crds`. 
 
 ### PKI resources
 
diff --git a/docs/index.md b/docs/index.md
@@ -26,7 +26,7 @@
     </a>
 </p>
 
-`etcd-druid` is an [etcd](https://github.com/etcd-io/etcd) [operator](https://kubernetes.io/docs/concepts/extend-kubernetes/operator/) which makes it easy to configure, provision, reconcile, monitor and delete etcd clusters. It enables management of etcd clusters through [declarative Kubernetes API model](../api/core/crds/druid.gardener.cloud_etcds.yaml).
+`etcd-druid` is an [etcd](https://github.com/etcd-io/etcd) [operator](https://kubernetes.io/docs/concepts/extend-kubernetes/operator/) which makes it easy to configure, provision, reconcile, monitor and delete etcd clusters. It enables management of etcd clusters through [declarative Kubernetes API model](../api/core/v1alpha1/crds/druid.gardener.cloud_etcds.yaml).
 
 In every etcd cluster managed by `etcd-druid`, each etcd member is a two container `Pod` which consists of:
 
diff --git a/hack/prepare-chart-resources.sh b/hack/prepare-chart-resources.sh
@@ -118,9 +118,9 @@ function copy_crds() {
   rm -rf "${target_path}"/*
   crd_file_names=($(get_crd_file_names))
   for crd_file_name in "${crd_file_names[@]}"; do
-    local source_crd_path="${PROJECT_ROOT}/api/core/crds/${crd_file_name}"
+    local source_crd_path="${PROJECT_ROOT}/api/core/v1alpha1/crds/${crd_file_name}"
     if [ ! -f ${source_crd_path} ]; then
-      echo -e "CRD ${crd_file_name} not found in ${PROJECT_ROOT}/api/core/crds, run 'make generate' first"
+      echo -e "CRD ${crd_file_name} not found in ${PROJECT_ROOT}/api/core/v1alpha1/crds, run 'make generate' first"
       exit 1
     fi
     echo "Copying CRD ${crd_file_name} to ${target_path}"
diff --git a/test/integration/controllers/assets/assets.go b/test/integration/controllers/assets/assets.go
@@ -15,12 +15,12 @@ import (
 
 // GetEtcdCrdPath returns the path to the Etcd CRD.
 func GetEtcdCrdPath() string {
-	return filepath.Join("..", "..", "..", "..", "api", "core", "crds", "druid.gardener.cloud_etcds.yaml")
+	return filepath.Join("..", "..", "..", "..", "api", "core", "v1alpha1", "crds", "druid.gardener.cloud_etcds.yaml")
 }
 
 // GetEtcdCopyBackupsTaskCrdPath returns the path to the EtcdCopyBackupsTask CRD.
 func GetEtcdCopyBackupsTaskCrdPath() string {
-	return filepath.Join("..", "..", "..", "..", "api", "core", "crds", "druid.gardener.cloud_etcdcopybackupstasks.yaml")
+	return filepath.Join("..", "..", "..", "..", "api", "core", "v1alpha1", "crds", "druid.gardener.cloud_etcdcopybackupstasks.yaml")
 }
 
 // CreateImageVector creates an image vector.
diff --git a/test/it/assets/assets.go b/test/it/assets/assets.go
@@ -31,14 +31,14 @@ func GetK8sVersionFromEnv() (string, error) {
 // GetEtcdCrdPath returns the path to the Etcd CRD for k8s versions >= 1.29 or the path to the Etcd CRD without CEL expressions (For versions < 1.29)
 func GetEtcdCrdPath(k8sVersionAbove129 bool) string {
 	if k8sVersionAbove129 {
-		return filepath.Join("..", "..", "..", "..", "api", "core", "crds", "druid.gardener.cloud_etcds.yaml")
+		return filepath.Join("..", "..", "..", "..", "api", "core", "v1alpha1", "crds", "druid.gardener.cloud_etcds.yaml")
 	}
-	return filepath.Join("..", "..", "..", "..", "api", "core", "crds", "druid.gardener.cloud_etcds_without_cel.yaml")
+	return filepath.Join("..", "..", "..", "..", "api", "core", "v1alpha1", "crds", "druid.gardener.cloud_etcds_without_cel.yaml")
 }
 
 // GetEtcdCopyBackupsTaskCrdPath returns the path to the EtcdCopyBackupsTask CRD.
 func GetEtcdCopyBackupsTaskCrdPath() string {
-	return filepath.Join("..", "..", "..", "..", "api", "core", "crds", "druid.gardener.cloud_etcdcopybackupstasks.yaml")
+	return filepath.Join("..", "..", "..", "..", "api", "core", "v1alpha1", "crds", "druid.gardener.cloud_etcdcopybackupstasks.yaml")
 }
 
 // CreateImageVector creates an image vector.
diff --git a/test/it/controller/etcd/reconciler_test.go b/test/it/controller/etcd/reconciler_test.go
@@ -11,8 +11,8 @@ import (
 	"testing"
 	"time"
 
-	"github.com/gardener/etcd-druid/api/core/crds"
 	druidv1alpha1 "github.com/gardener/etcd-druid/api/core/v1alpha1"
+	"github.com/gardener/etcd-druid/api/core/v1alpha1/crds"
 	"github.com/gardener/etcd-druid/internal/common"
 	"github.com/gardener/etcd-druid/internal/component"
 	"github.com/gardener/etcd-druid/internal/utils/kubernetes"
diff --git a/test/it/crdvalidation/etcd/validation_test.go b/test/it/crdvalidation/etcd/validation_test.go
@@ -9,7 +9,7 @@ import (
 	"os"
 	"testing"
 
-	"github.com/gardener/etcd-druid/api/core/crds"
+	"github.com/gardener/etcd-druid/api/core/v1alpha1/crds"
 	"github.com/gardener/etcd-druid/test/it/assets"
 	"github.com/gardener/etcd-druid/test/it/setup"
 )

Original file line number	Diff line number	Diff line change
`@@ -15,12 +15,12 @@ import (`
`15`	`15`
`16`	`16`	`// GetEtcdCrdPath returns the path to the Etcd CRD.`
`17`	`17`	`func GetEtcdCrdPath() string {`
`18`		`- return filepath.Join("..", "..", "..", "..", "api", "core", "crds", "druid.gardener.cloud_etcds.yaml")`
	`18`	`+ return filepath.Join("..", "..", "..", "..", "api", "core", "v1alpha1", "crds", "druid.gardener.cloud_etcds.yaml")`
`19`	`19`	`}`
`20`	`20`
`21`	`21`	`// GetEtcdCopyBackupsTaskCrdPath returns the path to the EtcdCopyBackupsTask CRD.`
`22`	`22`	`func GetEtcdCopyBackupsTaskCrdPath() string {`
`23`		`- return filepath.Join("..", "..", "..", "..", "api", "core", "crds", "druid.gardener.cloud_etcdcopybackupstasks.yaml")`
	`23`	`+ return filepath.Join("..", "..", "..", "..", "api", "core", "v1alpha1", "crds", "druid.gardener.cloud_etcdcopybackupstasks.yaml")`
`24`	`24`	`}`
`25`	`25`
`26`	`26`	`// CreateImageVector creates an image vector.`
Original file line number	Diff line number	Diff line change
`@@ -31,14 +31,14 @@ func GetK8sVersionFromEnv() (string, error) {`
`31`	`31`	`// GetEtcdCrdPath returns the path to the Etcd CRD for k8s versions >= 1.29 or the path to the Etcd CRD without CEL expressions (For versions < 1.29)`
`32`	`32`	`func GetEtcdCrdPath(k8sVersionAbove129 bool) string {`
`33`	`33`	`if k8sVersionAbove129 {`
`34`		`- return filepath.Join("..", "..", "..", "..", "api", "core", "crds", "druid.gardener.cloud_etcds.yaml")`
	`34`	`+ return filepath.Join("..", "..", "..", "..", "api", "core", "v1alpha1", "crds", "druid.gardener.cloud_etcds.yaml")`
`35`	`35`	`}`
`36`		`- return filepath.Join("..", "..", "..", "..", "api", "core", "crds", "druid.gardener.cloud_etcds_without_cel.yaml")`
	`36`	`+ return filepath.Join("..", "..", "..", "..", "api", "core", "v1alpha1", "crds", "druid.gardener.cloud_etcds_without_cel.yaml")`
`37`	`37`	`}`
`38`	`38`
`39`	`39`	`// GetEtcdCopyBackupsTaskCrdPath returns the path to the EtcdCopyBackupsTask CRD.`
`40`	`40`	`func GetEtcdCopyBackupsTaskCrdPath() string {`
`41`		`- return filepath.Join("..", "..", "..", "..", "api", "core", "crds", "druid.gardener.cloud_etcdcopybackupstasks.yaml")`
	`41`	`+ return filepath.Join("..", "..", "..", "..", "api", "core", "v1alpha1", "crds", "druid.gardener.cloud_etcdcopybackupstasks.yaml")`
`42`	`42`	`}`
`43`	`43`
`44`	`44`	`// CreateImageVector creates an image vector.`
Original file line number	Diff line number	Diff line change
`@@ -9,7 +9,7 @@ import (`
`9`	`9`	`"os"`
`10`	`10`	`"testing"`
`11`	`11`
`12`		`- "github.com/gardener/etcd-druid/api/core/crds"`
	`12`	`+ "github.com/gardener/etcd-druid/api/core/v1alpha1/crds"`
`13`	`13`	`"github.com/gardener/etcd-druid/test/it/assets"`
`14`	`14`	`"github.com/gardener/etcd-druid/test/it/setup"`
`15`	`15`	`)`