ingress-nginx icon indicating copy to clipboard operation
ingress-nginx copied to clipboard

Chart: Configure `appProtocol` case.

Open hau21um opened this issue 1 year ago • 19 comments

What this PR does / why we need it:

  • in GKE with GatewayAPI service port appProtocol have to be uppercase .
  • With GKE semverCompare for k8s version was not workig, appProtocol was always omited. Some similar cases: -- https://codeengineered.com/blog/2022/helm-kubeversion-gke/ -- https://github.com/helm/helm/issues/3801

With this change you can optionally switch the values to uppercase. If no changes in value file, then will chart will be rendered with lowercase as before.

Types of changes

  • [x] Bug fix (non-breaking change which fixes an issue)
  • [x] New feature (non-breaking change which adds functionality)
  • [ ] CVE Report (Scanner found CVE and adding report)
  • [ ] Breaking change (fix or feature that would cause existing functionality to change)
  • [ ] Documentation only

Which issue/s this PR fixes

How Has This Been Tested?

  • clone changes locally
  • helm install, helm upgrade to GKE cluster

Checklist:

  • [ ] My change requires a change to the documentation.
  • [ ] I have updated the documentation accordingly.
  • [x] I've read the CONTRIBUTION guide
  • [ ] I have added unit and/or e2e tests to cover my changes.
  • [ ] All new and existing tests passed.

hau21um avatar Jul 18 '23 14:07 hau21um

CLA Signed

The committers listed above are authorized under a signed CLA.

  • :white_check_mark: login: hau21um / name: Milos Hauser (904bd5554734996505df42e7dc3928ea15eda2c8, 318667fadee5064a78766b4ac072285f4cc431a8, c136dda909c75e5376a8e9f3169d63cd89800753, 7fffd8807714a70845d20e2907ac0e332ac0ca10, 7d77d33583568443b0742f7da257a2ae6b6a7c5a, 2fbfdc6934e206008342aaf8532687fdcf060f81, 017c5d9289c1c510a0482dc7113d4b5bea75f503)

This issue is currently awaiting triage.

If Ingress contributors determines this is a relevant issue, they will accept it by applying the triage/accepted label and provide further guidance.

The triage/accepted label can be added by org members by writing /triage accepted in a comment.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

k8s-ci-robot avatar Jul 18 '23 14:07 k8s-ci-robot

Deploy Preview for kubernetes-ingress-nginx canceled.

Name Link
Latest commit 017c5d9289c1c510a0482dc7113d4b5bea75f503
Latest deploy log https://app.netlify.com/sites/kubernetes-ingress-nginx/deploys/64ff021a0b03500008ad8251

netlify[bot] avatar Jul 18 '23 14:07 netlify[bot]

Welcome @hau21um!

It looks like this is your first PR to kubernetes/ingress-nginx 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes/ingress-nginx has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. :smiley:

k8s-ci-robot avatar Jul 18 '23 14:07 k8s-ci-robot

Hi @hau21um. Thanks for your PR.

I'm waiting for a kubernetes member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

k8s-ci-robot avatar Jul 18 '23 14:07 k8s-ci-robot

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: hau21um Once this PR has been reviewed and has the lgtm label, please assign cpanato for approval. For more information see the Kubernetes Code Review Process.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment Approvers can cancel approval by writing /approve cancel in a comment

k8s-ci-robot avatar Jul 18 '23 14:07 k8s-ci-robot

CLA Missing ID CLA Not Signed

  • :white_check_mark: login: hau21um / name: Milos Hauser (6f63c87139db20157f271a5075a3329693f83d98, 3902a9120a2d4b5ddbc1d9c96d5d07966a389b9f, eb49b99dc3093e0a938c2ac6fa3bb251e1f608ba, 3119737655c35e170f86557764809e930b3ee68e, 3df0f982d7ff7afcfe601fbb4e9d9ed56df7721e, 7fc28a55d006a75ae0869ad1fe5454fa401c876b)
  • :x: The email address for the commit (bb635056c58bc940837c467f902b5d13ef54f7d6, 21d7903d8deeb9e101e9c7c99b502704904d0369, f394f71244376603e7b0c6e6ebe46ba2511a11cc) is not linked to the GitHub account, preventing the EasyCLA check. Consult this Help Article and GitHub Help to resolve. (To view the commit's email address, add .patch at the end of this PR page's URL.) For further assistance with EasyCLA, please submit a support request ticket.

