Skip to content

Commit 4bd66ed

Browse files
committed
feat: Next steps for common use cases
1 parent f6fc660 commit 4bd66ed

File tree

6 files changed

+45
-27
lines changed

6 files changed

+45
-27
lines changed

content/ngf/install/control-plane-certs.md

Lines changed: 21 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,28 @@
11
---
2-
title: Add secure authentication to the control and data planes
3-
weight: 300
2+
title: Add certificates for secure authentication
3+
weight: 100
44
toc: true
5-
type: how-to
6-
product: NGF
7-
docs: DOCS-0000
5+
nd-content-type: how-to
6+
nd-product: NGF
87
---
98

10-
## Overview
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.
1110

12-
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. However, because these certificates are self-signed and will expire after 3 years, it is recommended to use a solution such as [cert-manager](https://cert-manager.io) to create and manage these certificates in a production environment.
11+
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.
1312

14-
This guide will step through how to install and use `cert-manager` to secure this connection. **This should be done _before_ you install NGINX Gateway Fabric.**
13+
This guide will step through how to install and use `cert-manager` to secure this connection.
14+
15+
{{< caution >}}
16+
17+
These steps should be completed before you install NGINX Gateway Fabric.
18+
19+
{{< /caution >}}
1520

1621
---
1722

1823
## Before you begin
1924

20-
You need:
25+
To complete this guide, you will need the following prerequisites:
2126

2227
- Administrator access to a Kubernetes cluster.
2328
- [Helm](https://helm.sh) and [kubectl](https://kubernetes.io/docs/tasks/tools/#kubectl) must be installed locally.
@@ -180,7 +185,7 @@ Specify the Secret name using the `agent-tls-secret` command-line argument.
180185

181186
{{</tabs>}}
182187

183-
## Final steps
188+
## Confirm the Secrets have been created
184189

185190
You should see the Secrets created in the `nginx-gateway` namespace:
186191

@@ -195,3 +200,9 @@ server-tls kubernetes.io/tls 3 8s
195200
```
196201

197202
You can now [install NGINX Gateway Fabric]({{< ref "/ngf/install/" >}}).
203+
204+
## Next steps
205+
206+
- [Install NGINX Gateway Fabric with Helm]({{< ref "/ngf/install/helm.md" >}})
207+
- [Install NGINX Gateway Fabric with Manifests]({{< ref "/ngf/install/manifests.md" >}})
208+
- [Install NGINX Gateway Fabric with NGINX Plus]({{< ref "/ngf/install/nginx-plus.md" >}})

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Deploy a Gateway for data plane instances
3-
weight: 500
3+
weight: 600
44
toc: true
55
type: how-to
66
product: NGF

content/ngf/install/helm.md

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
---
2-
title: Installation with Helm
3-
weight: 100
2+
title: Install NGINX Gateway Fabric with Helm
3+
weight: 200
44
toc: true
5-
type: how-to
6-
product: NGF
5+
nd-content-type: how-to
6+
nd-product: NGF
77
docs: DOCS-1430
88
---
99

@@ -15,11 +15,11 @@ Learn how to install, upgrade, and uninstall NGINX Gateway Fabric in a Kubernete
1515

1616
## Before you begin
1717

18-
To complete this guide, you'll need to install:
18+
To complete this guide, you will need:
1919

2020
- [kubectl](https://kubernetes.io/docs/tasks/tools/), a command-line tool for managing Kubernetes clusters.
2121
- [Helm 3.0 or later](https://helm.sh/docs/intro/install/), for deploying and managing applications on Kubernetes.
22-
- If deploying into a production environment, we highly recommend [installing custom certificates]({{< ref "/ngf/install/control-plane-certs.md" >}}) for securing the connection between the NGINX Gateway Fabric control plane and NGINX data plane Pods. **This should be done _before_ you install NGINX Gateway Fabric.** The default certificates are self-signed and will expire after 3 years.
22+
- [Add certificates for secure authentication]({{< ref "/ngf/install/control-plane-certs.md" >}}) in a production environment.
2323

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

@@ -316,8 +316,6 @@ For additional information on configuring and understanding the behavior of cont
316316
317317
{{</see-also>}}
318318
319-
---
320-
321319
## Uninstall NGINX Gateway Fabric
322320
323321
Follow these steps to uninstall NGINX Gateway Fabric and Gateway API from your Kubernetes cluster:
@@ -345,8 +343,9 @@ Follow these steps to uninstall NGINX Gateway Fabric and Gateway API from your K
345343

346344
- {{< include "/ngf/installation/uninstall-gateway-api-resources.md" >}}
347345

348-
---
346+
## Next steps
349347

350-
## Additional configuration
348+
- [Deploy a Gateway for data plane instances]({{< ref "/ngf/install/deploy-data-plane.md" >}})
349+
- [Routing traffic to applications]({{< ref "/ngf/traffic-management/routing-traffic-to-your-app.md" >}})
351350

352351
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: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Installation with Manifests
2+
title: Install NGINX Gateway Fabric with Manifests
33
weight: 200
44
toc: true
55
type: how-to
@@ -18,7 +18,7 @@ Learn how to install, upgrade, and uninstall NGINX Gateway Fabric using Kubernet
1818
To complete this guide, you'll need to install:
1919

2020
- [kubectl](https://kubernetes.io/docs/tasks/tools/), a command-line interface for managing Kubernetes clusters.
21-
- If deploying into a production environment, we highly recommend [installing custom certificates]({{< ref "/ngf/install/control-plane-certs.md" >}}) for securing the connection between the NGINX Gateway Fabric control plane and NGINX data plane Pods. **This should be done _before_ you install NGINX Gateway Fabric.** The default certificates are self-signed and will expire after 3 years.
21+
- [Add certificates for secure authentication]({{< ref "/ngf/install/control-plane-certs.md" >}}) in a production environment.
2222

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

@@ -305,3 +305,8 @@ Follow these steps to uninstall NGINX Gateway Fabric and Gateway API from your K
305305
1. **Remove the Gateway API resources:**
306306

307307
- {{< include "/ngf/installation/uninstall-gateway-api-resources.md" >}}
308+
309+
## Next steps
310+
311+
- [Deploy a Gateway for data plane instances]({{< ref "/ngf/install/deploy-data-plane.md" >}})
312+
- [Routing traffic to applications]({{< ref "/ngf/traffic-management/routing-traffic-to-your-app.md" >}})

content/ngf/install/nginx-plus.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Installation with NGINX Plus
2+
title: Install NGINX Gateway Fabric with NGINX Plus
33
weight: 300
44
toc: true
55
type: how-to
@@ -210,10 +210,13 @@ docker pull private-registry.nginx.com/nginx-gateway-fabric/nginx-plus:{{< versi
210210

211211
Once you have successfully pulled the image, you can tag it as needed, then push it to a different container registry.
212212

213-
---
214-
215213
## Alternative installation options
216214

217215
There are alternative ways to get an NGINX Plus image for NGINX Gateway Fabric:
218216

219217
- [Build the Gateway Fabric image]({{< ref "/ngf/install/build-image.md">}}) describes how to use the source code with an NGINX Plus subscription certificate and key to build an image.
218+
219+
## Next steps
220+
221+
- [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" >}})

content/ngf/install/upgrade-2.0.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Upgrade NGINX Gateway Fabric to version 2.x
3-
weight: 400
3+
weight: 700
44
toc: true
55
type: how-to
66
product: NGF

0 commit comments

Comments
 (0)