Skip to content

Commit 92081af

Browse files
JTorreGJTorreG
authored
chore: add NGF docs to catalog (#1599)
1 parent ecc3f84 commit 92081af

31 files changed

+33
-31
lines changed

‎site/content/how-to/configuration/control-plane-configuration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: "Control Plane Configuration"
33
description: "Learn how to dynamically update the Gateway Fabric control plane configuration."
44
weight: 100
55
toc: true
6-
docs: "DOCS-000"
6+
docs: "DOCS-1416"
77
---
88

99
## Overview

‎site/content/how-to/maintenance/upgrade-apps-without-downtime.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: "Upgrade applications without downtime"
33
description: "Learn how to use NGINX Gateway Fabric to upgrade applications without downtime."
44
weight: 100
55
toc: true
6-
docs: "DOCS-000"
6+
docs: "DOCS-1420"
77
---
88

99
{{<custom-styles>}}

‎site/content/how-to/monitoring/dashboard.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: "NGINX Plus Dashboard"
33
description: "Learn how to view the NGINX Plus dashboard to see real-time metrics."
44
weight: 200
55
toc: true
6-
docs: "DOCS-000"
6+
docs: "DOCS-1417"
77
---
88

99
{{<custom-styles>}}

‎site/content/how-to/monitoring/prometheus.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: "Prometheus Metrics"
33
description: "Learn how to monitor your NGINX Gateway Fabric effectively. This guide provides easy steps for configuring and understanding key performance metrics using Prometheus."
44
weight: 100
55
toc: true
6-
docs: "DOCS-000"
6+
docs: "DOCS-1418"
77
---
88

99
{{<custom-styles>}}

‎site/content/how-to/monitoring/troubleshooting.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: "Troubleshooting"
33

44
weight: 300
55
toc: true
6-
docs: "DOCS-000"
6+
docs: "DOCS-1419"
77
---
88

99
{{< custom-styles >}}

‎site/content/how-to/traffic-management/advanced-routing.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: "Routing to Applications Using HTTP Matching Conditions"
33
description: "Learn how to deploy multiple applications and HTTPRoutes with request conditions such as paths, methods, headers, and query parameters"
44
weight: 200
55
toc: true
6-
docs: "DOCS-000"
6+
docs: "DOCS-1422"
77
---
88

99
In this guide we will configure advanced routing rules for multiple applications. These rules will showcase request matching by path, headers, query parameters, and method. For an introduction to exposing your application, we recommend that you follow the [basic guide]({{< relref "/how-to/traffic-management/routing-traffic-to-your-app.md" >}}) first.

‎site/content/how-to/traffic-management/https-termination.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: "HTTPS Termination"
33
description: "Learn how to terminate HTTPS traffic using NGINX Gateway Fabric."
44
weight: 500
55
toc: true
6-
docs: "DOCS-000"
6+
docs: "DOCS-1421"
77
---
88

99
In this guide, we will show how to configure HTTPS termination for your application, using an [HTTPRoute](https://gateway-api.sigs.k8s.io/api-types/httproute/) redirect filter, secret, and [ReferenceGrant](https://gateway-api.sigs.k8s.io/api-types/referencegrant/).

‎site/content/how-to/traffic-management/integrating-cert-manager.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: "Securing Traffic using Let's Encrypt and Cert-Manager"
33
description: "Learn how to issue and mange certificates using Let's Encrypt and cert-manager."
44
weight: 300
55
toc: true
6-
docs: "DOCS-000"
6+
docs: "DOCS-1425"
77
---
88

99
Securing client server communication is a crucial part of modern application architectures. One of the most important steps in this process is implementing HTTPS (HTTP over TLS/SSL) for all communications. This encrypts the data transmitted between the client and server, preventing eavesdropping and tampering. To do this, you need an SSL/TLS certificate from a trusted Certificate Authority (CA). However, issuing and managing certificates can be a complicated manual process. Luckily, there are many services and tools available to simplify and automate certificate issuance and management.

‎site/content/how-to/traffic-management/redirects-and-rewrites.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: "HTTP Redirects and Rewrites"
33
description: "Learn how to redirect or rewrite your HTTP traffic using NGINX Gateway Fabric."
44
weight: 400
55
toc: true
6-
docs: "DOCS-000"
6+
docs: "DOCS-1424"
77
---
88

99
[HTTPRoute](https://gateway-api.sigs.k8s.io/api-types/httproute/) filters can be used to configure HTTP redirects or rewrites. Redirects return HTTP 3XX responses to a client, instructing it to retrieve a different resource. Rewrites modify components of a client request (such as hostname and/or path) before proxying it upstream.

‎site/content/how-to/traffic-management/routing-traffic-to-your-app.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: "Routing Traffic to Your Application"
33
description: "Learn how to route external traffic to your Kubernetes applications using NGINX Gateway Fabric."
44
weight: 100
55
toc: true
6-
docs: "DOCS-000"
6+
docs: "DOCS-1426"
77
---
88

99
{{<custom-styles>}}

‎site/content/how-to/traffic-management/securing-backend-traffic.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: "Securing Traffic to Backends"
33
description: "Learn how to encrypt HTTP traffic between NGINX Gateway Fabric and your backend pods."
44
weight: 600
55
toc: true
6-
docs: "DOCS-000"
6+
docs: "DOCS-1423"
77
---
88

99
In this guide, we will show how to specify the TLS configuration of the connection from the Gateway to a backend pod/s via the Service API object using a [BackendTLSPolicy](https://gateway-api.sigs.k8s.io/api-types/backendtlspolicy/). This covers the use-case where the service or backend owner is doing their own TLS and NGINX Gateway Fabric needs to know how to connect to this backend pod that has its own certificate over HTTPS.

‎site/content/includes/installation/delay-pod-termination/delay-pod-termination-overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
docs:
2+
docs: "DOCS-1441"
33
---
44

55
To avoid client service interruptions when upgrading NGINX Gateway Fabric, you can configure [`PreStop` hooks](https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/) to delay terminating the NGINX Gateway Fabric pod, allowing the pod to complete certain actions before shutting down. This ensures a smooth upgrade without any downtime, also known as a zero downtime upgrade.

‎site/content/includes/installation/delay-pod-termination/termination-grace-period.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
docs:
2+
docs: "DOCS-1440"
33
---
44

55
Set `terminationGracePeriodSeconds` to a value that is equal to or greater than the `sleep` duration specified in the `preStop` hook (default is `30`). This setting prevents Kubernetes from terminating the pod before before the `preStop` hook has completed running.

‎site/content/includes/installation/helm/pulling-the-chart.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
docs:
2+
docs: "DOCS-1439"
33
---
44

55
Pull the latest stable release of the NGINX Gateway Fabric chart:

‎site/content/includes/installation/install-gateway-api-resources.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
docs:
2+
docs: "DOCS-1438"
33
---
44

55
{{<note>}}The [Gateway API resources](https://github.com/kubernetes-sigs/gateway-api) from the standard channel must be installed before deploying NGINX Gateway Fabric. If they are already installed in your cluster, please ensure they are the correct version as supported by the NGINX Gateway Fabric - [see the Technical Specifications](https://github.com/nginxinc/nginx-gateway-fabric/blob/main/README.md#technical-specifications).{{</note>}}

‎site/content/includes/installation/next-step-expose-fabric.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
docs:
2+
docs: "DOCS-1437"
33
---
44

55
After installing NGINX Gateway Fabric, the next step is to make it accessible. Detailed instructions can be found in [Expose the NGINX Gateway Fabric]({{< relref "installation/expose-nginx-gateway-fabric.md" >}}).

‎site/content/includes/installation/uninstall-gateway-api-resources.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
docs:
2+
docs: "DOCS-1436"
33
---
44

55
{{<warning>}}This will remove all corresponding custom resources in your entire cluster, across all namespaces. Double-check to make sure you don't have any custom resources you need to keep, and confirm that there are no other Gateway API implementations active in your cluster.{{</warning>}}

‎site/content/installation/expose-nginx-gateway-fabric.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: "Expose NGINX Gateway Fabric"
33
description: ""
44
weight: 300
55
toc: true
6-
docs: "DOCS-000"
6+
docs: "DOCS-1427"
77
---
88

99
{{<custom-styles>}}

‎site/content/installation/installing-ngf/helm.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: "Installation with Helm"
33
description: "Learn how to install, upgrade, and uninstall NGINX Gateway Fabric in a Kubernetes cluster with Helm."
44
weight: 100
55
toc: true
6-
docs: "DOCS-000"
6+
docs: "DOCS-1430"
77
---
88

99
{{<custom-styles>}}

‎site/content/installation/installing-ngf/manifests.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: "Installation with Kubernetes manifests"
33
description: "Learn how to install, upgrade, and uninstall NGINX Gateway Fabric using Kubernetes manifests."
44
weight: 200
55
toc: true
6-
docs: "DOCS-000"
6+
docs: "DOCS-1429"
77
---
88

99
{{<custom-styles>}}

‎site/content/installation/ngf-images/building-the-images.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: "Building NGINX Gateway Fabric and NGINX Images"
33
weight: 300
44
toc: true
5-
docs: "DOCS-000"
5+
docs: "DOCS-1431"
66
---
77

88
{{<custom-styles>}}

‎site/content/installation/ngf-images/jwt-token-docker-secret.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
11
---
2-
title: Getting the NGINX Plus image using JWT
2+
title: "Getting the NGINX Plus image using JWT"
33
description: "This document describes how to use a JWT token to get an NGINX Plus image for NGINX Gateway Fabric from the F5 Docker registry."
44
weight: 100
55
doctypes: ["install"]
66
toc: true
7+
docs: "DOCS-1432"
78
---
89

910
## Overview

‎site/content/installation/ngf-images/pulling-ngf-image.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
11
---
2-
title: Pushing an NGINX Plus image to a private registry
2+
title: "Pushing an NGINX Plus image to a private registry"
33
description: "This document describes how to pull a NGINX Plus image for NGINX Gateway Fabric from the official F5 Docker registry and upload it to your private registry."
44
weight: 200
55
doctypes: ["install"]
66
toc: true
7+
docs: "DOCS-1433"
78
---
89

910
{{<custom-styles>}}

‎site/content/installation/running-on-kind.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: "Deploying NGINX Gateway Fabric on a kind Cluster"
33
description: "Learn how to run NGINX Gateway Fabric on a kind (Kubernetes in Docker) cluster."
44
weight: 400
55
toc: true
6-
docs: "DOCS-000"
6+
docs: "DOCS-1428"
77
---
88

99
{{< custom-styles >}}

‎site/content/overview/gateway-api-compatibility.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: "Gateway API Compatibility"
33
description: "Learn which Gateway API resources NGINX Gateway Fabric supports and the extent of that support."
44
weight: 200
55
toc: true
6-
docs: "DOCS-000"
6+
docs: "DOCS-1412"
77
---
88

99
## Summary

‎site/content/overview/gateway-architecture.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: "Gateway Architecture"
33
description: "Learn about the architecture and design principles of NGINX Gateway Fabric."
44
weight: 100
55
toc: true
6-
docs: "DOCS-000"
6+
docs: "DOCS-1413"
77
---
88

99
The intended audience for this information is primarily the two following groups:

‎site/content/overview/nginx-plus.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: "Advanced features of NGINX Plus"
33
weight: 300
44
toc: true
5-
docs: "DOCS-000"
5+
docs: "DOCS-1415"
66
---
77

88
NGINX Gateway Fabric can use NGINX Open Source or NGINX Plus as its data plane. [NGINX Plus](https://www.nginx.com/products/nginx/) is the closed source, commercial version of NGINX. Using NGINX Plus as the data plane offers additional benefits compared to the open source version.

‎site/content/overview/resource-validation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: "Resource Validation"
33
weight: 400
44
toc: true
5-
docs: "DOCS-000"
5+
docs: "DOCS-1414"
66
---
77

88
## Overview

‎site/content/reference/cli-help.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: "Command-line Reference Guide"
33
description: "Learn about the commands available for the executable file of the NGINX Gateway Fabric container."
44
weight: 100
55
toc: true
6-
docs: "DOCS-000"
6+
docs: "DOCS-1435"
77
---
88

99
## Static Mode

‎site/content/reference/technical-specifications.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description: "NGINX Gateway Fabric technical specifications."
55
weight: 200
66
toc: true
77
tags: [ "docs" ]
8-
docs: "DOCS-000"
8+
docs: "DOCS-1434"
99
---
1010

1111
See the NGINX Gateway Fabric technical specifications page:

‎site/content/support.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ draft: false
44
weight: 1100
55
toc: true
66
tags: [ "docs" ]
7-
docs: "DOCS-OOO"
7+
docs: "DOCS-1411"
88
---
99

1010
NGINX Gateway Fabric adheres to the support policy detailed at [nginx.com/support](https://nginx.com/support).

0 commit comments

Comments
 (0)