Skip to content

docs: explain backend policies and timeouts - #1012

Merged
kristin-kronstain-brown merged 6 commits into
agentgateway:mainfrom
danehans:docs-backend-policies
Sep 3, 2026
Merged

docs: explain backend policies and timeouts#1012
kristin-kronstain-brown merged 6 commits into
agentgateway:mainfrom
danehans:docs-backend-policies

Conversation

@danehans

@danehans danehans commented Sep 2, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • Add a backend policy overview with attachment and capability guidance.
  • Document backend connection and response timeouts with a tested Service example.
  • Show how to configure a guardrail webhook timeout.
  • Order the policy overview pages consistently.
  • Fix observability compatibility checks for moved pages and deprecated tab syntax.

Testing

  • Production Hugo build.
  • Targeted backend timeout doc test.
  • Static and content checks.
  • Link checker.
  • OpenTelemetry stack doc test.
  • DCO check.

Signed-off-by: Daneyon Hansen <daneyon.hansen@solo.io>
Signed-off-by: Daneyon Hansen <daneyon.hansen@solo.io>
Signed-off-by: Daneyon Hansen <daneyon.hansen@solo.io>
Signed-off-by: Daneyon Hansen <daneyon.hansen@solo.io>
@danehans

danehans commented Sep 3, 2026

Copy link
Copy Markdown
Collaborator Author

cc: @Nadine2016

Reviewed PR agentgateway#1012 and applied maintainer fixes on top.

Deduplication:
- Remove about/policies/backend-policies.md. Three of its five sections
  restated about/policies/target-merge.md, which already documents the
  backend attachment table, the ai/mcp Service restriction, inline versus
  attached precedence, the full 7-level merge order, and equal-specificity
  ties. Fold the part with no existing home, the backend.* field to guide
  table, into about/policies/overview.md as 'Backend policy fields'.
- Drop the 'Choose the timeout' table from resiliency/timeouts/backend.md
  and add backend connection and backend response rows to the existing
  Configuration options table in timeouts/about.md instead.
- Replace the duplicated 'Set a webhook timeout' example with a link to
  the worked example in the guardrails guide.
- Cross-link resiliency/connection.md#backend and timeouts/backend.md, so
  the route-attached and Service-attached cases point at each other.

Accuracy, verified against agentgateway.dev_agentgatewaypolicies.yaml:
- Drop the claim that a Service policy overrides backend.http from a route
  policy. Service does not appear in the merge precedence order in
  target-merge.md, so the claim is unsupported.
- Name failureMode and its FailClosed default in the guardrails guide. The
  webhook block carries no timeout field, which is why the separate policy
  is needed; failureMode was previously undocumented.
- Add the 1ms minimum for backend.http.requestTimeout.
- Fix connection.md, which said a backend policy sets tcp and http only.
- Move the same-namespace targeting rule to target-merge.md, where the
  other targeting rules live.

Alias hunk reverted to main:
- main already fixed these aliases, with the reasoning inline. Keeping the
  bare /observability/tracing rebuilt a redirect at the site root, which
  main deliberately removed. The added main-tree access-logging alias was
  inert: main/security/access-logging.md is a live redirect stub, so the
  real page won and Hugo dropped the alias.
- Kept the otel-stack tab fix. tabTotal is not a Hextra parameter and
  items fires a deprecation warnf, against 1,679 uses of the name form.

Weights: keep filter-order at 5, which fixes the pre-existing collision
with target-merge, and leave conditional-policies at 15.

Verified: Hugo 0.160.1 production build clean, 6,438 pages, no warnings;
all internal links on the 7 touched pages resolve; new anchors resolve.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Signed-off-by: Kristin Brown <kristin.brown@solo.io>
@kristin-kronstain-brown
kristin-kronstain-brown merged commit 2c57c37 into agentgateway:main Sep 3, 2026
4 checks passed
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.

2 participants