Contour · Schema

Route

A single routing rule mapping request conditions to backend services.

EnvoyIngress ControllerKubernetesNetworkingProxy

Properties

Name	Type	Description
conditions	array	Match conditions for this route.
services	array	Backend services to route matching requests to.
enableWebsockets	boolean	If true, upgrades HTTP connections to WebSocket connections.
permitInsecure	boolean	If true, allows this route to respond to non-TLS requests when the parent virtual host has TLS enabled.
retryPolicy	object
timeoutPolicy	object
rateLimitPolicy	object
requestHeadersPolicy	object
responseHeadersPolicy	object

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Route",
  "title": "Route",
  "type": "object",
  "description": "A single routing rule mapping request conditions to backend services.",
  "properties": {
    "conditions": {
      "type": "array",
      "description": "Match conditions for this route.",
      "items": {
        "$ref": "#/components/schemas/MatchCondition"
      }
    },
    "services": {
      "type": "array",
      "description": "Backend services to route matching requests to.",
      "items": {
        "$ref": "#/components/schemas/Service"
      }
    },
    "enableWebsockets": {
      "type": "boolean",
      "description": "If true, upgrades HTTP connections to WebSocket connections."
    },
    "permitInsecure": {
      "type": "boolean",
      "description": "If true, allows this route to respond to non-TLS requests when the parent virtual host has TLS enabled."
    },
    "retryPolicy": {
      "$ref": "#/components/schemas/RetryPolicy"
    },
    "timeoutPolicy": {
      "$ref": "#/components/schemas/TimeoutPolicy"
    },
    "rateLimitPolicy": {
      "$ref": "#/components/schemas/RateLimitPolicy"
    },
    "requestHeadersPolicy": {
      "$ref": "#/components/schemas/HeadersPolicy"
    },
    "responseHeadersPolicy": {
      "$ref": "#/components/schemas/HeadersPolicy"
    }
  }
}