Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
befab04
feat: Update NGINX Gateway Fabric information architecture
ADubhlaoich May 26, 2025
a823242
feat: Additional IA changes
ADubhlaoich May 26, 2025
9840067
Merge branch 'ngf-release-2.0' into ngf/use-case-ia
ADubhlaoich May 29, 2025
9898aea
Merge branch 'ngf-release-2.0' into ngf/use-case-ia
ADubhlaoich May 29, 2025
f6fc660
feat: Fix file references post merge resolution
ADubhlaoich May 29, 2025
4bd66ed
feat: Next steps for common use cases
ADubhlaoich May 29, 2025
3586349
Merge branch 'ngf-release-2.0' into ngf/use-case-ia
ADubhlaoich May 30, 2025
0d876be
feat: Update banner link for 2.0 IA changes
ADubhlaoich May 30, 2025
b16d532
feat: Update NGF 1.6 doc links to be old code repository branch
ADubhlaoich May 30, 2025
872844c
feat: Make upgrade a standalone topic, consolidate existing information
ADubhlaoich May 30, 2025
c065e46
Apply suggestions from code review
ADubhlaoich May 30, 2025
a05d10c
feat: Fix prometheus documentation link
ADubhlaoich May 30, 2025
8e690fb
fix: "definitions" typo at top of document
ADubhlaoich May 30, 2025
93be9e9
feat: Imperative sentence structure in Gateway deployment headings
ADubhlaoich May 30, 2025
9689e86
Merge branch 'ngf-release-2.0' into ngf/use-case-ia
ADubhlaoich Jun 3, 2025
729c169
feat: Remove redundant shell variable information
ADubhlaoich Jun 3, 2025
e26ca30
feat: Remove additional unnecessary shell instructions
ADubhlaoich Jun 3, 2025
857e322
feat: Move external IP note for NGF beside shell variable instructions
ADubhlaoich Jun 3, 2025
7a7a71c
feat: Implement feedback, update frontmatter of files and remove hrs
ADubhlaoich Jun 4, 2025
3c73dce
feat: Adjust phrasing of dashboard sentence, add note to upgrade
ADubhlaoich Jun 4, 2025
25e614c
feat: Improve phrasing of some upgrade instructions, reduce text
ADubhlaoich Jun 4, 2025
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
9 changes: 4 additions & 5 deletions content/ngf/changelog.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,10 @@
---
title: Changelog
description: "NGINX Gateway Fabric releases."
weight: 900
toc: true
type: reference
product: NGF
docs: "DOCS-1359"
weight: 900
nd-content-type: reference
nd-product: NGF
nd-docs: "DOCS-1359"
---

See the NGINX Gateway Fabric changelog page:
Expand Down
24 changes: 3 additions & 21 deletions content/ngf/get-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
title: Get started
weight: 200
toc: true
type: how-to
product: NGF
docs: DOCS-000
nd-content-type: how-to
nd-product: NGF
nd-docs: DOCS-000
---

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

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

---

## Before you begin

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

{{< /note >}}

---

## Install NGINX Gateway Fabric

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

---

### Install the Helm chart

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

---

## Create an example application

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.
Expand All @@ -138,8 +130,6 @@ In the previous section, you deployed NGINX Gateway Fabric to a local cluster. T
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.
{{< /note >}}

---

### Create the application resources

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

---

### Create Gateway and HTTPRoute resources

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

---

### Verify the configuration

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

---

## Test NGINX Gateway Fabric

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.
Expand Down Expand Up @@ -463,8 +447,6 @@ URI: /tea
Request ID: 1b5c8f3a4532ea7d7510cf14ffeb27af
```

---

## Next steps

- [Install NGINX Gateway Fabric]({{< ref "/ngf/install/" >}}), for additional ways to install NGINX Gateway Fabric
Expand Down
9 changes: 3 additions & 6 deletions content/ngf/install/build-image.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,15 @@
title: Build NGINX Gateway Fabric
weight: 400
toc: true
type: how-to
product: NGF
docs: DOCS-1431
nd-content-type: how-to
nd-product: NGF
nd-docs: DOCS-1431
---

## Overview

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.

---

## Before you begin

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

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.

---

## Steps

Expand Down
8 changes: 4 additions & 4 deletions content/ngf/install/deploy-data-plane.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
title: Deploy a Gateway for data plane instances
weight: 600
toc: true
type: how-to
product: NGF
docs: DOCS-000
nd-content-type: how-to
nd-product: NGF
nd-docs: DOCS-000
---

## Overview
Expand Down Expand Up @@ -236,7 +236,7 @@ Annotations: annotationKey: annotationValue

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

- [Routing traffic to applications]({{< ref "/ngf/traffic-management/routing-traffic-to-your-app.md" >}})
- [Routing traffic to applications]({{< ref "/ngf/traffic-management/basic-routing.md" >}})
- [Application routes using HTTP matching conditions]({{< ref "/ngf/traffic-management/advanced-routing.md" >}})
- [Data plane configuration]({{< ref "/ngf/how-to/data-plane-configuration.md" >}})
- [API reference]({{< ref "/ngf/reference/api.md" >}})
6 changes: 3 additions & 3 deletions content/ngf/install/helm.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ weight: 200
toc: true
nd-content-type: how-to
nd-product: NGF
docs: DOCS-1430
nd-docs: DOCS-1430
---

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

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

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

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

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

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).
10 changes: 5 additions & 5 deletions content/ngf/install/manifests.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
title: Install NGINX Gateway Fabric with Manifests
weight: 200
toc: true
type: how-to
product: NGF
docs: DOCS-1429
nd-content-type: how-to
nd-product: NGF
nd-docs: DOCS-1429
---

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

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

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

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

- [Deploy a Gateway for data plane instances]({{< ref "/ngf/install/deploy-data-plane.md" >}})
- [Routing traffic to applications]({{< ref "/ngf/traffic-management/routing-traffic-to-your-app.md" >}})
- [Routing traffic to applications]({{< ref "/ngf/traffic-management/basic-routing.md" >}})
26 changes: 4 additions & 22 deletions content/ngf/install/nginx-plus.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
title: Install NGINX Gateway Fabric with NGINX Plus
weight: 300
toc: true
type: how-to
product: NGF
docs: DOCS-000
nd-content-type: how-to
nd-product: NGF
nd-docs: DOCS-000
---

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

{{< 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 >}}

---

## Set up the JWT

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.

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

---

### Download the JWT from MyF5

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

---

### Docker Registry Secret

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

{{</tabs>}}

---

### NGINX Plus Secret

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

{{< 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 >}}

---

### Reporting to NGINX Instance Manager {#nim}

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.
Expand All @@ -105,8 +95,6 @@ Specify the endpoint in the `--usage-report-endpoint` command-line flag on the `

{{</tabs>}}

---

#### CA and Client certificate/key {#nim-cert}

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

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

---

## Installation flags to configure usage reporting {#flags}

When installing NGINX Gateway Fabric, the following flags can be specified to configure usage reporting to fit your needs:
Expand All @@ -167,8 +153,6 @@ If using manifests, the following command-line options should be set as necessar
- `--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).
- `--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).

---

## What’s reported and how it’s protected {#telemetry}

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

---

### Security and privacy of reported data

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.
Expand Down Expand Up @@ -219,4 +201,4 @@ There are alternative ways to get an NGINX Plus image for NGINX Gateway Fabric:
## Next steps

- [Deploy a Gateway for data plane instances]({{< ref "/ngf/install/deploy-data-plane.md" >}})
- [Routing traffic to applications]({{< ref "/ngf/traffic-management/routing-traffic-to-your-app.md" >}})
- [Routing traffic to applications]({{< ref "/ngf/traffic-management/basic-routing.md" >}})
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ helm install \
--set crds.enabled=true
```

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" >}}).
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" >}}).

## Create the CA issuer

Expand Down
9 changes: 5 additions & 4 deletions content/ngf/install/upgrade-version.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,14 +56,15 @@ Run the following command to upgrade the CRDs:
kubectl apply -f https://raw.githubusercontent.com/nginx/nginx-gateway-fabric/v{{< version-ngf >}}/deploy/crds.yaml
```

{{< note>}} Ignore the following warning, as it is expected.
{{< note >}}

Ignore the following warning, as it is expected.

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


{{< /note >}}

### Upgrade NGINX Gateway Fabric release

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

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

Expand Down
Loading
Loading