Skip to content
Open
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
12 changes: 6 additions & 6 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand All @@ -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
Expand Down Expand Up @@ -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).

Expand Down Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand Down Expand Up @@ -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)

Expand Down
2 changes: 1 addition & 1 deletion build/README.md
Original file line number Diff line number Diff line change
@@ -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.
2 changes: 1 addition & 1 deletion charts/nginx-ingress/README.md
Original file line number Diff line number Diff line change
@@ -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.
4 changes: 2 additions & 2 deletions charts/nginx-ingress/templates/NOTES.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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 -}}
2 changes: 1 addition & 1 deletion deployments/README.md
Original file line number Diff line number Diff line change
@@ -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/).
2 changes: 1 addition & 1 deletion examples/custom-resources/advanced-routing/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
2 changes: 1 addition & 1 deletion examples/custom-resources/api-key/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
2 changes: 1 addition & 1 deletion examples/custom-resources/basic-auth/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
2 changes: 1 addition & 1 deletion examples/custom-resources/basic-configuration/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
6 changes: 3 additions & 3 deletions examples/custom-resources/basic-tcp-udp/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
2 changes: 1 addition & 1 deletion examples/custom-resources/cache-policy/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
2 changes: 1 addition & 1 deletion examples/custom-resources/certmanager/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
2 changes: 1 addition & 1 deletion examples/custom-resources/custom-listeners/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
2 changes: 1 addition & 1 deletion examples/custom-resources/egress-mtls/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
Loading
Loading