Skip to content
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
2 changes: 0 additions & 2 deletions content/nginx-one-console/api/api-reference-guide.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
---
description: ''
nd-docs: DOCS-1398
doctypes:
- reference
nd-content-type: redoc
nd-product: NONECO
tags:
Expand Down
4 changes: 2 additions & 2 deletions content/nic/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ cascade:
# The logo file is resolved from the theme, in the folder /static/images/icons/
logo: NGINX-Ingress-Controller-product-icon.svg
# The subtitle displays directly underneath the heading of a given page
nd-subtitle:
nd-subtitle:
# Indicates that this is a custom landing page
nd-landing-page: true
# Types have a 1:1 relationship with Hugo archetypes, so you shouldn't need to change this
Expand All @@ -20,7 +20,7 @@ nd-product: INGRESS

## About

NGINX Ingress Controller is an [Ingress Controller]({{< ref "/nic/glossary.md#ingress-controller">}}) implementation for NGINX that can load balance Websocket, gRPC, TCP and UDP applications.
NGINX Ingress Controller is an [Ingress Controller]({{< ref "/nic/glossary.md#ingress-controller">}}) implementation for NGINX that can load balance Websocket, gRPC, TCP and UDP applications.

It supports standard [Ingress]({{< ref "/nic/glossary.md#ingress">}}) features such as content-based routing and TLS/SSL termination. Several NGINX and NGINX Plus features are available as extensions to Ingress resources through [Annotations]({{< ref "/nic/configuration/ingress-resources/advanced-configuration-with-annotations">}}) and the [ConfigMap]({{< ref "/nic/configuration/global-configuration/configmap-resource">}}) resource.

Expand Down
4 changes: 2 additions & 2 deletions content/nic/configuration/configuration-examples.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
nd-docs: DOCS-584
doctypes:
- ''
title: Configuration examples
toc: true
weight: 400
nd-content-type: reference
nd-product: INGRESS
---

