Skip to content

Commit 6115c14

Browse files
ivanmatmatiGopher Bot
authored andcommitted
DOC/MINOR: document the renamed Service Backend CR annotation
Update the Backend CustomResource documentation to use the renamed Service-level annotation gate.v3.haproxy.org/cr-backend.
1 parent 74b4e06 commit 6115c14

1 file changed

Lines changed: 4 additions & 4 deletions

File tree

documentation/CustomResources/backend.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ A `Backend` CR is never rendered on its own — it only takes effect once it is
2020
| Mechanism | Declared on | Applies to | Selects the backend by |
2121
|---|---|---|---|
2222
| **Route-level** | an `HTTPRoute` `backendRef` (`ExtensionRef` filter) | HTTPRoute **only** | the specific `backendRef` (its filter hash) |
23-
| **Service-level** | a `Service` annotation (`gate.v3.haproxy.org/backend-cr`) | HTTPRoute **and** TLSRoute | every backend built for that Service |
23+
| **Service-level** | a `Service` annotation (`gate.v3.haproxy.org/cr-backend`) | HTTPRoute **and** TLSRoute | every backend built for that Service |
2424

2525
> **TLSRoute note:** TLSRoute rules have no filters, so the route-level mechanism
2626
> is not available for TLSRoutes. A TLSRoute can only receive a Backend CR through
@@ -129,7 +129,7 @@ value in the CR replaces the current one.
129129

130130
## Service-level attachment (HTTPRoute and TLSRoute)
131131

132-
Annotate the target `Service` with `gate.v3.haproxy.org/backend-cr`. The CR is
132+
Annotate the target `Service` with `gate.v3.haproxy.org/cr-backend`. The CR is
133133
then merged into **every** backend HUG builds for that Service, no matter which
134134
route (HTTPRoute or TLSRoute) references it:
135135

@@ -140,7 +140,7 @@ metadata:
140140
name: http-echo
141141
namespace: example
142142
annotations:
143-
gate.v3.haproxy.org/backend-cr: backend-tuning
143+
gate.v3.haproxy.org/cr-backend: backend-tuning
144144
spec:
145145
ports:
146146
- name: http
@@ -178,7 +178,7 @@ metadata:
178178
name: http-echo
179179
namespace: team-a
180180
annotations:
181-
gate.v3.haproxy.org/backend-cr: infra/backend-tuning # CR lives in "infra"
181+
gate.v3.haproxy.org/cr-backend: infra/backend-tuning # CR lives in "infra"
182182
---
183183
apiVersion: gateway.networking.k8s.io/v1beta1
184184
kind: ReferenceGrant

0 commit comments

Comments
 (0)