Contour · Schema

Service

A backend Kubernetes service to route traffic to.

EnvoyIngress ControllerKubernetesNetworkingProxy

Properties

Name Type Description
name string Name of the Kubernetes Service.
port integer Port number of the Kubernetes Service.
weight integer Relative weight for traffic distribution when multiple services are specified. Defaults to 1.
healthPort integer Port to use for health checking, if different from the service port.
protocol string Protocol to use when connecting to the service.
View JSON Schema on GitHub

JSON Schema

contour-service-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Service",
  "title": "Service",
  "type": "object",
  "description": "A backend Kubernetes service to route traffic to.",
  "required": [
    "name",
    "port"
  ],
  "properties": {
    "name": {
      "type": "string",
      "description": "Name of the Kubernetes Service."
    },
    "port": {
      "type": "integer",
      "description": "Port number of the Kubernetes Service.",
      "minimum": 1,
      "maximum": 65535
    },
    "weight": {
      "type": "integer",
      "description": "Relative weight for traffic distribution when multiple services are specified. Defaults to 1.",
      "minimum": 0
    },
    "healthPort": {
      "type": "integer",
      "description": "Port to use for health checking, if different from the service port."
    },
    "protocol": {
      "type": "string",
      "description": "Protocol to use when connecting to the service.",
      "enum": [
        "h2",
        "h2c",
        "tls"
      ]
    }
  }
}