Skip to content

Update Control Plane Configuration documentation for Hugo formatting #1296

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Nov 30, 2023
Merged

Update Control Plane Configuration documentation for Hugo formatting #1296

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4df59d4
Update Control Plane Configuration documentation for Hugo formatting
ADubhlaoich Nov 30, 2023
42ea286
Merge branch 'docs/hugo-docs' into control-plane-rewrite
JTorreG Nov 30, 2023
a9c5f43
Apply suggestions from code review
ADubhlaoich Nov 30, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 13 additions & 16 deletions site/content/how-to/configuration/control-plane-configuration.md
View file
Open in desktop
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 F5 NGINX Gateway Fabric control plane configuration."
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think F5 should be in the name here, our product doesn't include that in its name.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

following up on that

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Getting clarification from further up if Gateway is an exception: the first instance of any NGINX product name on any page is always prepended by F5. This description is currently visible to the end user but will not be in the future, as it's HTML metadata.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Removing it for now.

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