This is stale, but we won't close it automatically, just bare in mind the maintainers may be busy with other tasks and will reach your issue ASAP. If you have any question or request to prioritize this, please reach #ingress-nginx-dev on Kubernetes Slack.

github-actions[bot] avatar Sep 04 '23 01:09 github-actions[bot]

PR needs rebase.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

k8s-ci-robot avatar Sep 19 '23 00:09 k8s-ci-robot

I did not review the functional changes, yet. But please do not bump the version in the Chart.yaml on your own. Thank you!

Gacko avatar Dec 20 '23 20:12 Gacko

The lifecycle/frozen label can not be applied to PRs.

This bot removes lifecycle/frozen from PRs because:

  • Commenting /lifecycle frozen on a PR has not worked since March 2021
  • PRs that remain open for >150 days are unlikely to be easily rebased

You can:

  • Rebase this PR and attempt to get it merged
  • Close this PR with /close

Please send feedback to sig-contributor-experience at kubernetes/community.

/remove-lifecycle frozen

k8s-triage-robot avatar Jan 18 '24 22:01 k8s-triage-robot

/assign

Gacko avatar Jan 19 '24 17:01 Gacko

/retitle Chart: Configure appProtocol case.

Gacko avatar Feb 01 '24 21:02 Gacko

While thinking about that, I'd rather make the appProtocol configurable on a port basis and default to http and https for the HTTP and HTTPS port. So if one needs to override them with HTTPS or YetAnotherProviderSpecificName they can still do so.

Gacko avatar Feb 01 '24 21:02 Gacko

By the way, I don't want to be petty, but the docs are kind of clear on that: https://kubernetes.io/docs/concepts/services-networking/service/#application-protocol

This field follows standard Kubernetes label syntax. Valid values are one of:

  • IANA standard service names.
  • Implementation-defined prefixed names such as mycompany.com/my-custom-protocol.
  • Kubernetes-defined prefixed names:

...

The IANA standard service names list HTTP and HTTPS as http and https. So maybe one should rather file an issue at GKE. 😈

Gacko avatar Feb 01 '24 21:02 Gacko

Can you please elaborate on how you want to implement Gateway API using Ingress NGINX? From how I understand the docs, the Gateway API controller already is an implementation of the Gateway API which comes with all the L7 features. So it's "on the same level" as Ingress NGINX and I don't understand why you want to front Ingress NGINX by a Gateway API Controller. Shouldn't you front your services by the GKE Gateway API Controller directly?

Gacko avatar Feb 01 '24 21:02 Gacko

  • fully support "ppProtocol configurable on a port basis and default to http and https for the HTTP and HTTPS port. So if one needs to override them with HTTPS or YetAnotherProviderSpecificName they can still do so.". This should also enable implementation-defined prefixed and Kubernetes-defined prefixed names. Actually I was on similar PR with other helm chart. But for ingress-nginx chart was not sure how to achieve same with current code. I can try to rewrite this PR in this direction when will have some free time.

  • I gave a feedback to gcp that this uppercase/lower case is not good, but they probably want to align it with the protocol format of spec.ports[].protocol, which is uppercase. Grrr. I did not even found any GitHub project with their "GKE Gateway Controller" to file proper issue.

  • I do not have intention on implementing Gateway API using Ingress NGINX. We just have a use case where Gateway API implementation we have is not enough, so we use LB->Gateway->OurBackendService by default and for this one special use case we do LB->Gateway->ingress-nginx->OurBackendService.

hau21um avatar Feb 02 '24 08:02 hau21um

Yes, I got you don't want to implement Gateway API using Ingress NGINX and are simple backing your Gateway API implementation by Ingress NGINX (so Ingress API) for at least one use case. That's what surprised me... but as long as we make the actual appProtocol configurable and still default to http and https, I don't think we need to care.

The appProtocol is a provider specific value by definition and we are just lucky http and https was good enough so far.

Gacko avatar Feb 02 '24 09:02 Gacko

I will finish my work on the chart CI and propose a PR for this asap.

Gacko avatar Feb 02 '24 09:02 Gacko