Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
6 changes: 6 additions & 0 deletions content/ngf/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,12 @@ f5-content-type: landing-page
# Intended for internal catalogue and search, case sensitive:
# Agent, N4Azure, NIC, NIM, NGF, NAP-DOS, NAP-WAF, NGINX One, NGINX+, Solutions, Unit
f5-product: NGINX Gateway Fabric
f5-summary: >
NGINX Gateway Fabric is a Kubernetes Gateway API implementation that uses NGINX as the data plane.
Use it to configure HTTP, gRPC, TCP, and UDP load balancing, reverse proxying, and API gateway features for applications on Kubernetes.
This landing page links to get started, install, traffic management, security, monitoring, and reference documentation.
f5-description: "Implement the Kubernetes Gateway API with NGINX Gateway Fabric using NGINX as the data plane."
f5-keywords: "NGINX Gateway Fabric, NGF, Gateway API, Kubernetes, load balancer, reverse proxy, API gateway"
---

## About
Expand Down
7 changes: 6 additions & 1 deletion content/ngf/changelog.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,15 @@
---
title: Changelog
title: NGINX Gateway Fabric changelog
toc: true
weight: 900
f5-content-type: reference
f5-product: NGINX Gateway Fabric
f5-docs: DOCS-1359
f5-summary: >
Find NGINX Gateway Fabric release notes and version history.
Use the changelog to track new features, fixes, and breaking changes across releases.
f5-description: "Review release notes and version history for NGINX Gateway Fabric."
f5-keywords: "NGINX Gateway Fabric, changelog, release notes, version history, updates"
nollms: true
---

Expand Down
7 changes: 6 additions & 1 deletion content/ngf/get-started.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,15 @@
---
title: Get started
title: Get started with NGINX Gateway Fabric
weight: 200
toc: true
f5-content-type: how-to
f5-product: NGINX Gateway Fabric
f5-docs: DOCS-1834
f5-summary: >
Deploy NGINX Gateway Fabric on a local kind cluster and exercise a basic Gateway and HTTPRoute setup.
This quickstart is intended for evaluation and learning, not production environments.
f5-description: "Try NGINX Gateway Fabric on a kind cluster for a non-production quickstart."
f5-keywords: "NGINX Gateway Fabric, get started, kind, quickstart, tutorial, Kubernetes, Gateway API"
---

{{< call-out class="important" >}}
Expand Down
5 changes: 5 additions & 0 deletions content/ngf/how-to/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,9 @@
title: "How-to guides"
url: /nginx-gateway-fabric/how-to/
weight: 550
f5-summary: >
Browse task-focused how-to guides for NGINX Gateway Fabric operations.
Topics include control plane and data plane configuration, scaling, inference extension, and zero-downtime app upgrades.
f5-description: "Operational how-to guides for configuring and running NGINX Gateway Fabric."
f5-keywords: "NGINX Gateway Fabric, how-to, guides, configuration, operations"
---
5 changes: 5 additions & 0 deletions content/ngf/how-to/control-plane-configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,11 @@ weight: 400
toc: true
f5-product: NGINX Gateway Fabric
f5-docs: DOCS-1839
f5-summary: >
Update NGINX Gateway Fabric control plane settings without reinstalling the product.
Use this guide when you need to change controller behavior at runtime.
f5-description: "Dynamically update the NGINX Gateway Fabric control plane configuration."
f5-keywords: "NGINX Gateway Fabric, control plane, NginxGateway, configuration, dynamic update"
f5-content-type: how-to
---

Expand Down
5 changes: 5 additions & 0 deletions content/ngf/how-to/data-plane-configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,11 @@ toc: true
f5-content-type: how-to
f5-product: NGINX Gateway Fabric
f5-docs: DOCS-1838
f5-summary: >
Change global data plane settings that apply across NGINX instances managed by NGINX Gateway Fabric.
Use this when you need product-wide NGINX configuration beyond per-route policies.
f5-description: "Dynamically update global NGINX data plane configuration for NGINX Gateway Fabric."
f5-keywords: "NGINX Gateway Fabric, data plane, NginxProxy, global configuration, NGINX settings"
---

Learn how to dynamically update the NGINX Gateway Fabric global data plane configuration.
Expand Down
7 changes: 6 additions & 1 deletion content/ngf/how-to/gateway-api-inference-extension.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,15 @@
---
title: Gateway API Inference Extension
title: Configure Gateway API Inference Extension routing
weight: 800
toc: true
f5-content-type: how-to
f5-product: NGINX Gateway Fabric
f5-docs: DOCS-0000
f5-summary: >
Enable the Gateway API Inference Extension so NGINX Gateway Fabric can act as an Inference Gateway for self-hosted generative AI models on Kubernetes.
This guide covers CRD install, controller flags, and model-aware routing features such as serving priority and model rollouts.
f5-description: "Use the Gateway API Inference Extension with NGINX Gateway Fabric to route traffic to self-hosted AI models."
f5-keywords: "NGINX Gateway Fabric, Gateway API Inference Extension, InferencePool, AI, generative AI, model routing, Endpoint Picker"
---

Learn how to use NGINX Gateway Fabric with the Gateway API Inference Extension to optimize traffic routing to self-hosting Generative AI Models on Kubernetes.
Expand Down
5 changes: 5 additions & 0 deletions content/ngf/how-to/scaling.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,11 @@ toc: true
f5-content-type: how-to
f5-product: NGINX Gateway Fabric
f5-docs: DOCS-1840
f5-summary: >
Scale control plane and data plane components separately to match availability and traffic needs.
Use this guide when sizing NGINX Gateway Fabric for production workloads.
f5-description: "Scale the NGINX Gateway Fabric control plane and data plane independently."
f5-keywords: "NGINX Gateway Fabric, scaling, control plane, data plane, high availability, replicas"
---

This document describes how you can separately scale the NGINX Gateway Fabric control plane and data plane.
Expand Down
5 changes: 5 additions & 0 deletions content/ngf/how-to/upgrade-apps-without-downtime.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,11 @@ toc: true
f5-content-type: how-to
f5-product: NGINX Gateway Fabric
f5-docs: DOCS-1841
f5-summary: >
Shift traffic safely while upgrading application versions so users experience no downtime.
Use Gateway API routes with NGINX Gateway Fabric to control rollout of backend changes.
f5-description: "Upgrade Kubernetes applications without downtime using NGINX Gateway Fabric routing."
f5-keywords: "NGINX Gateway Fabric, rolling update, zero downtime, application upgrade, HTTPRoute, blue green"
---

Learn how to use NGINX Gateway Fabric to upgrade applications without downtime.
Expand Down
5 changes: 5 additions & 0 deletions content/ngf/install/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,9 @@
title: "Install"
url: /nginx-gateway-fabric/install/
weight: 300
f5-summary: >
Choose an installation path for NGINX Gateway Fabric in Kubernetes.
This section covers Helm, manifests, OpenShift OperatorHub, NGINX Plus, upgrades, and related setup tasks.
f5-description: "Install NGINX Gateway Fabric using Helm, manifests, OpenShift, or NGINX Plus options."
f5-keywords: "NGINX Gateway Fabric, install, Helm, manifests, OpenShift, NGINX Plus"
---
5 changes: 5 additions & 0 deletions content/ngf/install/build-image.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,11 @@ toc: true
f5-content-type: how-to
f5-product: NGINX Gateway Fabric
f5-docs: DOCS-1431
f5-summary: >
Manually build NGINX Gateway Fabric and NGINX images when you need custom images instead of published charts or manifests.
Most users should prefer Helm or Kubernetes manifests for installation.
f5-description: "Build custom NGINX Gateway Fabric and NGINX container images from source."
f5-keywords: "NGINX Gateway Fabric, build image, container image, Docker, custom build"
---

## Overview
Expand Down
5 changes: 5 additions & 0 deletions content/ngf/install/deploy-data-plane.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,11 @@ toc: true
f5-content-type: how-to
f5-product: NGINX Gateway Fabric
f5-docs: DOCS-1854
f5-summary: >
Provision data plane instances through a Gateway and adjust them with NGINX custom resources.
Use this after installing the control plane when you are ready to serve traffic.
f5-description: "Deploy NGINX data plane instances by creating a Gateway and related custom resources."
f5-keywords: "NGINX Gateway Fabric, Gateway, data plane, NginxProxy, deploy instances"
---

## Overview
Expand Down
5 changes: 5 additions & 0 deletions content/ngf/install/helm.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,11 @@ toc: true
f5-content-type: how-to
f5-product: NGINX Gateway Fabric
f5-docs: DOCS-1430
f5-summary: >
Deploy NGINX Gateway Fabric with the official Helm chart, including upgrade and uninstall steps.
Helm is a primary installation path for Kubernetes clusters.
f5-description: "Install, upgrade, and uninstall NGINX Gateway Fabric in Kubernetes using Helm."
f5-keywords: "NGINX Gateway Fabric, Helm, install, upgrade, uninstall, chart, Kubernetes"
---

## Overview
Expand Down
5 changes: 5 additions & 0 deletions content/ngf/install/ingress-to-gateway.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,11 @@ weight: 800
toc: true
f5-content-type: how-to
f5-product: NGINX Gateway Fabric
f5-summary: >
Move workloads from NGINX Ingress Controller to NGINX Gateway Fabric and the Gateway API model.
Use this guide when adopting Gateway API resources in place of Ingress-based configuration.
f5-description: "Migrate from F5 NGINX Ingress Controller to NGINX Gateway Fabric."
f5-keywords: "NGINX Gateway Fabric, migration, NGINX Ingress Controller, Gateway API, Ingress"
---

This document describes how to migrate from F5 NGINX Ingress Controller to NGINX Gateway Fabric.
Expand Down
5 changes: 5 additions & 0 deletions content/ngf/install/manifests/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,9 @@
title: "Manifests"
url: /nginx-gateway-fabric/install/manifests
weight: 200
f5-summary: >
Use static Kubernetes manifests as an alternative to Helm for installing NGINX Gateway Fabric.
Choose Open Source or Plus variants, including experimental feature sets.
f5-description: "Install or uninstall NGINX Gateway Fabric using Kubernetes manifests."
f5-keywords: "NGINX Gateway Fabric, manifests, YAML, kubectl, install"
---
5 changes: 5 additions & 0 deletions content/ngf/install/manifests/open-source-experimental.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,11 @@ toc: true
f5-content-type: how-to
f5-product: NGINX Gateway Fabric
f5-docs: DOCS-1429
f5-summary: >
Apply Kubernetes manifests to install NGINX Gateway Fabric with NGINX Open Source and experimental Gateway API features enabled.
Use this path when you need experimental resources without Helm.
f5-description: "Install NGINX Gateway Fabric with experimental features using manifests and NGINX Open Source."
f5-keywords: "NGINX Gateway Fabric, manifests, NGINX Open Source, experimental, Gateway API"
---

This page describes how to use Manifests to install NGINX Gateway Fabric (experimental) with NGINX Open Source.
Expand Down
5 changes: 5 additions & 0 deletions content/ngf/install/manifests/open-source.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,11 @@ toc: true
f5-content-type: how-to
f5-product: NGINX Gateway Fabric
f5-docs: DOCS-1429
f5-summary: >
Apply Kubernetes manifests to install NGINX Gateway Fabric with the NGINX Open Source data plane.
Use this when you prefer declarative YAML over Helm.
f5-description: "Install NGINX Gateway Fabric with NGINX Open Source using Kubernetes manifests."
f5-keywords: "NGINX Gateway Fabric, manifests, NGINX Open Source, install, YAML"
---

This page describes how to use Manifests to install NGINX Gateway Fabric with NGINX Open Source.
Expand Down
5 changes: 5 additions & 0 deletions content/ngf/install/manifests/plus-experimental.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,11 @@ weight: 400
toc: true
f5-content-type: how-to
f5-product: NGINX Gateway Fabric
f5-summary: >
Apply Kubernetes manifests to install NGINX Gateway Fabric with NGINX Plus and experimental Gateway API features.
Requires NGINX Plus credentials and is suited to non-Helm deployments.
f5-description: "Install NGINX Gateway Fabric with experimental features using manifests and NGINX Plus."
f5-keywords: "NGINX Gateway Fabric, manifests, NGINX Plus, experimental, install"
---

This page describes how to use Manifests to install NGINX Gateway Fabric (experimental) with NGINX Plus.
Expand Down
5 changes: 5 additions & 0 deletions content/ngf/install/manifests/plus.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,11 @@ weight: 200
toc: true
f5-content-type: how-to
f5-product: NGINX Gateway Fabric
f5-summary: >
Apply Kubernetes manifests to install NGINX Gateway Fabric with the NGINX Plus data plane.
Use this when you need Plus features and prefer manifests to Helm.
f5-description: "Install NGINX Gateway Fabric with NGINX Plus using Kubernetes manifests."
f5-keywords: "NGINX Gateway Fabric, manifests, NGINX Plus, install, YAML"
---

This page describes how to use Manifests to install NGINX Gateway Fabric with NGINX Plus.
Expand Down
5 changes: 5 additions & 0 deletions content/ngf/install/manifests/uninstall.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,11 @@ weight: 500
toc: true
f5-content-type: how-to
f5-product: NGINX Gateway Fabric
f5-summary: >
Remove NGINX Gateway Fabric installed via manifests, including custom resource definitions and Gateway API resources as needed.
Follow this page for a clean teardown of YAML-based installs.
f5-description: "Uninstall a manifests-based NGINX Gateway Fabric deployment and related resources."
f5-keywords: "NGINX Gateway Fabric, uninstall, manifests, CRDs, Gateway API, cleanup"
---

This page describes how to uninstall NGINX Gateway Fabric in a Manifest-based deployment, its custom resource definitions, and its Gateway API resources.
Expand Down
5 changes: 5 additions & 0 deletions content/ngf/install/nginx-plus.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,11 @@ toc: true
f5-content-type: how-to
f5-product: NGINX Gateway Fabric
f5-docs: DOCS-1853
f5-summary: >
Configure the JWT required to download and run NGINX Plus with NGINX Gateway Fabric.
From version 1.5.0, the JWT is needed both to pull the image and to run NGINX Plus.
f5-description: "Install NGINX Gateway Fabric with NGINX Plus using a JWT for image pull and runtime."
f5-keywords: "NGINX Gateway Fabric, NGINX Plus, JWT, install, F5 registry, image pull"
---

## Overview
Expand Down
5 changes: 5 additions & 0 deletions content/ngf/install/openshift.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,11 @@ weight: 400
toc: true
f5-content-type: how-to
f5-product: NGINX Gateway Fabric
f5-summary: >
Install F5 NGINX Gateway Fabric on OpenShift using OperatorHub and configure it with the NginxGatewayFabric custom resource.
Use this path for OpenShift-managed clusters.
f5-description: "Install NGINX Gateway Fabric on Red Hat OpenShift through OperatorHub."
f5-keywords: "NGINX Gateway Fabric, OpenShift, OperatorHub, NginxGatewayFabric, install"
---

## Overview
Expand Down
5 changes: 5 additions & 0 deletions content/ngf/install/secure-certificates.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,11 @@ toc: true
f5-content-type: how-to
f5-product: NGINX Gateway Fabric
f5-docs: DOCS-1851
f5-summary: >
Manage TLS certificates that secure communication between the NGINX Gateway Fabric control plane and data plane pods.
By default a cert-generator job creates self-signed certificates at install time.
f5-description: "Add or replace certificates used to secure control plane to data plane authentication."
f5-keywords: "NGINX Gateway Fabric, certificates, TLS, cert-generator, control plane, data plane"
---

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.
Expand Down
5 changes: 5 additions & 0 deletions content/ngf/install/upgrade-version.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,11 @@ toc: true
f5-content-type: how-to
f5-product: NGINX Gateway Fabric
f5-docs: DOCS-1852
f5-summary: >
Move an existing NGINX Gateway Fabric installation to a newer version.
Follow the upgrade steps that match how you originally installed the product.
f5-description: "Upgrade NGINX Gateway Fabric to a new release version."
f5-keywords: "NGINX Gateway Fabric, upgrade, version, Helm, manifests, release"
---

This document describes how to upgrade NGINX Gateway Fabric when a new version releases.
Expand Down
5 changes: 5 additions & 0 deletions content/ngf/monitoring/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,9 @@
title: "Monitoring"
url: /nginx-gateway-fabric/monitoring/
weight: 600
f5-summary: >
Observe NGINX Gateway Fabric health and traffic using NGINX Plus dashboard, Prometheus metrics, Grafana, and OpenTelemetry tracing.
Start here to pick the right monitoring approach for your cluster.
f5-description: "Monitor NGINX Gateway Fabric with dashboards, Prometheus, Grafana, and tracing."
f5-keywords: "NGINX Gateway Fabric, monitoring, metrics, tracing, Prometheus, Grafana, dashboard"
---
5 changes: 5 additions & 0 deletions content/ngf/monitoring/dashboard.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,11 @@ toc: true
f5-content-type: how-to
f5-product: NGINX Gateway Fabric
f5-docs: DOCS-1417
f5-summary: >
Open the NGINX Plus dashboard to view real-time metrics for NGINX data plane instances.
Requires NGINX Plus as the data plane.
f5-description: "Access the NGINX Plus dashboard for real-time NGINX Gateway Fabric metrics."
f5-keywords: "NGINX Gateway Fabric, NGINX Plus dashboard, metrics, real-time, monitoring"
---

