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
Copy file name to clipboardExpand all lines: site/content/how-to/traffic-management/snippets-filters.md
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,16 +11,19 @@ This topic introduces Snippets and how to implement them using the `SnippetsFilt
11
11
12
12
## Overview
13
13
14
-
Snippets allow Cluster Operators to insert NGINX configuration into different contexts of the
14
+
Snippets allow users to insert NGINX configuration into different contexts of the
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 don't apply.
18
+
and can be used in cases where Gateway API resources or NGINX extensions policies don't apply.
19
19
20
20
---
21
21
22
22
## Disadvantages of Snippets
23
23
24
+
{{< warning >}} We recommend managing NGINX configuration through Gateway API resources, [first-class policies]({{< relref "overview/custom-policies.md" >}}), and other existing NGINX extensions
25
+
before using Snippets. {{< /warning >}}
26
+
24
27
Snippets are configured using the `SnippetsFilter` API, but are disabled by default due to their complexity and security implications.
25
28
26
29
To use Snippets, set the `nginxGateway.snippetsFilters.enable` command line argument to true.
@@ -35,9 +38,6 @@ Snippets have the following disadvantages:
35
38
36
39
{{< note >}} If the NGINX configuration includes an invalid Snippet, NGINX will continue to operate with the last valid configuration. {{< /note >}}
37
40
38
-
Due to the described disadvantages of Snippets, we recommend exhausting all other means of NGINX configuration through Gateway API resources,
39
-
[first-class policies]({{< relref "overview/custom-policies.md" >}}), and other NGINX extensions before using Snippets.
40
-
41
41
{{< note >}} If you end up using Snippets and run into situations where an NGINX directive fails to be applied, please create an issue in the
0 commit comments