diff --git a/content/nic/configuration/access-control.md b/content/nic/configuration/access-control.md index 54fee5f91..4af2ecb27 100644 --- a/content/nic/configuration/access-control.md +++ b/content/nic/configuration/access-control.md @@ -2,7 +2,7 @@ title: Deploy a Policy for access control weight: 900 toc: true -docs: DOCS-000 +nd-docs: DOCS-1858 --- 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" >}}). diff --git a/content/nic/configuration/configuration-examples.md b/content/nic/configuration/configuration-examples.md index 0a0e6e3bb..c49c0790e 100644 --- a/content/nic/configuration/configuration-examples.md +++ b/content/nic/configuration/configuration-examples.md @@ -1,5 +1,5 @@ --- -docs: DOCS-584 +nd-docs: DOCS-584 doctypes: - '' title: Configuration examples diff --git a/content/nic/configuration/global-configuration/command-line-arguments.md b/content/nic/configuration/global-configuration/command-line-arguments.md index 79d8f3f02..e7ca266e9 100644 --- a/content/nic/configuration/global-configuration/command-line-arguments.md +++ b/content/nic/configuration/global-configuration/command-line-arguments.md @@ -1,5 +1,5 @@ --- -docs: DOCS-585 +nd-docs: DOCS-585 doctypes: - '' title: Command-line arguments diff --git a/content/nic/configuration/global-configuration/configmap-resource.md b/content/nic/configuration/global-configuration/configmap-resource.md index 662c9a4a2..499f7733a 100644 --- a/content/nic/configuration/global-configuration/configmap-resource.md +++ b/content/nic/configuration/global-configuration/configmap-resource.md @@ -184,12 +184,12 @@ For more information, view the [VirtualServer and VirtualServerRoute resources]( 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. -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`. +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`. 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). -{{< caution >}} -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`. +{{< caution >}} +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`. 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. {{< /caution >}} diff --git a/content/nic/configuration/global-configuration/custom-templates.md b/content/nic/configuration/global-configuration/custom-templates.md index 589ce5951..6bb99f87f 100644 --- a/content/nic/configuration/global-configuration/custom-templates.md +++ b/content/nic/configuration/global-configuration/custom-templates.md @@ -1,5 +1,5 @@ --- -docs: DOCS-587 +nd-docs: DOCS-587 doctypes: - '' title: Custom templates diff --git a/content/nic/configuration/global-configuration/globalconfiguration-resource.md b/content/nic/configuration/global-configuration/globalconfiguration-resource.md index 80d05bd55..16fd90edc 100644 --- a/content/nic/configuration/global-configuration/globalconfiguration-resource.md +++ b/content/nic/configuration/global-configuration/globalconfiguration-resource.md @@ -1,5 +1,5 @@ --- -docs: DOCS-588 +nd-docs: DOCS-588 doctypes: - '' title: GlobalConfiguration resource diff --git a/content/nic/configuration/global-configuration/mgmt-configmap-resource.md b/content/nic/configuration/global-configuration/mgmt-configmap-resource.md index e1d9a120c..f7eb66aea 100644 --- a/content/nic/configuration/global-configuration/mgmt-configmap-resource.md +++ b/content/nic/configuration/global-configuration/mgmt-configmap-resource.md @@ -1,5 +1,5 @@ --- -docs: DOCS-586 +nd-docs: DOCS-1859 doctypes: - '' title: Management ConfigMap resource @@ -7,7 +7,7 @@ toc: true weight: 300 --- -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=` 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. +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=` 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. --- diff --git a/content/nic/configuration/host-and-listener-collisions.md b/content/nic/configuration/host-and-listener-collisions.md index 502ef830c..3336bb21e 100644 --- a/content/nic/configuration/host-and-listener-collisions.md +++ b/content/nic/configuration/host-and-listener-collisions.md @@ -2,7 +2,7 @@ title: Host and Listener collisions toc: true weight: 800 -docs: DOCS-590 +nd-docs: DOCS-590 --- This document explains how F5 NGINX Ingress Controller handles host and listener collisions between resources. diff --git a/content/nic/configuration/ingress-resources/advanced-configuration-with-snippets.md b/content/nic/configuration/ingress-resources/advanced-configuration-with-snippets.md index 0060a7e3b..8f5c8b764 100644 --- a/content/nic/configuration/ingress-resources/advanced-configuration-with-snippets.md +++ b/content/nic/configuration/ingress-resources/advanced-configuration-with-snippets.md @@ -1,5 +1,5 @@ --- -docs: DOCS-592 +nd-docs: DOCS-592 doctypes: - '' title: Advanced configuration with Snippets @@ -7,9 +7,9 @@ toc: true weight: 400 --- -Snippets allow you to insert raw NGINX config into different contexts of the NGINX configurations that F5 NGINX Ingress Controller generates. +Snippets allow you to insert raw NGINX config into different contexts of the NGINX configurations that F5 NGINX Ingress Controller generates. -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. +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. @@ -27,7 +27,7 @@ Snippets have the following disadvantages: - *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. - *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. -{{< note >}} If the NGINX configuration includes an invalid snippet, NGINX will continue to operate with the last valid configuration. {{< /note >}} +{{< note >}} If the NGINX configuration includes an invalid snippet, NGINX will continue to operate with the last valid configuration. {{< /note >}} ## Using snippets @@ -68,7 +68,7 @@ spec: These snippets generate the following NGINX configuration: -{{< note >}} The example is shortened for conciseness. {{< /note >}} +{{< note >}} The example is shortened for conciseness. {{< /note >}} ```nginx server { diff --git a/content/nic/configuration/ingress-resources/basic-configuration.md b/content/nic/configuration/ingress-resources/basic-configuration.md index 8d1948693..00ed51ef6 100644 --- a/content/nic/configuration/ingress-resources/basic-configuration.md +++ b/content/nic/configuration/ingress-resources/basic-configuration.md @@ -4,7 +4,7 @@ weight: 100 toc: true type: reference product: NIC -docs: DOCS-593 +nd-docs: DOCS-593 --- 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 ## Advanced configuration -NGINX Ingress Controller generates NGINX configuration by executing a template file that contains the configuration options. +NGINX Ingress Controller generates NGINX configuration by executing a template file that contains the configuration options. -These options are set with the Ingress resource and NGINX Ingress Controller's ConfigMap. +These options are set with the Ingress resource and NGINX Ingress Controller's ConfigMap. The Ingress resource only allows you to use basic NGINX features: host and path-based routing and TLS termination. diff --git a/content/nic/configuration/policy-resource.md b/content/nic/configuration/policy-resource.md index a6c33e3e4..6b4fd7cde 100644 --- a/content/nic/configuration/policy-resource.md +++ b/content/nic/configuration/policy-resource.md @@ -201,7 +201,7 @@ The rate limit policy will only apply to requests that contain a JWT with the sp { "user_details": { "level": "premium" - }, + }, "sub": "client1" } ``` diff --git a/content/nic/configuration/transportserver-resource.md b/content/nic/configuration/transportserver-resource.md index b725ea2e6..ea2f3c688 100644 --- a/content/nic/configuration/transportserver-resource.md +++ b/content/nic/configuration/transportserver-resource.md @@ -2,7 +2,7 @@ title: TransportServer resources toc: true weight: 600 -docs: DOCS-598 +nd-docs: DOCS-598 --- This document is reference material for the TransportServer resource used by F5 NGINX Ingress Controller. diff --git a/content/nic/glossary.md b/content/nic/glossary.md index d76f9e3db..3985d7857 100644 --- a/content/nic/glossary.md +++ b/content/nic/glossary.md @@ -1,6 +1,6 @@ --- description: null -docs: DOCS-1446 +nd-docs: DOCS-1446 title: Glossary weight: 10000 --- diff --git a/content/nic/installation/build-nginx-ingress-controller.md b/content/nic/installation/build-nginx-ingress-controller.md index 4f37d8f25..560a46ca4 100644 --- a/content/nic/installation/build-nginx-ingress-controller.md +++ b/content/nic/installation/build-nginx-ingress-controller.md @@ -4,7 +4,7 @@ toc: true weight: 400 type: how-to product: NIC -docs: DOCS-1453 +nd-docs: DOCS-1453 --- This document describes how to build an F5 NGINX Ingress Controller image from source code and upload it to a private Docker registry. diff --git a/content/nic/installation/create-license-secret.md b/content/nic/installation/create-license-secret.md index 91be0f9f9..3b13bc543 100644 --- a/content/nic/installation/create-license-secret.md +++ b/content/nic/installation/create-license-secret.md @@ -1,12 +1,13 @@ --- -title: Create a license Secret +title: Create a license Secret toc: true weight: 300 nd-content-type: how-to nd-product: NIC +nd-docs: DOCS-1860 --- -This document explains how to create and use a license secret for F5 NGINX Ingress Controller. +This document explains how to create and use a license secret for F5 NGINX Ingress Controller. # Overview @@ -18,18 +19,18 @@ The JWT is required for validating your subscription and reporting telemetry dat {{< 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`). {{}} -## Set up your NGINX Plus license +## Set up your NGINX Plus license ### Download the JWT {{< include "/nic/installation/download-jwt.md" >}} -### Create the Secret +### Create the Secret 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. ```shell -kubectl create secret generic license-token --from-file=license.jwt= --type=nginx.com/license -n +kubectl create secret generic license-token --from-file=license.jwt= --type=nginx.com/license -n ``` You can now delete the downloaded `.jwt` file. @@ -91,7 +92,7 @@ Specify the endpoint in the `usage-report-endpoint` Management ConfigMap key. To configure SSL certificates or SSL trusted certificates, extra steps are necessary. -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. +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. ```shell kubectl create secret tls ssl-certificate --cert= --key= -n @@ -112,7 +113,7 @@ Providing an optional CRL (certificate revocation list) will configure the [`ssl {{%tab name="Helm"%}} -Specify the SSL certificate Secret name using the `controller.mgmt.sslCertificateSecretName` Helm value. +Specify the SSL certificate Secret name using the `controller.mgmt.sslCertificateSecretName` Helm value. Specify the SSL trusted certificate Secret name using the `controller.mgmt.sslTrustedCertificateSecretName` Helm value. diff --git a/content/nic/installation/ingress-nginx.md b/content/nic/installation/ingress-nginx.md index cc8fc2ebb..faa3d3b04 100644 --- a/content/nic/installation/ingress-nginx.md +++ b/content/nic/installation/ingress-nginx.md @@ -1,5 +1,5 @@ --- -docs: DOCS-1469 +nd-docs: DOCS-1469 doctypes: - tutorial tags: diff --git a/content/nic/installation/installing-nic/deploy-with-nap-using-helm.md b/content/nic/installation/installing-nic/deploy-with-nap-using-helm.md index 815ac0166..054b4e887 100644 --- a/content/nic/installation/installing-nic/deploy-with-nap-using-helm.md +++ b/content/nic/installation/installing-nic/deploy-with-nap-using-helm.md @@ -4,9 +4,10 @@ toc: true weight: 500 nd-content-type: how-to nd-product: NIC +nd-docs: DOCS-1861 --- -This document describes how to build a local F5 NGINX App Protect WAF v5 Docker image with NGINX Plus Ingress +This document describes how to build a local F5 NGINX App Protect WAF v5 Docker image with NGINX Plus Ingress Controller, which can be used to compile WAF policies. This is accomplished with the following steps: @@ -21,7 +22,7 @@ This is accomplished with the following steps: ## Prepare Secrets and credentials -1. Download your NGINX Ingress Controller subscription's JSON Web Token, SSL Certificate, and Private Key from MyF5. +1. Download your NGINX Ingress Controller subscription's JSON Web Token, SSL Certificate, and Private Key from MyF5. You can use the same JSON Web Token, Certificate, and Key as NGINX Plus in your MyF5 portal. 1. Rename the files to the following: - `nginx-repo.crt` @@ -330,7 +331,7 @@ curl --resolve webapp.example.com:$IC_HTTP_PORT:$IC_IP "http://webapp.example.co ``` ```text -Request RejectedThe requested URL was rejected. Please consult with your +Request RejectedThe requested URL was rejected. Please consult with your administrator.

