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

Correct docs to explain how loadBalancerIP can be specified for the internal service #9156

Closed
wants to merge 1 commit into from

Conversation

AlexPykavy
Copy link

@AlexPykavy AlexPykavy commented Oct 13, 2022

Docs update only.

What this PR does / why we need it:

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • 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?

Checklist:

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

Does my pull request need a release note?

Any user-visible or operator-visible change qualifies for a release note. This could be a:

  • CLI change
  • API change
  • UI change
  • configuration schema change
  • behavioral change
  • change in non-functional attributes such as efficiency or availability, availability of a new platform
  • a warning about a deprecation
  • fix of a previous Known Issue
  • fix of a vulnerability (CVE)

No release notes are required for changes to the following:

  • Tests
  • Build infrastructure
  • Fixes for unreleased bugs

For more tips on writing good release notes, check out the Release Notes Handbook

PLACE RELEASE NOTES HERE 

@linux-foundation-easycla
Copy link

linux-foundation-easycla bot commented Oct 13, 2022

CLA Signed

The committers listed above are authorized under a signed CLA.

  • ✅ login: AlexPykavy / name: Alexander Pykavy (ace7539)

@k8s-ci-robot k8s-ci-robot added the area/helm Issues or PRs related to helm charts label Oct 13, 2022
@k8s-ci-robot
Copy link
Contributor

@AlexPykavy: 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 k8s-ci-robot added cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. labels Oct 13, 2022
@k8s-ci-robot
Copy link
Contributor

Welcome @AlexPykavy!

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. 😃

@k8s-ci-robot k8s-ci-robot added needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. needs-kind Indicates a PR lacks a `kind/foo` label and requires one. labels Oct 13, 2022
@k8s-ci-robot
Copy link
Contributor

Hi @AlexPykavy. 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 k8s-ci-robot added needs-priority size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. and removed cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. labels Oct 13, 2022
@k8s-ci-robot k8s-ci-robot added size/S Denotes a PR that changes 10-29 lines, ignoring generated files. and removed size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Oct 14, 2022
@longwuyuan
Copy link
Contributor

@AlexPykavy On AWS, the LB is a FQDN and not an ipaddress. Will this take care of that scene ?

@AlexPykavy
Copy link
Author

@AlexPykavy On AWS, the LB is a FQDN and not an ipaddress. Will this take care of that scene ?

@longwuyuan , I'm updating the documentation for the existing functionality and don't invent something new only but I'll try to answer to your question)

As Kubernetes docs states, loadBalancerIP service attribute is supported only for some cloud providers. For AWS, I found that it seems to be achieved by using annotations.

@AlexPykavy
Copy link
Author

@ChiefAlexander, @cpanato, any comments?

@longwuyuan
Copy link
Contributor

  • I read the stackoverflow link but I am not convinced that introduction of that file .gitattributes in this project has been tested, verified and that everyone feels confident that there will be no undesired result of adding that .gitattrinutes file. I would not want to risk it at this stage. Maybe after a proper review from @rikatz @strongjz @tao12345666333

  • The intended addition of explicit content on a "internal" LB seems a improvement at first glance

  • The thought process behind using a "internal" LB are far more detailed than a few simple lines. Beginning with the existence of the a "internal" and a "external" network, and the corresponding cloud-controller-manager possibilities, there is DNS mapping and so much more involved. I am not sure if this PR should limit itself to just adding one sentence on the topic, or if there should be proper full scope content related to a "internal" LB

  • The helm chart README is autogenerated using the helm-docs tool. Description is here https://github.com/kubernetes/ingress-nginx/blob/main/RELEASE.md#d-edit-the-valuesyaml-and-run-helm-docs . I am suspecting that the change committed here did not use the helm-docs tool. Should be a easy fox to use helm-docs

@AlexPykavy
Copy link
Author

  • I read the stackoverflow link but I am not convinced that introduction of that file .gitattributes in this project has been tested, verified and that everyone feels confident that there will be no undesired result of adding that .gitattrinutes file. I would not want to risk it at this stage. Maybe after a proper review from @rikatz @strongjz @tao12345666333

For some reason I faced the issue with automatic change of line encodings in the generated README.md file but I can't reproduce it now. Maybe it's my local issue with Git, VSCode or smth else. I just remember that having .gitattributes in the root of the repository should prevent changing EOL of the files already committed in the repo. So, I removed this for now.

  • The intended addition of explicit content on a "internal" LB seems a improvement at first glance
  • The thought process behind using a "internal" LB are far more detailed than a few simple lines. Beginning with the existence of the a "internal" and a "external" network, and the corresponding cloud-controller-manager possibilities, there is DNS mapping and so much more involved. I am not sure if this PR should limit itself to just adding one sentence on the topic, or if there should be proper full scope content related to a "internal" LB

I agree that giving more details is always better but external and internal terminology seems confusing because you can easily use default (external) service as internal one if you don't expose LB to the global by settings the appropriate annotations. We could just name the services first and second and get exactly the same behavior.

I used the tool but I did it on Windows and got some extra whitespace characters. Then I tried it inside the Docker container and it worked fine, so the committed docs are autogenerated as expected.

@tao12345666333
Copy link
Member

/assign

@k8s-ci-robot k8s-ci-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Feb 14, 2023
@k8s-ci-robot k8s-ci-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Feb 25, 2023
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: AlexPykavy
Once this PR has been reviewed and has the lgtm label, please ask for approval from tao12345666333. 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

Copy link
Member

@tao12345666333 tao12345666333 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/ok-to-test

@k8s-ci-robot k8s-ci-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Mar 14, 2023
@k8s-ci-robot k8s-ci-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Mar 24, 2023
@k8s-ci-robot
Copy link
Contributor

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.

@rikatz
Copy link
Contributor

rikatz commented Aug 22, 2024

Please rebase
/assign @Gacko

@Gacko
Copy link
Member

Gacko commented Aug 24, 2024

I closed this PR as it is outdated. The related docs already have been updated ages ago.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/helm Issues or PRs related to helm charts cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. needs-kind Indicates a PR lacks a `kind/foo` label and requires one. needs-priority needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. size/S Denotes a PR that changes 10-29 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants