Skip to content

Commit 7a7a71c

Browse files
committed
feat: Implement feedback, update frontmatter of files and remove hrs
1 parent 857e322 commit 7a7a71c

32 files changed

+121
-444
lines changed

content/ngf/changelog.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,10 @@
11
---
22
title: Changelog
3-
description: "NGINX Gateway Fabric releases."
4-
weight: 900
53
toc: true
6-
type: reference
7-
product: NGF
8-
docs: "DOCS-1359"
4+
weight: 900
5+
nd-content-type: reference
6+
nd-product: NGF
7+
nd-docs: "DOCS-1359"
98
---
109

1110
See the NGINX Gateway Fabric changelog page:

content/ngf/get-started.md

Lines changed: 3 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22
title: Get started
33
weight: 200
44
toc: true
5-
type: how-to
6-
product: NGF
7-
docs: DOCS-000
5+
nd-content-type: how-to
6+
nd-product: NGF
7+
nd-docs: DOCS-000
88
---
99

1010
{{< important >}}
@@ -21,8 +21,6 @@ This is a guide for getting started with NGINX Gateway Fabric. It explains how t
2121

2222
By following the steps in order, you will finish with a functional NGINX Gateway Fabric cluster.
2323

24-
---
25-
2624
## Before you begin
2725

2826
To complete this guide, you need the following prerequisites installed:
@@ -84,8 +82,6 @@ make create-kind-cluster
8482

8583
{{< /note >}}
8684

87-
---
88-
8985
## Install NGINX Gateway Fabric
9086

9187
### Add Gateway API resources
@@ -104,8 +100,6 @@ customresourcedefinition.apiextensions.k8s.io/httproutes.gateway.networking.k8s.
104100
customresourcedefinition.apiextensions.k8s.io/referencegrants.gateway.networking.k8s.io created
105101
```
106102

107-
---
108-
109103
### Install the Helm chart
110104

111105
Use `helm` to install NGINX Gateway Fabric, specifying the NodePort configuration that will be set on the
@@ -128,8 +122,6 @@ REVISION: 1
128122
TEST SUITE: None
129123
```
130124

131-
---
132-
133125
## Create an example application
134126

