Skip to content

Backport of Fix logic on apigateway that ignores current annotations on services into release/1.2.x#3622

Merged
missylbytes merged 1 commit intorelease/1.2.xfrom
backport/mg-fix-logic-on-apigateway-that-ignores-current-annotations-on-services/directly-shining-cockatoo
Feb 14, 2024
Merged

Backport of Fix logic on apigateway that ignores current annotations on services into release/1.2.x#3622
missylbytes merged 1 commit intorelease/1.2.xfrom
backport/mg-fix-logic-on-apigateway-that-ignores-current-annotations-on-services/directly-shining-cockatoo

Conversation

@hc-github-team-consul-core
Copy link
Copy Markdown
Collaborator

Backport

This PR is auto-generated from #3597 to be assessed for backporting due to the inclusion of the label backport/1.2.x.

🚨

Warning automatic cherry-pick of commits failed. If the first commit failed,
you will see a blank no-op commit below. If at least one commit succeeded, you
will see the cherry-picked commits up to, not including, the commit where
the merge conflict occurred.

The person who merged in the original PR is:
@missylbytes
This person should manually cherry-pick the original PR into a new backport PR,
and close this one when the manual backport PR is merged in.

merge conflict error: POST https://api.github.com/repos/hashicorp/consul-k8s/merges: 409 Merge conflict []

The below text is copied from the body of the original PR.


Changes proposed in this PR

  • Fixes for NET-7113
  • Previously, any extra annotations added to a service controlled by an API Gateway would infinitely reconcile, as the Gateway would keep removing the extra annotations.
  • Logic was added to prevent this, as well as prevent the same issue with labels.

How I've tested this PR

Built a local image and installed onto a Kind cluster with the following values:

# values.yaml
global:
  name: consul
  imageK8S: consul-k8s-control-plane:local

connectInject:
  enabled: true
  apiGateway:
    managedGatewayClass:
      copyAnnotations:
        service:
          annotations: |
            - cupcake

Then I created an API Gateway with the following values:

# gateway.yaml
apiVersion: gateway.networking.k8s.io/v1beta1
kind: Gateway
metadata:
  name: my-gateway
  annotations:
    cupcake: strawberry
spec:
  gatewayClassName: consul
  listeners:
  - protocol: HTTP
    port: 80
    name: http
    allowedRoutes:
      namespaces:
        from: "All"

These resulted in a service that looked like this:
image

---------- Testing Annotations -------------------------------------------------------------------------------------

I then edited the service to add an additional annotation

image

And after editing, I made sure this additional annotation was still there:

image

---------- Testing Labels -------------------------------------------------------------------------------------

I also tested for labels by editing the service and adding a label

image

Then looked at the service again to make sure the label stayed

image

How I expect reviewers to test this PR

Check out the tests, test manually

Checklist


Overview of commits

@hc-github-team-consul-core hc-github-team-consul-core force-pushed the backport/mg-fix-logic-on-apigateway-that-ignores-current-annotations-on-services/directly-shining-cockatoo branch from 088557e to a147d6f Compare February 13, 2024 19:51
@missylbytes missylbytes force-pushed the backport/mg-fix-logic-on-apigateway-that-ignores-current-annotations-on-services/directly-shining-cockatoo branch from a147d6f to fb44cbc Compare February 14, 2024 15:25
@missylbytes missylbytes marked this pull request as ready for review February 14, 2024 15:26
@missylbytes missylbytes enabled auto-merge (squash) February 14, 2024 18:35
@missylbytes missylbytes merged commit 8ee69dd into release/1.2.x Feb 14, 2024
@missylbytes missylbytes deleted the backport/mg-fix-logic-on-apigateway-that-ignores-current-annotations-on-services/directly-shining-cockatoo branch February 14, 2024 18:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants