Set up Ingress on Minikube with the NGINX Ingress Controller

An Ingress is an API object that defines rules which allow external access to services in a cluster. An Ingress controller fulfills the rules set in the Ingress.

This page shows you how to set up a simple Ingress which routes requests to Service 'web' or 'web2' depending on the HTTP URI.

Before you begin

This tutorial assumes that you are using minikube to run a local Kubernetes cluster. Visit Install tools to learn how to install minikube.

Note:

This tutorial uses a container that requires the AMD64 architecture. If you are using minikube on a computer with a different CPU architecture, you could try using minikube with a driver that can emulate AMD64. For example, the Docker Desktop driver can do this.

You need to have a Kubernetes cluster, and the kubectl command-line tool must be configured to communicate with your cluster. It is recommended to run this tutorial on a cluster with at least two nodes that are not acting as control plane hosts. If you do not already have a cluster, you can create one by using minikube or you can use one of these Kubernetes playgrounds:

Your Kubernetes server must be at or later than version 1.19. To check the version, enter kubectl version. If you are using an older Kubernetes version, switch to the documentation for that version.

Create a minikube cluster

If you haven't already set up a cluster locally, run minikube start to create a cluster.

Enable the Ingress controller

To enable the NGINX Ingress controller, run the following command:
```
minikube addons enable ingress
```

Verify that the NGINX Ingress controller is running

kubectl get pods -n ingress-nginx

Note:

It can take up to a minute before you see these pods running OK.

The output is similar to:

NAME                                        READY   STATUS      RESTARTS    AGE
ingress-nginx-admission-create-g9g49        0/1     Completed   0          11m
ingress-nginx-admission-patch-rqp78         0/1     Completed   1          11m
ingress-nginx-controller-59b45fb494-26npt   1/1     Running     0          11m

Deploy a hello, world app

Create a Deployment using the following command:

kubectl create deployment web --image=gcr.io/google-samples/hello-app:1.0

The output should be:

deployment.apps/web created

Verify that the Deployment is in a Ready state:

kubectl get deployment web

The output should be similar to:

NAME   READY   UP-TO-DATE   AVAILABLE   AGE
web    1/1     1            1           53s

Expose the Deployment:

kubectl expose deployment web --type=NodePort --port=8080

The output should be:

service/web exposed

Verify the Service is created and is available on a node port:

kubectl get service web

The output is similar to:

NAME      TYPE       CLUSTER-IP       EXTERNAL-IP   PORT(S)          AGE
web       NodePort   10.104.133.249   <none>        8080:31637/TCP   12m

Visit the Service via NodePort, using the minikube service command. Follow the instructions for your platform:
- Linux
- MacOS
```
minikube service web --url
```
The output is similar to:
```
http://172.17.0.15:31637
```
Invoke the URL obtained in the output of the previous step:
```
curl http://172.17.0.15:31637 
```
```
# The command must be run in a separate terminal.
minikube service web --url 
```
The output is similar to:
```
http://127.0.0.1:62445
! Because you are using a Docker driver on darwin, the terminal needs to be open to run it.
```
From a different terminal, invoke the URL obtained in the output of the previous step:
```
curl http://127.0.0.1:62445 
```
The output is similar to:
```
Hello, world!
Version: 1.0.0
Hostname: web-55b8c6998d-8k564
```
You can now access the sample application via the Minikube IP address and NodePort. The next step lets you access the application using the Ingress resource.

Create an Ingress

The following manifest defines an Ingress that sends traffic to your Service via hello-world.example.

Create example-ingress.yaml from the following file:

service/networking/example-ingress.yaml

apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
  name: example-ingress
spec:
  ingressClassName: nginx
  rules:
    - host: hello-world.example
      http:
        paths:
          - path: /
            pathType: Prefix
            backend:
              service:
                name: web
                port:
                  number: 8080

Create the Ingress object by running the following command:

kubectl apply -f https://k8s.io/examples/service/networking/example-ingress.yaml

The output should be:

ingress.networking.k8s.io/example-ingress created

Verify the IP address is set:

kubectl get ingress

Note:

This can take a couple of minutes.

You should see an IPv4 address in the ADDRESS column; for example:

NAME              CLASS   HOSTS                 ADDRESS        PORTS   AGE
example-ingress   nginx   hello-world.example   172.17.0.15    80      38s