135127
In the previous section, you deployed NGINX Gateway Fabric to a local cluster. This section shows you how to deploy a simple web application to test that NGINX Gateway Fabric works.
@@ -138,8 +130,6 @@ In the previous section, you deployed NGINX Gateway Fabric to a local cluster. T
138130
The YAML code in the following sections can be found in the [cafe-example folder](https://github.com/nginx/nginx-gateway-fabric/tree/main/examples/cafe-example) of the GitHub repository.
139131
{{< /note >}}
140132

141-
---
142-
143133
### Create the application resources
144134

145135
Create the file _cafe.yaml_ with the following contents:
@@ -171,8 +161,6 @@ coffee-676c9f8944-k2bmd 1/1 Running 0 9s
171161
tea-6fbfdcb95d-9lhbj 1/1 Running 0 9s
172162
```
173163

174-
---
175-
176164
### Create Gateway and HTTPRoute resources
177165

178166
Create the file _gateway.yaml_ with the following contents:
@@ -217,8 +205,6 @@ httproute.gateway.networking.k8s.io/coffee created
217205
httproute.gateway.networking.k8s.io/tea created
218206
```
219207

220-
---
221-
222208
### Verify the configuration
223209

224210
You can check that all of the expected services are available using `kubectl get`:
@@ -431,8 +417,6 @@ Status:
431417
Events: <none>
432418
```
433419

434-
---
435-
436420
## Test NGINX Gateway Fabric
437421

438422
By configuring the cluster with the port `31437`, there is implicit port forwarding from your local machine to NodePort, allowing for direct communication to the NGINX Gateway Fabric service.
@@ -463,8 +447,6 @@ URI: /tea
463447
Request ID: 1b5c8f3a4532ea7d7510cf14ffeb27af
464448
```
465449

466-
---
467-
468450
## Next steps
469451

470452
- [Install NGINX Gateway Fabric]({{< ref "/ngf/install/" >}}), for additional ways to install NGINX Gateway Fabric

content/ngf/install/build-image.md

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,15 @@
22
title: Build NGINX Gateway Fabric
33
weight: 400
44
toc: true
5-
type: how-to
6-
product: NGF
7-
docs: DOCS-1431
5+
nd-content-type: how-to
6+
nd-product: NGF
7+
nd-docs: DOCS-1431
88
---
99

1010
## Overview
1111

1212
While most users will install NGINX Gateway Fabric [with Helm]({{< ref "/ngf/install/helm.md" >}}) or [Kubernetes manifests]({{< ref "/ngf/install/manifests.md" >}}), manually building the [NGINX Gateway Fabric and NGINX images]({{< ref "/ngf/overview/gateway-architecture.md#the-nginx-gateway-fabric-pod" >}}) can be helpful for testing and development purposes. Follow the steps in this document to build the NGINX Gateway Fabric and NGINX images.
1313

14-
---
15-
1614
## Before you begin
1715

1816
Before you can build the NGINX Gateway Fabric and NGINX images, make sure you have the following software
@@ -25,7 +23,6 @@ installed on your machine:
2523

2624
If building the NGINX Plus image, you will also need a valid NGINX Plus license certificate (`nginx-repo.crt`) and key (`nginx-repo.key`) in the root of the repo.
2725

28-
---
2926

3027
## Steps
3128

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22
title: Deploy a Gateway for data plane instances
33
weight: 600
44
toc: true
5-
type: how-to
6-
product: NGF
7-
docs: DOCS-000
5+
nd-content-type: how-to
6+
nd-product: NGF
7+
nd-docs: DOCS-000
88
---
99

1010
## Overview
@@ -236,7 +236,7 @@ Annotations: annotationKey: annotationValue
236236

237237
For more guides on routing traffic to applications and more information on Data Plane configuration, check out the following resources:
238238

239-
- [Routing traffic to applications]({{< ref "/ngf/traffic-management/routing-traffic-to-your-app.md" >}})
239+
- [Routing traffic to applications]({{< ref "/ngf/traffic-management/basic-routing.md" >}})
240240
- [Application routes using HTTP matching conditions]({{< ref "/ngf/traffic-management/advanced-routing.md" >}})
241241
- [Data plane configuration]({{< ref "/ngf/how-to/data-plane-configuration.md" >}})
242242
- [API reference]({{< ref "/ngf/reference/api.md" >}})

content/ngf/install/helm.md

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

1010
## Overview
@@ -18,7 +18,7 @@ To complete this guide, you will need:
1818

1919
- [kubectl](https://kubernetes.io/docs/tasks/tools/), a command-line tool for managing Kubernetes clusters.
2020
- [Helm 3.0 or later](https://helm.sh/docs/intro/install/), for deploying and managing applications on Kubernetes.
21-
- [Add certificates for secure authentication]({{< ref "/ngf/install/control-plane-certs.md" >}}) in a production environment.
21+
- [Add certificates for secure authentication]({{< ref "/ngf/install/secure-certificates.md" >}}) in a production environment.
2222

2323
{{< important >}} If you’d like to use NGINX Plus, some additional setup is also required: {{</ important >}}
2424

@@ -192,6 +192,6 @@ Follow these steps to uninstall NGINX Gateway Fabric and Gateway API from your K
192192
## Next steps
193193

194194
- [Deploy a Gateway for data plane instances]({{< ref "/ngf/install/deploy-data-plane.md" >}})
195-
- [Routing traffic to applications]({{< ref "/ngf/traffic-management/routing-traffic-to-your-app.md" >}})
195+
- [Routing traffic to applications]({{< ref "/ngf/traffic-management/basic-routing.md" >}})
196196

197197
For a full list of the Helm Chart configuration parameters, read [the NGINX Gateway Fabric Helm Chart](https://github.com/nginx/nginx-gateway-fabric/blob/v{{< version-ngf >}}/charts/nginx-gateway-fabric/README.md#configuration).

content/ngf/install/manifests.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22
title: Install NGINX Gateway Fabric with Manifests
33
weight: 200
44
toc: true
5-
type: how-to
6-
product: NGF
7-
docs: DOCS-1429
5+
nd-content-type: how-to
6+
nd-product: NGF
7+
nd-docs: DOCS-1429
88
---
99

1010
## Overview
@@ -16,7 +16,7 @@ Learn how to install, upgrade, and uninstall NGINX Gateway Fabric using Kubernet
1616
To complete this guide, you'll need to install:
1717

1818
- [kubectl](https://kubernetes.io/docs/tasks/tools/), a command-line interface for managing Kubernetes clusters.
19-
- [Add certificates for secure authentication]({{< ref "/ngf/install/control-plane-certs.md" >}}) in a production environment.
19+
- [Add certificates for secure authentication]({{< ref "/ngf/install/secure-certificates.md" >}}) in a production environment.
2020

2121
{{< important >}} If you’d like to use NGINX Plus, some additional setup is also required: {{</ important >}}
2222

@@ -213,4 +213,4 @@ Follow these steps to uninstall NGINX Gateway Fabric and Gateway API from your K
213213
## Next steps
214214

215215
- [Deploy a Gateway for data plane instances]({{< ref "/ngf/install/deploy-data-plane.md" >}})
216-
- [Routing traffic to applications]({{< ref "/ngf/traffic-management/routing-traffic-to-your-app.md" >}})
216+
- [Routing traffic to applications]({{< ref "/ngf/traffic-management/basic-routing.md" >}})

content/ngf/install/nginx-plus.md

Lines changed: 4 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22
title: Install NGINX Gateway Fabric with NGINX Plus
33
weight: 300
44
toc: true
5-
type: how-to
6-
product: NGF
7-
docs: DOCS-000
5+
nd-content-type: how-to
6+
nd-product: NGF
7+
nd-docs: DOCS-000
88
---
99

1010
## Overview
@@ -17,22 +17,16 @@ The JWT is required for validating your subscription and reporting telemetry dat
1717

1818
{{< note >}} The following Secrets should be created in the same namespace as the NGINX Gateway Fabric control plane (default: nginx-gateway). The control plane will copy these Secrets into any namespaces where NGINX gets deployed. If you need to update the Secrets, update the originals that you created in the control plane namespace, and the control plane will propagate those updates to all duplicated Secrets. {{< /note >}}
1919

20-
---
21-
2220
## Set up the JWT
2321

2422
The JWT needs to be configured before deploying NGINX Gateway Fabric. The JWT will be stored in two Kubernetes Secrets: one for downloading the NGINX Plus container image, and the other for running NGINX Plus.
2523

2624
{{< include "/ngf/installation/jwt-password-note.md" >}}
2725

28-
---
29-
3026
### Download the JWT from MyF5
3127

3228
{{< include "/ngf/installation/nginx-plus/download-jwt.md" >}}
3329

34-
---
35-
3630
### Docker Registry Secret
3731

3832
{{< include "/ngf/installation/nginx-plus/docker-registry-secret.md" >}}
@@ -55,8 +49,6 @@ Specify the Secret name in the `nginx-docker-secret` command-line argument of th
5549

5650
{{</tabs>}}
5751

58-
---
59-
6052
### NGINX Plus Secret
6153

6254
{{< include "/ngf/installation/nginx-plus/nginx-plus-secret.md" >}}
@@ -81,8 +73,6 @@ Specify the Secret name in the `--usage-report-secret` command-line flag on the
8173

8274
{{< note >}} If you are reporting to the default licensing endpoint, then you can now proceed with [installing NGINX Gateway Fabric]({{< ref "/ngf/install/" >}}). Otherwise, follow the steps below to configure reporting to NGINX Instance Manager. {{< /note >}}
8375

84-
---
85-
8676
### Reporting to NGINX Instance Manager {#nim}
8777

8878
If you are deploying NGINX Gateway Fabric in an environment where you need to report to NGINX Instance Manager instead of the default licensing endpoint, a few extra steps may be required.
@@ -105,8 +95,6 @@ Specify the endpoint in the `--usage-report-endpoint` command-line flag on the `
10595

10696
{{</tabs>}}
10797

108-
---
109-
11098
#### CA and Client certificate/key {#nim-cert}
11199

112100
To configure a CA cert and/or client certificate and key, a few extra steps are needed.
@@ -143,8 +131,6 @@ Specify the CA Secret name in the `--usage-report-ca-secret` command-line flag o
143131

144132
{{< note >}} Once these Secrets are created and configuration options are set, you can now [install NGINX Gateway Fabric]({{< ref "/ngf/install/" >}}). {{< /note >}}
145133

146-
---
147-
148134
## Installation flags to configure usage reporting {#flags}
149135

150136
When installing NGINX Gateway Fabric, the following flags can be specified to configure usage reporting to fit your needs:
@@ -167,8 +153,6 @@ If using manifests, the following command-line options should be set as necessar
167153
- `--usage-report-ca-secret` is the name of the Secret containing the NGINX Instance Manager CA certificate. Must exist in the same namespace that the NGINX Gateway Fabric control plane is running in (default namespace: nginx-gateway).
168154
- `--usage-report-client-ssl-secret` is the name of the Secret containing the client certificate and key for authenticating with NGINX Instance Manager. Must exist in the same namespace that the NGINX Gateway Fabric control plane is running in (default namespace: nginx-gateway).
169155

170-
---
171-
172156
## What’s reported and how it’s protected {#telemetry}
173157

174158
NGINX Plus reports the following data every hour by default:
@@ -184,8 +168,6 @@ NGINX Plus reports the following data every hour by default:
184168
- **Usage report timestamps**: Start and end times for each usage report.
185169
- **Kubernetes node details**: Information about Kubernetes nodes.
186170

187-
---
188-
189171
### Security and privacy of reported data
190172

191173
All communication between your NGINX Plus instances, NGINX Instance Manager, and F5’s licensing endpoint (`product.connect.nginx.com`) is protected using **SSL/TLS** encryption.
@@ -219,4 +201,4 @@ There are alternative ways to get an NGINX Plus image for NGINX Gateway Fabric:
219201
## Next steps
220202

221203
- [Deploy a Gateway for data plane instances]({{< ref "/ngf/install/deploy-data-plane.md" >}})
222-
- [Routing traffic to applications]({{< ref "/ngf/traffic-management/routing-traffic-to-your-app.md" >}})
204+
- [Routing traffic to applications]({{< ref "/ngf/traffic-management/basic-routing.md" >}})

content/ngf/install/control-plane-certs.md renamed to content/ngf/install/secure-certificates.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ helm install \
4949
--set crds.enabled=true
5050
```
5151

52-
This also enables Gateway API features for cert-manager, which can be useful for [securing your workload traffic]({{< ref "/ngf/traffic-security/integrating-cert-manager.md" >}}).
52+
This also enables Gateway API features for cert-manager, which can be useful for [securing your workload traffic]({{< ref "/ngf/traffic-security/integrate-cert-manager.md" >}}).
5353

5454
## Create the CA issuer
5555

content/ngf/install/upgrade-version.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -56,14 +56,15 @@ 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>}} Ignore the following warning, as it is expected.
59+
{{< note >}}
60+
61+
Ignore the following warning, as it is expected.
6062

6163
```text
6264
Warning: kubectl apply should be used on resource created by either kubectl create --save-config or kubectl apply.
6365
```
64-
{{</ note >}}
65-
6666

67+
{{< /note >}}
6768

6869
### Upgrade NGINX Gateway Fabric release
6970

@@ -183,7 +184,7 @@ For detailed instructions on how to modify these settings, refer to the [Configu
183184

184185
- To read more on [modifying data plane configuration]({{< ref "/ngf/how-to/data-plane-configuration.md" >}}).
185186
- To learn more about [deploying a Gateway for data plane instances]({{< ref "/ngf/install/deploy-data-plane.md" >}}).
186-
- To adding secure [authentication to control plane and data planes]({{< ref "/ngf/install/control-plane-certs.md" >}}).
187+
- To adding secure [authentication to control plane and data planes]({{< ref "/ngf/install/secure-certificates.md" >}}).
187188
- To read more about [architecture changes]({{< ref "/ngf/overview/gateway-architecture.md" >}}).
188189
- For detailed [API reference]({{< ref "/ngf/reference/api.md" >}}).
189190

0 commit comments

Comments
 (0)