Awesome

Contour

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 supports multiple configuration APIs in order to meet the needs of as many users as possible:

• Ingress - A stable upstream API that enables basic ingress use cases.
• HTTPProxy - Contour's Custom Resource Definition (CRD) which expands upon the functionality of the Ingress API to allow for a richer user experience as well as solve shortcomings in the original design.
• Gateway API - A new CRD-based API managed by the Kubernetes SIG-Network community that aims to evolve Kubernetes service networking APIs in a vendor-neutral way.

Prerequisites

See the compatibility matrix for the Kubernetes versions Contour is supported with.

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 section of the 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 - schedule, notes, and recordings can be found here
• Find GOVERNANCE in our Community repo

Roadmap

See Contour's roadmap to learn more about where we are headed.

Security

Security Audit

A third party security audit was performed by Cure53 in December of 2020. You can see the full report here.

Reporting security vulnerabilities

If you've found a security related issue, a vulnerability, or a potential vulnerability in Contour please let the Contour Security Team know with the details of the vulnerability. We'll send a confirmation email to acknowledge your report, and we'll send an additional email when we've identified the issue positively or negatively.

For further details please see our security policy.

Changelog

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