Heptio Contour

Maintainers: Heptio

Overview

Contour is an Ingress controller for Kubernetes that works by deploying the Envoy proxy as a reverse proxy and load balancer. Unlike other Ingress controllers, Contour supports dynamic configuration updates out of the box while maintaining a lightweight profile.

This is an early release so that we can start sharing with the community. Check out the roadmap to see where we plan to go with the project.

Prerequisites

Contour is tested with Kubernetes clusters running version 1.7 and later, but should work with earlier versions.

Get started

You can try out Contour by creating a deployment from a hosted manifest -- no clone or local install necessary.

What you do need:

A Kubernetes cluster that supports Service objects of type: LoadBalancer (AWS Quickstart cluster or Minikube, for example)
kubectl configured with admin access to your cluster

See the deployment documentation for more deployment options if you don't meet these requirements.

Add Contour to your cluster

Run:

$ kubectl apply -f http://j.hept.io/contour-deployment-rbac

If RBAC isn't enabled on your cluster (for example, if you're on GKE with legacy authorization), run:

$ kubectl apply -f http://j.hept.io/contour-deployment-norbac

This command creates:

A new namespace heptio-contour with two instances of Contour in the namespace
A Service of type: LoadBalancer that points to the Contour instances
Depending on your configuration, new cloud resources -- for example, ELBs in AWS

Example workload

If you don't have an application ready to run with Contour, you can explore with kuard.

Run:

$ kubectl apply -f http://j.hept.io/contour-kuard-example

This example specifies a default backend for all hosts, so that you can test your Contour install. It's recommended for exploration and testing only, however, because it responds to all requests regardless of the incoming DNS that is mapped. You probably want to run with specific Ingress rules for specific hostnames.

Access your cluster

Now you can retrieve the external address of Contour's load balancer:

$ kubectl get -n heptio-contour service contour -o wide
NAME      CLUSTER-IP     EXTERNAL-IP                                                                    PORT(S)        AGE       SELECTOR
contour   10.106.53.14   a47761ccbb9ce11e7b27f023b7e83d33-2036788482.ap-southeast-2.elb.amazonaws.com   80:30274/TCP   3h        app=contour

On Minikube:

$ minikube service -n heptio-contour contour --url
http://192.168.99.100:30588

Configuring DNS

How you configure DNS depends on your platform:

On AWS, create a CNAME record that maps the host in your Ingress object to the ELB address.
If you have an IP address instead (on GCE, for example), create an A record.
On Minikube, you can fake DNS by editing /etc/hosts.

Known limitations

Contour does not yet support customizations with annotations.
Contour and Envoy do not yet support SSL/TLS. Work is underway in the Envoy project to support SNI. This work will let Contour support TLS for multiple hostnames.

Troubleshooting

If you encounter any problems that the documentation does not address, file an issue.

Contributing

Thanks for taking the time to join our community and start contributing!

Please familiarize yourself with the Code of Conduct before contributing.
See CONTRIBUTING.md for information about setting up your environment, the workflow that we expect, and instructions on the developer certificate of origin that we require.
Check out the issues and our roadmap.

Changelog

See the list of releases to find out about feature changes.

heptio / contour