KEP-2170: Generate CRDs for v2 CRDs

Signed-off-by: Yuki Iwai <[email protected]>
kubeflow · Aug 28, 2024 · efa6c8d · efa6c8d
1 parent ea5272f
commit efa6c8d
Show file tree

Hide file tree

Showing 32 changed files with 21,672 additions and 26 deletions.
diff --git a/Makefile b/Makefile
@@ -38,9 +38,11 @@ help: ## Display this help.
 
 manifests: controller-gen ## Generate WebhookConfiguration, ClusterRole and CustomResourceDefinition objects.
 	$(CONTROLLER_GEN) $(CRD_OPTIONS) rbac:roleName=training-operator webhook paths="./pkg/apis/kubeflow.org/v1/..." \
-		output:crd:artifacts:config=manifests/base/crds \
-		output:rbac:artifacts:config=manifests/base/rbac \
-		output:webhook:artifacts:config=manifests/base/webhook
+		output:crd:artifacts:config=manifests/base/v1/crds \
+		output:rbac:artifacts:config=manifests/base/v1/rbac \
+		output:webhook:artifacts:config=manifests/v1/base/webhook
+	$(CONTROLLER_GEN) "crd:generateEmbeddedObjectMeta=true" paths="./pkg/apis/kubeflow.org/v2alpha1/..." \
+		output:crd:artifacts:config=manifests/base/v2alpha1/crds
 
 generate: controller-gen ## Generate apidoc, sdk and code containing DeepCopy, DeepCopyInto, and DeepCopyObject method implementations.
 	$(CONTROLLER_GEN) object:headerFile="hack/boilerplate/boilerplate.go.txt" paths="./pkg/apis/..."
@@ -95,10 +97,10 @@ docker-push: ## Push docker image with the manager.
 ##@ Deployment
 
 install: manifests kustomize ## Install CRDs into the K8s cluster specified in ~/.kube/config.
-	$(KUSTOMIZE) build manifests/base/crds | kubectl apply -f -
+	$(KUSTOMIZE) build manifests/base/v1/crds | kubectl apply -f -
 
 uninstall: manifests kustomize ## Uninstall CRDs from the K8s cluster specified in ~/.kube/config.
-	$(KUSTOMIZE) build manifests/base/crds | kubectl delete -f -
+	$(KUSTOMIZE) build manifests/base/v1/crds | kubectl delete -f -
 
 deploy: manifests kustomize ## Deploy controller to the K8s cluster specified in ~/.kube/config.
 	cd manifests/overlays/standalone && $(KUSTOMIZE) edit set image kubeflow/training-operator=${IMG}

