Gateway kuadrant.io/namespace annotation owned by a single controller

[eguzki]

What

The assignment of a gateway to a kuadrant instance is done using the kuadrant.io/namespace annotation. The owner of that annotation was a shared ownership between gateway_kuadrant_controller and kuadrant_controller. This PR moves the full ownership to gateway_kuadrant_controller.

Verification steps

• Setup the environment:

make local-setup         

Checking the annotations of the istio-ingressgateway gateway

❯ k get gateways istio-ingressgateway -n istio-system -o jsonpath='{.metadata.annotations}' | yq e 'keys' -P

It does not have any kuadrant namespace annotation

- gateway.istio.io/controller-version
- kubectl.kubernetes.io/last-applied-configuration

Request an instance of Kuadrant:

kubectl -n kuadrant-system apply -f - <<EOF
apiVersion: kuadrant.io/v1beta1
kind: Kuadrant
metadata:
  name: kuadrant
spec: {}
EOF

The istio istio-ingressgateway gateway, should be annotated with the kuadrant annotation

❯ k get gateways istio-ingressgateway -n istio-system -o jsonpath='{.metadata.annotations}' | yq e 'keys' -P

- gateway.istio.io/controller-version
- kuadrant.io/namespace
- kubectl.kubernetes.io/last-applied-configuration

Create a new gateway

kubectl -n kuadrant-system apply -f - <<EOF
apiVersion: gateway.networking.k8s.io/v1beta1
kind: Gateway
metadata:
  name: second
spec:
  gatewayClassName: istio
  listeners:
    - allowedRoutes:
        namespaces:
          from: All
      hostname: '*.example.com'
      name: api
      port: 80
      protocol: HTTP
EOF

Note that the gateway initial spec does not have the kuadrant annotation. The kuadrant controller will add it.

The new gateway second gateway, should be annotated with the kuadrant annotation

❯ k get gateways second -n kuadrant-system -o jsonpath='{.metadata.annotations}' | yq e 'keys' -P

- gateway.istio.io/controller-version
- kuadrant.io/namespace
- kubectl.kubernetes.io/last-applied-configuration

Now, let's delete the kuadrant CR

kubectl delete kuadrant kuadrant -n kuadrant-system 

The istio istio-ingressgateway gateway, must not have the annotation with the kuadrant namespace

❯ k get gateways istio-ingressgateway -n istio-system -o jsonpath='{.metadata.annotations}' | yq e 'keys' -P

- gateway.istio.io/controller-version
- kubectl.kubernetes.io/last-applied-configuration

The new gateway second, must not have the annotation with the kuadrant namespace

❯ k get gateways second -n kuadrant-system -o jsonpath='{.metadata.annotations}' | yq e 'keys' -P

- gateway.istio.io/controller-version
- kubectl.kubernetes.io/last-applied-configuration

[codecov]

Codecov Report

Merging #520 (38d7c8e) into main (ece13e8) will increase coverage by 0.34%.
Report is 25 commits behind head on main.
The diff coverage is 76.27%.

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #520      +/-   ##
==========================================
+ Coverage   80.20%   80.55%   +0.34%     
==========================================
  Files          64       71       +7     
  Lines        4492     4957     +465     
==========================================
+ Hits         3603     3993     +390     
- Misses        600      648      +48     
- Partials      289      316      +27     

Flag	Coverage Δ
integration	71.41% <76.27%> (+0.13%)	⬆️
unit	33.52% <3.38%> (+3.48%)	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Components	Coverage Δ
api/v1beta1 (u)	71.42% <ø> (ø)
api/v1beta2 (u)	88.51% <100.00%> (-2.92%)	⬇️
pkg/common (u)	83.01% <ø> (-5.81%)	⬇️
pkg/istio (u)	75.14% <100.00%> (+1.23%)	⬆️
pkg/log (u)	94.73% <ø> (ø)
pkg/reconcilers (u)	∅ <ø> (∅)
pkg/rlptools (u)	79.77% <ø> (+0.31%)	⬆️
controllers (i)	76.62% <82.66%> (-0.18%)	⬇️

Files	Coverage Δ
controllers/kuadrant_controller.go	49.81% <ø> (-3.76%)	⬇️
pkg/library/kuadrant/kuadrant.go	85.29% <66.66%> (-14.71%)	⬇️
controllers/gateway_kuadrant_controller.go	82.85% <84.21%> (+1.72%)	⬆️
pkg/library/mappers/kuadrant_to_gateway.go	60.00% <60.00%> (ø)

... and 12 files with indirect coverage changes

[didierofrivia]

Works like a charm! 🍔