Skip to content

Commit f2a8261

Browse files
JTorreGADubhlaoich
andauthored
docs: add missing NGF docs to the catalog (#763)
Co-authored-by: Alan Dooley <a.dooley@f5.com>
1 parent 5019dac commit f2a8261

27 files changed

+69
-68
lines changed

content/ngf/changelog.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ toc: true
44
weight: 900
55
nd-content-type: reference
66
nd-product: NGF
7-
nd-docs: "DOCS-1359"
7+
nd-docs: DOCS-1359
88
---
99

1010
See the NGINX Gateway Fabric changelog page:

content/ngf/get-started.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,11 @@ weight: 200
44
toc: true
55
nd-content-type: how-to
66
nd-product: NGF
7-
nd-docs: DOCS-000
7+
nd-docs: DOCS-1834
88
---
99

1010
{{< important >}}
11-
This document is for trying out NGINX Gateway Fabric, and not intended for a production environment.
11+
This document is for trying out NGINX Gateway Fabric, and not intended for a production environment.
1212

1313
For standard deployments, you should read the [Install NGINX Gateway Fabric]({{< ref "/ngf/install/" >}}) section.
1414
{{< /important >}}
@@ -102,7 +102,7 @@ customresourcedefinition.apiextensions.k8s.io/referencegrants.gateway.networking
102102

103103
### Install the Helm chart
104104

105-
Use `helm` to install NGINX Gateway Fabric, specifying the NodePort configuration that will be set on the
105+
Use `helm` to install NGINX Gateway Fabric, specifying the NodePort configuration that will be set on the
106106
NGINX Service when it is provisioned:
107107

108108
```shell

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ weight: 400
44
toc: true
55
type: how-to
66
product: NGF
7-
docs: DOCS-1416
7+
nd-docs: DOCS-1839
88
---
99

1010
Learn how to dynamically update the NGINX Gateway Fabric control plane configuration.

content/ngf/how-to/data-plane-configuration.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ weight: 500
44
toc: true
55
type: how-to
66
product: NGF
7-
docs: DOCS-000
7+
nd-docs: DOCS-1838
88
---
99

1010
Learn how to dynamically update the NGINX Gateway Fabric global data plane configuration.
@@ -342,7 +342,7 @@ EOF
342342

343343
## Configure infrastructure-related settings
344344

345-
You can configure deployment and service settings for all data plane instances by editing the `NginxProxy` resource at the Gateway or GatewayClass level. These settings can also be specified under the `nginx` section in the Helm values file. You can edit things such as replicas, pod scheduling options, container resource limits, extra volume mounts, service types and load balancer settings.
345+
You can configure deployment and service settings for all data plane instances by editing the `NginxProxy` resource at the Gateway or GatewayClass level. These settings can also be specified under the `nginx` section in the Helm values file. You can edit things such as replicas, pod scheduling options, container resource limits, extra volume mounts, service types and load balancer settings.
346346

347347
The following command creates an `NginxProxy` resource with 2 replicas, sets `container.resources.requests` to 100m CPU and 128Mi memory, configures a 90 second `pod.terminationGracePeriodSeconds`, and sets the service type to `LoadBalancer` with IP `192.87.9.1` and AWS NLB annotation.
348348

content/ngf/how-to/scaling.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ weight: 700
44
toc: true
55
type: how-to
66
product: NGF
7-
docs: DOCS-0000
7+
nd-docs: DOCS-1840
88
---
99

1010
This document describes how you can separately scale the NGINX Gateway Fabric control plane and data plane.
@@ -14,7 +14,7 @@ It provides guidance on how to scale each plane effectively, and when you should
1414

1515
### Scaling the data plane
1616

17-
The data plane is the NGINX deployment that handles user traffic to backend applications. Every Gateway object created provisions its own NGINX deployment and configuration.
17+
The data plane is the NGINX deployment that handles user traffic to backend applications. Every Gateway object created provisions its own NGINX deployment and configuration.
1818

1919
You have two options for scaling the data plane:
2020

@@ -25,9 +25,9 @@ You have two options for scaling the data plane:
2525

2626
Understanding when to increase replicas or create a new Gateway is key to managing traffic effectively.
2727

28-
Increasing data plane replicas is ideal when you need to handle more traffic without changing the configuration.
28+
Increasing data plane replicas is ideal when you need to handle more traffic without changing the configuration.
2929

30-
For example, if you're routing traffic to `api.example.com` and notice an increase in load, you can scale the replicas from 1 to 5 to better distribute the traffic and reduce latency.
30+
For example, if you're routing traffic to `api.example.com` and notice an increase in load, you can scale the replicas from 1 to 5 to better distribute the traffic and reduce latency.
3131

3232
All replicas will share the same configuration from the Gateway used to set up the data plane, simplifying configuration management.
3333

@@ -45,15 +45,15 @@ Secondly, you can update the `NginxProxy` resource while NGINX is running to mod
4545
kubectl edit nginxproxies.gateway.nginx.org ngf-proxy-config -n nginx-gateway
4646
```
4747

48-
The alternate way to scale the data plane is by creating a new Gateway. This is beneficial when you need distinct configurations, isolation, or separate policies.
48+
The alternate way to scale the data plane is by creating a new Gateway. This is beneficial when you need distinct configurations, isolation, or separate policies.
4949

50-
For example, if you're routing traffic to a new domain `admin.example.com` and require a different TLS certificate, stricter rate limits, or separate authentication policies, creating a new Gateway could be a good approach.
50+
For example, if you're routing traffic to a new domain `admin.example.com` and require a different TLS certificate, stricter rate limits, or separate authentication policies, creating a new Gateway could be a good approach.
5151

5252
It allows for safe experimentation with isolated configurations and makes it easier to enforce security boundaries and specific routing rules.
5353

5454
### Scaling the control plane
5555

56-
The control plane builds configuration based on defined Gateway API resources and sends that configuration to the NGINX data planes. With leader election enabled by default, the control plane can be scaled horizontally by running multiple replicas, although only the pod with leader lease can actively manage configuration status updates.
56+
The control plane builds configuration based on defined Gateway API resources and sends that configuration to the NGINX data planes. With leader election enabled by default, the control plane can be scaled horizontally by running multiple replicas, although only the pod with leader lease can actively manage configuration status updates.
5757

5858
Scaling the control plane can be beneficial in the following scenarios:
5959

@@ -70,11 +70,11 @@ To scale the control plane, use the `kubectl scale` command on the control plane
7070

7171
When scaling the control plane, it's important to understand how status updates are handled for Gateway API resources.
7272

73-
All control plane pods can send NGINX configuration to the data planes. However, only the leader control plane pod is allowed to write status updates to Gateway API resources.
73+
All control plane pods can send NGINX configuration to the data planes. However, only the leader control plane pod is allowed to write status updates to Gateway API resources.
7474

75-
If an NGINX instance connects to a non-leader pod, and an error occurs when applying the config, that error status will not be written to the Gateway object status.
75+
If an NGINX instance connects to a non-leader pod, and an error occurs when applying the config, that error status will not be written to the Gateway object status.
7676

77-
To mitigate the potential for this issue, ensure that the number of NGINX data plane pods equals or exceeds the number of control plane pods.
77+
To mitigate the potential for this issue, ensure that the number of NGINX data plane pods equals or exceeds the number of control plane pods.
7878

7979
This increases the likelihood that at least one of the data planes is connected to the leader control plane pod. If an applied configuration has an error, the leader pod will be aware of it and status can still be written.
8080

content/ngf/how-to/upgrade-apps-without-downtime.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ weight: 600
44
toc: true
55
type: how-to
66
product: NGF
7-
docs: DOCS-1420
7+
nd-docs: DOCS-1841
88
---
99

1010
Learn how to use NGINX Gateway Fabric to upgrade applications without downtime.

content/ngf/install/deploy-data-plane.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ weight: 600
44
toc: true
55
nd-content-type: how-to
66
nd-product: NGF
7-
nd-docs: DOCS-000
7+
nd-docs: DOCS-1854
88
---
99

1010
## Overview
@@ -104,13 +104,13 @@ The NginxProxy custom resource can modify the provisioning of the Service object
104104

105105
{{< note >}} Updating most Kubernetes related fields in NginxProxy will trigger a restart of the related resources. {{< /note >}}
106106

107-
An NginxProxy resource is created by default after deploying NGINX Gateway Fabric. This NginxProxy resource is attached to the GatewayClass (created on NGINX Gateway Fabric installation), and
107+
An NginxProxy resource is created by default after deploying NGINX Gateway Fabric. This NginxProxy resource is attached to the GatewayClass (created on NGINX Gateway Fabric installation), and
108108
its settings are applied globally to all Gateways.
109109

110110
Use `kubectl get` and `kubectl describe` to get some more information on the resource:
111111

112112
```shell
113-
kubectl get nginxproxies -A
113+
kubectl get nginxproxies -A
114114
```
115115
```text
116116
NAMESPACE NAME AGE
@@ -159,7 +159,7 @@ Under `Spec.Kubernetes` you can see a few things:
159159
- How many NGINX Deployment replicas are specified
160160
- The type of Service and external traffic policy
161161

162-
{{< note >}} Depending on installation configuration, the default NginxProxy settings may be slightly different from what is shown in the example.
162+
{{< note >}} Depending on installation configuration, the default NginxProxy settings may be slightly different from what is shown in the example.
163163
For more information on NginxProxy and its configurable fields, see the [API reference]({{< ref "/ngf/reference/api.md" >}}). {{< /note >}}
164164

165165
Modify the NginxProxy resource to change the type of Service.
@@ -173,7 +173,7 @@ type: NodePort
173173
After saving the changes, use `kubectl get` on the service, and you should see the service type has changed to `LoadBalancer`.
174174

175175
```shell
176-
kubectl get service cafe-nginx
176+
kubectl get service cafe-nginx
177177
```
178178
```text
179179
NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE
@@ -184,7 +184,7 @@ cafe-nginx NodePort 10.96.172.204 <none> 80:32615/TCP 3h5m
184184

185185
While the majority of configuration will happen on the NginxProxy resource, that is not always the case. Uniquely, if
186186
you want to set any annotations or labels on the NGINX Deployment or Service, you need to set those annotations on the Gateway which
187-
provisioned them.
187+
provisioned them.
188188

189189
You can use `kubectl edit` on the Gateway and add the following to the `spec`:
190190

content/ngf/install/nginx-plus.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ weight: 300
44
toc: true
55
nd-content-type: how-to
66
nd-product: NGF
7-
nd-docs: DOCS-000
7+
nd-docs: DOCS-1853
88
---
99

1010
## Overview

content/ngf/install/secure-certificates.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,14 @@ weight: 100
44
toc: true
55
nd-content-type: how-to
66
nd-product: NGF
7+
nd-docs: DOCS-1851
78
---
89

9-
By default, NGINX Gateway Fabric installs self-signed certificates to secure the connection between the NGINX Gateway Fabric control plane and the NGINX data plane pods. These certificates are created by a `cert-generator` job when NGINX Gateway Fabric is first installed.
10+
By default, NGINX Gateway Fabric installs self-signed certificates to secure the connection between the NGINX Gateway Fabric control plane and the NGINX data plane pods. These certificates are created by a `cert-generator` job when NGINX Gateway Fabric is first installed.
1011

1112
However, because these certificates are self-signed and will expire after 3 years, we recommend a solution such as [cert-manager](https://cert-manager.io) to create and manage these certificates in a production environment.
1213

13-
This guide will step through how to install and use `cert-manager` to secure this connection.
14+
This guide will step through how to install and use `cert-manager` to secure this connection.
1415

1516
{{< caution >}}
1617

@@ -179,7 +180,7 @@ Specify the Secret name using the `certGenerator.agentTLSSecretName` helm value.
179180

180181
{{%tab name="Manifests"%}}
181182

182-
Specify the Secret name using the `agent-tls-secret` command-line argument.
183+
Specify the Secret name using the `agent-tls-secret` command-line argument.
183184

184185
{{% /tab %}}
185186

content/ngf/install/upgrade-version.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,18 +4,18 @@ weight: 700
44
toc: true
55
type: how-to
66
product: NGF
7-
docs: DOCS-0000
7+
nd-docs: DOCS-1852
88
---
99

10-
This document describes how to upgrade NGINX Gateway Fabric when a new version releases.
10+
This document describes how to upgrade NGINX Gateway Fabric when a new version releases.
1111

1212
It covers the necessary steps for minor versions as well as major versions (such as 1.x to 2.x).
1313

1414
Many of the nuances in upgrade paths relate to how custom resource definitions (CRDs) are managed.
1515

16-
{{< tip >}}
16+
{{< tip >}}
1717

18-
To avoid interruptions, review the [Delay pod termination for zero downtime upgrades](#configure-delayed-pod-termination-for-zero-downtime-upgrades) section.
18+
To avoid interruptions, review the [Delay pod termination for zero downtime upgrades](#configure-delayed-pod-termination-for-zero-downtime-upgrades) section.
1919

2020
{{< /tip >}}
2121

@@ -24,7 +24,7 @@ To avoid interruptions, review the [Delay pod termination for zero downtime upgr
2424

2525
{{< important >}} NGINX Plus users need a JWT secret before upgrading from version 1.4.0 to 1.5.x.
2626

27-
Follow the steps in [Set up the JWT]({{< ref "/ngf/install/nginx-plus.md#set-up-the-jwt" >}}) to create the Secret.
27+
Follow the steps in [Set up the JWT]({{< ref "/ngf/install/nginx-plus.md#set-up-the-jwt" >}}) to create the Secret.
2828

2929
{{< /important >}}
3030

@@ -33,7 +33,7 @@ Follow the steps in [Set up the JWT]({{< ref "/ngf/install/nginx-plus.md#set-up-
3333

3434
To upgrade your Gateway API resources, take the following steps:
3535

36-
- Use [Technical specifications]({{< ref "/ngf/reference/technical-specifications.md" >}}) to verify your Gateway API resources are compatible with your NGINX Gateway Fabric version.
36+
- Use [Technical specifications]({{< ref "/ngf/reference/technical-specifications.md" >}}) to verify your Gateway API resources are compatible with your NGINX Gateway Fabric version.
3737
- Review the [release notes](https://github.com/kubernetes-sigs/gateway-api/releases) for any important upgrade-specific information.
3838

3939
To upgrade the Gateway API resources, run the following command:
@@ -56,7 +56,7 @@ Run the following command to upgrade the CRDs:
5656
kubectl apply -f https://raw.githubusercontent.com/nginx/nginx-gateway-fabric/v{{< version-ngf >}}/deploy/crds.yaml
5757
```
5858

59-
{{< note >}}
59+
{{< note >}}
6060

6161
Ignore the following warning, as it is expected.
6262

@@ -119,7 +119,7 @@ To remove the previous version 1.x of NGINX Gateway Fabric, follow these steps:
119119
First, run the following command to uninstall NGINX Gateway Fabric from the `nginx-gateway` namespace, and update `ngf` to your release name if it is different:
120120

121121
```shell
122-
helm uninstall ngf -n nginx-gateway
122+
helm uninstall ngf -n nginx-gateway
123123
```
124124

125125
Afterwards, remove CRDs associated with NGINX Gateway Fabric version 1.x with the following command:
@@ -240,7 +240,7 @@ You can then follow [this localhost link](http://localhost:1313/nginx-gateway-fa
240240

241241
## Upgrade from NGINX Open Source to NGINX Plus
242242

243-
{{< important >}}
243+
{{< important >}}
244244

245245
Ensure that you [Set up the JWT]({{< ref "/ngf/install/nginx-plus.md#set-up-the-jwt" >}}) before upgrading. These instructions only apply to Helm.
246246

0 commit comments

Comments
 (0)