Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: add NGF docs to catalog #1599

Merged
merged 2 commits into from
Feb 21, 2024
Merged
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
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: "Control Plane Configuration"
description: "Learn how to dynamically update the Gateway Fabric control plane configuration."
weight: 100
toc: true
docs: "DOCS-000"
docs: "DOCS-1416"
---

## Overview
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: "Upgrade applications without downtime"
description: "Learn how to use NGINX Gateway Fabric to upgrade applications without downtime."
weight: 100
toc: true
docs: "DOCS-000"
docs: "DOCS-1420"
---

{{<custom-styles>}}
Expand Down
2 changes: 1 addition & 1 deletion site/content/how-to/monitoring/dashboard.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: "NGINX Plus Dashboard"
description: "Learn how to view the NGINX Plus dashboard to see real-time metrics."
weight: 200
toc: true
docs: "DOCS-000"
docs: "DOCS-1417"
---

{{<custom-styles>}}
Expand Down
2 changes: 1 addition & 1 deletion site/content/how-to/monitoring/prometheus.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: "Prometheus Metrics"
description: "Learn how to monitor your NGINX Gateway Fabric effectively. This guide provides easy steps for configuring and understanding key performance metrics using Prometheus."
weight: 100
toc: true
docs: "DOCS-000"
docs: "DOCS-1418"
---

{{<custom-styles>}}
Expand Down
2 changes: 1 addition & 1 deletion site/content/how-to/monitoring/troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: "Troubleshooting"

weight: 300
toc: true
docs: "DOCS-000"
docs: "DOCS-1419"
---

{{< custom-styles >}}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: "Routing to Applications Using HTTP Matching Conditions"
description: "Learn how to deploy multiple applications and HTTPRoutes with request conditions such as paths, methods, headers, and query parameters"
weight: 200
toc: true
docs: "DOCS-000"
docs: "DOCS-1422"
---

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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: "HTTPS Termination"
description: "Learn how to terminate HTTPS traffic using NGINX Gateway Fabric."
weight: 500
toc: true
docs: "DOCS-000"
docs: "DOCS-1421"
---

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/).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: "Securing Traffic using Let's Encrypt and Cert-Manager"
description: "Learn how to issue and mange certificates using Let's Encrypt and cert-manager."
weight: 300
toc: true
docs: "DOCS-000"
docs: "DOCS-1425"
---

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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: "HTTP Redirects and Rewrites"
description: "Learn how to redirect or rewrite your HTTP traffic using NGINX Gateway Fabric."
weight: 400
toc: true
docs: "DOCS-000"
docs: "DOCS-1424"
---

