Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Conversation

hc-github-team-consul-core

Backport

This PR is auto-generated from #3597 to be assessed for backporting due to the inclusion of the label backport/1.1.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

@hashicorp-cla
Copy link

CLA assistant check

Thank you for your submission! We require that all contributors sign our Contributor License Agreement ("CLA") before we can accept the contribution. Read and sign the agreement

Learn more about why HashiCorp requires a CLA and what the CLA includes


temp seems not to be a GitHub user.
You need a GitHub account to be able to sign the CLA. If you already have a GitHub account, please add the email address used for this commit to your account.

Have you signed the CLA already but the status is still pending? Recheck it.

@missylbytes
Copy link
Contributor

This was an accidental version add for backport, this did not exist in version 1.1.x.

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.

3 participants