This topic describes how to view the NGINX Plus dashboard to see real-time metrics.
Expand Down
5 changes: 5 additions & 0 deletions content/ngf/monitoring/prometheus.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,11 @@ toc: true
f5-content-type: how-to
f5-product: NGINX Gateway Fabric
f5-docs: DOCS-1418
f5-summary: >
Install and configure Prometheus and Grafana to scrape and visualize NGINX Gateway Fabric metrics.
This guide also lists which metrics are available for alerting and dashboards.
f5-description: "Monitor NGINX Gateway Fabric with Prometheus and Grafana, including available metrics."
f5-keywords: "NGINX Gateway Fabric, Prometheus, Grafana, metrics, scrape, monitoring"
---

This document describes how to monitor NGINX Gateway Fabric using Prometheus and Grafana. It explains installation and configuration, as well as what metrics are available.
Expand Down
5 changes: 5 additions & 0 deletions content/ngf/monitoring/tracing.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,11 @@ toc: true
f5-content-type: how-to
f5-product: NGINX Gateway Fabric
f5-docs: DOCS-1844
f5-summary: >
Configure distributed tracing for HTTPRoutes so you can follow requests through NGINX Gateway Fabric.
This guide uses the OpenTelemetry Collector and Jaeger to collect and process traces.
f5-description: "Enable OpenTelemetry tracing on HTTPRoutes in NGINX Gateway Fabric with the Collector and Jaeger."
f5-keywords: "NGINX Gateway Fabric, tracing, OpenTelemetry, Jaeger, HTTPRoute, distributed tracing"
---

This guide explains how to enable tracing on HTTPRoutes in NGINX Gateway Fabric using the OpenTelemetry Collector. Jaeger is used to process and collect the traces.
Expand Down
5 changes: 5 additions & 0 deletions content/ngf/overview/_index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
---
title: "Overview"
weight: 100
f5-summary: >
Read conceptual topics for NGINX Gateway Fabric before you install or configure traffic.
Coverage includes architecture, Gateway API compatibility, policies, validation, telemetry, and technical specifications.
f5-description: "Learn core concepts for NGINX Gateway Fabric, including architecture and Gateway API support."
f5-keywords: "NGINX Gateway Fabric, overview, architecture, Gateway API, concepts"
url: /nginx-gateway-fabric/overview
---
7 changes: 6 additions & 1 deletion content/ngf/overview/custom-policies.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,15 @@
---
title: Custom policies
title: Custom policies for NGINX data plane features
weight: 700
toc: true
f5-content-type: reference
f5-product: NGINX Gateway Fabric
f5-docs: DOCS-1835
f5-summary: >
Custom policies let you configure NGINX features that are not available in the Gateway API itself.
Learn how policy attachments work and when to use first-class NGINX Gateway Fabric CRDs.
f5-description: "Understand custom policies that expose NGINX data plane features beyond the Gateway API."
f5-keywords: "NGINX Gateway Fabric, custom policies, PolicyAttachment, CRD, extensions"
---

This topic explains the custom policies for NGINX Gateway Fabric CRDs (Custom Resource Definitions), which allow users to configure NGINX data plane features that are unavailable in the Gateway API.
Expand Down
5 changes: 5 additions & 0 deletions content/ngf/overview/gateway-api-compatibility.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,11 @@ toc: true
f5-content-type: reference
f5-product: NGINX Gateway Fabric
f5-docs: DOCS-1412
f5-summary: >
Review Gateway API compatibility for NGINX Gateway Fabric, including supported resources and support levels.
Use this page to confirm whether a Gateway API feature is available before you design your configuration.
f5-description: "See which Gateway API resources and features NGINX Gateway Fabric supports."
f5-keywords: "NGINX Gateway Fabric, Gateway API, compatibility, supported resources, conformance"
---

This page describes which Gateway API resources NGINX Gateway Fabric supports and to which level.
Expand Down
5 changes: 5 additions & 0 deletions content/ngf/overview/gateway-architecture.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,11 @@ toc: true
f5-content-type: reference
f5-product: NGINX Gateway Fabric
f5-docs: DOCS-1413
f5-summary: >
Understand how the NGINX Gateway Fabric control plane and NGINX data plane work together as a Gateway API implementation.
This overview covers design principles and component roles.
f5-description: "Learn the architecture and design principles of NGINX Gateway Fabric."
f5-keywords: "NGINX Gateway Fabric, architecture, control plane, data plane, design principles, NGINX Agent"
---

Learn about the architecture and design principles of NGINX Gateway Fabric: a Kubernetes Gateway API implementation which uses NGINX as the data plane.
Expand Down
Loading
Loading