OpenShift · Schema

RouteSpec

Desired state of the Route resource.

CI/CDCloud NativeContainersDevOpsEnterpriseKubernetesPaaS

Properties

Name	Type	Description
host	string	The desired hostname for the route. If not specified, a hostname is generated by the router.
path	string	The path that the router watches to route traffic to the service. Only used for path-based routing with edge or re-encrypt TLS termination.
subdomain	string	A DNS subdomain request. If set, the route hostname is composed using this value and the ingress domain.
to	object
alternateBackends	array	Up to 3 additional backends for A/B testing. Traffic is split among the backends according to their weights.
port	object
tls	object
wildcardPolicy	string	The wildcard policy for the hostname. None disallows wildcard routes, Subdomain allows wildcard routes with subdomains.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/RouteSpec",
  "title": "RouteSpec",
  "type": "object",
  "description": "Desired state of the Route resource.",
  "required": [
    "to"
  ],
  "properties": {
    "host": {
      "type": "string",
      "description": "The desired hostname for the route. If not specified, a hostname is generated by the router.",
      "example": "myapp.apps.openshift.example.com"
    },
    "path": {
      "type": "string",
      "description": "The path that the router watches to route traffic to the service. Only used for path-based routing with edge or re-encrypt TLS termination.",
      "example": "/api"
    },
    "subdomain": {
      "type": "string",
      "description": "A DNS subdomain request. If set, the route hostname is composed using this value and the ingress domain.",
      "example": "example_value"
    },
    "to": {
      "$ref": "#/components/schemas/RouteTargetReference"
    },
    "alternateBackends": {
      "type": "array",
      "description": "Up to 3 additional backends for A/B testing. Traffic is split among the backends according to their weights.",
      "items": {
        "$ref": "#/components/schemas/RouteTargetReference"
      },
      "maxItems": 3,
      "example": []
    },
    "port": {
      "$ref": "#/components/schemas/RoutePort"
    },
    "tls": {
      "$ref": "#/components/schemas/TLSConfig"
    },
    "wildcardPolicy": {
      "type": "string",
      "description": "The wildcard policy for the hostname. None disallows wildcard routes, Subdomain allows wildcard routes with subdomains.",
      "enum": [
        "None",
        "Subdomain"
      ],
      "default": "None",
      "example": "None"
    }
  }
}