From 12f1321bbaa32b38a77fe3afe615820478d87515 Mon Sep 17 00:00:00 2001
From: nginx-aoife <50101789+nginx-aoife@users.noreply.github.com>
Date: Tue, 20 Aug 2024 09:31:41 +0100
Subject: [PATCH 1/8] Update globalconfiguration-resource.md
Fix broken link
Signed-off-by: nginx-aoife <50101789+nginx-aoife@users.noreply.github.com>
---
.../global-configuration/globalconfiguration-resource.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/docs/content/configuration/global-configuration/globalconfiguration-resource.md b/docs/content/configuration/global-configuration/globalconfiguration-resource.md
index b91c7ee1c4..130b3f577f 100644
--- a/docs/content/configuration/global-configuration/globalconfiguration-resource.md
+++ b/docs/content/configuration/global-configuration/globalconfiguration-resource.md
@@ -56,7 +56,7 @@ spec:
### Listener
-The `listeners:` key defines a listener (a combination of a protocol and a port) that NGINX will use to accept traffic for a [TransportServer](/nginx-ingress-controller/configuration/transportserver-resource) and a [VirtualServer](nginx-ingress-controller/configuration/virtualserver-and-virtualserverroute-resources):
+The `listeners:` key defines a listener (a combination of a protocol and a port) that NGINX will use to accept traffic for a [TransportServer]({{< relref "/configuration/transportserver-resource.md" >}}) and a [VirtualServer]({{< relref "/configuration/virtualserver-and-virtualserverroute-resources.md" >}}):
```yaml
- name: dns-tcp
From 5f83eb52e5a208f3def74dfe15e52debb5dc99f0 Mon Sep 17 00:00:00 2001
From: nginx-aoife <50101789+nginx-aoife@users.noreply.github.com>
Date: Tue, 20 Aug 2024 10:37:45 +0100
Subject: [PATCH 2/8] Update configmap-resource.md
Update broken link
Signed-off-by: nginx-aoife <50101789+nginx-aoife@users.noreply.github.com>
---
.../configuration/global-configuration/configmap-resource.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/docs/content/configuration/global-configuration/configmap-resource.md b/docs/content/configuration/global-configuration/configmap-resource.md
index d6fffd9d33..2faee1a82d 100644
--- a/docs/content/configuration/global-configuration/configmap-resource.md
+++ b/docs/content/configuration/global-configuration/configmap-resource.md
@@ -203,7 +203,7 @@ For more information, view the [VirtualServer and VirtualServerRoute resources](
{{<bootstrap-table "table table-striped table-bordered table-responsive">}}
|ConfigMap Key | Description | Default | Example |
| ---| ---| ---| --- |
-|*opentracing* | Enables [OpenTracing](https://opentracing.io) globally (for all Ingress, VirtualServer and VirtualServerRoute resources). Note: requires the Ingress Controller image with OpenTracing module and a tracer. See the [docs](/nginx-ingress-controller/third-party-modules/opentracing) for more information. | *False* | |
+|*opentracing* | Enables [OpenTracing](https://opentracing.io) globally (for all Ingress, VirtualServer and VirtualServerRoute resources). Note: requires the Ingress Controller image with OpenTracing module and a tracer. See the [docs]({{< relref "/installation/integrations/opentracing.md" >}}) for more information. | *False* | |
|*opentracing-tracer* | Sets the path to the vendor tracer binary plugin. | N/A | |
|*opentracing-tracer-config* | Sets the tracer configuration in JSON format. | N/A | |
|*app-protect-compressed-requests-action* | Sets the *app_protect_compressed_requests_action* [global directive](/nginx-app-protect/configuration/#global-directives). | *drop* | |
From da7cc8da86cb288c1456568ff14719bd91ad02f7 Mon Sep 17 00:00:00 2001
From: nginx-aoife <50101789+nginx-aoife@users.noreply.github.com>
Date: Tue, 20 Aug 2024 10:40:29 +0100
Subject: [PATCH 3/8] Update policy-resource.md
Update broken link
Signed-off-by: nginx-aoife <50101789+nginx-aoife@users.noreply.github.com>
---
docs/content/configuration/policy-resource.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/docs/content/configuration/policy-resource.md b/docs/content/configuration/policy-resource.md
index 3092ceb2ea..9a66d819c6 100644
--- a/docs/content/configuration/policy-resource.md
+++ b/docs/content/configuration/policy-resource.md
@@ -43,7 +43,7 @@ spec:
|``jwt`` | The JWT policy configures NGINX Plus to authenticate client requests using JSON Web Tokens. | [jwt](#jwt) | No |
|``ingressMTLS`` | The IngressMTLS policy configures client certificate verification. | [ingressMTLS](#ingressmtls) | No |
|``egressMTLS`` | The EgressMTLS policy configures upstreams authentication and certificate verification. | [egressMTLS](#egressmtls) | No |
-|``waf`` | The WAF policy configures WAF and log configuration policies for [NGINX AppProtect](/nginx-ingress-controller/app-protect/installation/) | [WAF](#waf) | No |
+|``waf`` | The WAF policy configures WAF and log configuration policies for [NGINX AppProtect]({{< relref "installation/integrations/app-protect-waf/configuration.md" >}}) | [WAF](#waf) | No |
{{% /table %}}
\* A policy must include exactly one policy.
From 1f5c6f890617c9b308f338375f3b2d0f0a8e88a5 Mon Sep 17 00:00:00 2001
From: nginx-aoife <50101789+nginx-aoife@users.noreply.github.com>
Date: Tue, 20 Aug 2024 10:43:04 +0100
Subject: [PATCH 4/8] Update prometheus.md
Update broken link
Signed-off-by: nginx-aoife <50101789+nginx-aoife@users.noreply.github.com>
---
docs/content/logging-and-monitoring/prometheus.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/docs/content/logging-and-monitoring/prometheus.md b/docs/content/logging-and-monitoring/prometheus.md
index ef512d7d98..7f8708f98d 100644
--- a/docs/content/logging-and-monitoring/prometheus.md
+++ b/docs/content/logging-and-monitoring/prometheus.md
@@ -34,7 +34,7 @@ If you're using *Kubernetes manifests* (Deployment or DaemonSet) to install the
### Using Helm
-If you're using *Helm* to install the Ingress Controller, to enable Prometheus metrics, configure the `prometheus.*` parameters of the Helm chart. See the [Installation with Helm]({{< relref "installation/installing-nic/installation-with-helm.md">}}) doc.
+If you're using *Helm* to install the Ingress Controller, to enable Prometheus metrics, configure the `prometheus.*` parameters of the Helm chart. See the [Installation with Helm]({{< relref "/installation/installing-nic/installation-with-helm.md" >}}) doc.
### Using ServiceMonitor
From 5c533240369e59c3eaa488468be5dc8596e5496e Mon Sep 17 00:00:00 2001
From: nginx-aoife <50101789+nginx-aoife@users.noreply.github.com>
Date: Tue, 20 Aug 2024 10:47:06 +0100
Subject: [PATCH 5/8] Update releases.md
Update broken link
Signed-off-by: nginx-aoife <50101789+nginx-aoife@users.noreply.github.com>
---
docs/content/releases.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/docs/content/releases.md b/docs/content/releases.md
index 4fb0500445..490818059a 100644
--- a/docs/content/releases.md
+++ b/docs/content/releases.md
@@ -1535,7 +1535,7 @@ You will find the complete changelog for release 1.11.0, including bug fixes, im
- For NGINX, use the 1.11.0 image from our DockerHub: `nginx/nginx-ingress:1.11.0`, `nginx/nginx-ingress:1.11.0-alpine` or `nginx-ingress:1.11.0-ubi`
- For NGINX Plus, please build your own image using the 1.11.0 source code.
- For Helm, use version 0.9.0 of the chart.
-- [1241](https://github.com/nginxinc/kubernetes-ingress/pull/1241) improved the Makefile. As a result, the commands for building the Ingress Controller image were changed. See the updated commands [here](https://docs.nginx.com/nginx-ingress-controller/installation/building-ingress-controller-image/#building-the-image-and-pushing-it-to-the-private-registry).
+- [1241](https://github.com/nginxinc/kubernetes-ingress/pull/1241) improved the Makefile. As a result, the commands for building the Ingress Controller image were changed. See the updated commands [here]({{< relref "/installation/build-nginx-ingress-controller.md" >}}).
- [1241](https://github.com/nginxinc/kubernetes-ingress/pull/1241) also consolidated all Dockerfiles into a single Dockerfile. If you customized any of the Dockerfiles, make sure to port the changes to the new Dockerfile.
- [1288](https://github.com/nginxinc/kubernetes-ingress/pull/1288) further improved validation of Ingress annotations. See this [document](https://docs.nginx.com/nginx-ingress-controller/configuration/ingress-resources/advanced-configuration-with-annotations/#validation) to learn more about which annotations are validated. Note that the Ingress Controller will reject resources with invalid annotations, which means clients will see `404` responses from NGINX. Before upgrading, ensure the Ingress resources don't have annotations with invalid values. Otherwise, after the upgrade, the Ingress Controller will reject such resources.
- [1457](https://github.com/nginxinc/kubernetes-ingress/pull/1457) fixed the bug when an Ingress Controller pod could become ready before it generated the configuration for all relevant resources in the cluster. The fix also requires that the Ingress Controller can successfully list the relevant resources from the Kubernetes API. For example, if the `-enable-custom-resources` cli argument is `true` (which is the default), the VirtualServer, VirtualServerRoute, TransportServer, and Policy CRDs must be created in the cluster, so that the Ingress Controller can list them. This is similar to other custom resources -- see the list [here](https://docs.nginx.com/nginx-ingress-controller/installation/installation-with-manifests/#create-custom-resources). Thus, before upgrading, make sure that the CRDs are created in the cluster. Otherwise, the Ingress Controller pods will not become ready.
From 7ff7bb24d3cba47bd905582e90c443d84b9324b1 Mon Sep 17 00:00:00 2001
From: nginx-aoife <50101789+nginx-aoife@users.noreply.github.com>
Date: Tue, 20 Aug 2024 10:51:02 +0100
Subject: [PATCH 6/8] Update installation.md
Update broken links
Signed-off-by: nginx-aoife <50101789+nginx-aoife@users.noreply.github.com>
---
.../integrations/app-protect-waf-v5/installation.md | 8 ++++----
1 file changed, 4 insertions(+), 4 deletions(-)
diff --git a/docs/content/installation/integrations/app-protect-waf-v5/installation.md b/docs/content/installation/integrations/app-protect-waf-v5/installation.md
index 71a477feb4..ea576186cb 100644
--- a/docs/content/installation/integrations/app-protect-waf-v5/installation.md
+++ b/docs/content/installation/integrations/app-protect-waf-v5/installation.md
@@ -85,10 +85,10 @@ Create Docker image for NGINX Ingress Controller (Alpine with NGINX Plus, NGINX
{{<bootstrap-table "table table-striped table-bordered">}}
| Makefile Target | Description | Compatible Systems |
|---------------------------|-------------------------------------------------------------------|---------------------|
-| **alpine-image-nap-v5-plus-fips** | Builds a Alpine-based image with NGINX Plus and the [NGINX App Protect WAF v5](/nginx-app-protect-waf-v5/) module with FIPS. | Alpine |
-| **debian-image-nap-v5-plus** | Builds a Debian-based image with NGINX Plus and the [NGINX App Protect WAF v5](/nginx-app-protect-waf-v5/) module. | Debian |
-| **ubi-image-nap-v5-plus** | Builds a UBI-based image with NGINX Plus and the [NGINX App Protect WAF v5](/nginx-app-protect-waf-v5/) module. | OpenShift |
-| **ubi-image-nap-dos-v5-plus** | Builds a UBI-based image with NGINX Plus, [NGINX App Protect WAF v5](/nginx-app-protect-waf-v5/), and [NGINX App Protect DoS](/nginx-app-protect-dos/). | OpenShift |
+| **alpine-image-nap-v5-plus-fips** | Builds a Alpine-based image with NGINX Plus and the [NGINX App Protect WAF v5](/nginx-app-protect-waf/v5/) module with FIPS. | Alpine |
+| **debian-image-nap-v5-plus** | Builds a Debian-based image with NGINX Plus and the [NGINX App Protect WAF v5](/nginx-app-protect-waf/v5/) module. | Debian |
+| **ubi-image-nap-v5-plus** | Builds a UBI-based image with NGINX Plus and the [NGINX App Protect WAF v5](/nginx-app-protect-waf/v5/) module. | OpenShift |
+| **ubi-image-nap-dos-v5-plus** | Builds a UBI-based image with NGINX Plus, [NGINX App Protect WAF v5](/nginx-app-protect-waf/v5/), and [NGINX App Protect DoS](/nginx-app-protect-dos/). | OpenShift |
{{</bootstrap-table>}}
<br>
From 92211883728f0f12cbe033532b446b5f855fea5f Mon Sep 17 00:00:00 2001
From: nginx-aoife <50101789+nginx-aoife@users.noreply.github.com>
Date: Tue, 20 Aug 2024 10:55:08 +0100
Subject: [PATCH 7/8] Update installation.md
Update broken link
Signed-off-by: nginx-aoife <50101789+nginx-aoife@users.noreply.github.com>
---
.../integrations/app-protect-waf-v5/installation.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/docs/content/installation/integrations/app-protect-waf-v5/installation.md b/docs/content/installation/integrations/app-protect-waf-v5/installation.md
index ea576186cb..5bb896d148 100644
--- a/docs/content/installation/integrations/app-protect-waf-v5/installation.md
+++ b/docs/content/installation/integrations/app-protect-waf-v5/installation.md
@@ -95,7 +95,7 @@ Create Docker image for NGINX Ingress Controller (Alpine with NGINX Plus, NGINX
{{<see-also>}} For the complete list of _Makefile_ targets and customizable variables, see the [Build NGINX Ingress Controller]({{< relref "installation/build-nginx-ingress-controller.md#makefile-details" >}}) guide. {{</see-also>}}
-If you intend to use [external references](/nginx-app-protect-waf/v5/configuration/#external-references) in NGINX App Protect WAF policies, you may want to provide a custom CA certificate to authenticate with the hosting server.
+If you intend to use [external references](/nginx-app-protect-waf/v5/configuration-guide/configuration/#external-references) in NGINX App Protect WAF policies, you may want to provide a custom CA certificate to authenticate with the hosting server.
To do so, place the `*.crt` file in the build folder and uncomment the lines following this comment:
`#Uncomment the lines below if you want to install a custom CA certificate`
From c6866fcb937a311be2cba153f51ec61f0a7e303a Mon Sep 17 00:00:00 2001
From: Aoife Cullinane <a.cullinane@f5.com>
Date: Thu, 19 Sep 2024 15:18:03 +0100
Subject: [PATCH 8/8] Update broken URLs
---
.../virtualserver-and-virtualserverroute-resources.md | 2 +-
docs/content/logging-and-monitoring/service-insight.md | 2 +-
2 files changed, 2 insertions(+), 2 deletions(-)
diff --git a/docs/content/configuration/virtualserver-and-virtualserverroute-resources.md b/docs/content/configuration/virtualserver-and-virtualserverroute-resources.md
index 1f9cc75729..bfc316385a 100644
--- a/docs/content/configuration/virtualserver-and-virtualserverroute-resources.md
+++ b/docs/content/configuration/virtualserver-and-virtualserverroute-resources.md
@@ -59,7 +59,7 @@ spec:
{{<bootstrap-table "table table-striped table-bordered table-responsive">}}
|Field | Description | Type | Required |
| ---| ---| ---| --- |
-|``host`` | The host (domain name) of the server. Must be a valid subdomain as defined in RFC 1123, such as ``my-app`` or ``hello.example.com``. When using a wildcard domain like ``*.example.com`` the domain must be contained in double quotes. The ``host`` value needs to be unique among all Ingress and VirtualServer resources. See also [Handling Host and Listener Collisions](/nginx-ingress-controller/configuration/handling-host-and-listener-collisions). | ``string`` | Yes |
+|``host`` | The host (domain name) of the server. Must be a valid subdomain as defined in RFC 1123, such as ``my-app`` or ``hello.example.com``. When using a wildcard domain like ``*.example.com`` the domain must be contained in double quotes. The ``host`` value needs to be unique among all Ingress and VirtualServer resources. See also [Handling Host and Listener Collisions](/nginx-ingress-controller/configuration/host-and-listener-collisions). | ``string`` | Yes |
|``listener`` | Sets a custom HTTP and/or HTTPS listener. Valid fields are `listener.http` and `listener.https`. Each field must reference the name of a valid listener defined in a GlobalConfiguration resource | [listener](#virtualserverlistener) | No |
|``tls`` | The TLS termination configuration. | [tls](#virtualservertls) | No |
|``gunzip`` | Enables or disables [decompression](https://docs.nginx.com/nginx/admin-guide/web-server/compression/) of gzipped responses for clients. Allowed values “on”/“off”, “true”/“false” or “yes”/“no”. If the ``gunzip`` value is not set, it defaults to ``off``. | ``boolean`` | No |
diff --git a/docs/content/logging-and-monitoring/service-insight.md b/docs/content/logging-and-monitoring/service-insight.md
index 9851bc9b4c..aefeb4d983 100644
--- a/docs/content/logging-and-monitoring/service-insight.md
+++ b/docs/content/logging-and-monitoring/service-insight.md
@@ -31,7 +31,7 @@ If you're using *Kubernetes manifests* (Deployment or DaemonSet) to install the
containerPort: 9114
```
-If you're using *Helm* to install the Ingress Controller, to enable Service Insight endpoint, configure the `serviceInsight.*` parameters of the Helm chart. See the [Installation with Helm](/nginx-ingress-controller/installation/installation-with-helm) doc.
+If you're using *Helm* to install the Ingress Controller, to enable Service Insight endpoint, configure the `serviceInsight.*` parameters of the Helm chart. See the [Installation with Helm](/nginx-ingress-controller/installation/installing-nic/installation-with-helm) doc.
## Available Statistics and HTTP Response Codes