Skip to content
Contour is a Kubernetes ingress controller using Lyft's Envoy proxy.
Branch: master
Clone or download
Latest commit 532c4e1 Mar 21, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Update pull_request_template.md Mar 12, 2019
_integration _integration: add service selector to generator Apr 26, 2018
apis omit empty secret name Mar 5, 2019
cmd/contour use shared informer factories for watchers Mar 13, 2019
deployment Fix split hostnet example not creating Mar 14, 2019
design internal/dag: implement TLS Certificate Delegation Mar 4, 2019
docs Add some forgotten language identifiers Mar 7, 2019
hack Move IngressRoute generated client to apis package Sep 25, 2018
internal internal/grpc: do no use reflect.DeepEqual on errors Mar 14, 2019
.dockerignore Gopkg.toml: freshen depdenencies Nov 5, 2018
.gitignore Cleanup go module transition Mar 21, 2019
.travis.yml
CODE_OF_CONDUCT.md All: remove Heptio branding Feb 4, 2019
CONTRIBUTING.md Copy edit CONTRIBUTING Mar 21, 2019
Dockerfile Dockerfile: update for go modules Mar 21, 2019
FAQ.md All: remove Heptio branding Feb 4, 2019
LICENSE Add LICENSE Oct 31, 2017
Makefile travis.yaml: add make download Mar 21, 2019
README.md All: remove Heptio branding Feb 4, 2019
contour.png Add new contour logo Feb 25, 2019
go.mod Cleanup go module transition Mar 21, 2019

README.md

Contour Build Status Go Report Card

Contour is fun at parties!

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.

Contour also introduces a new ingress API (IngressRoute) which is implemented via a Custom Resource Definition (CRD). Its goal is to expand upon the functionality of the Ingress API to allow for a richer user experience as well as solve shortcomings in the original design.

See the launch blog post for our vision of how Contour fits into the larger Kubernetes ecosystem.

Prerequisites

Contour is tested with Kubernetes clusters running version 1.10 and later, but should work with earlier versions where Custom Resource Definitions are supported (Kubernetes 1.7+).

RBAC must be enabled on your cluster.

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 https://j.hept.io/contour-deployment-rbac

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

See also TLS support for details on configuring TLS support. TLS is available in Contour version 0.3 and later.

Example workload

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

Run:

$ kubectl apply -f https://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

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.

More information and documentation

For more deployment options, including uninstalling Contour, see the deployment documentation.

See also the Kubernetes documentation for Services, Ingress, and IngressRoutes.

The detailed documentation provides additional information, including an introduction to Envoy and an explanation of how Contour maps key Envoy concepts to Kubernetes.

We've also got an FAQ for short-answer questions and conceptual stuff that doesn't quite belong in the docs.

Troubleshooting

If you encounter issues, review the troubleshooting docs, file an issue, or talk to us on the #contour channel on the Kubernetes Slack server.

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 open issues.
  • Read how we're using ZenHub for project and roadmap planning.

Changelog

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

You can’t perform that action at this time.