Verify that the Ingress controller is directing traffic, by following the instructions for your platform:

Note:

The network is limited if using the Docker driver on MacOS (Darwin) and the Node IP is not reachable directly. To get ingress to work you’ll need to open a new terminal and run minikube tunnel.
sudo permission is required for it, so provide the password when prompted.

Linux
MacOS

curl --resolve "hello-world.example:80:$( minikube ip )" -i http://hello-world.example

minikube tunnel

The output is similar to:

Tunnel successfully started

NOTE: Please do not close this terminal as this process must stay alive for the tunnel to be accessible ...

The service/ingress example-ingress requires privileged ports to be exposed: [80 443]
sudo permission will be asked for it.
Starting tunnel for service example-ingress.

From within a new terminal, invoke the following command:

curl --resolve "hello-world.example:80:127.0.0.1" -i http://hello-world.example

You should see:

Hello, world!
Version: 1.0.0
Hostname: web-55b8c6998d-8k564

Optionally, you can also visit hello-world.example from your browser.
Add a line to the bottom of the /etc/hosts file on your computer (you will need administrator access):
- Linux
- MacOS
Look up the external IP address as reported by minikube
```
  minikube ip 
```
```
  172.17.0.15 hello-world.example
```
Note:
Change the IP address to match the output from minikube ip.
```
127.0.0.1 hello-world.example
```
After you make this change, your web browser sends requests for hello-world.example URLs to Minikube.

Create a second Deployment

Create another Deployment using the following command:

kubectl create deployment web2 --image=gcr.io/google-samples/hello-app:2.0

The output should be:

deployment.apps/web2 created

Verify that the Deployment is in a Ready state:

kubectl get deployment web2

The output should be similar to:

NAME   READY   UP-TO-DATE   AVAILABLE   AGE
web2   1/1     1            1           16s

Expose the second Deployment:

kubectl expose deployment web2 --port=8080 --type=NodePort

The output should be:

service/web2 exposed

Edit the existing Ingress

Edit the existing example-ingress.yaml manifest, and add the following lines at the end:

- path: /v2
  pathType: Prefix
  backend:
    service:
      name: web2
      port:
        number: 8080

Apply the changes:

kubectl apply -f example-ingress.yaml

You should see:

ingress.networking/example-ingress configured

Test your Ingress

Access the 1st version of the Hello World app.

Linux
MacOS

curl --resolve "hello-world.example:80:$( minikube ip )" -i http://hello-world.example

minikube tunnel

The output is similar to:

Tunnel successfully started

NOTE: Please do not close this terminal as this process must stay alive for the tunnel to be accessible ...

The service/ingress example-ingress requires privileged ports to be exposed: [80 443]
sudo permission will be asked for it.
Starting tunnel for service example-ingress.

From within a new terminal, invoke the following command:

curl --resolve "hello-world.example:80:127.0.0.1" -i http://hello-world.example

The output is similar to:

Hello, world!
Version: 1.0.0
Hostname: web-55b8c6998d-8k564

Access the 2nd version of the Hello World app.

Linux
MacOS

curl --resolve "hello-world.example:80:$( minikube ip )" -i http://hello-world.example/v2

minikube tunnel

The output is similar to:

Tunnel successfully started

NOTE: Please do not close this terminal as this process must stay alive for the tunnel to be accessible ...

The service/ingress example-ingress requires privileged ports to be exposed: [80 443]
sudo permission will be asked for it.
Starting tunnel for service example-ingress.

From within a new terminal, invoke the following command:

curl --resolve "hello-world.example:80:127.0.0.1" -i http://hello-world.example/v2

The output is similar to:

Hello, world!
Version: 2.0.0
Hostname: web2-75cd47646f-t8cjk

Note:

If you did the optional step to update /etc/hosts, you can also visit hello-world.example and hello-world.example/v2 from your browser.

What's next

Read more about Ingress
Read more about Ingress Controllers
Read more about Services

Last modified June 20, 2024 at 12:44 PM PST: Sync changest from andygol/k8s-website (36d05bc8a1)

Set up Ingress on Minikube with the NGINX Ingress Controller

Before you begin

Note:

Create a minikube cluster

Enable the Ingress controller

Note:

Deploy a hello, world app

Create an Ingress

Note:

Note:

Note:

Create a second Deployment

Edit the existing Ingress

Test your Ingress

Note:

What's next

Feedback