Our [GitHub repo](https://github.com/nginx/kubernetes-ingress) includes a number of configuration examples:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
---
nd-docs: DOCS-587
doctypes:
- ''
title: Custom templates
toc: true
weight: 500
Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
nd-docs: DOCS-1859
doctypes:
- ''
title: Management ConfigMap resource
toc: true
weight: 300
nd-content-type: how-to
nd-product: INGRESS
---

When using F5 NGINX Ingress Controller with NGINX Plus, it is required to pass a [command line argument]({{< ref "/nic/configuration/global-configuration/command-line-arguments" >}}) to NGINX Ingress Controller, `--mgmt-configmap=<namespace/name>` which specifies the ConfigMap to use. The minimal required ConfigMap must have a `license-token-secret-name` key. Helm users will not need to create this map or pass the argument, it will be created with a Helm install.
Expand Down
2 changes: 2 additions & 0 deletions content/nic/configuration/host-and-listener-collisions.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ title: Host and Listener collisions
toc: true
weight: 800
nd-docs: DOCS-590
nd-product: INGRESS
nd-content-type: reference
---

This document explains how F5 NGINX Ingress Controller handles host and listener collisions between resources.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
nd-docs: DOCS-592
doctypes:
- ''
title: Advanced configuration with Snippets
toc: true
weight: 400
nd-content-type: how-to
nd-product: INGRESS
---

Snippets allow you to insert raw NGINX config into different contexts of the NGINX configurations that F5 NGINX Ingress Controller generates.
Expand Down
2 changes: 2 additions & 0 deletions content/nic/configuration/proxy-buffers-configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ title: Proxy Buffer Configuration Auto-Adjustment
toc: true
weight: 850
nd-docs: DOCS-590
nd-product: INGRESS
nd-content-type: how-to
---

This document explains how the `--enable-directive-autoadjust` option prevents NGINX configuration errors by automatically adjusting some HTTP proxy buffer directives.
Expand Down
2 changes: 2 additions & 0 deletions content/nic/configuration/transportserver-resource.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ title: TransportServer resources
toc: true
weight: 600
nd-docs: DOCS-598
nd-content-type : reference
nd-product: INGRESS
---

This document is reference material for the TransportServer resource used by F5 NGINX Ingress Controller.
Expand Down
3 changes: 2 additions & 1 deletion content/nic/glossary.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
---
description: null
nd-docs: DOCS-1446
title: Glossary
weight: 10100
nd-content-type: reference
nd-product: INGRESS
---

This is a glossary of terms related to F5 NGINX Ingress Controller and Kubernetes as a whole.
Expand Down
4 changes: 2 additions & 2 deletions content/nic/install/images/use-aws-image.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
---
nd-docs: DOCS-607
doctypes:
- ''
title: Use the AWS Marketplace NGINX Ingress Controller image
toc: true
weight: 200
draft: true
nd-content-type: how-to
nd-product: INGRESS
---

This guide walks you through the steps to set up NGINX Ingress Controller using the AWS Marketplace
Expand Down
4 changes: 2 additions & 2 deletions content/nic/install/images/use-gcp-image.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
---
nd-docs: DOCS-1455
doctypes:
- ''
title: Use the GCP Marketplace NGINX Ingress Controller image
toc: true
weight: 300
draft: true
nd-content-type: how-to
nd-product: INGRESS
---

Follow these steps to deploy F5 NGINX Ingress Controller through the GCP Marketplace.
Expand Down
10 changes: 2 additions & 8 deletions content/nic/install/upgrade.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,12 @@
---
# We use sentence case and present imperative tone
title: "Upgrade NGINX Ingress Controller"
# Weights are assigned in increments of 100: determines sorting order
weight: 900
# Creates a table of contents and sidebar, useful for large documents
toc: true
# Types have a 1:1 relationship with Hugo archetypes, so you shouldn't need to change this
nd-content-type: how-to
# Intended for internal catalogue and search, case sensitive:
# Agent, N4Azure, NIC, NIM, NGF, NAP-DOS, NAP-WAF, NGINX One, NGINX+, Solutions, Unit
nd-product: INGRESS
nd-product: INGRESS
---

This document describes how to upgrade F5 NGINX Ingress Controller when a new version releases.
This document describes how to upgrade F5 NGINX Ingress Controller when a new version releases.

It covers the necessary steps for minor versions as well as major versions (Such as 3.x to 4.x).

Expand Down
6 changes: 0 additions & 6 deletions content/nic/logging-and-monitoring/opentelemetry.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,8 @@
---
# We use sentence case and present imperative tone
title: "Enable OpenTelemetry"
# Weights are assigned in increments of 100: determines sorting order
weight: 300
# Creates a table of contents and sidebar, useful for large documents
toc: true
# Types have a 1:1 relationship with Hugo archetypes, so you shouldn't need to change this
nd-content-type: how-to
# Intended for internal catalogue and search, case sensitive:
# Agent, N4Azure, NIC, NIM, NGF, NAP-DOS, NAP-WAF, NGINX One, NGINX+, Solutions, Unit
nd-product: INGRESS
---

Expand Down
2 changes: 1 addition & 1 deletion content/nic/logging-and-monitoring/prometheus.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ The metrics exposed include NGINX Ingress Controller data, as well as NGINX Open

### Using Helm

To enable Prometheus metrics when using *Helm* to install NGINX Ingress Controller, configure the `prometheus.*` parameters of the Helm chart.
To enable Prometheus metrics when using *Helm* to install NGINX Ingress Controller, configure the `prometheus.*` parameters of the Helm chart.

See the [Installation with Helm]({{< ref "/nic/install/helm.md" >}}) topic.

Expand Down
4 changes: 2 additions & 2 deletions content/nic/logging-and-monitoring/status-page.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ To access the status:

1. Use the `kubectl port-forward` command to forward connections to port 8080 on your local machine to port 8080 of an NGINX Ingress Controller pod (replace `<nginx-ingress-pod>` with the actual name of a pod):.

```
```shell
kubectl port-forward <nginx-ingress-pod> 8080:8080 --namespace=nginx-ingress
```

Expand All @@ -49,7 +49,7 @@ To access the dashboard:

1. Use the `kubectl port-forward` command to forward connections to port 8080 on your local machine to port 8080 of an NGINX Plus Ingress Controller pod (replace `<nginx-plus-ingress-pod>` with the actual name of a pod):

```
```shell
kubectl port-forward <nginx-plus-ingress-pod> 8080:8080 --namespace=nginx-ingress
```

Expand Down
2 changes: 1 addition & 1 deletion content/nic/overview/controller-comparison.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ The table below summarizes the key difference between nginx/kubernetes-ingress a
| Configuration templates *1 | See the [template](https://github.com/kubernetes/ingress-nginx/blob/main/rootfs/etc/nginx/template/nginx.tmpl) | See the [templates](../internal/configs/version1) | See the [templates](../internal/configs/version1) |
| **Load balancing configuration via Custom Resources** |
| HTTP load balancing | Not supported | See [VirtualServer and VirtualServerRoute]({{< ref "/nic/configuration/virtualserver-and-virtualserverroute-resources.md" >}}) resources | See [VirtualServer and VirtualServerRoute]({{< ref "/nic/configuration/virtualserver-and-virtualserverroute-resources.md" >}}) resources |
| TCP/UDP load balancing | Not supported | See [TransportServer]({{< ref "/nic/configuration/transportserver-resource.md" >}}) resource | See [TransportServer](({{< ref "/nic/configuration/transportserver-resource.md" >}}) resource |
| TCP/UDP load balancing | Not supported | See [TransportServer]({{< ref "/nic/configuration/transportserver-resource.md" >}}) resource | See [TransportServer]({{< ref "/nic/configuration/transportserver-resource.md" >}}) resource |
| TCP SSL Passthrough load balancing | Not supported | See [TransportServer]({{< ref "/nic/configuration/transportserver-resource.md" >}}) resource | See [TransportServer]({{< ref "/nic/configuration/transportserver-resource.md" >}}) resource |
| **Deployment** |
| Command-line arguments *2 | See the [arguments](https://kubernetes.github.io/ingress-nginx/user-guide/cli-arguments/) | See the [arguments]({{< ref "/nic/configuration/global-configuration/command-line-arguments.md" >}}) | See the [arguments]({{< ref "/nic/configuration/global-configuration/command-line-arguments.md" >}}) |
Expand Down
2 changes: 2 additions & 0 deletions content/nic/overview/nginx-plus.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ doctypes:
- concept
title: Extensibility with NGINX Plus
weight: 300
nd-product: INGRESS
nd-content-type: reference
---

This document explains how F5 NGINX Plus can extend the functionality of F5 NGINX Ingress Controller.
Expand Down
2 changes: 2 additions & 0 deletions content/nic/overview/product-telemetry.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ title: Product telemetry
toc: true
weight: 500
nd-docs: DOCS-1857
nd-product: INGRESS
nd-content-type: reference
---

Learn why, what and how F5 NGINX Ingress Controller collects telemetry.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
nd-docs: DOCS-1457
doctypes:
- ''
title: Troubleshooting Policy resources
toc: true
weight: 300
nd-product: INGRESS
nd-content-type: how-to
---

This page describes how to troubleshoot NGINX Ingress Controller Policy Resources.
Expand Down
4 changes: 2 additions & 2 deletions content/nic/troubleshooting/troubleshoot-ingress.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
nd-docs: DOCS-1458
doctypes:
- ''
title: Troubleshooting Ingress resources
toc: true
weight: 300
nd-product: INGRESS
nd-content-type: how-to
---

This page describes how to troubleshoot NGINX Ingress Controller Policy Resources.
Expand Down
2 changes: 2 additions & 0 deletions content/nic/troubleshooting/troubleshoot-support.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
title: Commercial support
weight: 100
nd-docs: DOCS-1867
nd-product: INGRESS
nd-content-type: how-to
---

F5 NGINX Ingress Controller adheres to the support policy detailed in the following knowledge base article: [K000140156](https://my.f5.com/manage/s/article/K000140156).
Expand Down
4 changes: 2 additions & 2 deletions content/nic/troubleshooting/troubleshoot-transportserver.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
doctypes:
- ''
draft: true
title: Troubleshooting TransportServer Resources
weight: 500
nd-product: INGRESS
nd-content-type: how-to
---

# Troubleshooting TransportServer Resources
4 changes: 2 additions & 2 deletions content/nic/troubleshooting/troubleshoot-virtualserver.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
nd-docs: DOCS-1461
doctypes:
- ''
title: Troubleshooting VirtualServer resources
toc: true
weight: 600
nd-product: INGRESS
nd-content-type: how-to
---

This page describes how to troubleshoot VirtualServer and VirtualServer resource events.
Expand Down
2 changes: 2 additions & 0 deletions content/nic/tutorials/custom-listen-ports.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ doctypes:
title: Customizing NGINX Ingress Controller Ports
toc: true
weight: 1800
nd-product: INGRESS
nd-content-type: how-to
---

This document explains how to change the default ports that NGINX Ingress Controller is configured to use, as well as how to add additional `listen` settings. For more information, please read the [NGINX Listen documentation](http://nginx.org/en/docs/http/ngx_http_core_module.html#listen).
Expand Down
2 changes: 1 addition & 1 deletion content/nic/tutorials/oidc-custom-configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: Customize OIDC Configuration with NGINX Ingress Controller
weight: 1800
toc: true
type: how-to
nd-content-type: how-to
nd-product: INGRESS
nd-docs: DOCS-1448
---
Expand Down