From 4df59d4a40f4c5c034dc7bc37a5aee5661cc673f Mon Sep 17 00:00:00 2001 From: Alan Dooley Date: Thu, 30 Nov 2023 15:12:37 +0000 Subject: [PATCH 1/2] Update Control Plane Configuration documentation for Hugo formatting 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. --- .../control-plane-configuration.md | 29 +++++++++---------- 1 file changed, 13 insertions(+), 16 deletions(-) diff --git a/site/content/how-to/configuration/control-plane-configuration.md b/site/content/how-to/configuration/control-plane-configuration.md index 89f4016bad..ae483d6a7e 100644 --- a/site/content/how-to/configuration/control-plane-configuration.md +++ b/site/content/how-to/configuration/control-plane-configuration.md @@ -1,6 +1,6 @@ --- title: "Control Plane Configuration" -description: "Learn how to dynamically update the NGINX Gateway Fabric control plane configuration." +description: "Learn how to dynamically update the F5 NGINX Gateway Fabric control plane configuration." weight: 100 toc: true docs: "DOCS-000" @@ -8,19 +8,18 @@ docs: "DOCS-000" ## Overview -NGINX Gateway Fabric offers a way to update the control plane configuration dynamically without the need for a -restart. The control plane configuration is stored in the NginxGateway custom resource. This resource is created -during the installation of NGINX Gateway Fabric. +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. -If using manifests, the default name of the resource is `nginx-gateway-config`. If using Helm, the default name -of the resource is `-config`. It is deployed in the same Namespace as the controller -(default `nginx-gateway`). +NginxGateway is deployed in the same namespace as the controller (Default: `nginx-gateway`). The resource's default name is based on your [installation method]({{}}): -The control plane only watches this single instance of the custom resource. If the resource is invalid per 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. Additionally, the control plane updates the status of the resource (if it exists) -to reflect whether it is valid or not. +- Helm: `-config` +- Manifests: `nginx-gateway-config` + +The control plane only watches this single instance of the custom resource. + +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. + +Additionally, the control plane updates the status of the resource (if it exists) to reflect whether it is valid or not. ### Spec @@ -40,8 +39,7 @@ to reflect whether it is valid or not. ## Viewing and Updating the Configuration -> For the following examples, the name `nginx-gateway-config` should be updated to the name of the resource that -> was created by your installation. +{{< note >}} For the following examples, the name `nginx-gateway-config` should be updated to the name of the resource created for your installation. {{< /note >}} To view the current configuration: @@ -55,8 +53,7 @@ To update the configuration: kubectl -n nginx-gateway edit nginxgateways nginx-gateway-config ``` -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. +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. To view the status of the configuration: From a9c5f43ade40668bc0c45a1ce8e8f813571e1626 Mon Sep 17 00:00:00 2001 From: Alan Dooley Date: Thu, 30 Nov 2023 16:10:41 +0000 Subject: [PATCH 2/2] Apply suggestions from code review --- .../how-to/configuration/control-plane-configuration.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/site/content/how-to/configuration/control-plane-configuration.md b/site/content/how-to/configuration/control-plane-configuration.md index ae483d6a7e..4be6967119 100644 --- a/site/content/how-to/configuration/control-plane-configuration.md +++ b/site/content/how-to/configuration/control-plane-configuration.md @@ -1,6 +1,6 @@ --- title: "Control Plane Configuration" -description: "Learn how to dynamically update the F5 NGINX Gateway Fabric control plane configuration." +description: "Learn how to dynamically update the Gateway Fabric control plane configuration." weight: 100 toc: true docs: "DOCS-000" @@ -15,9 +15,9 @@ NginxGateway is deployed in the same namespace as the controller (Default: `ngin - Helm: `-config` - Manifests: `nginx-gateway-config` -The control plane only watches this single instance of the custom resource. +The control plane only watches this single instance of the custom resource. -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. +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. Additionally, the control plane updates the status of the resource (if it exists) to reflect whether it is valid or not.