fix: allow konnectID on ControlPlaneRef but disallow where unsupported

Kong · Jan 22, 2025 · fbfd68d · fbfd68d
1 parent b97af14
commit fbfd68d
Show file tree

Hide file tree

Showing 30 changed files with 76 additions and 2 deletions.
diff --git a/api/configuration/v1/kongconsumer_types.go b/api/configuration/v1/kongconsumer_types.go
@@ -76,6 +76,7 @@ type KongConsumer struct {
 type KongConsumerSpec struct {
 	// ControlPlaneRef is a reference to a ControlPlane this Consumer is associated with.
 	// +optional
+	// +kubebuilder:validation:XValidation:rule="!has(self.type) || self.type != 'konnectID'", message="konnectID type is not supported"
 	ControlPlaneRef *configurationv1alpha1.ControlPlaneRef `json:"controlPlaneRef,omitempty"`
 
 	// Tags is an optional set of tags applied to the consumer.

diff --git a/api/configuration/v1alpha1/controlplaneref_types.go b/api/configuration/v1alpha1/controlplaneref_types.go
@@ -31,6 +31,8 @@ type ControlPlaneRef struct {
 	// - kic
 	//
 	// The default is kic, which implies that the Control Plane is KIC.
+	// KonnectID might not be available for all the resources.
+	// Consult the specific resource documentation for more information.
 	//
 	// +kubebuilder:validation:Enum=konnectID;konnectNamespacedRef;kic
 	// +kubebuilder:default:=kic

diff --git a/api/configuration/v1alpha1/kong_ca_certificate.go b/api/configuration/v1alpha1/kong_ca_certificate.go
@@ -37,6 +37,7 @@ type KongCACertificate struct {
 type KongCACertificateSpec struct {
 	// ControlPlaneRef references the Konnect Control Plane that this KongCACertificate should be created in.
 	// +kubebuilder:validation:Required
+	// +kubebuilder:validation:XValidation:rule="!has(self.type) || self.type != 'konnectID'", message="konnectID type is not supported"
 	ControlPlaneRef *ControlPlaneRef `json:"controlPlaneRef"`
 
 	KongCACertificateAPISpec `json:",inline"`

diff --git a/api/configuration/v1alpha1/kong_certificate.go b/api/configuration/v1alpha1/kong_certificate.go
@@ -37,6 +37,7 @@ type KongCertificate struct {
 type KongCertificateSpec struct {
 	// ControlPlaneRef references the Konnect Control Plane that this KongCertificate should be created in.
 	// +kubebuilder:validation:Required
+	// +kubebuilder:validation:XValidation:rule="!has(self.type) || self.type != 'konnectID'", message="konnectID type is not supported"
 	ControlPlaneRef *ControlPlaneRef `json:"controlPlaneRef"`
 
 	KongCertificateAPISpec `json:",inline"`

diff --git a/api/configuration/v1alpha1/kong_vault_types.go b/api/configuration/v1alpha1/kong_vault_types.go
@@ -79,6 +79,7 @@ type KongVaultSpec struct {
 	Tags common.Tags `json:"tags,omitempty"`
 	// ControlPlaneRef is a reference to a Konnect ControlPlane this KongVault is associated with.
 	// +optional
+	// +kubebuilder:validation:XValidation:rule="!has(self.type) || self.type != 'konnectID'", message="konnectID type is not supported"
 	ControlPlaneRef *ControlPlaneRef `json:"controlPlaneRef,omitempty"`
 }
 

diff --git a/api/configuration/v1alpha1/kongdataplaneclientcertificate_types.go b/api/configuration/v1alpha1/kongdataplaneclientcertificate_types.go
@@ -53,6 +53,7 @@ type KongDataPlaneClientCertificate struct {
 type KongDataPlaneClientCertificateSpec struct {
 	// ControlPlaneRef is a reference to a Konnect ControlPlane this KongDataPlaneClientCertificate is associated with.
 	// +kubebuilder:validation:Required
+	// +kubebuilder:validation:XValidation:rule="!has(self.type) || self.type != 'konnectID'", message="konnectID type is not supported"
 	ControlPlaneRef *ControlPlaneRef `json:"controlPlaneRef"`
 
 	// KongDataPlaneClientCertificateAPISpec are the attributes of the KongDataPlaneClientCertificate itself.

diff --git a/api/configuration/v1alpha1/kongkey_types.go b/api/configuration/v1alpha1/kongkey_types.go
@@ -53,6 +53,7 @@ type KongKey struct {
 type KongKeySpec struct {
 	// ControlPlaneRef is a reference to a Konnect ControlPlane this KongKey is associated with.
 	// +optional
+	// +kubebuilder:validation:XValidation:rule="!has(self.type) || self.type != 'konnectID'", message="konnectID type is not supported"
 	ControlPlaneRef *ControlPlaneRef `json:"controlPlaneRef,omitempty"`
 
 	// KeySetRef is a reference to a KongKeySet this KongKey is attached to.

diff --git a/api/configuration/v1alpha1/kongkeyset_types.go b/api/configuration/v1alpha1/kongkeyset_types.go
@@ -52,6 +52,7 @@ type KongKeySet struct {
 type KongKeySetSpec struct {
 	// ControlPlaneRef is a reference to a Konnect ControlPlane with which KongKeySet is associated.
 	// +kubebuilder:validation:Required
+	// +kubebuilder:validation:XValidation:rule="!has(self.type) || self.type != 'konnectID'", message="konnectID type is not supported"
 	ControlPlaneRef *ControlPlaneRef `json:"controlPlaneRef"`
 
 	// KongKeySetAPISpec are the attributes of the KongKeySet itself.

diff --git a/api/configuration/v1alpha1/kongpluginbinding_types.go b/api/configuration/v1alpha1/kongpluginbinding_types.go
@@ -80,6 +80,7 @@ type KongPluginBindingSpec struct {
 
 	// ControlPlaneRef is a reference to a ControlPlane this KongPluginBinding is associated with.
 	// +optional
+	// +kubebuilder:validation:XValidation:rule="!has(self.type) || self.type != 'konnectID'", message="konnectID type is not supported"
 	ControlPlaneRef *ControlPlaneRef `json:"controlPlaneRef,omitempty"`
 }
 

diff --git a/api/configuration/v1alpha1/kongroute_types.go b/api/configuration/v1alpha1/kongroute_types.go
@@ -63,6 +63,7 @@ type KongRouteSpec struct {
 	// Route can either specify a ControlPlaneRef and be 'serviceless' route or
 	// specify a ServiceRef and be associated with a Service.
 	// +optional
+	// +kubebuilder:validation:XValidation:rule="!has(self.type) || self.type != 'konnectID'", message="konnectID type is not supported"
 	ControlPlaneRef *ControlPlaneRef `json:"controlPlaneRef,omitempty"`
 	// ServiceRef is a reference to a Service this KongRoute is associated with.
 	// Route can either specify a ControlPlaneRef and be 'serviceless' route or

diff --git a/api/configuration/v1alpha1/kongservice_types.go b/api/configuration/v1alpha1/kongservice_types.go
@@ -57,6 +57,7 @@ type KongService struct {
 type KongServiceSpec struct {
 	// ControlPlaneRef is a reference to a ControlPlane this KongService is associated with.
 	// +kubebuilder:validation:Required
+	// +kubebuilder:validation:XValidation:rule="!has(self.type) || self.type != 'konnectID'", message="konnectID type is not supported"
 	ControlPlaneRef *ControlPlaneRef `json:"controlPlaneRef"`
 
 	KongServiceAPISpec `json:",inline"`

diff --git a/api/configuration/v1alpha1/kongupstream_types.go b/api/configuration/v1alpha1/kongupstream_types.go
@@ -55,6 +55,7 @@ type KongUpstream struct {
 type KongUpstreamSpec struct {
 	// ControlPlaneRef is a reference to a ControlPlane this KongUpstream is associated with.
 	// +kubebuilder:validation:Required
+	// +kubebuilder:validation:XValidation:rule="!has(self.type) || self.type != 'konnectID'", message="konnectID type is not supported"
 	ControlPlaneRef *ControlPlaneRef `json:"controlPlaneRef"`
 
 	KongUpstreamAPISpec `json:",inline"`

diff --git a/api/configuration/v1beta1/kongconsumergroup_types.go b/api/configuration/v1beta1/kongconsumergroup_types.go
@@ -59,6 +59,7 @@ type KongConsumerGroupSpec struct {
 
 	// ControlPlaneRef is a reference to a ControlPlane this ConsumerGroup is associated with.
 	// +optional
+	// +kubebuilder:validation:XValidation:rule="!has(self.type) || self.type != 'konnectID'", message="konnectID type is not supported"
 	ControlPlaneRef *configurationv1alpha1.ControlPlaneRef `json:"controlPlaneRef,omitempty"`
 
 	// Tags is an optional set of tags applied to the ConsumerGroup.

diff --git a/config/crd/gateway-operator/configuration.konghq.com_kongcacertificates.yaml b/config/crd/gateway-operator/configuration.konghq.com_kongcacertificates.yaml
@@ -85,13 +85,17 @@ spec:
                       - kic
 
                       The default is kic, which implies that the Control Plane is KIC.
+                      KonnectID might not be available for all the resources.
+                      Consult the specific resource documentation for more information.
                     enum:
                     - konnectID
                     - konnectNamespacedRef
                     - kic
                     type: string
                 type: object
                 x-kubernetes-validations:
+                - message: konnectID type is not supported
+                  rule: '!has(self.type) || self.type != ''konnectID'''
                 - message: when type is konnectNamespacedRef, konnectNamespacedRef
                     must be set
                   rule: '(has(self.type) && self.type == ''konnectNamespacedRef'')

diff --git a/config/crd/gateway-operator/configuration.konghq.com_kongcertificates.yaml b/config/crd/gateway-operator/configuration.konghq.com_kongcertificates.yaml
@@ -91,13 +91,17 @@ spec:
                       - kic
 
                       The default is kic, which implies that the Control Plane is KIC.
+                      KonnectID might not be available for all the resources.
+                      Consult the specific resource documentation for more information.
                     enum:
                     - konnectID
                     - konnectNamespacedRef
                     - kic
                     type: string
                 type: object
                 x-kubernetes-validations:
+                - message: konnectID type is not supported
+                  rule: '!has(self.type) || self.type != ''konnectID'''
                 - message: when type is konnectNamespacedRef, konnectNamespacedRef
                     must be set
                   rule: '(has(self.type) && self.type == ''konnectNamespacedRef'')

diff --git a/config/crd/gateway-operator/configuration.konghq.com_kongconsumergroups.yaml b/config/crd/gateway-operator/configuration.konghq.com_kongconsumergroups.yaml
@@ -87,13 +87,17 @@ spec:
                       - kic
 
                       The default is kic, which implies that the Control Plane is KIC.
+                      KonnectID might not be available for all the resources.
+                      Consult the specific resource documentation for more information.
                     enum:
                     - konnectID
                     - konnectNamespacedRef
                     - kic
                     type: string
                 type: object
                 x-kubernetes-validations:
+                - message: konnectID type is not supported
+                  rule: '!has(self.type) || self.type != ''konnectID'''
                 - message: when type is konnectNamespacedRef, konnectNamespacedRef
                     must be set
                   rule: '(has(self.type) && self.type == ''konnectNamespacedRef'')

diff --git a/config/crd/gateway-operator/configuration.konghq.com_kongconsumers.yaml b/config/crd/gateway-operator/configuration.konghq.com_kongconsumers.yaml
@@ -112,13 +112,17 @@ spec:
                       - kic
 
                       The default is kic, which implies that the Control Plane is KIC.
+                      KonnectID might not be available for all the resources.
+                      Consult the specific resource documentation for more information.
                     enum:
                     - konnectID
                     - konnectNamespacedRef
                     - kic
                     type: string
                 type: object
                 x-kubernetes-validations:
+                - message: konnectID type is not supported
+                  rule: '!has(self.type) || self.type != ''konnectID'''
                 - message: when type is konnectNamespacedRef, konnectNamespacedRef
                     must be set
                   rule: '(has(self.type) && self.type == ''konnectNamespacedRef'')

diff --git a/config/crd/gateway-operator/configuration.konghq.com_kongdataplaneclientcertificates.yaml b/config/crd/gateway-operator/configuration.konghq.com_kongdataplaneclientcertificates.yaml
@@ -87,13 +87,17 @@ spec:
                       - kic
 
                       The default is kic, which implies that the Control Plane is KIC.
+                      KonnectID might not be available for all the resources.
+                      Consult the specific resource documentation for more information.
                     enum:
                     - konnectID
                     - konnectNamespacedRef
                     - kic
                     type: string
                 type: object
                 x-kubernetes-validations:
+                - message: konnectID type is not supported
+                  rule: '!has(self.type) || self.type != ''konnectID'''
                 - message: when type is konnectNamespacedRef, konnectNamespacedRef
                     must be set
                   rule: '(has(self.type) && self.type == ''konnectNamespacedRef'')

diff --git a/config/crd/gateway-operator/configuration.konghq.com_kongkeys.yaml b/config/crd/gateway-operator/configuration.konghq.com_kongkeys.yaml
@@ -81,13 +81,17 @@ spec:
                       - kic
 
                       The default is kic, which implies that the Control Plane is KIC.
+                      KonnectID might not be available for all the resources.
+                      Consult the specific resource documentation for more information.
                     enum:
                     - konnectID
                     - konnectNamespacedRef
                     - kic
                     type: string
                 type: object
                 x-kubernetes-validations:
+                - message: konnectID type is not supported
+                  rule: '!has(self.type) || self.type != ''konnectID'''
                 - message: when type is konnectNamespacedRef, konnectNamespacedRef
                     must be set
                   rule: '(has(self.type) && self.type == ''konnectNamespacedRef'')

diff --git a/config/crd/gateway-operator/configuration.konghq.com_kongkeysets.yaml b/config/crd/gateway-operator/configuration.konghq.com_kongkeysets.yaml
@@ -81,13 +81,17 @@ spec:
                       - kic
 
                       The default is kic, which implies that the Control Plane is KIC.
+                      KonnectID might not be available for all the resources.
+                      Consult the specific resource documentation for more information.
                     enum:
                     - konnectID
                     - konnectNamespacedRef
                     - kic
                     type: string
                 type: object
                 x-kubernetes-validations:
+                - message: konnectID type is not supported
+                  rule: '!has(self.type) || self.type != ''konnectID'''
                 - message: when type is konnectNamespacedRef, konnectNamespacedRef
                     must be set
                   rule: '(has(self.type) && self.type == ''konnectNamespacedRef'')

diff --git a/config/crd/gateway-operator/configuration.konghq.com_kongpluginbindings.yaml b/config/crd/gateway-operator/configuration.konghq.com_kongpluginbindings.yaml
@@ -89,13 +89,17 @@ spec:
                       - kic
 
                       The default is kic, which implies that the Control Plane is KIC.
+                      KonnectID might not be available for all the resources.
+                      Consult the specific resource documentation for more information.
                     enum:
                     - konnectID
                     - konnectNamespacedRef
                     - kic
                     type: string
                 type: object
                 x-kubernetes-validations:
+                - message: konnectID type is not supported
+                  rule: '!has(self.type) || self.type != ''konnectID'''
                 - message: when type is konnectNamespacedRef, konnectNamespacedRef
                     must be set
                   rule: '(has(self.type) && self.type == ''konnectNamespacedRef'')

diff --git a/config/crd/gateway-operator/configuration.konghq.com_kongroutes.yaml b/config/crd/gateway-operator/configuration.konghq.com_kongroutes.yaml
@@ -82,13 +82,17 @@ spec:
                       - kic
 
                       The default is kic, which implies that the Control Plane is KIC.
+                      KonnectID might not be available for all the resources.
+                      Consult the specific resource documentation for more information.
                     enum:
                     - konnectID
                     - konnectNamespacedRef
                     - kic
                     type: string
                 type: object
                 x-kubernetes-validations:
+                - message: konnectID type is not supported
+                  rule: '!has(self.type) || self.type != ''konnectID'''
                 - message: when type is konnectNamespacedRef, konnectNamespacedRef
                     must be set
                   rule: '(has(self.type) && self.type == ''konnectNamespacedRef'')

diff --git a/config/crd/gateway-operator/configuration.konghq.com_kongservices.yaml b/config/crd/gateway-operator/configuration.konghq.com_kongservices.yaml
@@ -94,13 +94,17 @@ spec:
                       - kic
 
                       The default is kic, which implies that the Control Plane is KIC.
+                      KonnectID might not be available for all the resources.
+                      Consult the specific resource documentation for more information.
                     enum:
                     - konnectID
                     - konnectNamespacedRef
                     - kic
                     type: string
                 type: object
                 x-kubernetes-validations:
+                - message: konnectID type is not supported
+                  rule: '!has(self.type) || self.type != ''konnectID'''
                 - message: when type is konnectNamespacedRef, konnectNamespacedRef
                     must be set
                   rule: '(has(self.type) && self.type == ''konnectNamespacedRef'')

diff --git a/config/crd/gateway-operator/configuration.konghq.com_kongupstreams.yaml b/config/crd/gateway-operator/configuration.konghq.com_kongupstreams.yaml
@@ -91,13 +91,17 @@ spec:
                       - kic
 
                       The default is kic, which implies that the Control Plane is KIC.
+                      KonnectID might not be available for all the resources.
+                      Consult the specific resource documentation for more information.
                     enum:
                     - konnectID
                     - konnectNamespacedRef
                     - kic
                     type: string
                 type: object
                 x-kubernetes-validations:
+                - message: konnectID type is not supported
+                  rule: '!has(self.type) || self.type != ''konnectID'''
                 - message: when type is konnectNamespacedRef, konnectNamespacedRef
                     must be set
                   rule: '(has(self.type) && self.type == ''konnectNamespacedRef'')

diff --git a/config/crd/gateway-operator/configuration.konghq.com_kongvaults.yaml b/config/crd/gateway-operator/configuration.konghq.com_kongvaults.yaml
@@ -114,13 +114,17 @@ spec:
                       - kic
 
                       The default is kic, which implies that the Control Plane is KIC.
+                      KonnectID might not be available for all the resources.
+                      Consult the specific resource documentation for more information.
                     enum:
                     - konnectID
                     - konnectNamespacedRef
                     - kic
                     type: string
                 type: object
                 x-kubernetes-validations:
+                - message: konnectID type is not supported
+                  rule: '!has(self.type) || self.type != ''konnectID'''
                 - message: when type is konnectNamespacedRef, konnectNamespacedRef
                     must be set
                   rule: '(has(self.type) && self.type == ''konnectNamespacedRef'')

diff --git a/config/crd/ingress-controller/configuration.konghq.com_kongconsumergroups.yaml b/config/crd/ingress-controller/configuration.konghq.com_kongconsumergroups.yaml
diff --git a/config/crd/ingress-controller/configuration.konghq.com_kongconsumers.yaml b/config/crd/ingress-controller/configuration.konghq.com_kongconsumers.yaml
diff --git a/config/crd/ingress-controller/configuration.konghq.com_kongvaults.yaml b/config/crd/ingress-controller/configuration.konghq.com_kongvaults.yaml
diff --git a/docs/api-reference.md b/docs/api-reference.md
@@ -685,7 +685,7 @@ It is used to reference a Control Plane entity.
 
 | Field | Description |
 | --- | --- |
-| `type` _string_ | Type indicates the type of the control plane being referenced. Allowed values: - konnectID - konnectNamespacedRef - kic<br /><br /> The default is kic, which implies that the Control Plane is KIC. |
+| `type` _string_ | Type indicates the type of the control plane being referenced. Allowed values: - konnectID - konnectNamespacedRef - kic<br /><br /> The default is kic, which implies that the Control Plane is KIC. KonnectID might not be available for all the resources. Consult the specific resource documentation for more information. |
 | `konnectID` _string_ | KonnectID is the schema for the KonnectID type. This field is required when the Type is konnectID. |
 | `konnectNamespacedRef` _[KonnectNamespacedRef](#konnectnamespacedref)_ | KonnectNamespacedRef is a reference to a Konnect Control Plane entity inside the cluster. It contains the name of the Konnect Control Plane. This field is required when the Type is konnectNamespacedRef. |