istio.io icon indicating copy to clipboard operation
istio.io copied to clipboard

docs: update GKE ambient guide to remove manual ResourceQuota step (Fix istio/istio#56376)

Open parv18050212 opened this issue 5 months ago • 14 comments

This PR updates the Istio ambient mesh installation guide for GKE:

  • Notes that Istio v1.26+ automatically creates ResourceQuota
  • Removes outdated manual step for newer versions
  • Keeps instructions for Istio <1.26 for clarity

Fixes istio/istio#56376

Signed-off-by: Parv Agarwal [email protected]

parv18050212 avatar Jul 13 '25 14:07 parv18050212

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

istio-policy-bot avatar Jul 13 '25 14:07 istio-policy-bot

Hi @parv18050212. 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.

istio-testing avatar Jul 13 '25 14:07 istio-testing

Because this is now more an FYI for people who don't want to install in istio-system (which will be very few people) I would be inclined to move the whole "Namespace restrictions" section to under the "platform profile" section.

craigbox avatar Jul 14 '25 03:07 craigbox

/ok-to-test

craigbox avatar Jul 14 '25 03:07 craigbox

Thanks for the suggestion, @craigbox! That makes sense. I’ll update the PR accordingly.

parv18050212 avatar Jul 14 '25 03:07 parv18050212

Fixed the error - please re-order the sections and I can merge.

craigbox avatar Jul 14 '25 04:07 craigbox

I’ve now reordered the sections as suggested. The updated file is ready for review and merge.

parv18050212 avatar Jul 14 '25 10:07 parv18050212

You seem to have lost all the edits that were made before you rearranged the content?

craigbox avatar Jul 14 '25 10:07 craigbox

Thanks for pointing that out! I've restored the earlier changes that were lost during the rearrangement. Let me know if anything else needs adjustment.

parv18050212 avatar Jul 14 '25 11:07 parv18050212

@craigbox This is my first time contributing, and I’ve tried to follow all the guidelines, but I’m still getting a linting error I can’t figure out. Could you please help me understand what might be causing it? I'd really appreciate any guidance. Thanks!

parv18050212 avatar Jul 14 '25 11:07 parv18050212

@craigbox This is my first time contributing, and I’ve tried to follow all the guidelines, but I’m still getting a linting error I can’t figure out. Could you please help me understand what might be causing it? I'd really appreciate any guidance. Thanks!

./en/docs/ambient/install/platform-prerequisites/index.md:197: MD024 Multiple headers with the same content

Means there are headers (which are #s) that share the same name. Headers have anchors applied to them, so they must be unique.

./en/docs/ambient/install/platform-prerequisites/index.md:211: MD029 Ordered list item prefix

Ordered lists (numbered) must all be prefixed with 1. In markdown, these will be numbered correctly... ie:

Bad

1. test
2. test
3. test

Good

1. test
1. test
1. test

dhawton avatar Jul 14 '25 13:07 dhawton

Revert 7cb276f and I can tell you what is wrong with it at that stage.

(If all you are doing is swapping two blocks, then there shouldn't be any net-new headings)

craigbox avatar Jul 15 '25 02:07 craigbox

Hi all, I’ve updated the Platform Prerequisites and Namespace Restrictions sections to improve clarity and correctness, particularly for the GKE part. Everything else is copied directly from the original file.

parv18050212 avatar Jul 16 '25 10:07 parv18050212

@dhawton @craigbox please review

parv18050212 avatar Jul 24 '25 18:07 parv18050212