diff --git a/manifests/base/kustomization.yaml b/manifests/base/kustomization.yaml
diff --git a/...fests/base/crds/kubeflow.org_jaxjobs.yaml → ...ts/base/v1/crds/kubeflow.org_jaxjobs.yaml b/...fests/base/crds/kubeflow.org_jaxjobs.yaml → ...ts/base/v1/crds/kubeflow.org_jaxjobs.yaml
diff --git a/...fests/base/crds/kubeflow.org_mpijobs.yaml → ...ts/base/v1/crds/kubeflow.org_mpijobs.yaml b/...fests/base/crds/kubeflow.org_mpijobs.yaml → ...ts/base/v1/crds/kubeflow.org_mpijobs.yaml
diff --git a/...ts/base/crds/kubeflow.org_paddlejobs.yaml → ...base/v1/crds/kubeflow.org_paddlejobs.yaml b/...ts/base/crds/kubeflow.org_paddlejobs.yaml → ...base/v1/crds/kubeflow.org_paddlejobs.yaml
diff --git a/...s/base/crds/kubeflow.org_pytorchjobs.yaml → ...ase/v1/crds/kubeflow.org_pytorchjobs.yaml b/...s/base/crds/kubeflow.org_pytorchjobs.yaml → ...ase/v1/crds/kubeflow.org_pytorchjobs.yaml
diff --git a/manifests/base/crds/kubeflow.org_tfjobs.yaml → ...sts/base/v1/crds/kubeflow.org_tfjobs.yaml b/manifests/base/crds/kubeflow.org_tfjobs.yaml → ...sts/base/v1/crds/kubeflow.org_tfjobs.yaml
diff --git a/...s/base/crds/kubeflow.org_xgboostjobs.yaml → ...ase/v1/crds/kubeflow.org_xgboostjobs.yaml b/...s/base/crds/kubeflow.org_xgboostjobs.yaml → ...ase/v1/crds/kubeflow.org_xgboostjobs.yaml
diff --git a/manifests/base/crds/kustomization.yaml → manifests/base/v1/crds/kustomization.yaml b/manifests/base/crds/kustomization.yaml → manifests/base/v1/crds/kustomization.yaml
diff --git a/manifests/base/deployment.yaml → manifests/base/v1/deployment.yaml b/manifests/base/deployment.yaml → manifests/base/v1/deployment.yaml
diff --git a/manifests/base/v1/kustomization.yaml b/manifests/base/v1/kustomization.yaml
@@ -0,0 +1,10 @@
+apiVersion: kustomize.config.k8s.io/v1beta1
+kind: Kustomization
+resources:
+  - crds
+  - rbac/cluster-role-binding.yaml
+  - rbac/role.yaml
+  - rbac/service-account.yaml
+  - webhook
+  - service.yaml
+  - deployment.yaml
diff --git a/...fests/base/rbac/cluster-role-binding.yaml → ...ts/base/v1/rbac/cluster-role-binding.yaml b/...fests/base/rbac/cluster-role-binding.yaml → ...ts/base/v1/rbac/cluster-role-binding.yaml
diff --git a/manifests/base/rbac/role.yaml → manifests/base/v1/rbac/role.yaml b/manifests/base/rbac/role.yaml → manifests/base/v1/rbac/role.yaml
diff --git a/manifests/base/rbac/service-account.yaml → manifests/base/v1/rbac/service-account.yaml b/manifests/base/rbac/service-account.yaml → manifests/base/v1/rbac/service-account.yaml
diff --git a/manifests/base/service.yaml → manifests/base/v1/service.yaml b/manifests/base/service.yaml → manifests/base/v1/service.yaml
diff --git a/manifests/base/webhook/kustomization.yaml → manifests/base/v1/webhook/kustomization.yaml b/manifests/base/webhook/kustomization.yaml → manifests/base/v1/webhook/kustomization.yaml
diff --git a/manifests/base/webhook/kustomizeconfig.yaml → ...ests/base/v1/webhook/kustomizeconfig.yaml b/manifests/base/webhook/kustomizeconfig.yaml → ...ests/base/v1/webhook/kustomizeconfig.yaml
diff --git a/manifests/base/webhook/manifests.yaml → manifests/base/v1/webhook/manifests.yaml b/manifests/base/webhook/manifests.yaml → manifests/base/v1/webhook/manifests.yaml
diff --git a/manifests/base/webhook/patch.yaml → manifests/base/v1/webhook/patch.yaml b/manifests/base/webhook/patch.yaml → manifests/base/v1/webhook/patch.yaml
diff --git a/manifests/base/v2alpha1/crds/kubeflow.org_clustertrainingruntimes.yaml b/manifests/base/v2alpha1/crds/kubeflow.org_clustertrainingruntimes.yaml
diff --git a/manifests/base/v2alpha1/crds/kubeflow.org_trainingruntimes.yaml b/manifests/base/v2alpha1/crds/kubeflow.org_trainingruntimes.yaml
diff --git a/manifests/base/v2alpha1/crds/kubeflow.org_trainjobs.yaml b/manifests/base/v2alpha1/crds/kubeflow.org_trainjobs.yaml
diff --git a/manifests/base/v2alpha1/crds/kustomization.yaml b/manifests/base/v2alpha1/crds/kustomization.yaml
@@ -0,0 +1,6 @@
+apiVersion: kustomize.config.k8s.io/v1beta1
+kind: Kustomization
+resources:
+- kubeflow.org_clustertrainingruntimes.yaml
+- kubeflow.org_trainingruntimes.yaml
+- kubeflow.org_trainjobs.yaml
diff --git a/manifests/overlays/kubeflow/kustomization.yaml b/manifests/overlays/kubeflow/kustomization.yaml
@@ -2,7 +2,7 @@ apiVersion: kustomize.config.k8s.io/v1beta1
 kind: Kustomization
 namespace: kubeflow
 resources:
-  - ../../base
+  - ../../base/v1
   - kubeflow-training-roles.yaml
 images:
   - name: kubeflow/training-operator

diff --git a/manifests/overlays/standalone/kustomization.yaml b/manifests/overlays/standalone/kustomization.yaml
@@ -2,7 +2,7 @@ apiVersion: kustomize.config.k8s.io/v1beta1
 kind: Kustomization
 namespace: kubeflow
 resources:
-  - ../../base
+  - ../../base/v1
   - namespace.yaml
 images:
   - name: kubeflow/training-operator

diff --git a/pkg/apis/kubeflow.org/v2alpha1/trainingruntime_types.go b/pkg/apis/kubeflow.org/v2alpha1/trainingruntime_types.go
@@ -23,6 +23,8 @@ import (
 )
 
 // +kubebuilder:object:root=true
+// +kubebuilder:storageversion
+// +kubebuilder:resource:scope=Cluster
 
 // ClusterTrainingRuntime represents a training runtime which can be referenced as part of
 // `trainingRuntimeRef` API in TrainJob. This resource is a cluster-scoped and can be referenced
@@ -51,6 +53,7 @@ type ClusterTrainingRuntimeList struct {
 }
 
 // +kubebuilder:object:root=true
+// +kubebuilder:storageversion
 
 // TrainingRuntime represents a training runtime which can be referenced as part of
 // `trainingRuntimeRef` API in TrainJob. This resource is a namespaced-scoped and can be referenced

