Skip to content

Commit 4978109

Browse files
committed
Review
1 parent aa0dd0c commit 4978109

File tree

1 file changed

+26
-2
lines changed

1 file changed

+26
-2
lines changed

site/content/how-to/data-plane-configuration.md

Lines changed: 26 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,13 @@ Learn how to dynamically update the NGINX Gateway Fabric global data plane confi
99

1010
## Overview
1111

12-
NGINX Gateway Fabric can dynamically update the global data plane configuration without restarting. The data plane configuration is a global configuration for nginx that has options that are not available using the standard Gateway API resources. This includes such things as setting an OpenTelemetry collector config, disabling http2, or changing the IP family.
12+
NGINX Gateway Fabric can dynamically update the global data plane configuration without restarting. The data plane configuration is a global configuration for NGINX that has options that are not available using the standard Gateway API resources. This includes such things as setting an OpenTelemetry collector config, disabling http2, or changing the IP family.
1313

1414
The data plane configuration is stored in the NginxProxy custom resource, which is a cluster-scoped resource that is attached to the `nginx` GatewayClass.
1515

1616
By default, the NginxProxy resource is not created when installing NGINX Gateway Fabric. However, you can set configuration options in the `nginx.config` Helm values, and the resource will be created and attached when NGINX Gateway Fabric is installed using Helm. You can also [manually create and attach](#manually-creating-the-configuration) the resource after NGINX Gateway Fabric is already installed.
1717

18-
If installed using the Helm chart, the NginxProxy resource is named `<release-name>-proxy-config`.
18+
When installed using the Helm chart, the NginxProxy resource is named `<release-name>-proxy-config`.
1919

2020
**For a full list of configuration options that can be set, see the `NginxProxy spec` in the [API reference]({{< relref "reference/api.md" >}}).**
2121

@@ -47,6 +47,18 @@ To view the status of the configuration, check the GatewayClass that it is attac
4747
kubectl describe gatewayclasses nginx
4848
```
4949

50+
```text
51+
...
52+
Status:
53+
Conditions:
54+
...
55+
Message: parametersRef resource is resolved
56+
Observed Generation: 1
57+
Reason: ResolvedRefs
58+
Status: True
59+
Type: ResolvedRefs
60+
```
61+
5062
If everything is valid, the `ResolvedRefs` condition should be `True`. Otherwise, you will see an `InvalidParameters` condition in the status.
5163

5264
## Manually Creating the Configuration
@@ -87,4 +99,16 @@ After updating, you can check the status of the GatewayClass to see if the confi
8799
kubectl describe gatewayclasses nginx
88100
```
89101

102+
```text
103+
...
104+
Status:
105+
Conditions:
106+
...
107+
Message: parametersRef resource is resolved
108+
Observed Generation: 1
109+
Reason: ResolvedRefs
110+
Status: True
111+
Type: ResolvedRefs
112+
```
113+
90114
If everything is valid, the `ResolvedRefs` condition should be `True`. Otherwise, you will see an `InvalidParameters` condition in the status.

0 commit comments

Comments
 (0)