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

Add missing entries to the documentation catalog. #5146

Merged
merged 3 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
4 changes: 2 additions & 2 deletions docs/content/community.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
title: Community and Contribution
title: "Community and Contribution"

description: "Learn about the NGINX Ingress Controller community and contribute to the project."
weight: 2200
toc: true
docs: "DOCS-584"
docs: "DOCS-1447"
---


Expand Down
3 changes: 2 additions & 1 deletion docs/content/glossary.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
---
title: Glossary
title: "Glossary"
description:
weight: 10000
menu:
docs:
parent: NGINX Ingress Controller
docs: "DOCS-1446"
---

{{<custom-styles>}}
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
docs:
docs: "DOCS-1464"
---

In this section, you'll create resources that most NGINX Ingress Controller installations require:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
docs: "DOCS-1463"
---

To make sure your NGINX Ingress Controller pods reach the `Ready` state, you'll need to create custom resource definitions (CRDs) for various components.

Alternatively, you can disable this requirement by setting the `-enable-custom-resources` command-line argument to `false`.
Expand Down
2 changes: 1 addition & 1 deletion docs/content/includes/installation/deploy-controller.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
docs:
docs: "DOCS-1462"
---

You have two options for deploying NGINX Ingress Controller:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
docs:
docs: "DOCS-1465"
---

