ingressroute_v1alpha1.json

{
  "description": "IngressRoute is the CRD implementation of a Traefik HTTP Router.",
  "properties": {
    "apiVersion": {
      "description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources",
      "type": "string"
    },
    "kind": {
      "description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.\nCannot be updated.\nIn CamelCase.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds",
      "type": "string"
    },
    "metadata": {
      "type": "object"
    },
    "spec": {
      "description": "IngressRouteSpec defines the desired state of IngressRoute.",
      "properties": {
        "entryPoints": {
          "description": "EntryPoints defines the list of entry point names to bind to.\nEntry points have to be configured in the static configuration.\nMore info: https://doc.traefik.io/traefik/v3.2/routing/entrypoints/\nDefault: all.",
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "routes": {
          "description": "Routes defines the list of routes.",
          "items": {
            "description": "Route holds the HTTP route configuration.",
            "properties": {
              "kind": {
                "description": "Kind defines the kind of the route.\nRule is the only supported kind.",
                "enum": [
                  "Rule"
                ],
                "type": "string"
              },
              "match": {
                "description": "Match defines the router's rule.\nMore info: https://doc.traefik.io/traefik/v3.2/routing/routers/#rule",
                "type": "string"
              },
              "middlewares": {
                "description": "Middlewares defines the list of references to Middleware resources.\nMore info: https://doc.traefik.io/traefik/v3.2/routing/providers/kubernetes-crd/#kind-middleware",
                "items": {
                  "description": "MiddlewareRef is a reference to a Middleware resource.",
                  "properties": {
                    "name": {
                      "description": "Name defines the name of the referenced Middleware resource.",
                      "type": "string"
                    },
                    "namespace": {
                      "description": "Namespace defines the namespace of the referenced Middleware resource.",
                      "type": "string"
                    }
                  },
                  "required": [
                    "name"
                  ],
                  "type": "object",
                  "additionalProperties": false
                },
                "type": "array"
              },
              "priority": {
                "description": "Priority defines the router's priority.\nMore info: https://doc.traefik.io/traefik/v3.2/routing/routers/#priority",
                "type": "integer"
              },
              "services": {
                "description": "Services defines the list of Service.\nIt can contain any combination of TraefikService and/or reference to a Kubernetes Service.",
                "items": {
                  "description": "Service defines an upstream HTTP service to proxy traffic to.",
                  "properties": {
                    "healthCheck": {
                      "description": "Healthcheck defines health checks for ExternalName services.",
                      "properties": {
                        "followRedirects": {
                          "description": "FollowRedirects defines whether redirects should be followed during the health check calls.\nDefault: true",
                          "type": "boolean"
                        },
                        "headers": {
                          "additionalProperties": {
                            "type": "string"
                          },
                          "description": "Headers defines custom headers to be sent to the health check endpoint.",
                          "type": "object"
                        },
                        "hostname": {
                          "description": "Hostname defines the value of hostname in the Host header of the health check request.",
                          "type": "string"
                        },
                        "interval": {
                          "anyOf": [
                            {
                              "type": "integer"
                            },
                            {
                              "type": "string"
                            }
                          ],
                          "description": "Interval defines the frequency of the health check calls.\nDefault: 30s",
                          "x-kubernetes-int-or-string": true
                        },
                        "method": {
                          "description": "Method defines the healthcheck method.",
                          "type": "string"
                        },
                        "mode": {
                          "description": "Mode defines the health check mode.\nIf defined to grpc, will use the gRPC health check protocol to probe the server.\nDefault: http",
                          "type": "string"
                        },
                        "path": {
                          "description": "Path defines the server URL path for the health check endpoint.",
                          "type": "string"
                        },
                        "port": {
                          "description": "Port defines the server URL port for the health check endpoint.",
                          "type": "integer"
                        },
                        "scheme": {
                          "description": "Scheme replaces the server URL scheme for the health check endpoint.",
                          "type": "string"
                        },
                        "status": {
                          "description": "Status defines the expected HTTP status code of the response to the health check request.",
                          "type": "integer"
                        },
                        "timeout": {
                          "anyOf": [
                            {
                              "type": "integer"
                            },
                            {
                              "type": "string"
                            }
                          ],
                          "description": "Timeout defines the maximum duration Traefik will wait for a health check request before considering the server unhealthy.\nDefault: 5s",
                          "x-kubernetes-int-or-string": true
                        }
                      },
                      "type": "object",
                      "additionalProperties": false
                    },
                    "kind": {
                      "description": "Kind defines the kind of the Service.",
                      "enum": [
                        "Service",
                        "TraefikService"
                      ],
                      "type": "string"
                    },
                    "name": {
                      "description": "Name defines the name of the referenced Kubernetes Service or TraefikService.\nThe differentiation between the two is specified in the Kind field.",
                      "type": "string"
                    },
                    "namespace": {
                      "description": "Namespace defines the namespace of the referenced Kubernetes Service or TraefikService.",
                      "type": "string"
                    },
                    "nativeLB": {
                      "description": "NativeLB controls, when creating the load-balancer,\nwhether the LB's children are directly the pods IPs or if the only child is the Kubernetes Service clusterIP.\nThe Kubernetes Service itself does load-balance to the pods.\nBy default, NativeLB is false.",
                      "type": "boolean"
                    },
                    "nodePortLB": {
                      "description": "NodePortLB controls, when creating the load-balancer,\nwhether the LB's children are directly the nodes internal IPs using the nodePort when the service type is NodePort.\nIt allows services to be reachable when Traefik runs externally from the Kubernetes cluster but within the same network of the nodes.\nBy default, NodePortLB is false.",
                      "type": "boolean"
                    },
                    "passHostHeader": {
                      "description": "PassHostHeader defines whether the client Host header is forwarded to the upstream Kubernetes Service.\nBy default, passHostHeader is true.",
                      "type": "boolean"
                    },
                    "port": {
                      "anyOf": [
                        {
                          "type": "integer"
                        },
                        {
                          "type": "string"
                        }
                      ],
                      "description": "Port defines the port of a Kubernetes Service.\nThis can be a reference to a named port.",
                      "x-kubernetes-int-or-string": true
                    },
                    "responseForwarding": {
                      "description": "ResponseForwarding defines how Traefik forwards the response from the upstream Kubernetes Service to the client.",
                      "properties": {
                        "flushInterval": {
                          "description": "FlushInterval defines the interval, in milliseconds, in between flushes to the client while copying the response body.\nA negative value means to flush immediately after each write to the client.\nThis configuration is ignored when ReverseProxy recognizes a response as a streaming response;\nfor such responses, writes are flushed to the client immediately.\nDefault: 100ms",
                          "type": "string"
                        }
                      },
                      "type": "object",
                      "additionalProperties": false
                    },
                    "scheme": {
                      "description": "Scheme defines the scheme to use for the request to the upstream Kubernetes Service.\nIt defaults to https when Kubernetes Service port is 443, http otherwise.",
                      "type": "string"
                    },
                    "serversTransport": {
                      "description": "ServersTransport defines the name of ServersTransport resource to use.\nIt allows to configure the transport between Traefik and your servers.\nCan only be used on a Kubernetes Service.",
                      "type": "string"
                    },
                    "sticky": {
                      "description": "Sticky defines the sticky sessions configuration.\nMore info: https://doc.traefik.io/traefik/v3.2/routing/services/#sticky-sessions",
                      "properties": {
                        "cookie": {
                          "description": "Cookie defines the sticky cookie configuration.",
                          "properties": {
                            "httpOnly": {
                              "description": "HTTPOnly defines whether the cookie can be accessed by client-side APIs, such as JavaScript.",
                              "type": "boolean"
                            },
                            "maxAge": {
                              "description": "MaxAge indicates the number of seconds until the cookie expires.\nWhen set to a negative number, the cookie expires immediately.\nWhen set to zero, the cookie never expires.",
                              "type": "integer"
                            },
                            "name": {
                              "description": "Name defines the Cookie name.",
                              "type": "string"
                            },
                            "sameSite": {
                              "description": "SameSite defines the same site policy.\nMore info: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie/SameSite",
                              "type": "string"
                            },
                            "secure": {
                              "description": "Secure defines whether the cookie can only be transmitted over an encrypted connection (i.e. HTTPS).",
                              "type": "boolean"
                            }
                          },
                          "type": "object",
                          "additionalProperties": false
                        }
                      },
                      "type": "object",
                      "additionalProperties": false
                    },
                    "strategy": {
                      "description": "Strategy defines the load balancing strategy between the servers.\nRoundRobin is the only supported value at the moment.",
                      "type": "string"
                    },
                    "weight": {
                      "description": "Weight defines the weight and should only be specified when Name references a TraefikService object\n(and to be precise, one that embeds a Weighted Round Robin).",
                      "type": "integer"
                    }
                  },
                  "required": [
                    "name"
                  ],
                  "type": "object",
                  "additionalProperties": false
                },
                "type": "array"
              },
              "syntax": {
                "description": "Syntax defines the router's rule syntax.\nMore info: https://doc.traefik.io/traefik/v3.2/routing/routers/#rulesyntax",
                "type": "string"
              }
            },
            "required": [
              "kind",
              "match"
            ],
            "type": "object",
            "additionalProperties": false
          },
          "type": "array"
        },
        "tls": {
          "description": "TLS defines the TLS configuration.\nMore info: https://doc.traefik.io/traefik/v3.2/routing/routers/#tls",
          "properties": {
            "certResolver": {
              "description": "CertResolver defines the name of the certificate resolver to use.\nCert resolvers have to be configured in the static configuration.\nMore info: https://doc.traefik.io/traefik/v3.2/https/acme/#certificate-resolvers",
              "type": "string"
            },
            "domains": {
              "description": "Domains defines the list of domains that will be used to issue certificates.\nMore info: https://doc.traefik.io/traefik/v3.2/routing/routers/#domains",
              "items": {
                "description": "Domain holds a domain name with SANs.",
                "properties": {
                  "main": {
                    "description": "Main defines the main domain name.",
                    "type": "string"
                  },
                  "sans": {
                    "description": "SANs defines the subject alternative domain names.",
                    "items": {
                      "type": "string"
                    },
                    "type": "array"
                  }
                },
                "type": "object",
                "additionalProperties": false
              },
              "type": "array"
            },
            "options": {
              "description": "Options defines the reference to a TLSOption, that specifies the parameters of the TLS connection.\nIf not defined, the `default` TLSOption is used.\nMore info: https://doc.traefik.io/traefik/v3.2/https/tls/#tls-options",
              "properties": {
                "name": {
                  "description": "Name defines the name of the referenced TLSOption.\nMore info: https://doc.traefik.io/traefik/v3.2/routing/providers/kubernetes-crd/#kind-tlsoption",
                  "type": "string"
                },
                "namespace": {
                  "description": "Namespace defines the namespace of the referenced TLSOption.\nMore info: https://doc.traefik.io/traefik/v3.2/routing/providers/kubernetes-crd/#kind-tlsoption",
                  "type": "string"
                }
              },
              "required": [
                "name"
              ],
              "type": "object",
              "additionalProperties": false
            },
            "secretName": {
              "description": "SecretName is the name of the referenced Kubernetes Secret to specify the certificate details.",
              "type": "string"
            },
            "store": {
              "description": "Store defines the reference to the TLSStore, that will be used to store certificates.\nPlease note that only `default` TLSStore can be used.",
              "properties": {
                "name": {
                  "description": "Name defines the name of the referenced TLSStore.\nMore info: https://doc.traefik.io/traefik/v3.2/routing/providers/kubernetes-crd/#kind-tlsstore",
                  "type": "string"
                },
                "namespace": {
                  "description": "Namespace defines the namespace of the referenced TLSStore.\nMore info: https://doc.traefik.io/traefik/v3.2/routing/providers/kubernetes-crd/#kind-tlsstore",
                  "type": "string"
                }
              },
              "required": [
                "name"
              ],
              "type": "object",
              "additionalProperties": false
            }
          },
          "type": "object",
          "additionalProperties": false
        }
      },
      "required": [
        "routes"
      ],
      "type": "object",
      "additionalProperties": false
    }
  },
  "required": [
    "metadata",
    "spec"
  ],
  "type": "object"
}