diff --git a/pkg/apis/kubeflow.org/v2alpha1/trainjob_types.go b/pkg/apis/kubeflow.org/v2alpha1/trainjob_types.go
@@ -24,6 +24,7 @@ import (
 
 // +kubebuilder:object:root=true
 // +kubebuilder:subresource:status
+// +kubebuilder:storageversion
 // +kubebuilder:printcolumn:name="State",type=string,JSONPath=`.status.conditions[-1:].type`
 // +kubebuilder:printcolumn:name="Age",type=date,JSONPath=`.metadata.creationTimestamp`
 

diff --git a/pkg/controller.v1/mpi/suite_test.go b/pkg/controller.v1/mpi/suite_test.go
@@ -60,7 +60,7 @@ var _ = BeforeSuite(func() {
 
 	By("bootstrapping test environment")
 	testEnv = &envtest.Environment{
-		CRDDirectoryPaths:     []string{filepath.Join("..", "..", "..", "manifests", "base", "crds")},
+		CRDDirectoryPaths:     []string{filepath.Join("..", "..", "..", "manifests", "base", "v1", "crds")},
 		ErrorIfCRDPathMissing: true,
 	}
 

diff --git a/pkg/controller.v1/paddlepaddle/paddlepaddle_controller_suite_test.go b/pkg/controller.v1/paddlepaddle/paddlepaddle_controller_suite_test.go
@@ -64,10 +64,10 @@ var _ = BeforeSuite(func() {
 
 	By("bootstrapping test environment")
 	testEnv = &envtest.Environment{
-		CRDDirectoryPaths:     []string{filepath.Join("..", "..", "..", "manifests", "base", "crds")},
+		CRDDirectoryPaths:     []string{filepath.Join("..", "..", "..", "manifests", "base", "v1", "crds")},
 		ErrorIfCRDPathMissing: true,
 		WebhookInstallOptions: envtest.WebhookInstallOptions{
-			Paths: []string{filepath.Join("..", "..", "..", "manifests", "base", "webhook", "manifests.yaml")},
+			Paths: []string{filepath.Join("..", "..", "..", "manifests", "base", "v1", "webhook", "manifests.yaml")},
 		},
 	}
 

diff --git a/pkg/controller.v1/pytorch/pytorchjob_controller_suite_test.go b/pkg/controller.v1/pytorch/pytorchjob_controller_suite_test.go
@@ -65,10 +65,10 @@ var _ = BeforeSuite(func() {
 
 	By("bootstrapping test environment")
 	testEnv = &envtest.Environment{
-		CRDDirectoryPaths:     []string{filepath.Join("..", "..", "..", "manifests", "base", "crds")},
+		CRDDirectoryPaths:     []string{filepath.Join("..", "..", "..", "manifests", "base", "v1", "crds")},
 		ErrorIfCRDPathMissing: true,
 		WebhookInstallOptions: envtest.WebhookInstallOptions{
-			Paths: []string{filepath.Join("..", "..", "..", "manifests", "base", "webhook", "manifests.yaml")},
+			Paths: []string{filepath.Join("..", "..", "..", "manifests", "base", "v1", "webhook", "manifests.yaml")},
 		},
 	}
 

diff --git a/pkg/controller.v1/tensorflow/suite_test.go b/pkg/controller.v1/tensorflow/suite_test.go
@@ -67,10 +67,10 @@ var _ = BeforeSuite(func() {
 
 	By("bootstrapping test environment")
 	testEnv = &envtest.Environment{
-		CRDDirectoryPaths:     []string{filepath.Join("..", "..", "..", "manifests", "base", "crds")},
+		CRDDirectoryPaths:     []string{filepath.Join("..", "..", "..", "manifests", "base", "v1", "crds")},
 		ErrorIfCRDPathMissing: true,
 		WebhookInstallOptions: envtest.WebhookInstallOptions{
-			Paths: []string{filepath.Join("..", "..", "..", "manifests", "base", "webhook", "manifests.yaml")},
+			Paths: []string{filepath.Join("..", "..", "..", "manifests", "base", "v1", "webhook", "manifests.yaml")},
 		},
 	}
 

diff --git a/pkg/controller.v1/xgboost/suite_test.go b/pkg/controller.v1/xgboost/suite_test.go
@@ -64,10 +64,10 @@ var _ = BeforeSuite(func() {
 
 	By("bootstrapping test environment")
 	testEnv = &envtest.Environment{
-		CRDDirectoryPaths:     []string{filepath.Join("..", "..", "..", "manifests", "base", "crds")},
+		CRDDirectoryPaths:     []string{filepath.Join("..", "..", "..", "manifests", "base", "v1", "crds")},
 		ErrorIfCRDPathMissing: true,
 		WebhookInstallOptions: envtest.WebhookInstallOptions{
-			Paths: []string{filepath.Join("..", "..", "..", "manifests", "base", "webhook", "manifests.yaml")},
+			Paths: []string{filepath.Join("..", "..", "..", "manifests", "base", "v1", "webhook", "manifests.yaml")},
 		},
 	}