docs(agentgateway): Add AgentgatewayPolicy long-form docs+accessLog/backend TLS /transformation examples#654
Open
GauravSRC wants to merge 2 commits intokgateway-dev:mainfrom
Open
Conversation
…gateway-dev#471) Signed-off-by: Gaurav <gauravsingh70800@gmail.com>
…etRef + safety notes) Signed-off-by: Gaurav <gauravsingh70800@gmail.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes: #471
Summary
This PR adds a long-form documentation page for the
AgentgatewayPolicyCRD and includes three example manifests demonstrating:examples/access-logging-agentgatewaypolicy.yaml)examples/backend-tls-tcp-agentgatewaypolicy.yaml)examples/transformation-agentgatewaypolicy.yaml)What I changed
content/docs/agentgateway/agentgateway-policy.md-- long-form guide, schema excerpt, conceptual notes, and three example sections.content/docs/agentgateway/examples/:access-logging-agentgatewaypolicy.yamlbackend-tls-tcp-agentgatewaypolicy.yaml(usessecretRef; includes security note)transformation-agentgatewaypolicy.yamltitle,toc: true,publishDate, andauthor.hugo server -Druns andhugo --minifycompletes locally.Signed-off-by: Gaurav<gauravsingh70800@gmail.com>).Why
AgentgatewayPolicyreplaces the olderTrafficPolicyand adds first-class support for access logs, backend configuration (TLS/TCP), and transformations. These docs provide copy/paste examples and security guidance to help users adopt the new policy.How I validated
/docs/agentgateway/agentgateway-policy/.Notes for reviewers
name/namespace/secret values for their clusters.static/examples/or a newexamples/top-level folder), I can move them in a followup commit.Testing locally
hugo --minifyto verify a production-like build.Thank you --happy to iterate on wording, namespace choices, or to add a tiny CI workflow that runs
hugo --minifyif maintainers want a build check in the PR.