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

fix: DOCOPS-560 add DOCS-XXX metadata to KIC docs #2341

Merged
merged 1 commit into from
Jan 7, 2022
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
Empty file added docs/.hugo_build.lock
Empty file.
3 changes: 2 additions & 1 deletion docs/content/app-protect-dos/configuration.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
---
title: Configuration

description:
description: "This document describes how to configure the NGINX App Protect Dos module."
weight: 1900
doctypes: [""]
toc: true
docs: "DOCS-580"
---

This document describes how to configure the NGINX App Protect Dos module
Expand Down
3 changes: 2 additions & 1 deletion docs/content/app-protect-dos/dos-protected.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
---
title: Dos Protected Resource

description:
description: "Dos Protected Resource Specification"
weight: 1800
doctypes: [""]
toc: true
docs: "DOCS-581"
---

> Note: This feature is only available in NGINX Plus with AppProtectDos.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ description:
weight: 1900
doctypes: [""]
toc: true
docs: "DOCS-582"
---

## Prerequisites
Expand Down
3 changes: 2 additions & 1 deletion docs/content/app-protect-dos/installation.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
---
title: Installation with NGINX App Protect Dos
description:
description: "This document provides an overview of the steps required to use NGINX App Protect Dos with your NGINX Ingress Controller deployment."
weight: 1800
doctypes: [""]
toc: true
docs: "DOCS-583"
---

> **Note**: The NGINX Kubernetes Ingress Controller integration with NGINX App Protect requires the use of NGINX Plus.
Expand Down
3 changes: 2 additions & 1 deletion docs/content/app-protect/configuration.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
---
title: Configuration

description:
description: "This document describes how to configure the NGINX App Protect module"
weight: 1900
doctypes: [""]
toc: true
docs: "DOCS-578"
---

This document describes how to configure the NGINX App Protect module
Expand Down
3 changes: 2 additions & 1 deletion docs/content/app-protect/installation.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
---
title: Installation with NGINX App Protect
description:
description: "This document provides an overview of the steps required to use NGINX App Protect with your NGINX Ingress Controller deployment."
weight: 1800
doctypes: [""]
toc: true
docs: "DOCS-579"
---

> **Note**: The NGINX Kubernetes Ingress Controller integration with NGINX App Protect requires the use of NGINX Plus.
Expand Down
3 changes: 2 additions & 1 deletion docs/content/configuration/configuration-examples.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
---
title: Configuration Examples

description:
description: "NGINX Ingress Controller configuration examples."
weight: 2000
doctypes: [""]
toc: true
docs: "DOCS-584"
---


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ description:
weight: 1700
doctypes: [""]
toc: true
docs: "DOCS-585"
---


Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
---
title: ConfigMap Resource

description:
description: "The ConfigMap resources allows you to customize or fine tune NGINX behavior."
weight: 1600
doctypes: [""]
toc: true
docs: "DOCS-586"
---


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ description:
weight: 1800
doctypes: [""]
toc: true
docs: "DOCS-587"
---


Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
---
title: GlobalConfiguration Resource

description:
description: "The GlobalConfiguration resource allows you to define the global configuration parameters of the Ingress Controller."
weight: 2000
doctypes: [""]
toc: true
docs: "DOCS-588"
---


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ doctypes: [""]
aliases:
- /report-ingress-status/
toc: true
docs: "DOCS-589"
---


Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
---
title: Handling Host and Listener Collisions
description:
description: "This document explains how the Ingress Controller handles host and listener collisions among resources."
weight: 1700
doctypes: [""]
toc: true
docs: "DOCS-590"
---


Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
---
title: Advanced Configuration with Annotations
description:
description: "This document explains how to use advanced features using annotations."
weight: 1700
doctypes: [""]
toc: true
docs: "DOCS-591"
---


Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
---
title: Advanced Configuration with Snippets
description:
description: "Snippets allow you to insert raw NGINX config into different contexts of the NGINX configurations that the Ingress Controller generates."
weight: 1800
doctypes: [""]
toc: true
docs: "DOCS-592"
---


Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
---
title: Basic Configuration

description:
description: "The example in this document shows a basic Ingress resource definition."
weight: 1600
doctypes: [""]
toc: true
docs: "DOCS-593"
---


Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
---
title: Cross-namespace Configuration

description:
description: "This document explains how to spread Ingress configuration across different namespaces."
weight: 2000
doctypes: [""]
toc: true
docs: "DOCS-594"
---


Expand Down
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
---
title: Custom Annotations

description:
description: "Custom annotations enable you to quickly extend the Ingress resource to support many advanced features of NGINX, such as rate limiting, caching, etc."
weight: 1900
doctypes: [""]
aliases:
- /custom-annotations/
toc: true
docs: "DOCS-595"
---


Expand Down
3 changes: 2 additions & 1 deletion docs/content/configuration/policy-resource.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
---
title: Policy Resource

description:
description: "The Policy resource allows you to configure features like access control and rate-limiting."
weight: 1800
doctypes: [""]
toc: true
docs: "DOCS-596"
---


Expand Down
3 changes: 2 additions & 1 deletion docs/content/configuration/security.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
---
title: Security
description:
description: "NGINX Ingress controller security recommendations."
weight: 1500
doctypes: [""]
toc: true
docs: "DOCS-597"
---


