You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This directory contains the YAML files used in the [Use the SnippetsFilter API](https://docs.nginx.com/nginx-gateway-fabric/how-to/traffic-management/snippets/) guide.
3
+
This directory contains the YAML files used in the [SnippetsFilter API](https://docs.nginx.com/nginx-gateway-fabric/how-to/traffic-management/snippets/) guide.
Copy file name to clipboardExpand all lines: site/content/how-to/traffic-management/snippets.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -15,7 +15,7 @@ Snippets allow users to insert NGINX configuration into different contexts of th
15
15
NGINX configurations that NGINX Gateway Fabric generates.
16
16
17
17
Snippets are for advanced NGINX users who need more control over the generated NGINX configuration,
18
-
and can be used in cases where Gateway API resources or NGINX extensions policies don't apply.
18
+
and can be used in cases where Gateway API resources or NGINX extension policies don't apply.
19
19
20
20
Users can configure Snippets through the `SnippetsFilter` API. `SnippetsFilter` is an [HTTPRouteFilter](https://gateway-api.sigs.k8s.io/reference/spec/#gateway.networking.k8s.io/v1.HTTPRouteFilter)
21
21
that attaches to an HTTP/GRPCRoute rule and is intended to modify NGINX configuration specifically for that Route rule.
@@ -45,7 +45,7 @@ Snippets have the following disadvantages:
45
45
## Setup
46
46
47
47
- To enable Snippets, [install]({{< relref "/installation/" >}}) NGINX Gateway Fabric with these modifications:
48
-
- Using Helm: set the `nginxGateway.snippetsFilters.enable` command line argument to true.
48
+
- Using Helm: set the `nginxGateway.snippetsFilters.enable=true` Helm value.
49
49
- Using Kubernetes manifests: set the `--snippets-filters` flag in the nginx-gateway container argument, add `snippetsfilters` to the RBAC
50
50
rules with verbs `list` and `watch`, and add `snippetsfilters/status` to the RBAC rules with verb `update`. See this [example manifest](https://raw.githubusercontent.com/nginxinc/nginx-gateway-fabric/main/deploy/snippets-filters/deploy.yaml) for clarification.
51
51
@@ -351,7 +351,7 @@ for i in `seq 1 10`; do curl --resolve cafe.example.com:$GW_PORT:$GW_IP http://c
351
351
You should see all successful responses from the tea Pod, but they should be spaced apart roughly one second each as
352
352
expected through the rate limiting configuration.
353
353
354
-
You've now used the `SnippetFilter` resource to configure two distinct rate limiting rules to different backend applications through the use of Snippets.
354
+
You've now used the `SnippetsFilter` resource to configure two distinct rate limiting rules to different backend applications through the use of Snippets.
355
355
For an alternative method of modifying the NGINX configuration NGINX Gateway Fabric generates through Gateway API resources, check out
356
356
our supported [first-class policies]({{< relref "overview/custom-policies.md" >}}) which don't carry many of the aforementioned disadvantages of Snippets.
0 commit comments