Your support ID is: 11241918873745059631

[Go Back] ``` @@ -338,6 +339,6 @@ administrator.

Your support ID is: 11241918873745059631

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) deployment in a single file with the policy bundle already set. -You now have a fully operational NGINX Ingress Controller instance with NGINX App Protect deployed in your Kubernetes environment. +You now have a fully operational NGINX Ingress Controller instance with NGINX App Protect deployed in your Kubernetes environment. For further details, troubleshooting, or support, refer to the [official NGINX documentation]({{< ref "/" >}}) or reach out directly to your F5/NGINX account team. diff --git a/content/nic/installation/installing-nic/installation-with-manifests.md b/content/nic/installation/installing-nic/installation-with-manifests.md index 61f457808..2f44611f6 100644 --- a/content/nic/installation/installing-nic/installation-with-manifests.md +++ b/content/nic/installation/installing-nic/installation-with-manifests.md @@ -4,7 +4,7 @@ toc: true weight: 200 type: how-to product: NIC -docs: DOCS-603 +nd-docs: DOCS-603 --- 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. diff --git a/content/nic/installation/installing-nic/installation-with-operator.md b/content/nic/installation/installing-nic/installation-with-operator.md index 3fc35a09f..459d7cfd1 100644 --- a/content/nic/installation/installing-nic/installation-with-operator.md +++ b/content/nic/installation/installing-nic/installation-with-operator.md @@ -4,7 +4,7 @@ toc: true weight: 300 type: how-to product: NIC -docs: DOCS-604 +nd-docs: DOCS-604 --- This document explains how to install F5 NGINX Ingress Controller using NGINX Ingress Operator. diff --git a/content/nic/installation/installing-nic/upgrade-to-v4.md b/content/nic/installation/installing-nic/upgrade-to-v4.md index 23382a540..36b3e798d 100644 --- a/content/nic/installation/installing-nic/upgrade-to-v4.md +++ b/content/nic/installation/installing-nic/upgrade-to-v4.md @@ -4,7 +4,7 @@ toc: true weight: 400 type: how-to product: NIC -docs: DOCS-000 +nd-docs: DOCS-1862 --- This document explains how to upgrade F5 NGINX Ingress Controller to 4.0.0. diff --git a/content/nic/installation/integrations/app-protect-dos/installation.md b/content/nic/installation/integrations/app-protect-dos/installation.md index 9471d48c5..75a4439ae 100644 --- a/content/nic/installation/integrations/app-protect-dos/installation.md +++ b/content/nic/installation/integrations/app-protect-dos/installation.md @@ -4,7 +4,7 @@ weight: 100 toc: true type: how-to product: NIC -docs: DOCS-583 +nd-docs: DOCS-583 --- This document explains how to build an image for F5 NGINX Ingress Controller with NGINX App Protect DoS from source code. diff --git a/content/nic/installation/integrations/app-protect-waf-v5/compile-waf-policies.md b/content/nic/installation/integrations/app-protect-waf-v5/compile-waf-policies.md index c34785d49..e21c90e4e 100644 --- a/content/nic/installation/integrations/app-protect-waf-v5/compile-waf-policies.md +++ b/content/nic/installation/integrations/app-protect-waf-v5/compile-waf-policies.md @@ -4,7 +4,7 @@ weight: 300 toc: true nd-content-type: how-to nd-product: NIC -nd-docs: DOCS-000 +nd-docs: DOCS-1863 --- ## Overview diff --git a/content/nic/installation/integrations/app-protect-waf-v5/configuration.md b/content/nic/installation/integrations/app-protect-waf-v5/configuration.md index 748e56d79..d6cbc208a 100644 --- a/content/nic/installation/integrations/app-protect-waf-v5/configuration.md +++ b/content/nic/installation/integrations/app-protect-waf-v5/configuration.md @@ -4,7 +4,7 @@ weight: 200 toc: true nd-content-type: how-to nd-product: NIC -nd-docs: DOCS-000 +nd-docs: DOCS-1866 --- ## Overview diff --git a/content/nic/installation/integrations/app-protect-waf-v5/installation.md b/content/nic/installation/integrations/app-protect-waf-v5/installation.md index 40f638f1a..2cdc5964c 100644 --- a/content/nic/installation/integrations/app-protect-waf-v5/installation.md +++ b/content/nic/installation/integrations/app-protect-waf-v5/installation.md @@ -4,7 +4,7 @@ weight: 100 toc: true type: how-to product: NIC -docs: DOCS-000 +nd-docs: DOCS-1865 --- This document explains how to build a F5 NGINX Ingress Controller image with NGINX App Protect WAF v5 from source code. diff --git a/content/nic/installation/integrations/app-protect-waf-v5/troubleshoot-app-protect-waf.md b/content/nic/installation/integrations/app-protect-waf-v5/troubleshoot-app-protect-waf.md index 65594dcf6..aca3370d7 100644 --- a/content/nic/installation/integrations/app-protect-waf-v5/troubleshoot-app-protect-waf.md +++ b/content/nic/installation/integrations/app-protect-waf-v5/troubleshoot-app-protect-waf.md @@ -4,7 +4,7 @@ weight: 400 toc: true nd-content-type: how-to nd-product: NIC -nd-docs: DOCS-000 +nd-docs: DOCS-1864 --- This document describes how to troubleshoot problems when using NGINX Ingress Controller and the NGINX App Protect WAF module version 5. diff --git a/content/nic/installation/integrations/app-protect-waf/configuration.md b/content/nic/installation/integrations/app-protect-waf/configuration.md index 50d2c6352..ce77de634 100644 --- a/content/nic/installation/integrations/app-protect-waf/configuration.md +++ b/content/nic/installation/integrations/app-protect-waf/configuration.md @@ -4,7 +4,7 @@ weight: 200 toc: true type: how-to product: NIC -docs: DOCS-578 +nd-docs: DOCS-578 --- This document explains how to use F5 NGINX Ingress Controller to configure NGINX App Protect WAF. diff --git a/content/nic/installation/integrations/app-protect-waf/installation.md b/content/nic/installation/integrations/app-protect-waf/installation.md index 08e7404e9..ed7732450 100644 --- a/content/nic/installation/integrations/app-protect-waf/installation.md +++ b/content/nic/installation/integrations/app-protect-waf/installation.md @@ -4,7 +4,7 @@ weight: 100 toc: true type: how-to product: NIC -docs: DOCS-579 +nd-docs: DOCS-579 --- This document explains how to build a F5 NGINX Ingress Controller image with F5 NGINX App Protect WAF from source code. diff --git a/content/nic/installation/integrations/f5-ingresslink.md b/content/nic/installation/integrations/f5-ingresslink.md index 1e06bbab7..887138ac3 100644 --- a/content/nic/installation/integrations/f5-ingresslink.md +++ b/content/nic/installation/integrations/f5-ingresslink.md @@ -1,5 +1,5 @@ --- -docs: DOCS-600 +nd-docs: DOCS-600 doctypes: - concept title: F5 BIG-IP diff --git a/content/nic/installation/integrations/opentracing.md b/content/nic/installation/integrations/opentracing.md index 55c6efd2a..9b131dc8c 100644 --- a/content/nic/installation/integrations/opentracing.md +++ b/content/nic/installation/integrations/opentracing.md @@ -1,5 +1,5 @@ --- -docs: DOCS-618 +nd-docs: DOCS-618 doctypes: - '' title: OpenTracing (Deprecated in v5.0.0) diff --git a/content/nic/installation/nic-images/get-registry-image.md b/content/nic/installation/nic-images/get-registry-image.md index 9fadafa08..9cf8dd08a 100644 --- a/content/nic/installation/nic-images/get-registry-image.md +++ b/content/nic/installation/nic-images/get-registry-image.md @@ -7,7 +7,7 @@ nd-product: NIC nd-docs: DOCS-605 --- -Learn how to pull an F5 NGINX Plus Ingress Controller image from the official F5 Docker registry and upload it to your private registry. +Learn how to pull an F5 NGINX Plus Ingress Controller image from the official F5 Docker registry and upload it to your private registry. The F5 Registry images include versions with NGINX App Protect WAF and NGINX App Protect DoS. diff --git a/content/nic/installation/nic-images/use-aws-image.md b/content/nic/installation/nic-images/use-aws-image.md index 38178778c..4198e253c 100644 --- a/content/nic/installation/nic-images/use-aws-image.md +++ b/content/nic/installation/nic-images/use-aws-image.md @@ -1,5 +1,5 @@ --- -docs: DOCS-607 +nd-docs: DOCS-607 doctypes: - '' title: Use the AWS Marketplace NGINX Ingress Controller image @@ -107,7 +107,7 @@ Follow this guide to set up NGINX Ingress Controller using AWS Marketplace. This
- Ensure the service account name matches the one in your _values.yaml_ file for helm deployment. + Ensure the service account name matches the one in your _values.yaml_ file for helm deployment. Ensure the EKS `role-arn` matches the service account annotation in your _values.yaml_ file for helm deployment. You can use this command to retrieve the `role-arn` ``` shell aws iam list-roles | jq -r --arg role "my-cluster-sa" '.Roles[] | select(.RoleName==$role) | .Arn' diff --git a/content/nic/installation/nic-images/use-gcp-image.md b/content/nic/installation/nic-images/use-gcp-image.md index 2c38c8cff..2eb4e2f76 100644 --- a/content/nic/installation/nic-images/use-gcp-image.md +++ b/content/nic/installation/nic-images/use-gcp-image.md @@ -1,5 +1,5 @@ --- -docs: DOCS-1455 +nd-docs: DOCS-1455 doctypes: - '' title: Use the GCP Marketplace NGINX Ingress Controller image diff --git a/content/nic/installation/run-multiple-ingress-controllers.md b/content/nic/installation/run-multiple-ingress-controllers.md index 3c2bd7116..98f3417b8 100644 --- a/content/nic/installation/run-multiple-ingress-controllers.md +++ b/content/nic/installation/run-multiple-ingress-controllers.md @@ -1,5 +1,5 @@ --- -docs: DOCS-606 +nd-docs: DOCS-606 doctypes: - '' title: Run multiple NGINX Ingress Controllers diff --git a/content/nic/logging-and-monitoring/prometheus.md b/content/nic/logging-and-monitoring/prometheus.md index 3d56d486f..17f32abe5 100644 --- a/content/nic/logging-and-monitoring/prometheus.md +++ b/content/nic/logging-and-monitoring/prometheus.md @@ -1,5 +1,5 @@ --- -docs: DOCS-614 +nd-docs: DOCS-614 doctypes: - concept title: Prometheus diff --git a/content/nic/overview/about.md b/content/nic/overview/about.md index f6231c24a..ef6bdeaf6 100644 --- a/content/nic/overview/about.md +++ b/content/nic/overview/about.md @@ -8,7 +8,7 @@ nd-docs: DOCS-612 This document describes the F5 NGINX Ingress Controller, an Ingress Controller implementation for NGINX and NGINX Plus. -NGINX Ingress Controller is an [Ingress Controller]({{< ref "/nic/glossary.md#ingress-controller">}}) implementation for [NGINX](https://nginx.org) and [NGINX Plus](https://www.f5.com/products/nginx/nginx-plus) that can load balance Websocket, gRPC, TCP and UDP applications. NGINX Ingress Controller gives you a way to manage NGINX through the [Kubernetes](https://kubernetes.io/) API, and is built to handle the continuous change that happens in Kubernetes environments. +NGINX Ingress Controller is an [Ingress Controller]({{< ref "/nic/glossary.md#ingress-controller">}}) implementation for [NGINX](https://nginx.org) and [NGINX Plus](https://www.f5.com/products/nginx/nginx-plus) that can load balance Websocket, gRPC, TCP and UDP applications. NGINX Ingress Controller gives you a way to manage NGINX through the [Kubernetes](https://kubernetes.io/) API, and is built to handle the continuous change that happens in Kubernetes environments. 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. diff --git a/content/nic/overview/nginx-plus.md b/content/nic/overview/nginx-plus.md index 67adfa515..07316c039 100644 --- a/content/nic/overview/nginx-plus.md +++ b/content/nic/overview/nginx-plus.md @@ -1,5 +1,5 @@ --- -docs: DOCS-611 +nd-docs: DOCS-611 doctypes: - concept title: Extensibility with NGINX Plus diff --git a/content/nic/overview/product-telemetry.md b/content/nic/overview/product-telemetry.md index f6421b1f1..29f1ad409 100644 --- a/content/nic/overview/product-telemetry.md +++ b/content/nic/overview/product-telemetry.md @@ -2,6 +2,7 @@ title: Product telemetry toc: true weight: 500 +nd-docs: DOCS-1857 --- Learn why, what and how F5 NGINX Ingress Controller collects telemetry. diff --git a/content/nic/releases.md b/content/nic/releases.md index 4738b69be..cfed5b4ab 100644 --- a/content/nic/releases.md +++ b/content/nic/releases.md @@ -18,7 +18,7 @@ With the removal of the OpenTracing dynamic module from [NGINX Plus R34](({{< re We have extended the rate-limit Policy to allow tiered rate limit groups with JWT claims. This will also allow users to apply different rate limits to their `VirtualServer` or `VirtualServerRoutes` with the value of a JWT claim. See [here](https://github.com/nginx/kubernetes-ingress/tree/v5.0.0/examples/custom-resources/rate-limit-tiered-jwt-claim/) for a working example. -We introduced NGINX Plus Zone Sync as a managed service within NGINX Ingress Controller in this release. In previous releases, we had examples using `stream-snippets` for OIDC support, users can now enable `zone-sync` without the need for `snippets`. NGINX Plus Zone Sync is available when utilising two or more replicas, it supports OIDC & rate limiting. +We introduced NGINX Plus Zone Sync as a managed service within NGINX Ingress Controller in this release. In previous releases, we had examples using `stream-snippets` for OIDC support, users can now enable `zone-sync` without the need for `snippets`. NGINX Plus Zone Sync is available when utilising two or more replicas, it supports OIDC & rate limiting. {{< note >}} For users who have previously installed OIDC or used the `zone_sync` directive with `stream-snippets`, please see the note in the [Configmap resources]({{< ref "/nic/configuration/global-configuration/configmap-resource.md#zone-sync" >}}) topic to use the new `zone-sync` ConfigMap option. diff --git a/content/nic/technical-specifications.md b/content/nic/technical-specifications.md index ad9d5b2e4..524cbd358 100644 --- a/content/nic/technical-specifications.md +++ b/content/nic/technical-specifications.md @@ -4,7 +4,7 @@ toc: true weight: 200 doctype: reference product: NIC -docs: DOCS-617 +nd-docs: DOCS-617 --- This page describes technical specifications for F5 NGINX Ingress Controller, such as its version compatibility with Kubernetes and other NGINX software. diff --git a/content/nic/troubleshooting/troubleshoot-common.md b/content/nic/troubleshooting/troubleshoot-common.md index 23438408c..4207917a9 100644 --- a/content/nic/troubleshooting/troubleshoot-common.md +++ b/content/nic/troubleshooting/troubleshoot-common.md @@ -92,7 +92,7 @@ args: - -log-level=debug ``` -**ConfigMap settings** +**ConfigMap settings** You can configure `error-log-level` in NGINX Ingress Controller `configMap`: ```yaml diff --git a/content/nic/troubleshooting/troubleshoot-configmap-policy.md b/content/nic/troubleshooting/troubleshoot-configmap-policy.md index fa5f44059..32169d55c 100644 --- a/content/nic/troubleshooting/troubleshoot-configmap-policy.md +++ b/content/nic/troubleshooting/troubleshoot-configmap-policy.md @@ -1,5 +1,5 @@ --- -docs: DOCS-1457 +nd-docs: DOCS-1457 doctypes: - '' title: Troubleshooting Policy resources diff --git a/content/nic/troubleshooting/troubleshoot-ingress.md b/content/nic/troubleshooting/troubleshoot-ingress.md index e970b2548..3fccf4aec 100644 --- a/content/nic/troubleshooting/troubleshoot-ingress.md +++ b/content/nic/troubleshooting/troubleshoot-ingress.md @@ -1,5 +1,5 @@ --- -docs: DOCS-1458 +nd-docs: DOCS-1458 doctypes: - '' title: Troubleshooting Ingress resources diff --git a/content/nic/troubleshooting/troubleshoot-support.md b/content/nic/troubleshooting/troubleshoot-support.md index 37308268b..340796320 100644 --- a/content/nic/troubleshooting/troubleshoot-support.md +++ b/content/nic/troubleshooting/troubleshoot-support.md @@ -1,7 +1,7 @@ --- title: Commercial support weight: 100 -docs: DOCS-000 +nd-docs: DOCS-1867 --- 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). diff --git a/content/nic/troubleshooting/troubleshoot-virtualserver.md b/content/nic/troubleshooting/troubleshoot-virtualserver.md index 72af8d32c..b671aa00e 100644 --- a/content/nic/troubleshooting/troubleshoot-virtualserver.md +++ b/content/nic/troubleshooting/troubleshoot-virtualserver.md @@ -1,5 +1,5 @@ --- -docs: DOCS-1461 +nd-docs: DOCS-1461 doctypes: - '' title: Troubleshooting VirtualServer resources diff --git a/content/nic/tutorials/custom-listen-ports.md b/content/nic/tutorials/custom-listen-ports.md index a2ab3347f..5e263f288 100644 --- a/content/nic/tutorials/custom-listen-ports.md +++ b/content/nic/tutorials/custom-listen-ports.md @@ -1,5 +1,5 @@ --- -docs: DOCS-1449 +nd-docs: DOCS-1449 doctypes: - concept title: Customizing NGINX Ingress Controller Ports diff --git a/content/nic/tutorials/oidc-custom-configuration.md b/content/nic/tutorials/oidc-custom-configuration.md index 460f88070..a38143ad4 100644 --- a/content/nic/tutorials/oidc-custom-configuration.md +++ b/content/nic/tutorials/oidc-custom-configuration.md @@ -4,7 +4,7 @@ weight: 1800 toc: true type: how-to product: NIC -docs: DOCS-000 +nd-docs: DOCS-1448 --- The F5 NGINX Ingress Controller implements OpenID Connect (OIDC) using the NGINX OpenID Connect Reference implementation: [nginx-openid-connect](https://github.com/nginxinc/nginx-openid-connect). @@ -46,7 +46,6 @@ Annotations: Data ==== oidc.conf: -docs: "DOCS-1448" ---- # Advanced configuration START set $internal_error_message "NGINX / OpenID Connect login failure\n"; diff --git a/content/nic/tutorials/security-monitoring.md b/content/nic/tutorials/security-monitoring.md index d41478b06..4f2f17340 100644 --- a/content/nic/tutorials/security-monitoring.md +++ b/content/nic/tutorials/security-monitoring.md @@ -4,6 +4,7 @@ toc: true weight: 1800 nd-content-type: how-to nd-product: NIC +nd-docs: DOCS-1856 --- This document explains how to use NGINX Ingress Controller to configure NGINX Agent for sending F5 NGINX App Protect WAF metrics to NGINX Security Monitoring.