February 12, 2019

296 words 2 mins read

projectcontour/contour

projectcontour/contour

Contour is a Kubernetes ingress controller using Lyft’s Envoy proxy.

repo name projectcontour/contour
repo link https://github.com/projectcontour/contour
homepage https://projectcontour.io
language Go
size (curr.) 10020 kB
stars (curr.) 2146
created 2017-10-26
license Apache License 2.0

Contour Build Status Go Report Card GitHub release License

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. Contour supports dynamic configuration updates out of the box while maintaining a lightweight profile.

Contour also introduces a new ingress API (HTTPProxy) 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.

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

Getting started with Contour is as simple as one command. See the Getting Started document.

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.
  • Join our Kubernetes Slack channel: #contour
  • Join the Contour Community Meetings, every third Tuesday at 6PM ET / 3PM PT / Wednesday at 8AM Australian Eastern Time.
    • Meeting notes can be found here.
    • Meetings are recorded and can be found here.

Changelog

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

comments powered by Disqus