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

0 commit comments

Comments
 (0)