Skip to content

Commit 9529010

Browse files
authored
docs: add missing NIC docs to the catalog (#764)
1 parent f2a8261 commit 9529010

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

47 files changed

+68
-65
lines changed

content/nic/configuration/access-control.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: Deploy a Policy for access control
33
weight: 900
44
toc: true
5-
docs: DOCS-000
5+
nd-docs: DOCS-1858
66
---
77

88
This topic describes how to use F5 NGINX Ingress Controller to apply and update a Policy for access control. It demonstrates it using an example application and a [VirtualServer custom resource]({{< ref "/nic/configuration/virtualserver-and-virtualserverroute-resources.md" >}}).

content/nic/configuration/configuration-examples.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
docs: DOCS-584
2+
nd-docs: DOCS-584
33
doctypes:
44
- ''
55
title: Configuration examples

content/nic/configuration/global-configuration/command-line-arguments.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
docs: DOCS-585
2+
nd-docs: DOCS-585
33
doctypes:
44
- ''
55
title: Command-line arguments

content/nic/configuration/global-configuration/configmap-resource.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -184,12 +184,12 @@ For more information, view the [VirtualServer and VirtualServerRoute resources](
184184
185185
Zone Sync enables the [ngx_stream_zone_sync_module](https://nginx.org/en/docs/stream/ngx_stream_zone_sync_module.html) in NGINX Ingress Controller when NGINX Plus is used. Multiple replicas are required to effectively utililise this functionality. More information is available in the [How NGINX Plus Performs Zone Synchronization]({{< ref "/nginx/admin-guide/high-availability/zone_sync_details.md" >}}) topic.
186186
187-
Zone synchronization with TLS for NGINX Ingress Controller is not yet available with ConfigMap. If you would like to enable Zone Sync with TLS, please remove `zone-sync` from ConfigMap and add Zone Sync parameters via [`stream-snippets`]({{< ref "/nic/configuration/ingress-resources/advanced-configuration-with-snippets.md" >}}) similar to [this example](https://github.com/nginx/kubernetes-ingress/blob/v4.0.1/examples/custom-resources/oidc/nginx-config.yaml) and adding the [zone_sync_ssl directive](https://nginx.org/en/docs/stream/ngx_stream_zone_sync_module.html#zone_sync_ssl) along with any other TLS parameters to the `stream-snippets`.
187+
Zone synchronization with TLS for NGINX Ingress Controller is not yet available with ConfigMap. If you would like to enable Zone Sync with TLS, please remove `zone-sync` from ConfigMap and add Zone Sync parameters via [`stream-snippets`]({{< ref "/nic/configuration/ingress-resources/advanced-configuration-with-snippets.md" >}}) similar to [this example](https://github.com/nginx/kubernetes-ingress/blob/v4.0.1/examples/custom-resources/oidc/nginx-config.yaml) and adding the [zone_sync_ssl directive](https://nginx.org/en/docs/stream/ngx_stream_zone_sync_module.html#zone_sync_ssl) along with any other TLS parameters to the `stream-snippets`.
188188
189189
You will also need to manually add the headless service, such as in [this example](https://github.com/nginx/kubernetes-ingress/blob/v4.0.1/examples/custom-resources/oidc/nginx-ingress-headless.yaml).
190190
191-
{{< caution >}}
192-
If you previously installed OIDC or used the `zone_sync` directive with `stream-snippets` in [v4.0.1](https://github.com/nginx/kubernetes-ingress/tree/v4.0.1) or earlier, and you plan to enable the `zone-sync` ConfigMap key, the `zone_sync` directive should be removed from `stream-snippets`.
191+
{{< caution >}}
192+
If you previously installed OIDC or used the `zone_sync` directive with `stream-snippets` in [v4.0.1](https://github.com/nginx/kubernetes-ingress/tree/v4.0.1) or earlier, and you plan to enable the `zone-sync` ConfigMap key, the `zone_sync` directive should be removed from `stream-snippets`.
193193
194194
If you encounter the error `error [emerg] 13#13: "zone_sync" directive is duplicate in /etc/nginx/nginx.conf:164` it is likely due to `zone_sync` being enabled in both `stream-snippets` and the ConfigMap. Once upgraded, remove the [old headless service](https://github.com/nginx/kubernetes-ingress/blob/v4.0.1/examples/custom-resources/oidc/nginx-ingress-headless.yaml) deployed for OIDC.
195195
{{< /caution >}}

content/nic/configuration/global-configuration/custom-templates.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
docs: DOCS-587
2+
nd-docs: DOCS-587
33
doctypes:
44
- ''
55
title: Custom templates

content/nic/configuration/global-configuration/globalconfiguration-resource.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
docs: DOCS-588
2+
nd-docs: DOCS-588
33
doctypes:
44
- ''
55
title: GlobalConfiguration resource

content/nic/configuration/global-configuration/mgmt-configmap-resource.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
---
2-
docs: DOCS-586
2+
nd-docs: DOCS-1859
33
doctypes:
44
- ''
55
title: Management ConfigMap resource
66
toc: true
77
weight: 300
88
---
99

10-
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.
10+
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.
1111

1212
---
1313

content/nic/configuration/host-and-listener-collisions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: Host and Listener collisions
33
toc: true
44
weight: 800
5-
docs: DOCS-590
5+
nd-docs: DOCS-590
66
---
77

88
This document explains how F5 NGINX Ingress Controller handles host and listener collisions between resources.

content/nic/configuration/ingress-resources/advanced-configuration-with-snippets.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
---
2-
docs: DOCS-592
2+
nd-docs: DOCS-592
33
doctypes:
44
- ''
55
title: Advanced configuration with Snippets
66
toc: true
77
weight: 400
88
---
99

10-
Snippets allow you to insert raw NGINX config into different contexts of the NGINX configurations that F5 NGINX Ingress Controller generates.
10+
Snippets allow you to insert raw NGINX config into different contexts of the NGINX configurations that F5 NGINX Ingress Controller generates.
1111

12-
Snippets are intended for advanced NGINX users who need more control over the generated NGINX configuration, and can be used in cases where Annotations and ConfigMap entries would not apply.
12+
Snippets are intended for advanced NGINX users who need more control over the generated NGINX configuration, and can be used in cases where Annotations and ConfigMap entries would not apply.
1313

1414

1515

@@ -27,7 +27,7 @@ Snippets have the following disadvantages:
2727
- *Decreased robustness*. An incorrect snippet can invalidate NGINX configuration, causing reload failures. Until the snippet is fixed, it will prevent any new configuration updates, including updates for the other Ingress resources.
2828
- *Security implications*. Snippets give access to NGINX configuration primitives, which are not validated by NGINX Ingress Controller. For example, a snippet can configure NGINX to serve the TLS certificates and keys used for TLS termination for Ingress resources.
2929

30-
{{< note >}} If the NGINX configuration includes an invalid snippet, NGINX will continue to operate with the last valid configuration. {{< /note >}}
30+
{{< note >}} If the NGINX configuration includes an invalid snippet, NGINX will continue to operate with the last valid configuration. {{< /note >}}
3131

3232
## Using snippets
3333

@@ -68,7 +68,7 @@ spec:
6868
6969
These snippets generate the following NGINX configuration:
7070
71-
{{< note >}} The example is shortened for conciseness. {{< /note >}}
71+
{{< note >}} The example is shortened for conciseness. {{< /note >}}
7272
7373
```nginx
7474
server {

content/nic/configuration/ingress-resources/basic-configuration.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ weight: 100
44
toc: true
55
type: reference
66
product: NIC
7-
docs: DOCS-593
7+
nd-docs: DOCS-593
88
---
99

1010
This document shows a basic Ingress resource definition for F5 NGINX Ingress Controller. It load balances requests for two services as part of a single application.
@@ -93,9 +93,9 @@ NGINX Ingress Controller imposes the following restrictions on Ingress resources
9393

9494
## Advanced configuration
9595

96-
NGINX Ingress Controller generates NGINX configuration by executing a template file that contains the configuration options.
96+
NGINX Ingress Controller generates NGINX configuration by executing a template file that contains the configuration options.
9797

98-
These options are set with the Ingress resource and NGINX Ingress Controller's ConfigMap.
98+
These options are set with the Ingress resource and NGINX Ingress Controller's ConfigMap.
9999

100100
The Ingress resource only allows you to use basic NGINX features: host and path-based routing and TLS termination.
101101

content/nic/configuration/policy-resource.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -201,7 +201,7 @@ The rate limit policy will only apply to requests that contain a JWT with the sp
201201
{
202202
"user_details": {
203203
"level": "premium"
204-
},
204+
},
205205
"sub": "client1"
206206
}
207207
```

content/nic/configuration/transportserver-resource.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: TransportServer resources
33
toc: true
44
weight: 600
5-
docs: DOCS-598
5+
nd-docs: DOCS-598
66
---
77

88
This document is reference material for the TransportServer resource used by F5 NGINX Ingress Controller.

content/nic/glossary.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
description: null
3-
docs: DOCS-1446
3+
nd-docs: DOCS-1446
44
title: Glossary
55
weight: 10000
66
---

content/nic/installation/build-nginx-ingress-controller.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ toc: true
44
weight: 400
55
type: how-to
66
product: NIC
7-
docs: DOCS-1453
7+
nd-docs: DOCS-1453
88
---
99

1010
This document describes how to build an F5 NGINX Ingress Controller image from source code and upload it to a private Docker registry.

content/nic/installation/create-license-secret.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,13 @@
11
---
2-
title: Create a license Secret
2+
title: Create a license Secret
33
toc: true
44
weight: 300
55
nd-content-type: how-to
66
nd-product: NIC
7+
nd-docs: DOCS-1860
78
---
89

9-
This document explains how to create and use a license secret for F5 NGINX Ingress Controller.
10+
This document explains how to create and use a license secret for F5 NGINX Ingress Controller.
1011

1112
# Overview
1213

@@ -18,18 +19,18 @@ The JWT is required for validating your subscription and reporting telemetry dat
1819

1920
{{< note >}} Read the [subscription licenses topic]({{< ref "/solutions/about-subscription-licenses.md#for-internet-connected-environments" >}}) for a list of IPs associated with F5's licensing endpoint (`product.connect.nginx.com`). {{</ note >}}
2021

21-
## Set up your NGINX Plus license
22+
## Set up your NGINX Plus license
2223

2324
### Download the JWT
2425

2526
{{< include "/nic/installation/download-jwt.md" >}}
2627

27-
### Create the Secret
28+
### Create the Secret
2829

2930
The JWT needs to be configured before deploying NGINX Ingress Controller. The JWT will be stored in a Kubernetes Secret of type `nginx.com/license`, and can be created with the following command.
3031

3132
```shell
32-
kubectl create secret generic license-token --from-file=license.jwt=<path-to-your-jwt> --type=nginx.com/license -n <Your Namespace>
33+
kubectl create secret generic license-token --from-file=license.jwt=<path-to-your-jwt> --type=nginx.com/license -n <Your Namespace>
3334
```
3435
You can now delete the downloaded `.jwt` file.
3536

@@ -91,7 +92,7 @@ Specify the endpoint in the `usage-report-endpoint` Management ConfigMap key.
9192

9293
To configure SSL certificates or SSL trusted certificates, extra steps are necessary.
9394

94-
To use Client Auth with NGINX Instance Manager, first create a Secret of type `kubernetes.io/tls` in the same namespace as the NGINX Ingress Controller pods.
95+
To use Client Auth with NGINX Instance Manager, first create a Secret of type `kubernetes.io/tls` in the same namespace as the NGINX Ingress Controller pods.
9596

9697
```shell
9798
kubectl create secret tls ssl-certificate --cert=<path-to-your-client.pem> --key=<path-to-your-client.key> -n <Your Namespace>
@@ -112,7 +113,7 @@ Providing an optional CRL (certificate revocation list) will configure the [`ssl
112113

113114
{{%tab name="Helm"%}}
114115

115-
Specify the SSL certificate Secret name using the `controller.mgmt.sslCertificateSecretName` Helm value.
116+
Specify the SSL certificate Secret name using the `controller.mgmt.sslCertificateSecretName` Helm value.
116117

117118
Specify the SSL trusted certificate Secret name using the `controller.mgmt.sslTrustedCertificateSecretName` Helm value.
118119

content/nic/installation/ingress-nginx.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
docs: DOCS-1469
2+
nd-docs: DOCS-1469
33
doctypes:
44
- tutorial
55
tags:

content/nic/installation/installing-nic/deploy-with-nap-using-helm.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,10 @@ toc: true
44
weight: 500
55
nd-content-type: how-to
66
nd-product: NIC
7+
nd-docs: DOCS-1861
78
---
89

9-
This document describes how to build a local F5 NGINX App Protect WAF v5 Docker image with NGINX Plus Ingress
10+
This document describes how to build a local F5 NGINX App Protect WAF v5 Docker image with NGINX Plus Ingress
1011
Controller, which can be used to compile WAF policies.
1112

1213
This is accomplished with the following steps:
@@ -21,7 +22,7 @@ This is accomplished with the following steps:
2122

2223
## Prepare Secrets and credentials
2324

24-
1. Download your NGINX Ingress Controller subscription's JSON Web Token, SSL Certificate, and Private Key from MyF5.
25+
1. Download your NGINX Ingress Controller subscription's JSON Web Token, SSL Certificate, and Private Key from MyF5.
2526
You can use the same JSON Web Token, Certificate, and Key as NGINX Plus in your MyF5 portal.
2627
1. Rename the files to the following:
2728
- `nginx-repo.crt`
@@ -330,14 +331,14 @@ curl --resolve webapp.example.com:$IC_HTTP_PORT:$IC_IP "http://webapp.example.co
330331
```
331332

332333
```text
333-
<html><head><title>Request Rejected</title></head><body>The requested URL was rejected. Please consult with your
334+
<html><head><title>Request Rejected</title></head><body>The requested URL was rejected. Please consult with your
334335
administrator.<br><br>Your support ID is: 11241918873745059631<br><br>
335336
<a href='javascript:history.back();'>[Go Back]</a></body></html>
336337
```
337338

338339
This is mostly the same as the [examples/custom_resources/app-protect-waf-v5](https://github.com/nginx/kubernetes-ingress/tree/main/examples/custom-resources/app-protect-waf-v5)
339340
deployment in a single file with the policy bundle already set.
340341

341-
You now have a fully operational NGINX Ingress Controller instance with NGINX App Protect deployed in your Kubernetes environment.
342+
You now have a fully operational NGINX Ingress Controller instance with NGINX App Protect deployed in your Kubernetes environment.
342343

343344
For further details, troubleshooting, or support, refer to the [official NGINX documentation]({{< ref "/" >}}) or reach out directly to your F5/NGINX account team.

content/nic/installation/installing-nic/installation-with-manifests.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ toc: true
44
weight: 200
55
type: how-to
66
product: NIC
7-
docs: DOCS-603
7+
nd-docs: DOCS-603
88
---
99

1010
This guide explains how to use Manifests to install F5 NGINX Ingress Controller, then create both common and custom resources and set up role-based access control.

content/nic/installation/installing-nic/installation-with-operator.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ toc: true
44
weight: 300
55
type: how-to
66
product: NIC
7-
docs: DOCS-604
7+
nd-docs: DOCS-604
88
---
99

1010
This document explains how to install F5 NGINX Ingress Controller using NGINX Ingress Operator.

content/nic/installation/installing-nic/upgrade-to-v4.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ toc: true
44
weight: 400
55
type: how-to
66
product: NIC
7-
docs: DOCS-000
7+
nd-docs: DOCS-1862
88
---
99

1010
This document explains how to upgrade F5 NGINX Ingress Controller to 4.0.0.

content/nic/installation/integrations/app-protect-dos/installation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ weight: 100
44
toc: true
55
type: how-to
66
product: NIC
7-
docs: DOCS-583
7+
nd-docs: DOCS-583
88
---
99

1010
This document explains how to build an image for F5 NGINX Ingress Controller with NGINX App Protect DoS from source code.

content/nic/installation/integrations/app-protect-waf-v5/compile-waf-policies.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ weight: 300
44
toc: true
55
nd-content-type: how-to
66
nd-product: NIC
7-
nd-docs: DOCS-000
7+
nd-docs: DOCS-1863
88
---
99

1010
## Overview

content/nic/installation/integrations/app-protect-waf-v5/configuration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ weight: 200
44
toc: true
55
nd-content-type: how-to
66
nd-product: NIC
7-
nd-docs: DOCS-000
7+
nd-docs: DOCS-1866
88
---
99

1010
## Overview

content/nic/installation/integrations/app-protect-waf-v5/installation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ weight: 100
44
toc: true
55
type: how-to
66
product: NIC
7-
docs: DOCS-000
7+
nd-docs: DOCS-1865
88
---
99

1010
This document explains how to build a F5 NGINX Ingress Controller image with NGINX App Protect WAF v5 from source code.

content/nic/installation/integrations/app-protect-waf-v5/troubleshoot-app-protect-waf.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ weight: 400
44
toc: true
55
nd-content-type: how-to
66
nd-product: NIC
7-
nd-docs: DOCS-000
7+
nd-docs: DOCS-1864
88
---
99

1010
This document describes how to troubleshoot problems when using NGINX Ingress Controller and the NGINX App Protect WAF module version 5.

content/nic/installation/integrations/app-protect-waf/configuration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ weight: 200
44
toc: true
55
type: how-to
66
product: NIC
7-
docs: DOCS-578
7+
nd-docs: DOCS-578
88
---
99

1010
This document explains how to use F5 NGINX Ingress Controller to configure NGINX App Protect WAF.

content/nic/installation/integrations/app-protect-waf/installation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ weight: 100
44
toc: true
55
type: how-to
66
product: NIC
7-
docs: DOCS-579
7+
nd-docs: DOCS-579
88
---
99

1010
This document explains how to build a F5 NGINX Ingress Controller image with F5 NGINX App Protect WAF from source code.

content/nic/installation/integrations/f5-ingresslink.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
docs: DOCS-600
2+
nd-docs: DOCS-600
33
doctypes:
44
- concept
55
title: F5 BIG-IP

content/nic/installation/integrations/opentracing.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
docs: DOCS-618
2+
nd-docs: DOCS-618
33
doctypes:
44
- ''
55
title: OpenTracing (Deprecated in v5.0.0)

content/nic/installation/nic-images/get-registry-image.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ nd-product: NIC
77
nd-docs: DOCS-605
88
---
99

10-
Learn how to pull an F5 NGINX Plus Ingress Controller image from the official F5 Docker registry and upload it to your private registry.
10+
Learn how to pull an F5 NGINX Plus Ingress Controller image from the official F5 Docker registry and upload it to your private registry.
1111

1212
The F5 Registry images include versions with NGINX App Protect WAF and NGINX App Protect DoS.
1313

0 commit comments

Comments
 (0)