How to use default Ingress

Canonical Kubernetes allows you to configure Ingress into your cluster. When enabled, it tells your cluster how external HTTP and HTTPS traffic should be routed to its services.

What you’ll need

This guide assumes the following:

  • You have root or sudo access to the machine

  • You have a bootstrapped Canonical Kubernetes cluster (see the Getting Started guide).

Check Ingress status

Find out whether Ingress is enabled or disabled with the following command:

sudo k8s status

Please ensure that Ingress is enabled on your cluster.

Enable Ingress

To enable Ingress, run:

sudo k8s enable ingress

For more information on the command, execute:

sudo k8s help enable

Configure Ingress

Discover your configuration options by running:

sudo k8s get ingress

You should see three options:

  • enabled: If set to true, Ingress is enabled

  • default-tls-secret: Name of the TLS (Transport Layer Security) Secret in the kube-system namespace that will be used as the default Ingress certificate

  • enable-proxy-protocol: If set, proxy protocol will be enabled for the Ingress

TLS Secret

You can create a TLS secret by following the official Kubernetes documentation. Please remember to use sudo k8s kubectl (See the kubectl-guide).

Tell Ingress to use your new Ingress certificate:

sudo k8s set ingress.default-tls-secret=<new-default-tls-secret>

Replace <new-default-tls-secret> with the desired value for your Ingress configuration.

Proxy Protocol

Enabling the proxy protocol allows passing client connection information to the backend service.

Consult the official Kubernetes documentation on the proxy protocol.

Use the following command to enable the proxy protocol:

sudo k8s set ingress.enable-proxy-protocol=<new-enable-proxy-protocol>

Adjust the value of <new-enable-proxy-protocol> with your proxy protocol requirements.

Disable Ingress

You can disable the built-in ingress:

Warning

Disabling Ingress may impact external access to services within your cluster. Ensure that you have alternative configurations in place before disabling Ingress.

sudo k8s disable ingress

For more information on this command, run:

sudo k8s help disable