Skip to content

Commit 6105dde

Browse files
AlinsRanCopilot
andcommitted
docs: update CRD API reference with L4RoutePolicy
Run 'make generate-crd-docs' to add L4RoutePolicy and L4RoutePolicySpec entries to the auto-generated CRD reference documentation. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
1 parent c36522a commit 6105dde

1 file changed

Lines changed: 36 additions & 0 deletions

File tree

docs/en/latest/reference/api-reference.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ Package v1alpha1 contains API Schema definitions for the apisix.apache.org v1alp
1919
- [Consumer](#consumer)
2020
- [GatewayProxy](#gatewayproxy)
2121
- [HTTPRoutePolicy](#httproutepolicy)
22+
- [L4RoutePolicy](#l4routepolicy)
2223
- [PluginConfig](#pluginconfig)
2324
### BackendTrafficPolicy
2425

@@ -84,6 +85,24 @@ HTTPRoutePolicy defines configuration of traffic policies.
8485

8586

8687

88+
### L4RoutePolicy
89+
90+
91+
L4RoutePolicy defines plugin configuration for Gateway API L4 routes (TCPRoute, UDPRoute, TLSRoute).
92+
It follows the Gateway API Policy Attachment pattern and attaches APISIX stream plugins
93+
to the targeted L4 route resources.
94+
95+
<!-- L4RoutePolicy resource -->
96+
97+
| Field | Description |
98+
| --- | --- |
99+
| `apiVersion` _string_ | `apisix.apache.org/v1alpha1`
100+
| `kind` _string_ | `L4RoutePolicy`
101+
| `metadata` _[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#objectmeta-v1-meta)_ | Please refer to the Kubernetes API documentation for details on the `metadata` field. |
102+
| `spec` _[L4RoutePolicySpec](#l4routepolicyspec)_ | Spec defines the desired state of L4RoutePolicy. |
103+
104+
105+
87106
### PluginConfig
88107

89108

@@ -433,6 +452,22 @@ _Base type:_ `string`
433452
_Appears in:_
434453
- [BackendTrafficPolicySpec](#backendtrafficpolicyspec)
435454

455+
#### L4RoutePolicySpec
456+
457+
458+
L4RoutePolicySpec defines the desired state of L4RoutePolicy.
459+
460+
461+
462+
| Field | Description |
463+
| --- | --- |
464+
| `targetRefs` _LocalPolicyTargetReferenceWithSectionName array_ | TargetRefs identifies the L4 route resources (TCPRoute, UDPRoute, or TLSRoute) to which this policy applies. Only same-namespace targets are supported. |
465+
| `plugins` _[Plugin](#plugin) array_ | Plugins is the list of APISIX stream plugins to attach to the targeted L4 routes. Plugin names should be valid APISIX stream plugin names (e.g., limit-conn, ip-restriction). |
466+
467+
468+
_Appears in:_
469+
- [L4RoutePolicy](#l4routepolicy)
470+
436471
#### LoadBalancer
437472

438473

@@ -518,6 +553,7 @@ _Appears in:_
518553

519554
_Appears in:_
520555
- [ConsumerSpec](#consumerspec)
556+
- [L4RoutePolicySpec](#l4routepolicyspec)
521557
- [PluginConfigSpec](#pluginconfigspec)
522558

523559
#### PluginConfigSpec

0 commit comments

Comments
 (0)