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

edit name of ingress gateway install #15536

Open
wants to merge 2 commits into
base: release-1.22
Choose a base branch
from

Conversation

tesla59
Copy link

@tesla59 tesla59 commented Aug 8, 2024

Description

This PR updated release name of the istio gateway installed using helm. While in the gateway docs the release name is istio-ingressgateway, in the helm installation doc for istio the release name is istio-ingress.

Due to this change, anyone following the helm installation doc will have gateway label as istio: gateway instead of istio: ingressgateway. Other installation method sets the labels as istio: ingressgateway and the other docs also assume the label to be istio: ingressgateway.

image image

Reviewers

  • Ambient
  • Docs
  • Installation
  • Networking
  • Performance and Scalability
  • Extensions and Telemetry
  • Security
  • Test and Release
  • User Experience
  • Developer Infrastructure
  • Localization/Translation

@tesla59 tesla59 requested a review from a team as a code owner August 8, 2024 08:37
@istio-policy-bot
Copy link

😊 Welcome! This is either your first contribution to the Istio documentation repo, or
it's been a while since you've been here. A few things you should know:

  • You can learn about how we write and maintain documentation, our style guidelines,
    and the available web site features by visiting Contributing to the Docs.

  • In the next few minutes, an automatic preview of your change will be built with
    a full copy of the istio.io website. You can find this preview by clicking on
    the Details link next to the deploy/netlify entry in the status section of this
    page.

  • We care about quality, so we've put in place a number of checks to ensure our documentation
    is top-notch. We do spell checking, sanitize the Markdown, ensure all hyperlinks point to a
    valid location, and more. If your PR doesn't pass one of these checks, you'll see a red X in the
    lint_istio.io entry in the status section. Click on the Details link to get a list of the
    problems with your PR. Fix those problems and push an update; this will automatically re-run the
    tests. Hopefully this time everything will be perfect!

  • Once your changes are accepted and merged into the repository, they will initially show up
    on https://preliminary.istio.io. The changes will be published to https://istio.io
    the next time we do a major release (which typically happens every 3 months or so).
    To publish them sooner, add a cherrypick/release-x.xx label, where x.xx is the current
    release of Istio.

Thanks for contributing!

Courtesy of your friendly welcome wagon.

Copy link

linux-foundation-easycla bot commented Aug 8, 2024

CLA Signed

The committers listed above are authorized under a signed CLA.

@istio-testing istio-testing added size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. needs-ok-to-test labels Aug 8, 2024
@istio-testing
Copy link
Contributor

Hi @tesla59. Thanks for your PR.

I'm waiting for a istio 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-sigs/prow repository.

Signed-off-by: Nishant Singh <nishant@heim.id>
@dhawton
Copy link
Member

dhawton commented Aug 8, 2024

This has been requested before and been blocked: #13516 (review)

cc: @howardjohn since you were the blocker previously.

@dhawton dhawton changed the title Update index.md edit name of ingress gateway install Aug 8, 2024
@dhawton dhawton changed the base branch from release-1.22 to master August 8, 2024 15:06
@dhawton dhawton requested review from a team as code owners August 8, 2024 15:06
@istio-testing istio-testing added size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. and removed size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Aug 8, 2024
@dhawton dhawton changed the base branch from master to release-1.22 August 8, 2024 15:06
@dhawton dhawton added the cherrypick/master Set this label on a PR to auto-merge from a release branch to master label Aug 8, 2024
@istio-testing istio-testing added size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. and removed size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. labels Aug 8, 2024
@tesla59
Copy link
Author

tesla59 commented Aug 8, 2024

users should understand what fields link things up and set them to match when appropriate.

While i agree that the user should be aware of how the selector is working, i think we should mention it in docs then. if installing using istioctl sets istio: ingressgateway, other installation method should at least mention it. We are doing it at one place but not doing at other. we should make it clear in the doc itself that the istio: ingressgateway is just a label selector and it can even be foo: bar

@howardjohn
Copy link
Member

we should make it clear in the doc itself that the istio: ingressgateway is just a label selector and it can even be foo: bar

👍

@dhawton
Copy link
Member

dhawton commented Aug 8, 2024

/ok-to-test

You're going to need to run make gen as well to update the tests

@istio-testing istio-testing added ok-to-test Set this label allow normal testing to take place for a PR not submitted by an Istio org member. and removed needs-ok-to-test labels Aug 8, 2024
Signed-off-by: Nishant Singh <nishant@heim.id>
@tesla59
Copy link
Author

tesla59 commented Aug 9, 2024

@dhawton i have run make gen and pushed the commit. LMK if anything else is needed

@istio-testing
Copy link
Contributor

@tesla59: The following test failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name Commit Details Required Rerun command
doc.test.profile-none_istio.io_release-1.22 b46caab link true /test doc.test.profile-none

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-sigs/prow repository. I understand the commands that are listed here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cherrypick/master Set this label on a PR to auto-merge from a release branch to master kind/docs ok-to-test Set this label allow normal testing to take place for a PR not submitted by an Istio org member. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants