Skip to content

# Installation Guide

Attention

The default configuration watches Ingress object from all namespaces.

To change this behavior use the flag `--watch-namespace` to limit the scope to a particular namespace.

Warning

If multiple Ingresses define paths for the same host, the ingress controller merges the definitions.

Danger

The admission webhook requires connectivity between Kubernetes API server and the ingress controller.

In case Network policies or additional firewalls, please allow access to port `8443`.

Attention

The first time the ingress controller starts, two Jobs create the SSL Certificate used by the admission webhook. For this reason, there is an initial delay of up to two minutes until it is possible to create and validate Ingress definitions.

You can wait until it is ready to run the next command:

    kubectl wait --namespace ingress-nginx \
      --for=condition=ready pod \
      --selector=app.kubernetes.io/component=controller \
      --timeout=120s

## Contents

- Provider Specific Steps
- Docker for Mac
- minikube
- microk8s
- AWS
- GCE - GKE
- Azure
- Digital Ocean
- Scaleway
- Bare-metal
- Verify installation
- Detect installed version
- Using Helm

### Provider Specific Steps

#### Docker for Mac

Kubernetes is available in Docker for Mac (from version 18.06.0-ce)

    kubectl apply -f https://raw.githubusercontent.com/kubernetes/ingress-nginx/controller-v0.45.0/deploy/static/provider/cloud/deploy.yaml

#### minikube

For standard usage:

    minikube addons enable ingress

#### microk8s

For standard usage:

    microk8s enable ingress

Please check the microk8s documentation page

#### AWS

In AWS we use a Network load balancer (NLB) to expose the NGINX Ingress controller behind a Service of `Type=LoadBalancer`.

##### Network Load Balancer (NLB)

    kubectl apply -f https://raw.githubusercontent.com/kubernetes/ingress-nginx/controller-v0.45.0/deploy/static/provider/aws/deploy.yaml

##### TLS termination in AWS Load Balancer (ELB)

In some scenarios is required to terminate TLS in the Load Balancer and not in the ingress controller.

For this purpose we provide a template:

- Download deploy-tls-termination.yaml

    wget https://raw.githubusercontent.com/kubernetes/ingress-nginx/controller-v0.45.0/deploy/static/provider/aws/deploy-tls-termination.yaml

- Edit the file and change:

- VPC CIDR in use for the Kubernetes cluster:

`proxy-real-ip-cidr: XXX.XXX.XXX/XX`

- AWS Certificate Manager (ACM) ID

`arn:aws:acm:us-west-2:XXXXXXXX:certificate/XXXXXX-XXXXXXX-XXXXXXX-XXXXXXXX`

- Deploy the manifest:

    kubectl apply -f deploy-tls-termination.yaml

##### NLB Idle Timeouts

Idle timeout value for TCP flows is 350 seconds and cannot be modified.

For this reason, you need to ensure the keepalive_timeout value is configured less than 350 seconds to work as expected.

By default NGINX `keepalive_timeout` is set to `75s`.

More information with regards to timeouts can be found in the official AWS documentation

#### GCE-GKE

Info

Initialize your user as a cluster-admin with the following command:

    kubectl create clusterrolebinding cluster-admin-binding \
      --clusterrole cluster-admin \
      --user $(gcloud config get-value account)

Danger

For private clusters, you will need to either add an additional firewall rule that allows master nodes access to port `8443/tcp` on worker nodes, or change the existing rule that allows access to ports `80/tcp`, `443/tcp` and `10254/tcp` to also allow access to port `8443/tcp`.

See the GKE documentation on adding rules and the Kubernetes issue for more detail.

    kubectl apply -f https://raw.githubusercontent.com/kubernetes/ingress-nginx/controller-v0.45.0/deploy/static/provider/cloud/deploy.yaml

Failure

Proxy protocol is not supported in GCE/GKE

#### Azure

    kubectl apply -f https://raw.githubusercontent.com/kubernetes/ingress-nginx/controller-v0.45.0/deploy/static/provider/cloud/deploy.yaml

More information with regards to Azure annotations for ingress controller can be found in the official AKS documentation.

#### Digital Ocean

    kubectl apply -f https://raw.githubusercontent.com/kubernetes/ingress-nginx/controller-v0.45.0/deploy/static/provider/do/deploy.yaml

#### Scaleway

    kubectl apply -f https://raw.githubusercontent.com/kubernetes/ingress-nginx/controller-v0.45.0/deploy/static/provider/scw/deploy.yaml

#### Bare-metal

Using NodePort:

    kubectl apply -f https://raw.githubusercontent.com/kubernetes/ingress-nginx/controller-v0.45.0/deploy/static/provider/baremetal/deploy.yaml

Tip

Applicable on kubernetes clusters deployed on bare-metal with generic Linux distro(Such as CentOs, Ubuntu ...).

Info

For extended notes regarding deployments on bare-metal, see Bare-metal considerations.

### Verify installation

Info

In minikube the ingress addon is installed in the namespace kube-system instead of ingress-nginx

To check if the ingress controller pods have started, run the following command:

    kubectl get pods -n ingress-nginx \
      -l app.kubernetes.io/name=ingress-nginx --watch

Once the ingress controller pods are running, you can cancel the command typing `Ctrl+C`.

Now, you are ready to create your first ingress.

### Detect installed version

To detect which version of the ingress controller is running, exec into the pod and run `nginx-ingress-controller --version`.

    POD_NAMESPACE=ingress-nginx
    POD_NAME=$(kubectl get pods -n $POD_NAMESPACE -l app.kubernetes.io/name=ingress-nginx --field-selector=status.phase=Running -o jsonpath='{.items[0].metadata.name}')

    kubectl exec -it $POD_NAME -n $POD_NAMESPACE -- /nginx-ingress-controller --version

## Using Helm

Attention

Only Helm v3 is supported

NGINX Ingress controller can be installed via Helm using the chart from the project repository. To install the chart with the release name `ingress-nginx`:

    helm repo add ingress-nginx https://kubernetes.github.io/ingress-nginx
    helm repo update

    helm install ingress-nginx ingress-nginx/ingress-nginx

## Detect installed version:

    POD_NAME=$(kubectl get pods -l app.kubernetes.io/name=ingress-nginx -o jsonpath='{.items[0].metadata.name}')
    kubectl exec -it $POD_NAME -- /nginx-ingress-controller --version