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
Update Control Plane Configuration documentation for Hugo formatting (#1296)
This commit updates the control plane configuration documentation to
match NGINX's standardised Hugo formatting conventions: specifically,
avoiding breaking sentences across line and the use of shortcodes for a
note. There are also some minor content changes for product noun
conventions and rephrasing a few sentences.
---------
Co-authored-by: Jon Torre <[email protected]>
Copy file name to clipboardExpand all lines: site/content/how-to/configuration/control-plane-configuration.md
+13-16
Original file line number
Diff line number
Diff line change
@@ -1,26 +1,25 @@
1
1
---
2
2
title: "Control Plane Configuration"
3
-
description: "Learn how to dynamically update the NGINX Gateway Fabric control plane configuration."
3
+
description: "Learn how to dynamically update the Gateway Fabric control plane configuration."
4
4
weight: 100
5
5
toc: true
6
6
docs: "DOCS-000"
7
7
---
8
8
9
9
## Overview
10
10
11
-
NGINX Gateway Fabric offers a way to update the control plane configuration dynamically without the need for a
12
-
restart. The control plane configuration is stored in the NginxGateway custom resource. This resource is created
13
-
during the installation of NGINX Gateway Fabric.
11
+
NGINX Gateway Fabric can dynamically update the control plane configuration without restarting. The control plane configuration is stored in the NginxGateway custom resource, created during the installation of NGINX Gateway Fabric.
14
12
15
-
If using manifests, the default name of the resource is `nginx-gateway-config`. If using Helm, the default name
16
-
of the resource is `<release-name>-config`. It is deployed in the same Namespace as the controller
17
-
(default `nginx-gateway`).
13
+
NginxGateway is deployed in the same namespace as the controller (Default: `nginx-gateway`). The resource's default name is based on your [installation method]({{<relref "/installation/installing-ngf">}}):
18
14
19
-
The control plane only watches this single instance of the custom resource. If the resource is invalid per the OpenAPI
20
-
schema, the Kubernetes API server will reject the changes. If the resource is deleted or deemed invalid by NGINX
21
-
Gateway Fabric, a warning Event is created in the `nginx-gateway` Namespace, and the default values will be used by
22
-
the control plane for its configuration. Additionally, the control plane updates the status of the resource (if it exists)
23
-
to reflect whether it is valid or not.
15
+
- Helm: `<release-name>-config`
16
+
- Manifests: `nginx-gateway-config`
17
+
18
+
The control plane only watches this single instance of the custom resource.
19
+
20
+
If the resource is invalid to the OpenAPI schema, the Kubernetes API server will reject the changes. If the resource is deleted or deemed invalid by NGINX Gateway Fabric, a warning event is created in the `nginx-gateway` namespace, and the default values will be used by the control plane for its configuration.
21
+
22
+
Additionally, the control plane updates the status of the resource (if it exists) to reflect whether it is valid or not.
24
23
25
24
### Spec
26
25
@@ -40,8 +39,7 @@ to reflect whether it is valid or not.
40
39
41
40
## Viewing and Updating the Configuration
42
41
43
-
> For the following examples, the name `nginx-gateway-config` should be updated to the name of the resource that
44
-
> was created by your installation.
42
+
{{< note >}} For the following examples, the name `nginx-gateway-config` should be updated to the name of the resource created for your installation. {{< /note >}}
This will open the configuration in your default editor. You can then update and save the configuration, which is
59
-
applied automatically to the control plane.
56
+
This will open the configuration in your default editor. You can then update and save the configuration, which is applied automatically to the control plane.
0 commit comments