Skip to content

docs: add EnvoyPatchPolicy examples for cluster resources - #9711

Open
thiagomedina wants to merge 4 commits into
envoyproxy:mainfrom
thiagomedina:7306/docs/add-envoy-cluster-jsonpatch-example
Open

docs: add EnvoyPatchPolicy examples for cluster resources#9711
thiagomedina wants to merge 4 commits into
envoyproxy:mainfrom
thiagomedina:7306/docs/add-envoy-cluster-jsonpatch-example

Conversation

@thiagomedina

Copy link
Copy Markdown

What this PR does / why we need it:

Adds two examples to the EnvoyPatchPolicy page showing how to customize Envoy Cluster resources with JSONPatch

Which issue(s) this PR fixes:

Fixes #7306


PR Checklist

  • Authorship & ownership: Coding agents / AI assistants are welcome, but I have reviewed every change, understand how and why it works, can explain and maintain it, and take full responsibility for this PR. I have not submitted generated output I do not understand.
  • DCO: All commits are signed off (git commit -s). See DCO: Sign your work.
  • API agreed first: If this PR contains API changes (changes under /api), the API was discussed and agreed before the implementation. The API change can be in a separate PR, or in the same PR, but the API must be agreed before implementation. N/A if this PR does not contain API changes.
  • Required checks pass: make generate gen-check, make lint, and the unit-test/coverage build pass. (Flaky e2e failures are not considered breakages, but gen-check, lint, and coverage MUST pass.)
  • Tests added/updated: New/changed code is covered by appropriate tests. N/A if this PR does not contain code changes.
  • Docs: User-facing changes update the docs, either in this PR or a follow-up PR. N/A if this PR does not contain user-facing changes.
  • Release notes: For any non-trivial change, added a release-note fragment under release-notes/current/<section>/<pr-number>-<slug>.md (see release-notes/current/README.md for sections and naming). N/A if this PR does not contain non-trivial changes.
  • Generated files committed: Ran make gen-check and committed the result if API/helm charts/modules changed.
  • Scope & compatibility: The PR is reasonably scoped (no unrelated changes) and preserves backward compatibility, or any breaking change is called out above and documented in release-notes/current/breaking_changes/.
  • Codex review: Requested a Codex review and addressed all of its comments.
  • Copilot review: Requested a Copilot review and addressed all of its comments.

@thiagomedina
thiagomedina requested a review from a team as a code owner August 8, 2026 20:19
@netlify

netlify Bot commented Aug 8, 2026

Copy link
Copy Markdown

Deploy Preview for cerulean-figolla-1f9435 ready!

Name Link
🔨 Latest commit c9d7efd
🔍 Latest deploy log https://app.netlify.com/projects/cerulean-figolla-1f9435/deploys/6a9c3567c5f48100081459d7
😎 Deploy Preview https://deploy-preview-9711--cerulean-figolla-1f9435.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@zirain

zirain commented Aug 14, 2026

Copy link
Copy Markdown
Member

please fix DCO.

@thiagomedina
thiagomedina force-pushed the 7306/docs/add-envoy-cluster-jsonpatch-example branch from f3c2748 to e46400d Compare August 15, 2026 14:40
@thiagomedina

Copy link
Copy Markdown
Author

please fix DCO.

@zirain done

@zirain

zirain commented Aug 15, 2026

Copy link
Copy Markdown
Member

@codex review

@chatgpt-codex-connector

Copy link
Copy Markdown

Codex Review: Didn't find any major issues. Keep it up!

Reviewed commit: e46400db4b

ℹ️ About Codex in GitHub

Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".

@zirain

zirain commented Aug 15, 2026

Copy link
Copy Markdown
Member

v1.9 released, can you also copy to v1.9?

Signed-off-by: thiagomedina <thiagomedina001@gmail.com>
Signed-off-by: thiagomedina <thiagomedina001@gmail.com>
@thiagomedina
thiagomedina force-pushed the 7306/docs/add-envoy-cluster-jsonpatch-example branch from d831332 to bd50f38 Compare August 17, 2026 17:27
@thiagomedina

thiagomedina commented Aug 17, 2026

Copy link
Copy Markdown
Author

v1.9 released, can you also copy to v1.9?

sure, it's done
@zirain

zirain
zirain previously approved these changes Aug 17, 2026
@thiagomedina

Copy link
Copy Markdown
Author

Hi @zirain, the check-links step in the docs-lint failed, can you rerun ?

https://github.com/envoyproxy/gateway/actions/runs/32050386572/job/95536675767?pr=9711

> docsy-example-site@0.10.0 _check:links
> echo IMPLEMENTATION PENDING for check-links; echo

IMPLEMENTATION PENDING for check-links

cp tools/hack/get-egctl.sh site/public
===========> Running docs-check ... 
===========> Running docs-check-links ... 
tools/node_modules/.bin/linkinator site/public/ -r --concurrency 25 --retry-errors --retry --retry-errors-jitter --retry-errors-count 5 --skip "opentelemetry.io blog.envoyproxy.io envoyproxy.io/slack ntia.gov nvd.nist.gov github.com jwt.io githubusercontent.com example.com foo.bar.com github.io gnu.org _print canva.com communityinviter.com sched.co sap.com httpbin.org nemlig.com verve.com goteleport.com developer.hashicorp.com www.signal-ai.com v0.1 v0.2 v0.3 v0.4 v0.5 v0.6 v1.0 v1.1 v1.2 v1.3 v1.4" --verbosity error
→ crawling site/public/
[408] site/public/v1.9/tasks/security/jwt-authentication
site/public/v1.9/tasks/traffic/response-override/
  [408] site/public/v1.9/tasks/security/jwt-authentication
ERROR: Detected 1 broken links. Scanned 2513 links in 1344.894 seconds.
make[1]: *** [tools/make/docs.mk:180: docs-check-links] Error 1
make[1]: Leaving directory '/home/runner/work/gateway/gateway'
make: *** [Makefile:18: _run] Error 2
Error: Process completed with exit code 2.

@arkodg

arkodg commented Aug 23, 2026

Copy link
Copy Markdown
Contributor

hey @thiagomedina can we add an example that is not covered by the first class APIs

Signed-off-by: thiagomedina <thiagomedina001@gmail.com>
@thiagomedina

thiagomedina commented Sep 5, 2026

Copy link
Copy Markdown
Author

hey @thiagomedina can we add an example that is not covered by the first class APIs

hey @arkodg, yes
I changed it to an example not covered by the first class APIs

cc @zirain

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

How to patch Cluster with EnvoyPatchPolicy

3 participants