Skip to content

Commit ba2b986

Browse files
ADubhlaoichJTorreG
andauthored
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]>
1 parent e886318 commit ba2b986

File tree

1 file changed

+13
-16
lines changed

1 file changed

+13
-16
lines changed

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

+13-16
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,25 @@
11
---
22
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."
44
weight: 100
55
toc: true
66
docs: "DOCS-000"
77
---
88

99
## Overview
1010

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.
1412

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">}}):
1814

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.
2423

2524
### Spec
2625

@@ -40,8 +39,7 @@ to reflect whether it is valid or not.
4039

4140
## Viewing and Updating the Configuration
4241

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 >}}
4543

4644
To view the current configuration:
4745

@@ -55,8 +53,7 @@ To update the configuration:
5553
kubectl -n nginx-gateway edit nginxgateways nginx-gateway-config
5654
```
5755

58-
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.
6057

6158
To view the status of the configuration:
6259

0 commit comments

Comments
 (0)