Documentation

Annotations are used in Ingress Controllers to configure features that are not covered by the Kubernetes Ingress API.

Some of the features that have been historically configured via annotations are supported as first-class features in Contour's IngressRoute API, which provides a more robust configuration interface over annotations.

However, Contour still supports a number of annotations on the Ingress resources.

Deprecation Notice
The contour.heptio.com annotations are deprecated, please use the projectcontour.io form going forward.

Standard Kubernetes Ingress annotations

  • kubernetes.io/ingress.class: The Ingress class that should interpret and serve the Ingress. If not set, then all Ingress controllers serve the Ingress. If specified as kubernetes.io/ingress.class: contour, then Contour serves the Ingress. If any other value, Contour ignores the Ingress definition. You can override the default class contour with the --ingress-class-name flag at runtime. This can be useful while you are migrating from another controller, or if you need multiple instances of Contour.
  • ingress.kubernetes.io/force-ssl-redirect: Requires TLS/SSL for the Ingress to Envoy by setting the Envoy virtual host option require_tls.
  • kubernetes.io/ingress.allow-http: Instructs Contour to not create an Envoy HTTP route for the virtual host. The Ingress exists only for HTTPS requests. Specify "false" for Envoy to mark the endpoint as HTTPS only. All other values are ignored.

The ingress.kubernetes.io/force-ssl-redirect annotation takes precedence over kubernetes.io/ingress.allow-http. If they are set to "true" and "false" respectively, Contour will create an Envoy HTTP route for the Virtual host, and set the require_tls virtual host option.

Contour specific Ingress annotations

  • projectcontour.io/ingress.class: The Ingress class that should interpret and serve the Ingress. If not set, then all Ingress controllers serve the Ingress. If specified as projectcontour.io/ingress.class: contour, then Contour serves the Ingress. If any other value, Contour ignores the Ingress definition. You can override the default class contour with the --ingress-class-name flag at runtime. This can be useful while you are migrating from another controller, or if you need multiple instances of Contour.
  • projectcontour.io/num-retries: The maximum number of retries Envoy should make before abandoning and returning an error to the client. Applies only if projectcontour.io/retry-on is specified.
  • projectcontour.io/per-try-timeout: The timeout per retry attempt, if there should be one. Applies only if projectcontour.io/retry-on is specified.
  • projectcontour.io/response-timeout: The Envoy HTTP route timeout, specified as a golang duration. By default, Envoy has a 15 second timeout for a backend service to respond. Set this to infinity to specify that Envoy should never timeout the connection to the backend. Note that the value 0s / zero has special semantics for Envoy.
  • projectcontour.io/retry-on: The conditions for Envoy to retry a request. See also possible values and their meanings for retry-on.
  • projectcontour.io/tls-minimum-protocol-version: The minimum TLS protocol version the TLS listener should support.
  • projectcontour.io/websocket-routes: The routes supporting websocket protocol, the annotation value contains a list of route paths separated by a comma that must match with the ones defined in the Ingress definition. Defaults to Envoy's default behavior which is use_websocket to false.
  • contour.heptio.com/ingress.class: deprecated form of projectcontour.io/ingress.class.
  • contour.heptio.com/num-retries: deprecated form of projectcontour.io/num-retries.
  • contour.heptio.com/per-try-timeout: deprecated form of projectcontour.io/per-try-timeout.
  • contour.heptio.com/request-timeout: deprecated form of projectcontour.io/response-timeout. Note this is response-timeout.
  • contour.heptio.com/retry-on: deprecated form of projectcontour.io/retry-on.
  • contour.heptio.com/tls-minimum-protocol-version: deprecated form of projectcontour.io/tls-minimum-protocol-version.
  • contour.heptio.com/websocket-routes: deprecated form of projectcontour.io/websocket-routes.

Contour specific Service annotations

A Kubernetes Service maps to an Envoy Cluster. Envoy clusters have many settings to control specific behaviors. These annotations allow access to some of those settings.

  • projectcontour.io/max-connections: The maximum number of connections that a single Envoy instance allows to the Kubernetes Service; defaults to 1024.
  • projectcontour.io/max-pending-requests: The maximum number of pending requests that a single Envoy instance allows to the Kubernetes Service; defaults to 1024.
  • projectcontour.io/max-requests: The maximum parallel requests a single Envoy instance allows to the Kubernetes Service; defaults to 1024
  • projectcontour.io/max-retries: The maximum number of parallel retries a single Envoy instance allows to the Kubernetes Service; defaults to 1024. This is independent of the per-Kubernetes Ingress number of retries (projectcontour.io/num-retries) and retry-on (projectcontour.io/retry-on), which control whether retries are attempted and how many times a single request can retry.
  • projectcontour.io/upstream-protocol.{protocol} : The protocol used in the upstream. The annotation value contains a list of port names and/or numbers separated by a comma that must match with the ones defined in the Service definition. For now, just h2, h2c, and tls are supported: contour.heptio.com/upstream-protocol.h2: "443,https". Defaults to Envoy's default behavior which is http1 in the upstream.
    • The tls protocol allows for requests which terminate at Envoy to proxy via tls to the upstream. Note: This does not validate the upstream certificate.
  • contour.heptio.com/max-connections: deprecated form of projectcontour.io/max-connections
  • contour.heptio.com/max-pending-requests: deprecated form of projectcontour.io/max-pending-requests.
  • contour.heptio.com/max-requests: deprecated form of projectcontour.io/max-requests.
  • contour.heptio.com/max-retries: deprecated form of projectcontour.io/max-retries.
  • contour.heptio.com/upstream-protocol.{protocol} : deprecated form of projectcontour.io/upstream-protocol.{protocol}.

Contour specific IngressRoute annotations

  • contour.heptio.com/ingress.class: The Ingress class that should interpret and serve the IngressRoute. If not set, then all all Contour instances serve the IngressRoute. If specified as contour.heptio.com/ingress.class: contour, then Contour serves the IngressRoute. If any other value, Contour ignores the IngressRoute definition. You can override the default class contour with the --ingress-class-name flag at runtime.
Ready to try Contour?

Read our getting started documentation.