Merge pull request #128 from erikgb/deprecate-v1

chore: deprecate v1 and v2alpha1 SubNamespace API
cybozu-go · Jul 5, 2024 · 4b22f41 · 4b22f41
2 parents 8ccf25a + c351e25
commit 4b22f41
Show file tree

Hide file tree

Showing 5 changed files with 34 additions and 10 deletions.
diff --git a/api/accurate/v1/subnamespace_types.go b/api/accurate/v1/subnamespace_types.go
@@ -28,8 +28,10 @@ type SubNamespaceSpec struct {
 }
 
 //+kubebuilder:object:root=true
+//+kubebuilder:deprecatedversion:warning="The v1 version of SubNamespace has been deprecated and will be removed in a future release of the API. Please upgrade."
 
 // SubNamespace is the Schema for the subnamespaces API
+// Deprecated: This type will be removed in one of the next releases.
 type SubNamespace struct {
 	metav1.TypeMeta   `json:",inline"`
 	metav1.ObjectMeta `json:"metadata,omitempty"`
@@ -46,6 +48,7 @@ type SubNamespace struct {
 //+kubebuilder:object:root=true
 
 // SubNamespaceList contains a list of SubNamespace
+// Deprecated: This type will be removed in one of the next releases.
 type SubNamespaceList struct {
 	metav1.TypeMeta `json:",inline"`
 	metav1.ListMeta `json:"metadata,omitempty"`

diff --git a/api/accurate/v2alpha1/subnamespace_types.go b/api/accurate/v2alpha1/subnamespace_types.go
@@ -32,10 +32,12 @@ type SubNamespaceSpec struct {
 }
 
 //+kubebuilder:object:root=true
+//+kubebuilder:deprecatedversion:warning="The v2alpha1 version of SubNamespace has been deprecated and will be removed in a future release of the API. Please upgrade."
 //+kubebuilder:subresource:status
 //+genclient
 
 // SubNamespace is the Schema for the subnamespaces API
+// Deprecated: This type will be removed in one of the next releases.
 type SubNamespace struct {
 	metav1.TypeMeta   `json:",inline"`
 	metav1.ObjectMeta `json:"metadata,omitempty"`
@@ -52,6 +54,7 @@ type SubNamespace struct {
 //+kubebuilder:object:root=true
 
 // SubNamespaceList contains a list of SubNamespace
+// Deprecated: This type will be removed in one of the next releases.
 type SubNamespaceList struct {
 	metav1.TypeMeta `json:",inline"`
 	metav1.ListMeta `json:"metadata,omitempty"`

diff --git a/charts/accurate/templates/generated/crds.yaml b/charts/accurate/templates/generated/crds.yaml
diff --git a/config/crd/bases/accurate.cybozu.com_subnamespaces.yaml b/config/crd/bases/accurate.cybozu.com_subnamespaces.yaml
diff --git a/docs/crd_subnamespace.md b/docs/crd_subnamespace.md