Skip to content

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

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

Open
wants to merge 11 commits into
base: master
Choose a base branch
from

Conversation

parv18050212
Copy link

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 parv18050212 requested a review from a team as a code owner July 13, 2025 14:44
@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.

@istio-testing istio-testing added size/S Denotes a PR that changes 10-29 lines, ignoring generated files. needs-ok-to-test labels Jul 13, 2025
@istio-testing
Copy link
Contributor

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.

Comment on lines 28 to 29
⚠️ **For Istio versions earlier than 1.26:**
You must manually create a ResourceQuota in the namespace (such as `istio-system`), for example:
Copy link
Contributor

@craigbox craigbox Jul 14, 2025

Choose a reason for hiding this comment

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

Please use a shortcode for this kind of content.
(You won't be needing this after the changes so it's just a FYI)

@craigbox
Copy link
Contributor

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
Copy link
Contributor

/ok-to-test

@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 Jul 14, 2025
@parv18050212
Copy link
Author

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

@istio-testing istio-testing added size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Jul 14, 2025
@craigbox
Copy link
Contributor

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

@istio-testing istio-testing added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Jul 14, 2025
@parv18050212
Copy link
Author

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

@craigbox
Copy link
Contributor

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

@parv18050212
Copy link
Author

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.

@istio-testing istio-testing removed the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Jul 14, 2025
@istio-testing istio-testing added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Jul 14, 2025
@parv18050212
Copy link
Author

@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!

@dhawton
Copy link
Member

dhawton commented Jul 14, 2025

@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

Copy link
Member

@dhawton dhawton left a comment

Choose a reason for hiding this comment

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

I think you have a formatter or something that is replacing a lot in this file that it shouldn't be.


## CNI plugins

The following configurations apply to all platforms, when certain {{< gloss "CNI" >}}CNI plugins{{< /gloss >}} are used:
The following configurations apply to all platforms, when certain CNI plugins are used:
Copy link
Member

Choose a reason for hiding this comment

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

Why is this being changed?

Comment on lines 212 to 214
2. Cilium's BPF masquerading is currently disabled by default, and has issues with Istio's use of link-local IPs for Kubernetes health checking. Enabling BPF masquerading via `bpf.masquerade=true` is not currently supported, and results in non-functional pod health checks in Istio ambient. Cilium's default iptables masquerading implementation should continue to function correctly.
3. Due to how Cilium manages node identity and internally allow-lists node-level health probes to pods,
applying any default-DENY `NetworkPolicy` in a Cilium CNI install underlying Istio in ambient mode will cause `kubelet` health probes (which are by-default silently exempted from all policy enforcement by Cilium) to be blocked. This is because Istio uses a link-local SNAT address for kubelet health probes, which Cilium is not aware of, and Cilium does not have an option to exempt link-local addresses from policy enforcement.
Copy link
Member

Choose a reason for hiding this comment

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

This is where you're getting your ordered number linting failure. Not sure why these are being changed, however?

Comment on lines 274 to 218
{{< text syntax=yaml >}}
```yaml
Copy link
Member

Choose a reason for hiding this comment

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

Why?

@craigbox
Copy link
Contributor

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)

@parv18050212
Copy link
Author

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.

@istio-testing istio-testing added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Jul 16, 2025
@parv18050212 parv18050212 requested review from craigbox and dhawton July 19, 2025 13:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ok-to-test Set this label allow normal testing to take place for a PR not submitted by an Istio org member. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

ambient GKE docs: update section about manually creating ResourceQuota
5 participants