Skip to content

Commit

Permalink
Update Control Plane Configuration documentation for Hugo formatting (#…
Browse files Browse the repository at this point in the history
…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]>
  • Loading branch information
ADubhlaoich and Jcahilltorre authored Nov 30, 2023
1 parent e886318 commit ba2b986
Showing 1 changed file with 13 additions and 16 deletions.
29 changes: 13 additions & 16 deletions site/content/how-to/configuration/control-plane-configuration.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,25 @@
---
title: "Control Plane Configuration"
description: "Learn how to dynamically update the 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"
---

## 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 `<release-name>-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]({{<relref "/installation/installing-ngf">}}):

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: `<release-name>-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

Expand All @@ -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:

Expand All @@ -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:

Expand Down

0 comments on commit ba2b986

Please sign in to comment.