diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 88e2f3baa7..77e72d63ed 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -456,7 +456,7 @@ jobs: # This is the official implementation of NGINX Ingress Controller (based on NGINX Plus) from NGINX. # usage-instructions: | # This container requires Kubernetes and can be deployed to EKS. - # Review the installation instructions https://docs.nginx.com/nginx-ingress-controller/installation/ and utilize the deployment resources available https://github.com/nginx/kubernetes-ingress/tree/v${{ inputs.nic_version }}/deployments + # Review the installation instructions https://docs.nginx.com/nginx-ingress-controller/install and utilize the deployment resources available https://github.com/nginx/kubernetes-ingress/tree/v${{ inputs.nic_version }}/deployments # Use this image instead of building your own. binaries: diff --git a/CHANGELOG.md b/CHANGELOG.md index 4465490b73..8265a81720 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -122,8 +122,8 @@ UPGRADE: ``` As part of the upgrade, make sure to create the `v1` policies CRD. See the corresponding instructions for the - [manifests](https://docs.nginx.com/nginx-ingress-controller/installation/installation-with-manifests/#create-custom-resources) - and [Helm](https://docs.nginx.com/nginx-ingress-controller/installation/installation-with-helm/#upgrading-the-crds) + [manifests](https://docs.nginx.com/nginx-ingress-controller/install/manifests#create-custom-resources) + and [Helm](https://docs.nginx.com/nginx-ingress-controller/install/helm#upgrading-the-crds) installations. Also note that all policies except for `accessControl` are still in preview. To enable them, run the Ingress @@ -285,7 +285,7 @@ UPGRADE: - For Helm, use version 0.7.0 of the chart. For Kubernetes >= 1.18, when upgrading using the -[manifests](https://docs.nginx.com/nginx-ingress-controller/installation/installation-with-manifests/), make sure to +[manifests](https://docs.nginx.com/nginx-ingress-controller/install/manifests), make sure to update the [ClusterRole](deployments/rbac/rbac.yaml) and create the [IngressClass resource](deployments/common/ingress-class.yaml), which is required for Kubernetes >= 1.18. Otherwise, the Ingress Controller will fail to start. If you run multiple NGINX Ingress Controllers in the cluster, each Ingress Controller has @@ -308,7 +308,7 @@ NOTES: - When using Kubernetes >= 1.18 the Ingress Controller will only process resources that belong to its class. See [IngressClass - doc](https://docs.nginx.com/nginx-ingress-controller/installation/running-multiple-ingress-controllers/#ingress-class) + doc](https://docs.nginx.com/nginx-ingress-controller/install/multiple-controllers#ingress-class) to learn more. - For Kubernetes >= 1.18, a dedicated IngressClass resource, which is configured by `controller.ingressClass`, is required per helm release. When upgrading or installing releases, ensure `controller.ingressClass` is not set to the @@ -416,7 +416,7 @@ the cluster. Before upgrading, make sure to back up the custom resources. After NOTES: - As part of installing a release, Helm will install the CRDs unless that step is disabled (see the [corresponding - doc](https://docs.nginx.com/nginx-ingress-controller/installation/installation-with-helm/)). The installed CRDs + doc](https://docs.nginx.com/nginx-ingress-controller/install/helm/). The installed CRDs include the CRDs for all Ingress Controller features, including the ones disabled by default (like App Protect with `aplogconfs.appprotect.f5.com` and `appolicies.appprotect.f5.com` CRDs). @@ -536,7 +536,7 @@ UPGRADE: - For Helm, use version 0.5.0 of the chart. When upgrading using the -[manifests](https://docs.nginx.com/nginx-ingress-controller/installation/installation-with-manifests/), make sure to +[manifests](https://docs.nginx.com/nginx-ingress-controller/install/manifests), make sure to deploy the new TransportServer CRD (`common/ts-definition.yaml`), as it is required by the Ingress Controller. Otherwise, you will get error messages in the Ingress Controller logs. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f35b4a6a2b..18d727cbb5 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -28,7 +28,7 @@ Please reserve GitHub issues for feature requests and bugs rather than general q ## Getting Started -Follow our [Installation Guide](https://docs.nginx.com/nginx-ingress-controller/installation/) to +Follow our [Installation Guide](https://docs.nginx.com/nginx-ingress-controller/install/) to get NGINX Ingress Controller up and running. Read the [documentation](https://docs.nginx.com/nginx-ingress-controller) and diff --git a/README.md b/README.md index 5e32f7a096..ff2cea8370 100644 --- a/README.md +++ b/README.md @@ -106,8 +106,8 @@ In the case of NGINX, the Ingress Controller is deployed in a pod along with the > page](https://github.com/nginx/kubernetes-ingress/releases) of the GitHub repository. 1. Install NGINX Ingress Controller using the [Helm - chart](https://docs.nginx.com/nginx-ingress-controller/installation/installing-nic/installation-with-helm/) or the Kubernetes - [manifests](https://docs.nginx.com/nginx-ingress-controller/installation/installing-nic/installation-with-manifests/). + chart](https://docs.nginx.com/nginx-ingress-controller/install/helm/) or the Kubernetes + [manifests](https://docs.nginx.com/nginx-ingress-controller/install/manifests/). 1. Configure load balancing for a simple web application: - Use the Ingress resource. See the [Cafe example](https://github.com/nginx/kubernetes-ingress/tree/main/examples/ingress-resources/complete-example). @@ -143,8 +143,8 @@ your links to the correct versions: | Version | Description | Image for NGINX | Image for NGINX Plus | Installation Manifests and Helm Chart | Documentation and Examples | | ------- | ----------- | --------------- | -------------------- | ---------------------------------------| -------------------------- | -| Latest stable release | For production use | Use the 5.2.1 images from [DockerHub](https://hub.docker.com/r/nginx/nginx-ingress/), [GitHub Container](https://github.com/nginx/kubernetes-ingress/pkgs/container/kubernetes-ingress), [Amazon ECR Public Gallery](https://gallery.ecr.aws/nginx/nginx-ingress) or [Quay.io](https://quay.io/repository/nginx/nginx-ingress) or [build your own image](https://docs.nginx.com/nginx-ingress-controller/installation/build-nginx-ingress-controller/). | Use the 5.2.1 images from the [F5 Container Registry](https://docs.nginx.com/nginx-ingress-controller/installation/nic-images/registry-download/) or [Build your own image](https://docs.nginx.com/nginx-ingress-controller/installation/build-nginx-ingress-controller/). | [Manifests](https://github.com/nginx/kubernetes-ingress/tree/v5.2.1/deployments). [Helm chart](https://github.com/nginx/kubernetes-ingress/tree/v5.2.1/charts/nginx-ingress). | [Documentation](https://docs.nginx.com/nginx-ingress-controller/). [Examples](https://docs.nginx.com/nginx-ingress-controller/configuration/configuration-examples/). | -| Edge/Nightly | For testing and experimenting | Use the edge or nightly images from [DockerHub](https://hub.docker.com/r/nginx/nginx-ingress/), [GitHub Container](https://github.com/nginx/kubernetes-ingress/pkgs/container/kubernetes-ingress), [Amazon ECR Public Gallery](https://gallery.ecr.aws/nginx/nginx-ingress) or [Quay.io](https://quay.io/repository/nginx/nginx-ingress) or [build your own image](https://docs.nginx.com/nginx-ingress-controller/installation/build-nginx-ingress-controller/). | [Build your own image](https://docs.nginx.com/nginx-ingress-controller/installation/build-nginx-ingress-controller/). | [Manifests](https://github.com/nginx/kubernetes-ingress/tree/main/deployments). [Helm chart](https://github.com/nginx/kubernetes-ingress/tree/main/charts/nginx-ingress). | [Documentation](https://docs.nginx.com/nginx-ingress-controller). [Examples](https://github.com/nginx/kubernetes-ingress/tree/main/examples). | +| Latest stable release | For production use | Use the 5.2.1 images from [DockerHub](https://hub.docker.com/r/nginx/nginx-ingress/), [GitHub Container](https://github.com/nginx/kubernetes-ingress/pkgs/container/kubernetes-ingress), [Amazon ECR Public Gallery](https://gallery.ecr.aws/nginx/nginx-ingress) or [Quay.io](https://quay.io/repository/nginx/nginx-ingress) or [build your own image](https://docs.nginx.com/nginx-ingress-controller/install/build/). | Use the 5.2.1 images from the [F5 Container Registry](https://docs.nginx.com/nginx-ingress-controller/install/images/registry-download/) or [Build your own image](https://docs.nginx.com/nginx-ingress-controller/install/build). | [Manifests](https://github.com/nginx/kubernetes-ingress/tree/v5.2.1/deployments). [Helm chart](https://github.com/nginx/kubernetes-ingress/tree/v5.2.1/charts/nginx-ingress). | [Documentation](https://docs.nginx.com/nginx-ingress-controller/). [Examples](https://docs.nginx.com/nginx-ingress-controller/configuration/configuration-examples/). | +| Edge/Nightly | For testing and experimenting | Use the edge or nightly images from [DockerHub](https://hub.docker.com/r/nginx/nginx-ingress/), [GitHub Container](https://github.com/nginx/kubernetes-ingress/pkgs/container/kubernetes-ingress), [Amazon ECR Public Gallery](https://gallery.ecr.aws/nginx/nginx-ingress) or [Quay.io](https://quay.io/repository/nginx/nginx-ingress) or [build your own image](https://docs.nginx.com/nginx-ingress-controller/install/build/). | [Build your own image](https://docs.nginx.com/nginx-ingress-controller/install/build/). | [Manifests](https://github.com/nginx/kubernetes-ingress/tree/main/deployments). [Helm chart](https://github.com/nginx/kubernetes-ingress/tree/main/charts/nginx-ingress). | [Documentation](https://docs.nginx.com/nginx-ingress-controller). [Examples](https://github.com/nginx/kubernetes-ingress/tree/main/examples). | ## SBOM (Software Bill of Materials) diff --git a/build/README.md b/build/README.md index 1ba987e90e..94c6a65d38 100644 --- a/build/README.md +++ b/build/README.md @@ -1,3 +1,3 @@ # NGINX Ingress Controller -For instructions, read the [Build NGINX Ingress Controller](https://docs.nginx.com/nginx-ingress-controller/installation/build-nginx-ingress-controller/) documentation. +For instructions, read the [Build NGINX Ingress Controller](https://docs.nginx.com/nginx-ingress-controller/install/build) documentation. diff --git a/charts/nginx-ingress/README.md b/charts/nginx-ingress/README.md index ff68d539d2..bf0f7277ca 100644 --- a/charts/nginx-ingress/README.md +++ b/charts/nginx-ingress/README.md @@ -1,3 +1,3 @@ # Helm Documentation -Please refer to the [Installation with Helm](https://docs.nginx.com/nginx-ingress-controller/installation/installing-nic/installation-with-helm/) guide in the NGINX Ingress Controller documentation site. +Please refer to the [Installation with Helm](https://docs.nginx.com/nginx-ingress-controller/install/helm/) guide in the NGINX Ingress Controller documentation site. diff --git a/charts/nginx-ingress/templates/NOTES.txt b/charts/nginx-ingress/templates/NOTES.txt index 1fcca30c24..881999295b 100644 --- a/charts/nginx-ingress/templates/NOTES.txt +++ b/charts/nginx-ingress/templates/NOTES.txt @@ -2,12 +2,12 @@ NGINX Ingress Controller {{ .Chart.AppVersion }} has been installed. For release notes for this version please see: https://docs.nginx.com/nginx-ingress-controller/releases/ -Installation and upgrade instructions: https://docs.nginx.com/nginx-ingress-controller/installation/installing-nic/installation-with-helm/ +Installation and upgrade instructions: https://docs.nginx.com/nginx-ingress-controller/install/helm/ {{ if .Release.IsUpgrade -}} If you are upgrading from a version of the chart that uses older Custom Resource Definitions (CRD) it is necessary to manually upgrade the CRDs as this is not managed by Helm. To update to the latest version of the CRDs: $ kubectl apply -f https://raw.githubusercontent.com/nginx/kubernetes-ingress/v{{ .Chart.AppVersion }}/deploy/crds.yaml -More details on upgrading the CRDs: https://docs.nginx.com/nginx-ingress-controller/installation/installing-nic/installation-with-helm/#upgrading-the-crds +More details on upgrading the CRDs: https://docs.nginx.com/nginx-ingress-controller/install/helm#upgrading-the-crds {{- end -}} diff --git a/deployments/README.md b/deployments/README.md index 91049d68b7..a24a4eafef 100644 --- a/deployments/README.md +++ b/deployments/README.md @@ -1,4 +1,4 @@ # Installation This folder includes Kubernetes manifests for installing NGINX or NGINX Plus Ingress Controller. Read [the installation -instructions](https://docs.nginx.com/nginx-ingress-controller/installation/). +instructions](https://docs.nginx.com/nginx-ingress-controller/install/). diff --git a/examples/custom-resources/advanced-routing/README.md b/examples/custom-resources/advanced-routing/README.md index 021b77d93c..9abd4e9815 100644 --- a/examples/custom-resources/advanced-routing/README.md +++ b/examples/custom-resources/advanced-routing/README.md @@ -13,7 +13,7 @@ example, for which we have introduced the following changes: ## Prerequisites -1. Follow the [installation](https://docs.nginx.com/nginx-ingress-controller/installation/installation-with-manifests/) +1. Follow the [installation](https://docs.nginx.com/nginx-ingress-controller/install/manifests) instructions to deploy the Ingress Controller with custom resources enabled. 1. Save the public IP address of the Ingress Controller into a shell variable: diff --git a/examples/custom-resources/api-key/README.md b/examples/custom-resources/api-key/README.md index aeb800e4a5..3b41803338 100644 --- a/examples/custom-resources/api-key/README.md +++ b/examples/custom-resources/api-key/README.md @@ -6,7 +6,7 @@ a web application, configure load balancing for it via a VirtualServer, and appl ## Prerequisites -1. Follow the [installation](https://docs.nginx.com/nginx-ingress-controller/installation/installation-with-manifests/) instructions to deploy the Ingress Controller. +1. Follow the [installation](https://docs.nginx.com/nginx-ingress-controller/install/manifests) instructions to deploy the Ingress Controller. 1. Save the public IP address of the Ingress Controller into a shell variable: ```console diff --git a/examples/custom-resources/backup-directive/transport-server/README.md b/examples/custom-resources/backup-directive/transport-server/README.md index d16c6d68a5..d7abeea5a8 100644 --- a/examples/custom-resources/backup-directive/transport-server/README.md +++ b/examples/custom-resources/backup-directive/transport-server/README.md @@ -26,7 +26,7 @@ The application in the `external-ns` namespace will respond to our requests when This ensures that NGINX Ingress Controller will treat our service in the `external-ns` namespace as an external service. -2. Follow the [installation](https://docs.nginx.com/nginx-ingress-controller/installation/installation-with-manifests/) +2. Follow the [installation](https://docs.nginx.com/nginx-ingress-controller/install/manifests) instructions to deploy NGINX Ingress Controller. 3. Save the public IP address of the F5 NGINX Ingress Controller into a shell variable: diff --git a/examples/custom-resources/backup-directive/virtual-server/README.md b/examples/custom-resources/backup-directive/virtual-server/README.md index e1e812972d..6e39344343 100644 --- a/examples/custom-resources/backup-directive/virtual-server/README.md +++ b/examples/custom-resources/backup-directive/virtual-server/README.md @@ -30,7 +30,7 @@ When this happens, you should get a response from the `external-cafe` instead. This ensures that NGINX Ingress Controller will treat our service in the `external-ns` namespace as an external service. -2. Follow the [installation](https://docs.nginx.com/nginx-ingress-controller/installation/installation-with-manifests/) +2. Follow the [installation](https://docs.nginx.com/nginx-ingress-controller/install/manifests) instructions to deploy NGINX Ingress Controller. 3. Save the public IP address of the Ingress Controller into a shell variable: diff --git a/examples/custom-resources/basic-auth/README.md b/examples/custom-resources/basic-auth/README.md index 10e46af4d0..42680d32bf 100644 --- a/examples/custom-resources/basic-auth/README.md +++ b/examples/custom-resources/basic-auth/README.md @@ -6,7 +6,7 @@ a web application, configure load balancing for it via a VirtualServer, and appl ## Prerequisites -1. Follow the [installation](https://docs.nginx.com/nginx-ingress-controller/installation/installation-with-manifests/) +1. Follow the [installation](https://docs.nginx.com/nginx-ingress-controller/install/manifests) instructions to deploy the Ingress Controller. 1. Save the public IP address of the Ingress Controller into a shell variable: diff --git a/examples/custom-resources/basic-configuration/README.md b/examples/custom-resources/basic-configuration/README.md index 19311afd44..534cfe9ec3 100644 --- a/examples/custom-resources/basic-configuration/README.md +++ b/examples/custom-resources/basic-configuration/README.md @@ -11,7 +11,7 @@ However, instead of the Ingress resource, we use the VirtualServer. ## Prerequisites -1. Follow the [installation](https://docs.nginx.com/nginx-ingress-controller/installation/installation-with-manifests/) +1. Follow the [installation](https://docs.nginx.com/nginx-ingress-controller/install/manifests) instructions to deploy the Ingress Controller with custom resources enabled. 1. Save the public IP address of the Ingress Controller into a shell variable: diff --git a/examples/custom-resources/basic-tcp-udp/README.md b/examples/custom-resources/basic-tcp-udp/README.md index ce0c48f3c0..09847c9074 100644 --- a/examples/custom-resources/basic-tcp-udp/README.md +++ b/examples/custom-resources/basic-tcp-udp/README.md @@ -6,13 +6,13 @@ server pods. ## Prerequisites -1. Follow the [installation](https://docs.nginx.com/nginx-ingress-controller/installation/installation-with-manifests/) +1. Follow the [installation](https://docs.nginx.com/nginx-ingress-controller/install/manifests) instructions to deploy the Ingress Controller: - As part of Step 2 of those instructions, make sure to deploy the GlobalConfiguration resource and configure the Ingress Controller to use it. - Expose port 5353 of the Ingress Controller both for TCP and UDP traffic. - (Make use of [controller.customPorts](https://docs.nginx.com/nginx-ingress-controller/installation/installing-nic/installation-with-helm/#configuration) - and [controller.service.customPorts](https://docs.nginx.com/nginx-ingress-controller/installation/installing-nic/installation-with-helm/#configuration) + (Make use of [controller.customPorts](https://docs.nginx.com/nginx-ingress-controller/install/helm#configuration) + and [controller.service.customPorts](https://docs.nginx.com/nginx-ingress-controller/install/helm#configuration) for exposing Pod and LoadBalancer Port(s) respectively) 1. Save the public IP address of the Ingress Controller into a shell variable: diff --git a/examples/custom-resources/cache-policy/README.md b/examples/custom-resources/cache-policy/README.md index d3082699a5..a30fbb702c 100644 --- a/examples/custom-resources/cache-policy/README.md +++ b/examples/custom-resources/cache-policy/README.md @@ -5,7 +5,7 @@ policy to improve performance by caching responses. ## Prerequisites -1. Follow the [installation](https://docs.nginx.com/nginx-ingress-controller/installation/) instructions to deploy the Ingress Controller. +1. Follow the [installation](https://docs.nginx.com/nginx-ingress-controller/install/) instructions to deploy the Ingress Controller. 1. Make sure the snippets are enabled (this is only required for this example as we can see the `X-Cache-Status` header in the response, not required for functionality). 1. Save the public IP address of the Ingress Controller into a shell variable: diff --git a/examples/custom-resources/certmanager/README.md b/examples/custom-resources/certmanager/README.md index 65bedbfe83..26ffad6d31 100644 --- a/examples/custom-resources/certmanager/README.md +++ b/examples/custom-resources/certmanager/README.md @@ -23,7 +23,7 @@ that application using the VirtualServer resource. ## 1. Deploy the Ingress Controller -1. Follow the [installation](https://docs.nginx.com/nginx-ingress-controller/installation/installation-with-manifests/) +1. Follow the [installation](https://docs.nginx.com/nginx-ingress-controller/install/manifests) instructions to deploy the Ingress Controller. - Set the [`-enable-custom-resources`](https://docs.nginx.com/nginx-ingress-controller/configuration/global-configuration/command-line-arguments/#cmdoption-enable-custom-resources) diff --git a/examples/custom-resources/cross-namespace-configuration/README.md b/examples/custom-resources/cross-namespace-configuration/README.md index 6e415205fc..58eaca6cfa 100644 --- a/examples/custom-resources/cross-namespace-configuration/README.md +++ b/examples/custom-resources/cross-namespace-configuration/README.md @@ -13,7 +13,7 @@ and services into multiple namespaces. Instead of one namespace, we now use thre ## Prerequisites -1. Follow the [installation](https://docs.nginx.com/nginx-ingress-controller/installation/installation-with-manifests/) +1. Follow the [installation](https://docs.nginx.com/nginx-ingress-controller/install/manifests) instructions to deploy the Ingress Controller with custom resources enabled. 1. Save the public IP address of the Ingress Controller into a shell variable: diff --git a/examples/custom-resources/custom-ip-listeners/transportserver/README.md b/examples/custom-resources/custom-ip-listeners/transportserver/README.md index 83268398cc..f392bad326 100644 --- a/examples/custom-resources/custom-ip-listeners/transportserver/README.md +++ b/examples/custom-resources/custom-ip-listeners/transportserver/README.md @@ -4,7 +4,7 @@ In this example, we will configure a TransportServer resource with custom IPv4 a ## Prerequisites -1. Follow the [installation](https://docs.nginx.com/nginx-ingress-controller/installation/installation-with-manifests/) +1. Follow the [installation](https://docs.nginx.com/nginx-ingress-controller/install/manifests) instructions to deploy the Ingress Controller with custom resources enabled. 2. Ensure the Ingress Controller is configured with the `-global-configuration` argument: diff --git a/examples/custom-resources/custom-ip-listeners/virtualserver/README.md b/examples/custom-resources/custom-ip-listeners/virtualserver/README.md index 07e0c8d1e8..b8e6e2f47e 100644 --- a/examples/custom-resources/custom-ip-listeners/virtualserver/README.md +++ b/examples/custom-resources/custom-ip-listeners/virtualserver/README.md @@ -5,7 +5,7 @@ This will allow IPv4 and/or IPv6 address using HTTP and/or HTTPS based requests ## Prerequisites -1. Follow the [installation](https://docs.nginx.com/nginx-ingress-controller/installation/installation-with-manifests/) +1. Follow the [installation](https://docs.nginx.com/nginx-ingress-controller/install/manifests) instructions to deploy the Ingress Controller with custom resources enabled. 2. Ensure the Ingress Controller is configured with the `-global-configuration` argument: diff --git a/examples/custom-resources/custom-listeners/README.md b/examples/custom-resources/custom-listeners/README.md index d55935906f..85c444a3c9 100644 --- a/examples/custom-resources/custom-listeners/README.md +++ b/examples/custom-resources/custom-listeners/README.md @@ -5,7 +5,7 @@ This will allow HTTP and/or HTTPs based requests to be made on non-default ports ## Prerequisites -1. Follow the [installation](https://docs.nginx.com/nginx-ingress-controller/installation/installation-with-manifests/) +1. Follow the [installation](https://docs.nginx.com/nginx-ingress-controller/install/manifests) instructions to deploy the Ingress Controller with custom resources enabled. 2. Ensure the Ingress Controller is configured with the `-global-configuration` argument: diff --git a/examples/custom-resources/egress-mtls/README.md b/examples/custom-resources/egress-mtls/README.md index 46299943fe..bf0411ef96 100644 --- a/examples/custom-resources/egress-mtls/README.md +++ b/examples/custom-resources/egress-mtls/README.md @@ -5,7 +5,7 @@ Egress MTLS policy. ## Prerequisites -1. Follow the [installation](https://docs.nginx.com/nginx-ingress-controller/installation/installation-with-manifests/) +1. Follow the [installation](https://docs.nginx.com/nginx-ingress-controller/install/manifests) instructions to deploy the Ingress Controller. 1. Save the public IP address of the Ingress Controller into a shell variable: diff --git a/examples/custom-resources/external-dns/README.md b/examples/custom-resources/external-dns/README.md index 3a1cc4845a..aeb80935c8 100644 --- a/examples/custom-resources/external-dns/README.md +++ b/examples/custom-resources/external-dns/README.md @@ -6,7 +6,7 @@ server. In this example, we deploy an ExternalDNS deployment with the AWS provid ## Prerequisites -1. Follow the [installation](https://docs.nginx.com/nginx-ingress-controller/installation/installation-with-manifests/) +1. Follow the [installation](https://docs.nginx.com/nginx-ingress-controller/install/manifests) instructions to deploy the Ingress Controller with custom resources enabled. Additionally, the Ingress Controller must be configured to report the VirtualServer status by setting either the `external-service` command line argument, or setting the `external-status-address` key in the ConfigMap resource (see the [Reporting Resources Status diff --git a/examples/custom-resources/foreign-namespace-upstreams/README.md b/examples/custom-resources/foreign-namespace-upstreams/README.md index d46b59e2bd..ab18c8c2e8 100644 --- a/examples/custom-resources/foreign-namespace-upstreams/README.md +++ b/examples/custom-resources/foreign-namespace-upstreams/README.md @@ -15,7 +15,7 @@ and services into multiple namespaces. Instead of one namespace, we now use thre ## Prerequisites -1. Follow the [installation](https://docs.nginx.com/nginx-ingress-controller/installation/installation-with-manifests/) +1. Follow the [installation](https://docs.nginx.com/nginx-ingress-controller/install/manifests) instructions to deploy the Ingress Controller with custom resources enabled. 1. Save the public IP address of the Ingress Controller into a shell variable: diff --git a/examples/custom-resources/grpc-upstreams/README.md b/examples/custom-resources/grpc-upstreams/README.md index a3ca202fc4..db5f2b10e6 100644 --- a/examples/custom-resources/grpc-upstreams/README.md +++ b/examples/custom-resources/grpc-upstreams/README.md @@ -11,7 +11,7 @@ grpc** field to an upstream. The protocol defaults to http if left unset. 3. A working [`grpcurl`](https://github.com/fullstorydev/grpcurl) installation. -4. [Install NGINX Ingress Controller using Manifests](https://docs.nginx.com/nginx-ingress-controller/installation/installation-with-manifests/) +4. [Install NGINX Ingress Controller using Manifests](https://docs.nginx.com/nginx-ingress-controller/install/manifests) 5. Save the public IP address of NGINX Ingress Controller into a shell variable: diff --git a/examples/custom-resources/ingress-mtls/README.md b/examples/custom-resources/ingress-mtls/README.md index 487a5241e2..e01451f32a 100644 --- a/examples/custom-resources/ingress-mtls/README.md +++ b/examples/custom-resources/ingress-mtls/README.md @@ -10,7 +10,7 @@ MTLS policy. ## Prerequisites -1. Follow the [installation](https://docs.nginx.com/nginx-ingress-controller/installation/installation-with-manifests/) +1. Follow the [installation](https://docs.nginx.com/nginx-ingress-controller/install/manifests) instructions to deploy the Ingress Controller. 1. Save the public IP address of the Ingress Controller into a shell variable: diff --git a/examples/custom-resources/jwks/README.md b/examples/custom-resources/jwks/README.md index a84b29ad5f..97b27355de 100644 --- a/examples/custom-resources/jwks/README.md +++ b/examples/custom-resources/jwks/README.md @@ -10,7 +10,7 @@ example, KeyCloak is deployed as a single container for the purpose of exposing ## Prerequisites -1. Follow the [installation](https://docs.nginx.com/nginx-ingress-controller/installation/installation-with-manifests/) +1. Follow the [installation](https://docs.nginx.com/nginx-ingress-controller/install/manifests) instructions to deploy the Ingress Controller. 2. Save the public IP address of the Ingress Controller into `/etc/hosts` of your machine: diff --git a/examples/custom-resources/jwt/README.md b/examples/custom-resources/jwt/README.md index 174b49500d..23f9266481 100644 --- a/examples/custom-resources/jwt/README.md +++ b/examples/custom-resources/jwt/README.md @@ -5,7 +5,7 @@ policy. ## Prerequisites -1. Follow the [installation](https://docs.nginx.com/nginx-ingress-controller/installation/installation-with-manifests/) +1. Follow the [installation](https://docs.nginx.com/nginx-ingress-controller/install/manifests) instructions to deploy the Ingress Controller. 1. Save the public IP address of the Ingress Controller into a shell variable: diff --git a/examples/custom-resources/oidc-fclo/README.md b/examples/custom-resources/oidc-fclo/README.md index 8d674dd1f2..b35c6e2ab9 100644 --- a/examples/custom-resources/oidc-fclo/README.md +++ b/examples/custom-resources/oidc-fclo/README.md @@ -19,7 +19,7 @@ kubectl config set-context --namespace default --current ## Prerequisites -1. Follow the [installation](https://docs.nginx.com/nginx-ingress-controller/installation/installation-with-manifests/) +1. Follow the [installation](https://docs.nginx.com/nginx-ingress-controller/install/manifests) instructions to deploy NGINX Ingress Controller. This example requires that the HTTPS port of the Ingress Controller is `443`. 2. Save the public IP address of the Ingress Controller into `/etc/hosts` of your machine: diff --git a/examples/custom-resources/oidc/README.md b/examples/custom-resources/oidc/README.md index 3a500ed13c..817b7c5c32 100644 --- a/examples/custom-resources/oidc/README.md +++ b/examples/custom-resources/oidc/README.md @@ -19,7 +19,7 @@ kubectl config set-context --namespace default --current ## Prerequisites -1. Follow the [installation](https://docs.nginx.com/nginx-ingress-controller/installation/installation-with-manifests/) +1. Follow the [installation](https://docs.nginx.com/nginx-ingress-controller/install/manifests) instructions to deploy NGINX Ingress Controller. This example requires that the HTTPS port of the Ingress Controller is `443`. 2. Save the public IP address of the Ingress Controller into `/etc/hosts` of your machine: diff --git a/examples/custom-resources/rate-limit-jwt-claim/README.md b/examples/custom-resources/rate-limit-jwt-claim/README.md index f2b1f430da..677017b764 100644 --- a/examples/custom-resources/rate-limit-jwt-claim/README.md +++ b/examples/custom-resources/rate-limit-jwt-claim/README.md @@ -5,7 +5,7 @@ limit policy using a JWT claim as the key to the rate limit. ## Prerequisites -1. Follow the [installation](https://docs.nginx.com/nginx-ingress-controller/installation/installation-with-manifests/) +1. Follow the [installation](https://docs.nginx.com/nginx-ingress-controller/install/manifests) instructions to deploy the Ingress Controller. 1. Save the public IP address of the Ingress Controller into a shell variable: diff --git a/examples/custom-resources/rate-limit-tiered-apikey/README.md b/examples/custom-resources/rate-limit-tiered-apikey/README.md index f16a504ee8..591edeb521 100644 --- a/examples/custom-resources/rate-limit-tiered-apikey/README.md +++ b/examples/custom-resources/rate-limit-tiered-apikey/README.md @@ -7,7 +7,7 @@ limit Policies, grouped in a tier, using the API Key client name as the key to t ## Prerequisites -1. Follow the [installation](https://docs.nginx.com/nginx-ingress-controller/installation/installation-with-manifests/) +1. Follow the [installation](https://docs.nginx.com/nginx-ingress-controller/install/manifests) instructions to deploy NGINX Ingress Controller. 2. Save the public IP address of NGINX Ingress Controller into a shell variable: diff --git a/examples/custom-resources/rate-limit-tiered-jwt-claim/README.md b/examples/custom-resources/rate-limit-tiered-jwt-claim/README.md index c65d28d870..3942e23bee 100644 --- a/examples/custom-resources/rate-limit-tiered-jwt-claim/README.md +++ b/examples/custom-resources/rate-limit-tiered-jwt-claim/README.md @@ -7,7 +7,7 @@ limit for the group. ## Prerequisites -1. Follow the [installation](https://docs.nginx.com/nginx-ingress-controller/installation/installation-with-manifests/) +1. Follow the [installation](https://docs.nginx.com/nginx-ingress-controller/install/manifests) instructions to deploy the Ingress Controller. 1. Save the public IP address of the Ingress Controller into a shell variable: diff --git a/examples/custom-resources/rate-limit-tiered-request-method/README.md b/examples/custom-resources/rate-limit-tiered-request-method/README.md index 494e89e2a0..f881bde21a 100644 --- a/examples/custom-resources/rate-limit-tiered-request-method/README.md +++ b/examples/custom-resources/rate-limit-tiered-request-method/README.md @@ -5,7 +5,7 @@ limit Policies, grouped in a tier, using the client IP address as the key to the ## Prerequisites -1. Follow the [installation](https://docs.nginx.com/nginx-ingress-controller/installation/installation-with-manifests/) +1. Follow the [installation](https://docs.nginx.com/nginx-ingress-controller/install/manifests) instructions to deploy NGINX Ingress Controller. 2. Save the public IP address of NGINX Ingress Controller into a shell variable: diff --git a/examples/custom-resources/rate-limit/README.md b/examples/custom-resources/rate-limit/README.md index 70be10ccf5..daa7e829dc 100644 --- a/examples/custom-resources/rate-limit/README.md +++ b/examples/custom-resources/rate-limit/README.md @@ -5,7 +5,7 @@ limit policy. ## Prerequisites -1. Follow the [installation](https://docs.nginx.com/nginx-ingress-controller/installation/installation-with-manifests/) +1. Follow the [installation](https://docs.nginx.com/nginx-ingress-controller/install/manifests) instructions to deploy the Ingress Controller. 1. Save the public IP address of the Ingress Controller into a shell variable: diff --git a/examples/custom-resources/service-insight/README.md b/examples/custom-resources/service-insight/README.md index 018886e629..420cd19269 100644 --- a/examples/custom-resources/service-insight/README.md +++ b/examples/custom-resources/service-insight/README.md @@ -68,7 +68,7 @@ spec: ## Deployment [Install NGINX Ingress -Controller](https://docs.nginx.com/nginx-ingress-controller/installation/installation-with-manifests/), and uncomment +Controller](https://docs.nginx.com/nginx-ingress-controller/install/manifests), and uncomment the `-enable-service-insight` option: this will allow Service Insight to interact with it. The examples below use the `nodeport` service. @@ -199,7 +199,7 @@ Response: ## Transport Servers [Install NGINX Ingress -Controller](https://docs.nginx.com/nginx-ingress-controller/installation/installation-with-manifests/), and uncomment +Controller](https://docs.nginx.com/nginx-ingress-controller/install/manifests), and uncomment the `-enable-service-insight`, `-enable-custom-resources`, and `-enable-tls-passthrough` options. The examples below use the `nodeport` service. diff --git a/examples/custom-resources/tls-passthrough/README.md b/examples/custom-resources/tls-passthrough/README.md index bc325eda60..1cbeaa2dd6 100644 --- a/examples/custom-resources/tls-passthrough/README.md +++ b/examples/custom-resources/tls-passthrough/README.md @@ -25,7 +25,7 @@ You can see how the Secure App is implemented in the `secure-app.yaml` file. ## Prerequisites -1. Follow the [installation](https://docs.nginx.com/nginx-ingress-controller/installation/installation-with-manifests/) +1. Follow the [installation](https://docs.nginx.com/nginx-ingress-controller/install/manifests) instructions to deploy the Ingress Controller: - As part of Step 2 of those instructions, make sure to deploy the custom resource definition for the TransportServer resource. diff --git a/examples/custom-resources/traffic-splitting/README.md b/examples/custom-resources/traffic-splitting/README.md index 7429e4d875..ea6fd75e09 100644 --- a/examples/custom-resources/traffic-splitting/README.md +++ b/examples/custom-resources/traffic-splitting/README.md @@ -11,7 +11,7 @@ example, for which we have introduced the following changes: ## Prerequisites -1. Follow the [installation](https://docs.nginx.com/nginx-ingress-controller/installation/installation-with-manifests/) +1. Follow the [installation](https://docs.nginx.com/nginx-ingress-controller/install/manifests) instructions to deploy the Ingress Controller with custom resources enabled. 1. Save the public IP address of the Ingress Controller into a shell variable: diff --git a/examples/ingress-resources/basic-auth/README.md b/examples/ingress-resources/basic-auth/README.md index cd3f5e7608..6c0d629eac 100644 --- a/examples/ingress-resources/basic-auth/README.md +++ b/examples/ingress-resources/basic-auth/README.md @@ -11,7 +11,7 @@ The Ingress controller provides the following 2 annotations for configuring Basi ## Prerequisites -1. Follow the [installation](https://docs.nginx.com/nginx-ingress-controller/installation/installation-with-manifests/) +1. Follow the [installation](https://docs.nginx.com/nginx-ingress-controller/install/manifests) instructions to deploy the Ingress Controller. 1. Save the public IP address of the Ingress Controller into a shell variable: diff --git a/examples/ingress-resources/complete-example/README.md b/examples/ingress-resources/complete-example/README.md index 895537d3bb..7358eaab28 100644 --- a/examples/ingress-resources/complete-example/README.md +++ b/examples/ingress-resources/complete-example/README.md @@ -7,7 +7,7 @@ balancing for that application using the Ingress resource. ## 1. Deploy the Ingress Controller -1. Follow the [installation](https://docs.nginx.com/nginx-ingress-controller/installation/installation-with-manifests/) +1. Follow the [installation](https://docs.nginx.com/nginx-ingress-controller/install/manifests) instructions to deploy the Ingress Controller. 2. Save the public IP address of the Ingress Controller into a shell variable: diff --git a/examples/ingress-resources/daemon-set/README.md b/examples/ingress-resources/daemon-set/README.md index e04f86ea81..d049cfcf6b 100644 --- a/examples/ingress-resources/daemon-set/README.md +++ b/examples/ingress-resources/daemon-set/README.md @@ -3,4 +3,4 @@ You can deploy the NGINX or NGINX Plus controller as a [Daemon Set](https://kubernetes.io/docs/admin/daemons/). This allows you to deploy the controller on all or select nodes of your cluster. -Read [the installation instructions](https://docs.nginx.com/nginx-ingress-controller/installation/installation-with-manifests/). +Read [the installation instructions](https://docs.nginx.com/nginx-ingress-controller/install/manifests). diff --git a/examples/ingress-resources/mergeable-ingress-types/README.md b/examples/ingress-resources/mergeable-ingress-types/README.md index 0e27a03e0e..08d75cec4a 100644 --- a/examples/ingress-resources/mergeable-ingress-types/README.md +++ b/examples/ingress-resources/mergeable-ingress-types/README.md @@ -85,7 +85,7 @@ that application using Ingress resources with the `nginx.org/mergeable-ingress-t ## 1. Deploy the Ingress Controller -1. Follow the [installation](https://docs.nginx.com/nginx-ingress-controller/installation/installation-with-manifests/) +1. Follow the [installation](https://docs.nginx.com/nginx-ingress-controller/install/manifests) instructions to deploy the Ingress Controller. 2. Save the public IP address of the Ingress Controller into a shell variable: diff --git a/examples/ingress-resources/rate-limit/README.md b/examples/ingress-resources/rate-limit/README.md index 4ac38d46b8..6defac0d37 100644 --- a/examples/ingress-resources/rate-limit/README.md +++ b/examples/ingress-resources/rate-limit/README.md @@ -7,7 +7,7 @@ balancing for that application using the Ingress resource with rate-limiting con ## 1. Deploy the Ingress Controller -1. Follow the [installation](https://docs.nginx.com/nginx-ingress-controller/installation/installing-nic/installation-with-manifests/) +1. Follow the [installation](https://docs.nginx.com/nginx-ingress-controller/install/manifests) instructions to deploy the Ingress Controller. 2. Save the public IP address of the Ingress Controller into a shell variable: diff --git a/examples/ingress-resources/rewrite-target/README.md b/examples/ingress-resources/rewrite-target/README.md index f73262f2c4..8660847a6b 100644 --- a/examples/ingress-resources/rewrite-target/README.md +++ b/examples/ingress-resources/rewrite-target/README.md @@ -8,7 +8,7 @@ The annotation is mutually exclusive with `nginx.org/rewrites`. If both are pres ## 1. Deploy the Ingress Controller -1. Follow the [installation](https://docs.nginx.com/nginx-ingress-controller/installation/installation-with-manifests/) instructions to deploy the Ingress Controller. +1. Follow the [installation](https://docs.nginx.com/nginx-ingress-controller/install/manifests) instructions to deploy the Ingress Controller. 2. Save the public IP address of the Ingress Controller into a shell variable: ```console diff --git a/examples/ingress-resources/tcp-udp/README.md b/examples/ingress-resources/tcp-udp/README.md index 014c17ee97..f2afe19e3c 100644 --- a/examples/ingress-resources/tcp-udp/README.md +++ b/examples/ingress-resources/tcp-udp/README.md @@ -26,7 +26,7 @@ the DNS name frequently, so will update automatically when new pods are deployed ### 1. Deploy the Ingress Controller -1. Follow the [installation](https://docs.nginx.com/nginx-ingress-controller/installation/installation-with-manifests/) +1. Follow the [installation](https://docs.nginx.com/nginx-ingress-controller/install/manifests) instructions to deploy the Ingress Controller. Make sure to expose port 5353 of the Ingress Controller both for TCP and UDP traffic. diff --git a/examples/shared-examples/autoscaling-keda/README.md b/examples/shared-examples/autoscaling-keda/README.md index 5da5fc7067..dc0c8211d4 100644 --- a/examples/shared-examples/autoscaling-keda/README.md +++ b/examples/shared-examples/autoscaling-keda/README.md @@ -4,7 +4,7 @@ This example is based on the Keda [example](https://keda.sh/docs/2.18/scalers/cr ## 1. Deploy the Ingress Controller -1. Follow the [installation](https://docs.nginx.com/nginx-ingress-controller/installation/installation-with-manifests/) +1. Follow the [installation](https://docs.nginx.com/nginx-ingress-controller/install/manifests) instructions to deploy the Ingress Controller. ## 2. Deploy Keda diff --git a/examples/shared-examples/nginx-plus-secret/README.md b/examples/shared-examples/nginx-plus-secret/README.md index 1a90ae77e1..6912992a88 100644 --- a/examples/shared-examples/nginx-plus-secret/README.md +++ b/examples/shared-examples/nginx-plus-secret/README.md @@ -1,3 +1,3 @@ # NGINX Plus Secret -Refer to the [Create License Secret](https://docs.nginx.com/nginx-ingress-controller/installation/create-license-secret/) docs to download and create a License Secret +Refer to the [Create License Secret](https://docs.nginx.com/nginx-ingress-controller/install/license-secret/) docs to download and create a License Secret diff --git a/examples/shared-examples/rbac/README.md b/examples/shared-examples/rbac/README.md index 9f2da555b5..486d2ae39a 100644 --- a/examples/shared-examples/rbac/README.md +++ b/examples/shared-examples/rbac/README.md @@ -2,4 +2,4 @@ It is possible to run the Ingress Controller in a cluster with [RBAC](https://kubernetes.io/docs/admin/authorization/rbac/) enabled. -Read the [installation instructions](https://docs.nginx.com/nginx-ingress-controller/installation/installation-with-manifests/). +Read the [installation instructions](https://docs.nginx.com/nginx-ingress-controller/install/manifests).