Ingress can be added for workloads to provide load balancing, SSL termination and host/path based routing. When using ingresses in a project, you can program the ingress hostname to an external DNS by setting up a Global DNS entry.

  1. From the Global view, open the project that you want to add ingress to.
  2. Click Resources in the main navigation bar. Click the Load Balancing tab. (In versions before v2.3.0, just click the Load Balancing tab.) Then click Add Ingress.
  3. Enter a Name for the ingress.
  4. Select an existing Namespace from the drop-down list. Alternatively, you can create a new namespace on the fly by clicking Add to a new namespace.
  5. Create ingress forwarding Rules. For help configuring the rules, refer to this section. If any of your ingress rules handle requests for encrypted ports, add a certificate to encrypt/decrypt communications.
  6. Optional: click Add Rule to create additional ingress rules. For example, after you create ingress rules to direct requests for your hostname, you’ll likely want to create a default backend to handle 404s.

Result: Your ingress is added to the project. The ingress begins enforcing your ingress rules.

Ingress Rule Configuration

Automatically generate a xip.io hostname

If you choose this option, ingress routes requests to hostname to a DNS name that’s automatically generated. Rancher uses xip.io to automatically generates the DNS name. This option is best used for testing, not production environments.

Note: To use this option, you must be able to resolve to xip.io addresses.

  1. Add a Target Backend. By default, a workload is added to the ingress, but you can add more targets by clicking either Service or Workload.
  2. Optional: If you want specify a workload or service when a request is sent to a particular hostname path, add a Path for the target. For example, if you want requests for www.mysite.com/contact-us to be sent to a different service than www.mysite.com, enter /contact-us in the Path field. Typically, the first rule that you create does not include a path.
  3. Select a workload or service from the Target drop-down list for each target you’ve added.
  4. Enter the Port number that each target operates on.

Specify a hostname to use

If you use this option, ingress routes requests for a hostname to the service or workload that you specify.

  1. Enter the hostname that your ingress will handle request forwarding for. For example, www.mysite.com.
  2. Add a Target Backend. By default, a workload is added to the ingress, but you can add more targets by clicking either Service or Workload.
  3. Optional: If you want specify a workload or service when a request is sent to a particular hostname path, add a Path for the target. For example, if you want requests for www.mysite.com/contact-us to be sent to a different service than www.mysite.com, enter /contact-us in the Path field. Typically, the first rule that you create does not include a path.
  4. Select a workload or service from the Target drop-down list for each target you’ve added.
  5. Enter the Port number that each target operates on.

Use as the default backend

Use this option to set an ingress rule for handling requests that don’t match any other ingress rules. For example, use this option to route requests that can’t be found to a 404 page.

Note: If you deployed Rancher using RKE, a default backend for 404s and 202s is already configured.

  1. Add a Target Backend. Click either Service or Workload to add the target.
  2. Select a service or workload from the Target drop-down list.

Certificates

Note: You must have an SSL certificate that the ingress can use to encrypt/decrypt communications. For more information see Adding SSL Certificates.

  1. Click Add Certificate.
  2. Select a Certificate from the drop-down list.
  3. Enter the Host using encrypted communication.
  4. To add additional hosts that use the certificate, click Add Hosts.

Labels and Annotations

Add Labels and/or Annotations to provide metadata for your ingress.

For a list of annotations available for use, see the Nginx Ingress Controller Documentation.