[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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: "Routing Traffic to Your Application"
description: "Learn how to route external traffic to your Kubernetes applications using NGINX Gateway Fabric."
weight: 100
toc: true
docs: "DOCS-000"
docs: "DOCS-1426"
---

{{<custom-styles>}}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: "Securing Traffic to Backends"
description: "Learn how to encrypt HTTP traffic between NGINX Gateway Fabric and your backend pods."
weight: 600
toc: true
docs: "DOCS-000"
docs: "DOCS-1423"
---

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.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
docs:
docs: "DOCS-1441"
---

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.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
docs:
docs: "DOCS-1440"
---

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.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
docs:
docs: "DOCS-1439"
---

Pull the latest stable release of the NGINX Gateway Fabric chart:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
docs:
docs: "DOCS-1438"
---

{{<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>}}
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
docs:
docs: "DOCS-1437"
---

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" >}}).
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
docs:
docs: "DOCS-1436"
---

{{<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>}}
Expand Down
2 changes: 1 addition & 1 deletion site/content/installation/expose-nginx-gateway-fabric.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: "Expose NGINX Gateway Fabric"
description: ""
weight: 300
toc: true
docs: "DOCS-000"
docs: "DOCS-1427"
---

{{<custom-styles>}}
Expand Down
2 changes: 1 addition & 1 deletion site/content/installation/installing-ngf/helm.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: "Installation with Helm"
description: "Learn how to install, upgrade, and uninstall NGINX Gateway Fabric in a Kubernetes cluster with Helm."
weight: 100
toc: true
docs: "DOCS-000"
docs: "DOCS-1430"
---

{{<custom-styles>}}
Expand Down
2 changes: 1 addition & 1 deletion site/content/installation/installing-ngf/manifests.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: "Installation with Kubernetes manifests"
description: "Learn how to install, upgrade, and uninstall NGINX Gateway Fabric using Kubernetes manifests."
weight: 200
toc: true
docs: "DOCS-000"
docs: "DOCS-1429"
---

{{<custom-styles>}}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: "Building NGINX Gateway Fabric and NGINX Images"
weight: 300
toc: true
docs: "DOCS-000"
docs: "DOCS-1431"
---

{{<custom-styles>}}
Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
---
title: Getting the NGINX Plus image using JWT
title: "Getting the NGINX Plus image using JWT"
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."
weight: 100
doctypes: ["install"]
toc: true
docs: "DOCS-1432"
---

## Overview
Expand Down
3 changes: 2 additions & 1 deletion site/content/installation/ngf-images/pulling-ngf-image.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
---
title: Pushing an NGINX Plus image to a private registry
title: "Pushing an NGINX Plus image to a private registry"
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."
weight: 200
doctypes: ["install"]
toc: true
docs: "DOCS-1433"
---

{{<custom-styles>}}
Expand Down
2 changes: 1 addition & 1 deletion site/content/installation/running-on-kind.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: "Deploying NGINX Gateway Fabric on a kind Cluster"
description: "Learn how to run NGINX Gateway Fabric on a kind (Kubernetes in Docker) cluster."
weight: 400
toc: true
docs: "DOCS-000"
docs: "DOCS-1428"
---

{{< custom-styles >}}
Expand Down
2 changes: 1 addition & 1 deletion site/content/overview/gateway-api-compatibility.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: "Gateway API Compatibility"
description: "Learn which Gateway API resources NGINX Gateway Fabric supports and the extent of that support."
weight: 200
toc: true
docs: "DOCS-000"
docs: "DOCS-1412"
---

## Summary
Expand Down
2 changes: 1 addition & 1 deletion site/content/overview/gateway-architecture.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: "Gateway Architecture"
description: "Learn about the architecture and design principles of NGINX Gateway Fabric."
weight: 100
toc: true
docs: "DOCS-000"
docs: "DOCS-1413"
---

The intended audience for this information is primarily the two following groups:
Expand Down
2 changes: 1 addition & 1 deletion site/content/overview/nginx-plus.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: "Advanced features of NGINX Plus"
weight: 300
toc: true
docs: "DOCS-000"
docs: "DOCS-1415"
---

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.
Expand Down
2 changes: 1 addition & 1 deletion site/content/overview/resource-validation.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: "Resource Validation"
weight: 400
toc: true
docs: "DOCS-000"
docs: "DOCS-1414"
---

## Overview
Expand Down
2 changes: 1 addition & 1 deletion site/content/reference/cli-help.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: "Command-line Reference Guide"
description: "Learn about the commands available for the executable file of the NGINX Gateway Fabric container."
weight: 100
toc: true
docs: "DOCS-000"
docs: "DOCS-1435"
---

## Static Mode
Expand Down
2 changes: 1 addition & 1 deletion site/content/reference/technical-specifications.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: "NGINX Gateway Fabric technical specifications."
weight: 200
toc: true
tags: [ "docs" ]
docs: "DOCS-000"
docs: "DOCS-1434"
---

See the NGINX Gateway Fabric technical specifications page:
Expand Down
2 changes: 1 addition & 1 deletion site/content/support.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ draft: false
weight: 1100
toc: true
tags: [ "docs" ]
docs: "DOCS-OOO"
docs: "DOCS-1411"
---

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