Expand Down
3 changes: 2 additions & 1 deletion docs/content/configuration/transportserver-resource.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
---
title: TransportServer Resource
description:
description: "The TransportServer resource allows you to configure TCP, UDP, and TLS Passthrough load balancing."
weight: 1900
doctypes: [""]
toc: true
docs: "DOCS-598"
---


Expand Down
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
---
title: VirtualServer and VirtualServerRoute Resources
description:
description: "The VirtualServer and VirtualServerRoute resources are new load balancing configuration offered as an alternative to the Ingress resource."
weight: 1600
doctypes: [""]
aliases:
- /virtualserver-and-virtualserverroute/
toc: true
docs: "DOCS-599"
---


Expand Down
1 change: 1 addition & 0 deletions docs/content/f5-ingresslink.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ description: |
weight: 1800
doctypes: ["concept"]
toc: true
docs: "DOCS-600"
---


Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
---
title: Building the Ingress Controller Image
description:
description: "This document explains how to build an Ingress Controller image using the source code."
weight: 2200
doctypes: [""]
toc: true
docs: "DOCS-601"
---

This document explains how to build an Ingress Controller image using the source code. You can also use pre-built images: please see [here](/nginx-ingress-controller/installation/using-the-jwt-token-docker-secret) and [here](/nginx-ingress-controller/installation/pulling-ingress-controller-image) for details on how to pull the NGINX Ingress Controller based on NGINX Plus from the F5 Docker registry; for NGINX Ingress Controller based on NGINX OSS, we provide the images through [DockerHub](https://hub.docker.com/r/nginx/nginx-ingress/) and [GitHub Container](https://github.com/nginxinc/kubernetes-ingress/pkgs/container/kubernetes-ingress).
Expand Down
3 changes: 2 additions & 1 deletion docs/content/installation/installation-with-helm.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
---
title: Installation with Helm
description:
description: "This document describes how to install the NGINX Ingress Controller in your Kubernetes cluster using Helm."
weight: 1900
doctypes: [""]
toc: true
docs: "DOCS-602"
---


Expand Down
3 changes: 2 additions & 1 deletion docs/content/installation/installation-with-manifests.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
---
title: Installation with Manifests
description:
description: "This document describes how to install the NGINX Ingress Controller in your Kubernetes cluster using Kubernetes manifests."
weight: 1800
doctypes: [""]
aliases:
- /installation/
toc: true
docs: "DOCS-603"
---


Expand Down
3 changes: 2 additions & 1 deletion docs/content/installation/installation-with-operator.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
---
title: Installation with the NGINX Ingress Operator

description:
description: "This document describes how to install the NGINX Ingress Controller in your Kubernetes cluster using the NGINX Ingress Operator."
weight: 2000
doctypes: [""]
toc: true
docs: "DOCS-604"
---


Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
---
title: Pulling the Ingress Controller Image
description:
description: "This document explains how to pull an NGINX Plus Ingress Controller image from the F5 Docker registry."
weight: 1700
doctypes: [""]
toc: true
docs: "DOCS-605"
---

This document explains how to pull an NGINX Plus Ingress Controller image from the F5 Docker registry using your NGINX Ingress Controller subscription certificate and key. **Please note that an NGINX Plus subscription certificate and key will not work with the F5 Docker registry.** You can also get the image using alternative methods:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
---
title: Running Multiple Ingress Controllers

description:
description: "This document explains how to run multiple NGINX Ingress controllers."
weight: 2100
doctypes: [""]
aliases:
- /multiple-ingress-controllers/
toc: true
docs: "DOCS-606"
---


Expand Down
3 changes: 2 additions & 1 deletion docs/content/installation/using-aws-marketplace-image.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
---
title: Using the AWS Marketplace Ingress Controller Image
description:
description: "This document will walk you through the steps needed to use the NGINX Ingress Controller through the AWS Marketplace."
weight: 2300
doctypes: [""]
toc: true
docs: "DOCS-607"
---

This document will walk you through the steps needed to use the NGINX Ingress Controller through the AWS Marketplace. There are additional steps that must be followed in order for the AWS Marketplace NGINX Ingress Controller to work properly.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
---
title: Using the NGINX IC Plus JWT token in a Docker Config Secret
description:
description: "This document explains how to use the NGINX Plus Ingress Controller image from the F5 Docker registry in your Kubernetes cluster by using your NGINX Ingress Controller subscription JWT token."
weight: 1600
doctypes: [""]
toc: true
docs: "DOCS-608"
---

This document explains how to use the NGINX Plus Ingress Controller image from the F5 Docker registry in your Kubernetes cluster by using your NGINX Ingress Controller subscription JWT token. **Please note that an NGINX Plus subscription certificate and key will not work with the F5 Docker registry.** You can also get the image using alternative methods:
Expand Down
3 changes: 2 additions & 1 deletion docs/content/intro/how-nginx-ingress-controller-works.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
---
title: How NGINX Ingress Controller Works
description:
description: "This document explains how NGINX Ingress Controller works."
weight: 300
doctypes: [""]
toc: true
docs: "DOCS-609"
---


Expand Down
1 change: 1 addition & 0 deletions docs/content/intro/nginx-ingress-controllers.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ weight: 200
draft: true
doctypes: ["concept"]
toc: true
docs: "DOCS-610"
aliases:
- /nginx-ingress-controllers/
---
Expand Down
Loading