Skip to content

Commit

Permalink
Support for default annotations (#78)
Browse files Browse the repository at this point in the history 
Signed-off-by: Waleed Malik <[email protected]>
  • Loading branch information
@ahmedwaleedmalik
ahmedwaleedmalik authored Nov 25, 2024
1 parent b9cd5a3 commit eec2a1a
Show file tree
Hide file tree
Showing 14 changed files with 155 additions and 20 deletions.
27 changes: 25 additions & 2 deletions api/kubelb.k8c.io/v1alpha1/common_types.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -86,14 +86,37 @@ type EndpointAddress struct {
Hostname string `json:"hostname,omitempty" protobuf:"bytes,3,opt,name=hostname"`
}

type Annotations map[string]string

// +kubebuilder:validation:Enum=all;service;ingress;gateway;httproute;grpcroute;tcproute;udproute;tlsroute
type AnnotatedResource string

const (
AnnotatedResourceAll AnnotatedResource = "all"
AnnotatedResourceService AnnotatedResource = "service"
AnnotatedResourceIngress AnnotatedResource = "ingress"
AnnotatedResourceGateway AnnotatedResource = "gateway"
AnnotatedResourceHTTPRoute AnnotatedResource = "httproute"
AnnotatedResourceGRPCRoute AnnotatedResource = "grpcroute"
AnnotatedResourceTCPRoute AnnotatedResource = "tcproute"
AnnotatedResourceUDPRoute AnnotatedResource = "udproute"
AnnotatedResourceTLSRoute AnnotatedResource = "tlsroute"
)

type AnnotationSettings struct {
// PropagatedAnnotations defines the list of annotations(key-value pairs) that will be propagated to the LoadBalancer service. Keep the `value` field empty in the key-value pair to allow any value.
// This will have a higher precedence than the annotations specified at the Config level.
// Tenant configuration has higher precedence than the annotations specified at the Config level.
// +optional
PropagatedAnnotations *map[string]string `json:"propagatedAnnotations,omitempty"`

// PropagateAllAnnotations defines whether all annotations will be propagated to the LoadBalancer service. If set to true, PropagatedAnnotations will be ignored.
// This will have a higher precedence than the value specified at the Config level.
// Tenant configuration has higher precedence than the value specified at the Config level.
// +optional
PropagateAllAnnotations *bool `json:"propagateAllAnnotations,omitempty"`

// DefaultAnnotations defines the list of annotations(key-value pairs) that will be set on the load balancing resources if not already present. A special key `all` can be used to apply the same
// set of annotations to all resources.
// Tenant configuration has higher precedence than the annotations specified at the Config level.
// +optional
DefaultAnnotations map[AnnotatedResource]Annotations `json:"defaultAnnotations,omitempty"`
}
39 changes: 39 additions & 0 deletions api/kubelb.k8c.io/v1alpha1/zz_generated.deepcopy.go
View file

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

14 changes: 12 additions & 2 deletions charts/kubelb-manager/crds/kubelb.k8c.io_configs.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,16 @@ spec:
spec:
description: ConfigSpec defines the desired state of the Config
properties:
defaultAnnotations:
additionalProperties:
additionalProperties:
type: string
type: object
description: |-
DefaultAnnotations defines the list of annotations(key-value pairs) that will be set on the load balancing resources if not already present. A special key `all` can be used to apply the same
set of annotations to all resources.
Tenant configuration has higher precedence than the annotations specified at the Config level.
type: object
envoyProxy:
description: EnvoyProxy defines the desired state of the Envoy Proxy
properties:
Expand Down Expand Up @@ -1149,14 +1159,14 @@ spec:
propagateAllAnnotations:
description: |-
PropagateAllAnnotations defines whether all annotations will be propagated to the LoadBalancer service. If set to true, PropagatedAnnotations will be ignored.
This will have a higher precedence than the value specified at the Config level.
Tenant configuration has higher precedence than the value specified at the Config level.
type: boolean
propagatedAnnotations:
additionalProperties:
type: string
description: |-
PropagatedAnnotations defines the list of annotations(key-value pairs) that will be propagated to the LoadBalancer service. Keep the `value` field empty in the key-value pair to allow any value.
This will have a higher precedence than the annotations specified at the Config level.
Tenant configuration has higher precedence than the annotations specified at the Config level.
type: object
type: object
type: object
Expand Down
14 changes: 12 additions & 2 deletions charts/kubelb-manager/crds/kubelb.k8c.io_tenants.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,16 @@ spec:
spec:
description: TenantSpec defines the desired state of Tenant
properties:
defaultAnnotations:
additionalProperties:
additionalProperties:
type: string
type: object
description: |-
DefaultAnnotations defines the list of annotations(key-value pairs) that will be set on the load balancing resources if not already present. A special key `all` can be used to apply the same
set of annotations to all resources.
Tenant configuration has higher precedence than the annotations specified at the Config level.
type: object
gatewayAPI:
description: GatewayAPISettings defines the settings for the gateway
API.
Expand Down Expand Up @@ -83,14 +93,14 @@ spec:
propagateAllAnnotations:
description: |-
PropagateAllAnnotations defines whether all annotations will be propagated to the LoadBalancer service. If set to true, PropagatedAnnotations will be ignored.
This will have a higher precedence than the value specified at the Config level.
Tenant configuration has higher precedence than the value specified at the Config level.
type: boolean
propagatedAnnotations:
additionalProperties:
type: string
description: |-
PropagatedAnnotations defines the list of annotations(key-value pairs) that will be propagated to the LoadBalancer service. Keep the `value` field empty in the key-value pair to allow any value.
This will have a higher precedence than the annotations specified at the Config level.
Tenant configuration has higher precedence than the annotations specified at the Config level.
type: object
type: object
status:
Expand Down
14 changes: 12 additions & 2 deletions config/crd/bases/kubelb.k8c.io_configs.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,16 @@ spec:
spec:
description: ConfigSpec defines the desired state of the Config
properties:
defaultAnnotations:
additionalProperties:
additionalProperties:
type: string
type: object
description: |-
DefaultAnnotations defines the list of annotations(key-value pairs) that will be set on the load balancing resources if not already present. A special key `all` can be used to apply the same
set of annotations to all resources.
Tenant configuration has higher precedence than the annotations specified at the Config level.
type: object
envoyProxy:
description: EnvoyProxy defines the desired state of the Envoy Proxy
properties:
Expand Down Expand Up @@ -1149,14 +1159,14 @@ spec:
propagateAllAnnotations:
description: |-
PropagateAllAnnotations defines whether all annotations will be propagated to the LoadBalancer service. If set to true, PropagatedAnnotations will be ignored.
This will have a higher precedence than the value specified at the Config level.
Tenant configuration has higher precedence than the value specified at the Config level.
type: boolean
propagatedAnnotations:
additionalProperties:
type: string
description: |-
PropagatedAnnotations defines the list of annotations(key-value pairs) that will be propagated to the LoadBalancer service. Keep the `value` field empty in the key-value pair to allow any value.
This will have a higher precedence than the annotations specified at the Config level.
Tenant configuration has higher precedence than the annotations specified at the Config level.
type: object
type: object
type: object
Expand Down
14 changes: 12 additions & 2 deletions config/crd/bases/kubelb.k8c.io_tenants.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,16 @@ spec:
spec:
description: TenantSpec defines the desired state of Tenant
properties:
defaultAnnotations:
additionalProperties:
additionalProperties:
type: string
type: object
description: |-
DefaultAnnotations defines the list of annotations(key-value pairs) that will be set on the load balancing resources if not already present. A special key `all` can be used to apply the same
set of annotations to all resources.
Tenant configuration has higher precedence than the annotations specified at the Config level.
type: object
gatewayAPI:
description: GatewayAPISettings defines the settings for the gateway
API.
Expand Down Expand Up @@ -83,14 +93,14 @@ spec:
propagateAllAnnotations:
description: |-
PropagateAllAnnotations defines whether all annotations will be propagated to the LoadBalancer service. If set to true, PropagatedAnnotations will be ignored.
This will have a higher precedence than the value specified at the Config level.
Tenant configuration has higher precedence than the value specified at the Config level.
type: boolean
propagatedAnnotations:
additionalProperties:
type: string
description: |-
PropagatedAnnotations defines the list of annotations(key-value pairs) that will be propagated to the LoadBalancer service. Keep the `value` field empty in the key-value pair to allow any value.
This will have a higher precedence than the annotations specified at the Config level.
Tenant configuration has higher precedence than the annotations specified at the Config level.
type: object
type: object
status:
Expand Down
4 changes: 2 additions & 2 deletions internal/controllers/kubelb/loadbalancer_controller.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -235,7 +235,7 @@ func (r *LoadBalancerReconciler) reconcileService(ctx context.Context, loadBalan
Name: svcName,
Namespace: namespace,
Labels: labels,
Annotations: kubelb.PropagateAnnotations(loadBalancer.Annotations, annotations),
Annotations: kubelb.PropagateAnnotations(loadBalancer.Annotations, annotations, kubelbv1alpha1.AnnotatedResourceService),
},
}
err := r.Get(ctx, types.NamespacedName{
Expand Down Expand Up @@ -288,7 +288,7 @@ func (r *LoadBalancerReconciler) reconcileService(ctx context.Context, loadBalan
service.Annotations = make(map[string]string)
}

for k, v := range kubelb.PropagateAnnotations(loadBalancer.Annotations, annotations) {
for k, v := range kubelb.PropagateAnnotations(loadBalancer.Annotations, annotations, kubelbv1alpha1.AnnotatedResourceService) {
service.Annotations[k] = v
}
service.Spec.Ports = ports
Expand Down
7 changes: 7 additions & 0 deletions internal/controllers/kubelb/shared.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -72,5 +72,12 @@ func GetAnnotations(tenant *kubelbv1alpha1.Tenant, config *kubelbv1alpha1.Config
} else if config.Spec.AnnotationSettings.PropagatedAnnotations != nil {
annotations.PropagatedAnnotations = config.Spec.AnnotationSettings.PropagatedAnnotations
}

if tenant.Spec.AnnotationSettings.DefaultAnnotations != nil {
annotations.DefaultAnnotations = tenant.Spec.AnnotationSettings.DefaultAnnotations
} else if config.Spec.AnnotationSettings.DefaultAnnotations != nil {
annotations.DefaultAnnotations = config.Spec.AnnotationSettings.DefaultAnnotations
}

return annotations
}
32 changes: 29 additions & 3 deletions internal/kubelb/utils.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -90,13 +90,13 @@ func GetNamespace(obj client.Object) string {
return namespace
}

func PropagateAnnotations(loadbalancer map[string]string, annotations kubelbv1alpha1.AnnotationSettings) map[string]string {
func PropagateAnnotations(loadbalancer map[string]string, annotations kubelbv1alpha1.AnnotationSettings, resource kubelbv1alpha1.AnnotatedResource) map[string]string {
if loadbalancer == nil {
loadbalancer = make(map[string]string)
}

if annotations.PropagateAllAnnotations != nil && *annotations.PropagateAllAnnotations {
return loadbalancer
return applyDefaultAnnotations(loadbalancer, annotations, resource)
}
permitted := make(map[string]string)

Expand Down Expand Up @@ -126,7 +126,33 @@ func PropagateAnnotations(loadbalancer map[string]string, annotations kubelbv1al
}
}
}
return a
return applyDefaultAnnotations(a, annotations, resource)
}

func applyDefaultAnnotations(loadbalancer map[string]string, annotations kubelbv1alpha1.AnnotationSettings, resource kubelbv1alpha1.AnnotatedResource) map[string]string {
if annotations.DefaultAnnotations != nil {
if _, ok := annotations.DefaultAnnotations[resource]; ok {
// Merge the default annotations with the loadbalancer annotations while giving precedence to the loadbalancer annotations. If an annotation
// already exists in the loadbalancer, it will not be overridden by the default annotations.
for k, v := range annotations.DefaultAnnotations[resource] {
if _, ok := loadbalancer[k]; !ok {
loadbalancer[k] = v
}
}
}

// Apply the default annotations for all resources if they are set.
if _, ok := annotations.DefaultAnnotations[kubelbv1alpha1.AnnotatedResourceAll]; ok {
// Merge the default annotations with the loadbalancer annotations while giving precedence to the loadbalancer annotations. If an annotation
// already exists in the loadbalancer, it will not be overridden by the default annotations.
for k, v := range annotations.DefaultAnnotations[kubelbv1alpha1.AnnotatedResourceAll] {
if _, ok := loadbalancer[k]; !ok {
loadbalancer[k] = v
}
}
}
}
return loadbalancer
}

func AddKubeLBLabels(labels map[string]string, name, namespace, gvk string) map[string]string {
Expand Down
2 changes: 1 addition & 1 deletion internal/resources/gatewayapi/gateway/gateway.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ func CreateOrUpdateGateway(ctx context.Context, log logr.Logger, client ctrlclie
}

// Process annotations.
object.Annotations = kubelb.PropagateAnnotations(object.Annotations, annotations)
object.Annotations = kubelb.PropagateAnnotations(object.Annotations, annotations, kubelbv1alpha1.AnnotatedResourceGateway)

// Process secrets.
for i, listener := range object.Spec.Listeners {
Expand Down
2 changes: 1 addition & 1 deletion internal/resources/gatewayapi/grpcroute/grpcroute.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ func CreateOrUpdateGRPCRoute(ctx context.Context, log logr.Logger, client ctrlcl
}

// Process annotations.
object.Annotations = kubelb.PropagateAnnotations(object.Annotations, annotations)
object.Annotations = kubelb.PropagateAnnotations(object.Annotations, annotations, kubelbv1alpha1.AnnotatedResourceGRPCRoute)

// Process labels
object.Labels = kubelb.AddKubeLBLabels(object.Labels, object.Name, object.Namespace, "")
Expand Down
2 changes: 1 addition & 1 deletion internal/resources/gatewayapi/httproute/httproute.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ func CreateOrUpdateHTTPRoute(ctx context.Context, log logr.Logger, client ctrlcl
}

// Process annotations.
object.Annotations = kubelb.PropagateAnnotations(object.Annotations, annotations)
object.Annotations = kubelb.PropagateAnnotations(object.Annotations, annotations, kubelbv1alpha1.AnnotatedResourceHTTPRoute)

// Process labels
object.Labels = kubelb.AddKubeLBLabels(object.Labels, object.Name, object.Namespace, "")
Expand Down
2 changes: 1 addition & 1 deletion internal/resources/ingress/ingress.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ func CreateOrUpdateIngress(ctx context.Context, log logr.Logger, client ctrlclie
object.Spec.IngressClassName = className

// Process annotations.
object.Annotations = kubelb.PropagateAnnotations(object.Annotations, annotations)
object.Annotations = kubelb.PropagateAnnotations(object.Annotations, annotations, kubelbv1alpha1.AnnotatedResourceIngress)

// Process secrets.
if object.Spec.TLS != nil {
Expand Down
2 changes: 1 addition & 1 deletion internal/resources/service/service.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,7 @@ func GenerateServiceForLBCluster(service corev1.Service, appName, namespace stri
kubelb.LabelAppKubernetesName: appName,
}
}
service.Annotations = kubelb.PropagateAnnotations(service.Annotations, annotations)
service.Annotations = kubelb.PropagateAnnotations(service.Annotations, annotations, kubelbv1alpha1.AnnotatedResourceService)
return service
}

Expand Down

0 comments on commit eec2a1a

Please sign in to comment.