For additional context on managing containers using Kubernetes DaemonSets, refer to the official Kubernetes [DaemonSets](https://kubernetes.io/docs/concepts/workloads/controllers/daemonset/) documentation.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
docs:
docs: "DOCS-1467"
---

For additional context on managing containers using Kubernetes Deployments, refer to the official Kubernetes [Deployments](https://kubernetes.io/docs/concepts/workloads/controllers/deployment/) documentation.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
docs:
docs: "DOCS-1466"
---

To confirm the NGINX Ingress Controller pods are operational, run:
Expand Down
2 changes: 1 addition & 1 deletion docs/content/includes/rbac/set-up-rbac.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
docs:
docs: "DOCS-1468"
---

{{<call-out "important" "Admin access required" >}}To complete these steps you need admin access to your cluster. Refer to to your Kubernetes platform's documentation to set up admin access. For Google Kubernetes Engine (GKE), you can refer to their [Role-Based Access Control guide](https://cloud.google.com/kubernetes-engine/docs/how-to/role-based-access-control).{{</call-out>}}
Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
---
title: Building NGINX Ingress Controller
title: "Building NGINX Ingress Controller"
description: "Learn how to build an NGINX Ingress Controller image from source codes and upload it to a private Docker registry. You'll also find information on the Makefile targets and variables."
weight: 200
doctypes: ["installation"]
toc: true
docs: "DOCS-1453"
---

{{<custom-styles>}}
Expand Down
2 changes: 1 addition & 1 deletion docs/content/installation/ingress-nginx.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: "This document describes how to migrate from the community-maintain
weight: 500
toc: true
tags: [ "docs" ]
docs: "DOCS-000"
docs: "DOCS-1469"
categories: ["installation", "platform management"]
doctypes: ["tutorial"]
journeys: ["getting started"]
Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
title: Using the GCP Marketplace NGINX Ingress Controller Image
title: "Using the GCP Marketplace NGINX Ingress Controller Image"
description: "Follow these steps to deploy F5 NGINX Ingress Controller through the GCP Marketplace."
weight: 300
doctypes: [""]
toc: true
docs: "DOCS-000"
docs: "DOCS-1455"
---

## Overview
Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
---
title: Getting the NGINX Ingress Controller Image with JWT
title: "Getting the NGINX Ingress Controller Image with JWT"
description: "Use your NGINX Ingress Controller subscription JWT token to get the NGINX Plus Ingress Controller image from the F5 Docker registry."
weight: 150
doctypes: [""]
toc: true
docs: "DOCS-1454"
---

{{<custom-styles>}}
Expand Down
1 change: 1 addition & 0 deletions docs/content/troubleshooting/troubleshoot-common.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ tags: [ "docs" ]
doctypes: ["troubleshooting"]
aliases:
- /content/troubleshooting/troubleshoot-ingress-controller
docs: "DOCS-1459"
---

## Common Problems
Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
---
title: Troubleshooting Policy Resources
title: "Troubleshooting Policy Resources"
description: "This page describes how to troubleshoot NGINX Ingress Controller Policy Resources."
weight: 200
doctypes: [""]
toc: true
docs: "DOCS-1457"
---

## Policy Resources
Expand Down
3 changes: 2 additions & 1 deletion docs/content/troubleshooting/troubleshoot-ingress.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
---
title: Troubleshooting Ingress Resources
title: "Troubleshooting Ingress Resources"
description: "This page describes how to troubleshoot NGINX Ingress Controller Policy Resources."
weight: 300
doctypes: [""]
toc: true
docs: "DOCS-1458"
---

## Ingress Resources
Expand Down
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
---
title: Troubleshooting VirtualServer Resources
title: "Troubleshooting VirtualServer Resources"
description: "This page describes how to troubleshoot VirtualServer and VirtualServer Resource Events."
weight: 500
doctypes: [""]
toc: true
aliases:
- /content/troubleshooting/virtualserver-virtualserverroute
docs: "DOCS-1461"
---
## Inspecting VirtualServer and VirtualServerRoute Resource Events

Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
---
title: Troubleshooting with NGINX App Protect DoS
title: "Troubleshooting with NGINX App Protect DoS"
description: "This document describes how to troubleshoot problems when using NGINX Ingress Controller and the App Protect DoS module."
weight: 600
doctypes: [""]
toc: true
docs: "DOCS-1456"
aliases:
- /content/troubleshooting/troubleshooting-with-app-protect-dos
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
---
title: Troubleshooting with NGINX App Protect WAF
title: "Troubleshooting with NGINX App Protect WAF"
description: "This document describes how to troubleshoot problems when using NGINX Ingress Controller and the NGINX App Protect WAF module."
weight: 700
docs: "DOCS-1460"
doctypes: [""]
toc: true
aliases:
Expand Down
3 changes: 2 additions & 1 deletion docs/content/tutorials/custom-listen-ports.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
---
title: Customizing NGINX Ingress Controller Ports
title: "Customizing NGINX Ingress Controller Ports"
description: |
How to customize F5 NGINX Ingress Controller ports.
weight: 1800
doctypes: ["concept"]
toc: true
docs: "DOCS-1449"
---
## Customizing NGINX Ingress Controller Ports

Expand Down
3 changes: 2 additions & 1 deletion docs/content/tutorials/ingress-path-regex-annotation.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Ingresses Path Matching Using Path-Regex Annotation
title: "Ingresses Path Matching Using Path-Regex Annotation"
docs: "DOCS-1451"
description: |
How to customize Ingress and Mergeable Ingress types with path-regex annotations.
weight: 1800
Expand Down
3 changes: 2 additions & 1 deletion docs/content/tutorials/nginx-ingress-linkerd.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
---
title: NGINX Ingress Controller and Linkerd
title: "NGINX Ingress Controller and Linkerd"
description: |
Using Linkerd with the F5 NGINX Ingress Controller.
weight: 1800
docs: "DOCS-1450"
doctypes: ["concept"]
toc: true
---
Expand Down
3 changes: 2 additions & 1 deletion docs/content/tutorials/oidc-custom-configuration.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Customize OIDC Configuration with NGINX Ingress Controller
title: "Customize OIDC Configuration with NGINX Ingress Controller"
description: |
How to Customize the default OIDC Configuration with NGINX Ingress Controller
weight: 1800
Expand Down Expand Up @@ -48,6 +48,7 @@ Annotations: <none>
Data
====
oidc.conf:
docs: "DOCS-1448"
----
# Advanced configuration START
set $internal_error_message "NGINX / OpenID Connect login failure\n";
Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
---
title: Configuring VirtualServer with custom HTTP and HTTPS listener ports
title: "Configuring VirtualServer with custom HTTP and HTTPS listener ports"
description: |
This tutorial outlines how to configure and deploy a VirtualServer resource with custom HTTP and HTTPS listener ports.
weight: 1800
doctypes: ["concept"]
toc: true
docs: "DOCS-1452"
---
## Configuring a VirtualServer with custom HTTP and HTTPS listener ports.

Expand Down
3 changes: 2 additions & 1 deletion docs/content/usage-reporting.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
---
title: Enabling Usage Reporting
title: "Enabling Usage Reporting"
description: "This page outlines how to enable Usage Reporting for the NGINX Ingress Controller and how to view the usage data through the API."
weight: 1800
doctypes: ["concept"]
toc: true
docs: "DOCS-1445"
---

## Overview
Expand Down
Loading