-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* feat: KongPluginBinding CRD Signed-off-by: Mattia Lavacca <[email protected]> * Removed additional printcolumns Signed-off-by: Mattia Lavacca <[email protected]> * added docs and issues links - added documentation to the `.spec.kong` field - added a link to a TODO GH issue to the `.spec.kong` field - added a link to a TODO GH issue to the `.spec.entityRef` field Signed-off-by: Mattia Lavacca <[email protected]> * remove leftovers Signed-off-by: Mattia Lavacca <[email protected]> * commented out GenericEntityRef Signed-off-by: Mattia Lavacca <[email protected]> * added issue link on RefGrants Signed-off-by: Mattia Lavacca <[email protected]> * feat: added cel to pluginbinding kong field Signed-off-by: Mattia Lavacca <[email protected]> * added kongpluginbinding sample Signed-off-by: Mattia Lavacca <[email protected]> * kongpluginbindings added to kustomize Signed-off-by: Mattia Lavacca <[email protected]> * chore: changed kong field comment Signed-off-by: Mattia Lavacca <[email protected]> * chore: leftover comment removed Signed-off-by: Mattia Lavacca <[email protected]> * chore: changed CEL validation message Signed-off-by: Mattia Lavacca <[email protected]> --------- Signed-off-by: Mattia Lavacca <[email protected]>
- Loading branch information
Showing
12 changed files
with
1,062 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,162 @@ | ||
| /* | ||
| Copyright 2024 Kong, Inc. | ||
| 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. | ||
| */ | ||
|
|
||
| package v1alpha1 | ||
|
|
||
| import ( | ||
| metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" | ||
| ) | ||
|
|
||
| // KongPluginBinding is the schema for Plugin Bindings API which defines a Kong Plugin Binding. | ||
| // | ||
| // +genclient | ||
| // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object | ||
| // +kubebuilder:object:root=true | ||
| // +kubebuilder:resource:scope=Namespaced | ||
| // +kubebuilder:storageversion | ||
| // +kubebuilder:subresource:status | ||
| // +kubebuilder:printcolumn:name="Plugin-kind",type=string,JSONPath=`.spec.pluginReference.kind`,description="Kind of the plugin" | ||
| // +kubebuilder:printcolumn:name="Plugin-name",type=string,JSONPath=`.spec.pluginReference.name`,description="Name of the plugin" | ||
| // +kubebuilder:printcolumn:name="Programmed",description="The Resource is Programmed",type=string,JSONPath=`.status.conditions[?(@.type=='Programmed')].status` | ||
| // +kubebuilder:validation:XValidation:rule="(has(self.spec.kong.consumerRef) && has(self.spec.kong.routeRef) && has(self.spec.kong.serviceRef) && !has(self.spec.kong.consumerGroupRef)) || (has(self.spec.kong.consumerGroupRef) && has(self.spec.kong.serviceRef) && has(self.spec.kong.routeRef) && !has(self.spec.kong.consumerRef)) || (has(self.spec.kong.consumerRef) && has(self.spec.kong.routeRef) && !has(self.spec.kong.consumerGroupRef) && !has(self.spec.kong.serviceRef)) || (has(self.spec.kong.consumerRef) && has(self.spec.kong.serviceRef) && !has(self.spec.kong.routeRef) && !has(self.spec.kong.consumerGroupRef)) || (has(self.spec.kong.consumerGroupRef) && has(self.spec.kong.routeRef) && !has(self.spec.kong.serviceRef) && !has(self.spec.kong.consumerRef)) || (has(self.spec.kong.consumerGroupRef) && has(self.spec.kong.serviceRef) && !has(self.spec.kong.consumerRef) && !has(self.spec.kong.routeRef)) || (has(self.spec.kong.routeRef) && has(self.spec.kong.serviceRef) && !has(self.spec.kong.consumerRef) && !has(self.spec.kong.consumerGroupRef)) || (has(self.spec.kong.consumerRef) && !has(self.spec.kong.serviceRef) && !has(self.spec.kong.routeRef) && !has(self.spec.kong.consumerGroupRef)) || (has(self.spec.kong.consumerGroupRef) && !has(self.spec.kong.serviceRef) && !has(self.spec.kong.routeRef) && !has(self.spec.kong.consumerRef)) || (has(self.spec.kong.routeRef) && !has(self.spec.kong.serviceRef) && !has(self.spec.kong.consumerRef) && !has(self.spec.kong.consumerGroupRef)) || (has(self.spec.kong.serviceRef) && !has(self.spec.kong.routeRef) && !has(self.spec.kong.consumerGroupRef) && !has(self.spec.kong.consumerRef))", message="The combination of entities set is not allowed" | ||
| type KongPluginBinding struct { | ||
| metav1.TypeMeta `json:",inline"` | ||
| metav1.ObjectMeta `json:"metadata,omitempty"` | ||
|
|
||
| Spec KongPluginBindingSpec `json:"spec"` | ||
| Status KongPluginBindingStatus `json:"status,omitempty"` | ||
| } | ||
|
|
||
| func (c *KongPluginBinding) GetKonnectStatus() *KonnectEntityStatus { | ||
| return &c.Status.Konnect.KonnectEntityStatus | ||
| } | ||
|
|
||
| func (c KongPluginBinding) GetTypeName() string { | ||
| return "KongPluginBinding" | ||
| } | ||
|
|
||
| // GetConditions returns the Status Conditions | ||
| func (c *KongPluginBinding) GetConditions() []metav1.Condition { | ||
| return c.Status.Conditions | ||
| } | ||
|
|
||
| // SetConditions sets the Status Conditions | ||
| func (c *KongPluginBinding) SetConditions(conditions []metav1.Condition) { | ||
| c.Status.Conditions = conditions | ||
| } | ||
|
|
||
| // KongPluginBindingSpec defines specification of a KongPluginBinding. | ||
| type KongPluginBindingSpec struct { | ||
| // PluginReference is a reference to the KongPlugin or KongClusterPlugin resource. It is required | ||
| PluginReference PluginRef `json:"pluginRef"` | ||
|
|
||
| // Kong contains the Kong entity references. It is possible to set multiple combinations | ||
| // of references, as described in https://docs.konghq.com/gateway/latest/key-concepts/plugins/#precedence | ||
| // The complete set of allowed combinations and their order of precedence for plugins | ||
| // configured to multiple entities is: | ||
| // | ||
| // 1. Consumer + route + service | ||
| // 2. Consumer group + service + route | ||
| // 3. Consumer + route | ||
| // 4. Consumer + service | ||
| // 5. Consumer group + route | ||
| // 6. Consumer group + service | ||
| // 7. Route + service | ||
| // 8. Consumer | ||
| // 9. Consumer group | ||
| // 10. Route | ||
| // 11. Service | ||
| // 12. Global | ||
| // | ||
| // TODO(mlavacca): we need to figure out how to deal with global plugins. By means of this new API, | ||
| // KongClusterPlugin can be replaced by kongPluginBindings with no Kong references. This way we'd be | ||
| // more coherent with the Konnect approach. | ||
| // https://github.com/Kong/kubernetes-configuration/issues/7 | ||
| Kong *KongReferences `json:"kong,omitempty"` | ||
|
|
||
| // TODO(mlavacca): let's defer this one to the future as we are not sure about the shape we want to give it. | ||
| // https://github.com/Kong/kubernetes-configuration/issues/8 | ||
| // EntityReference *GenericEntityRef `json:"genericEntityRef,omitempty"` | ||
| } | ||
|
|
||
| type KongReferences struct { | ||
| RouteReference *EntityRef `json:"routeRef,omitempty"` | ||
| ServiceReference *EntityRef `json:"serviceRef,omitempty"` | ||
| ConsumerReference *EntityRef `json:"consumerRef,omitempty"` | ||
| ConsumerGroupReference *EntityRef `json:"consumerGroupRef,omitempty"` | ||
| } | ||
|
|
||
| type PluginRef struct { | ||
| // TODO(mattia): What about cross-namespace references? Do we want to introduce a namespace field | ||
| // to allow such a reference? We could allow it and require a RefGrant. | ||
| // https://github.com/Kong/kubernetes-configuration/issues/9 | ||
|
|
||
| // Name is the name of the KongPlugin or KongClusterPlugin resource. | ||
| // +kubebuilder:validation:Required | ||
| Name string `json:"name"` | ||
| // kind can be KongPlugin or KongClusterPlugin. If not set, it is assumed to be KongPlugin. | ||
| // +kubebuilder:validation:Enum=KongPlugin;KongClusterPlugin | ||
| // +kubebuilder:default:=KongPlugin | ||
| Kind *string `json:"kind,omitempty"` | ||
| } | ||
|
|
||
| type EntityRef struct { | ||
| // Name is the name of the entity. | ||
| // +kubebuilder:validation:Required | ||
| Name string `json:"name"` | ||
| } | ||
|
|
||
| // type GenericEntityRef struct { | ||
| // // Name is the name of the generic entity. | ||
| // // +kubebuilder:validation:Required | ||
| // Name string `json:"name"` | ||
|
|
||
| // // kind is the kind of the entity. | ||
| // // +kubebuilder:validation:Enum=Service;HTTPRoute;GCPRoute;TLSRoute;TCPRoute;UDPRoute;Ingress | ||
| // Kind string `json:"kind"` | ||
|
|
||
| // // TODO(mlavacca): add cross-field validation. Kind can be set depending on the group. | ||
| // // Group is the group of the entity. | ||
| // // +kubebuilder:validation:Enum="";core;gateway.networking.k8s.io;networking.k8s.io | ||
| // Group string `json:"group"` | ||
| // } | ||
|
|
||
| // KongPluginBindingStatus represents the current status of the KongBinding resource. | ||
| type KongPluginBindingStatus struct { | ||
| // Konnect contains the Konnect entity status. | ||
| Konnect KonnectEntityStatusWithControlPlaneAndServiceRefs `json:"konnect,omitempty"` | ||
|
|
||
| // Conditions describe the status of the Konnect entity. | ||
| // +listType=map | ||
| // +listMapKey=type | ||
| // +kubebuilder:validation:MinItems=1 | ||
| // +kubebuilder:validation:MaxItems=8 | ||
| // +kubebuilder:default={{type: "Programmed", status: "Unknown", reason:"Pending", message:"Waiting for controller", lastTransitionTime: "1970-01-01T00:00:00Z"}} | ||
| Conditions []metav1.Condition `json:"conditions,omitempty"` | ||
| } | ||
|
|
||
| // +kubebuilder:object:root=true | ||
|
|
||
| // KongPluginBindingList contains a list of KongPluginBindings. | ||
| type KongPluginBindingList struct { | ||
| metav1.TypeMeta `json:",inline"` | ||
| metav1.ListMeta `json:"metadata,omitempty"` | ||
| Items []KongPluginBinding `json:"items"` | ||
| } | ||
|
|
||
| func init() { | ||
| SchemeBuilder.Register(&KongPluginBinding{}, &KongPluginBindingList{}) | ||
| } |
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
Oops, something went wrong.