2023-03-20 14:38:08 +00:00
|
|
|
---
|
|
|
|
|
apiVersion: apiextensions.k8s.io/v1
|
|
|
|
|
kind: CustomResourceDefinition
|
|
|
|
|
metadata:
|
|
|
|
|
annotations:
|
2024-02-07 16:14:07 +00:00
|
|
|
controller-gen.kubebuilder.io/version: v0.14.0
|
2023-03-20 14:38:08 +00:00
|
|
|
name: ingressroutes.traefik.io
|
|
|
|
|
spec:
|
|
|
|
|
group: traefik.io
|
|
|
|
|
names:
|
|
|
|
|
kind: IngressRoute
|
|
|
|
|
listKind: IngressRouteList
|
|
|
|
|
plural: ingressroutes
|
|
|
|
|
singular: ingressroute
|
|
|
|
|
scope: Namespaced
|
|
|
|
|
versions:
|
|
|
|
|
- name: v1alpha1
|
|
|
|
|
schema:
|
|
|
|
|
openAPIV3Schema:
|
|
|
|
|
description: IngressRoute is the CRD implementation of a Traefik HTTP Router.
|
|
|
|
|
properties:
|
|
|
|
|
apiVersion:
|
2024-02-07 16:14:07 +00:00
|
|
|
description: |-
|
|
|
|
|
APIVersion defines the versioned schema of this representation of an object.
|
|
|
|
|
Servers should convert recognized schemas to the latest internal value, and
|
|
|
|
|
may reject unrecognized values.
|
|
|
|
|
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
|
2023-03-20 14:38:08 +00:00
|
|
|
type: string
|
|
|
|
|
kind:
|
2024-02-07 16:14:07 +00:00
|
|
|
description: |-
|
|
|
|
|
Kind is a string value representing the REST resource this object represents.
|
|
|
|
|
Servers may infer this from the endpoint the client submits requests to.
|
|
|
|
|
Cannot be updated.
|
|
|
|
|
In CamelCase.
|
|
|
|
|
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
|
2023-03-20 14:38:08 +00:00
|
|
|
type: string
|
|
|
|
|
metadata:
|
|
|
|
|
type: object
|
|
|
|
|
spec:
|
|
|
|
|
description: IngressRouteSpec defines the desired state of IngressRoute.
|
|
|
|
|
properties:
|
|
|
|
|
entryPoints:
|
2024-02-07 16:14:07 +00:00
|
|
|
description: |-
|
|
|
|
|
EntryPoints defines the list of entry point names to bind to.
|
|
|
|
|
Entry points have to be configured in the static configuration.
|
2023-03-21 11:00:46 +00:00
|
|
|
More info: https://doc.traefik.io/traefik/v3.0/routing/entrypoints/
|
2024-02-07 16:14:07 +00:00
|
|
|
Default: all.
|
2023-03-20 14:38:08 +00:00
|
|
|
items:
|
|
|
|
|
type: string
|
|
|
|
|
type: array
|
|
|
|
|
routes:
|
|
|
|
|
description: Routes defines the list of routes.
|
|
|
|
|
items:
|
|
|
|
|
description: Route holds the HTTP route configuration.
|
|
|
|
|
properties:
|
|
|
|
|
kind:
|
2024-02-07 16:14:07 +00:00
|
|
|
description: |-
|
|
|
|
|
Kind defines the kind of the route.
|
|
|
|
|
Rule is the only supported kind.
|
2023-03-20 14:38:08 +00:00
|
|
|
enum:
|
|
|
|
|
- Rule
|
|
|
|
|
type: string
|
|
|
|
|
match:
|
2024-02-07 16:14:07 +00:00
|
|
|
description: |-
|
|
|
|
|
Match defines the router's rule.
|
2024-02-08 13:15:45 +00:00
|
|
|
More info: https://doc.traefik.io/traefik/v3.0/routing/routers/#rule
|
2023-03-20 14:38:08 +00:00
|
|
|
type: string
|
|
|
|
|
middlewares:
|
2024-02-07 16:14:07 +00:00
|
|
|
description: |-
|
|
|
|
|
Middlewares defines the list of references to Middleware resources.
|
2024-02-08 13:15:45 +00:00
|
|
|
More info: https://doc.traefik.io/traefik/v3.0/routing/providers/kubernetes-crd/#kind-middleware
|
2023-03-20 14:38:08 +00:00
|
|
|
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
|
|
|
|
|
type: array
|
|
|
|
|
priority:
|
2024-02-07 16:14:07 +00:00
|
|
|
description: |-
|
|
|
|
|
Priority defines the router's priority.
|
2024-02-08 13:15:45 +00:00
|
|
|
More info: https://doc.traefik.io/traefik/v3.0/routing/routers/#priority
|
2023-03-20 14:38:08 +00:00
|
|
|
type: integer
|
|
|
|
|
services:
|
2024-02-07 16:14:07 +00:00
|
|
|
description: |-
|
|
|
|
|
Services defines the list of Service.
|
|
|
|
|
It can contain any combination of TraefikService and/or reference to a Kubernetes Service.
|
2023-03-20 14:38:08 +00:00
|
|
|
items:
|
|
|
|
|
description: Service defines an upstream HTTP service to proxy
|
|
|
|
|
traffic to.
|
|
|
|
|
properties:
|
2024-05-30 15:18:05 +00:00
|
|
|
healthCheck:
|
2024-06-04 07:32:04 +00:00
|
|
|
description: Healthcheck defines health checks for ExternalName
|
|
|
|
|
services.
|
2024-05-30 15:18:05 +00:00
|
|
|
properties:
|
|
|
|
|
followRedirects:
|
2024-06-04 07:32:04 +00:00
|
|
|
description: |-
|
|
|
|
|
FollowRedirects defines whether redirects should be followed during the health check calls.
|
|
|
|
|
Default: true
|
2024-05-30 15:18:05 +00:00
|
|
|
type: boolean
|
|
|
|
|
headers:
|
|
|
|
|
additionalProperties:
|
|
|
|
|
type: string
|
2024-06-04 07:32:04 +00:00
|
|
|
description: Headers defines custom headers to be
|
|
|
|
|
sent to the health check endpoint.
|
2024-05-30 15:18:05 +00:00
|
|
|
type: object
|
|
|
|
|
hostname:
|
2024-06-04 07:32:04 +00:00
|
|
|
description: Hostname defines the value of hostname
|
|
|
|
|
in the Host header of the health check request.
|
2024-05-30 15:18:05 +00:00
|
|
|
type: string
|
|
|
|
|
interval:
|
2024-06-04 07:32:04 +00:00
|
|
|
anyOf:
|
|
|
|
|
- type: integer
|
|
|
|
|
- type: string
|
2024-05-30 15:18:05 +00:00
|
|
|
description: |-
|
2024-06-04 07:32:04 +00:00
|
|
|
Interval defines the frequency of the health check calls.
|
|
|
|
|
Default: 30s
|
|
|
|
|
x-kubernetes-int-or-string: true
|
2024-05-30 15:18:05 +00:00
|
|
|
method:
|
2024-06-04 07:32:04 +00:00
|
|
|
description: Method defines the healthcheck method.
|
2024-05-30 15:18:05 +00:00
|
|
|
type: string
|
|
|
|
|
mode:
|
2024-06-04 07:32:04 +00:00
|
|
|
description: |-
|
|
|
|
|
Mode defines the health check mode.
|
|
|
|
|
If defined to grpc, will use the gRPC health check protocol to probe the server.
|
|
|
|
|
Default: http
|
2024-05-30 15:18:05 +00:00
|
|
|
type: string
|
|
|
|
|
path:
|
2024-06-04 07:32:04 +00:00
|
|
|
description: Path defines the server URL path for
|
|
|
|
|
the health check endpoint.
|
2024-05-30 15:18:05 +00:00
|
|
|
type: string
|
|
|
|
|
port:
|
2024-06-04 07:32:04 +00:00
|
|
|
description: Port defines the server URL port for
|
|
|
|
|
the health check endpoint.
|
2024-05-30 15:18:05 +00:00
|
|
|
type: integer
|
|
|
|
|
scheme:
|
2024-06-04 07:32:04 +00:00
|
|
|
description: Scheme replaces the server URL scheme
|
|
|
|
|
for the health check endpoint.
|
2024-05-30 15:18:05 +00:00
|
|
|
type: string
|
|
|
|
|
status:
|
2024-06-04 07:32:04 +00:00
|
|
|
description: Status defines the expected HTTP status
|
|
|
|
|
code of the response to the health check request.
|
2024-05-30 15:18:05 +00:00
|
|
|
type: integer
|
|
|
|
|
timeout:
|
2024-06-04 07:32:04 +00:00
|
|
|
anyOf:
|
|
|
|
|
- type: integer
|
|
|
|
|
- type: string
|
2024-05-30 15:18:05 +00:00
|
|
|
description: |-
|
2024-06-04 07:32:04 +00:00
|
|
|
Timeout defines the maximum duration Traefik will wait for a health check request before considering the server unhealthy.
|
|
|
|
|
Default: 5s
|
|
|
|
|
x-kubernetes-int-or-string: true
|
2024-05-30 15:18:05 +00:00
|
|
|
type: object
|
2023-03-20 14:38:08 +00:00
|
|
|
kind:
|
|
|
|
|
description: Kind defines the kind of the Service.
|
|
|
|
|
enum:
|
|
|
|
|
- Service
|
|
|
|
|
- TraefikService
|
|
|
|
|
type: string
|
|
|
|
|
name:
|
2024-02-07 16:14:07 +00:00
|
|
|
description: |-
|
|
|
|
|
Name defines the name of the referenced Kubernetes Service or TraefikService.
|
|
|
|
|
The differentiation between the two is specified in the Kind field.
|
2023-03-20 14:38:08 +00:00
|
|
|
type: string
|
|
|
|
|
namespace:
|
|
|
|
|
description: Namespace defines the namespace of the referenced
|
|
|
|
|
Kubernetes Service or TraefikService.
|
|
|
|
|
type: string
|
2023-03-20 15:46:05 +00:00
|
|
|
nativeLB:
|
2024-02-07 16:14:07 +00:00
|
|
|
description: |-
|
|
|
|
|
NativeLB controls, when creating the load-balancer,
|
|
|
|
|
whether the LB's children are directly the pods IPs or if the only child is the Kubernetes Service clusterIP.
|
|
|
|
|
The Kubernetes Service itself does load-balance to the pods.
|
|
|
|
|
By default, NativeLB is false.
|
2023-03-20 15:46:05 +00:00
|
|
|
type: boolean
|
2024-02-27 09:54:04 +00:00
|
|
|
nodePortLB:
|
|
|
|
|
description: |-
|
|
|
|
|
NodePortLB controls, when creating the load-balancer,
|
|
|
|
|
whether the LB's children are directly the nodes internal IPs using the nodePort when the service type is NodePort.
|
|
|
|
|
It allows services to be reachable when Traefik runs externally from the Kubernetes cluster but within the same network of the nodes.
|
|
|
|
|
By default, NodePortLB is false.
|
|
|
|
|
type: boolean
|
2023-03-20 14:38:08 +00:00
|
|
|
passHostHeader:
|
2024-02-07 16:14:07 +00:00
|
|
|
description: |-
|
|
|
|
|
PassHostHeader defines whether the client Host header is forwarded to the upstream Kubernetes Service.
|
|
|
|
|
By default, passHostHeader is true.
|
2023-03-20 14:38:08 +00:00
|
|
|
type: boolean
|
|
|
|
|
port:
|
|
|
|
|
anyOf:
|
|
|
|
|
- type: integer
|
|
|
|
|
- type: string
|
2024-02-07 16:14:07 +00:00
|
|
|
description: |-
|
|
|
|
|
Port defines the port of a Kubernetes Service.
|
2023-03-20 14:38:08 +00:00
|
|
|
This 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:
|
2024-02-07 16:14:07 +00:00
|
|
|
description: |-
|
|
|
|
|
FlushInterval defines the interval, in milliseconds, in between flushes to the client while copying the response body.
|
|
|
|
|
A negative value means to flush immediately after each write to the client.
|
|
|
|
|
This configuration is ignored when ReverseProxy recognizes a response as a streaming response;
|
|
|
|
|
for such responses, writes are flushed to the client immediately.
|
|
|
|
|
Default: 100ms
|
2023-03-20 14:38:08 +00:00
|
|
|
type: string
|
|
|
|
|
type: object
|
|
|
|
|
scheme:
|
2024-02-07 16:14:07 +00:00
|
|
|
description: |-
|
|
|
|
|
Scheme defines the scheme to use for the request to the upstream Kubernetes Service.
|
|
|
|
|
It defaults to https when Kubernetes Service port is 443, http otherwise.
|
2023-03-20 14:38:08 +00:00
|
|
|
type: string
|
|
|
|
|
serversTransport:
|
2024-02-07 16:14:07 +00:00
|
|
|
description: |-
|
|
|
|
|
ServersTransport defines the name of ServersTransport resource to use.
|
|
|
|
|
It allows to configure the transport between Traefik and your servers.
|
|
|
|
|
Can only be used on a Kubernetes Service.
|
2023-03-20 14:38:08 +00:00
|
|
|
type: string
|
|
|
|
|
sticky:
|
2024-02-07 16:14:07 +00:00
|
|
|
description: |-
|
|
|
|
|
Sticky defines the sticky sessions configuration.
|
2024-02-08 13:15:45 +00:00
|
|
|
More info: https://doc.traefik.io/traefik/v3.0/routing/services/#sticky-sessions
|
2023-03-20 14:38:08 +00:00
|
|
|
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
|
2024-01-18 08:30:06 +00:00
|
|
|
maxAge:
|
2024-02-08 13:15:45 +00:00
|
|
|
description: |-
|
|
|
|
|
MaxAge indicates the number of seconds until the cookie expires.
|
|
|
|
|
When set to a negative number, the cookie expires immediately.
|
|
|
|
|
When set to zero, the cookie never expires.
|
2024-01-18 08:30:06 +00:00
|
|
|
type: integer
|
2023-03-20 14:38:08 +00:00
|
|
|
name:
|
|
|
|
|
description: Name defines the Cookie name.
|
|
|
|
|
type: string
|
|
|
|
|
sameSite:
|
2024-02-07 16:14:07 +00:00
|
|
|
description: |-
|
|
|
|
|
SameSite defines the same site policy.
|
|
|
|
|
More info: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie/SameSite
|
2023-03-20 14:38:08 +00:00
|
|
|
type: string
|
|
|
|
|
secure:
|
|
|
|
|
description: Secure defines whether the cookie
|
|
|
|
|
can only be transmitted over an encrypted connection
|
|
|
|
|
(i.e. HTTPS).
|
|
|
|
|
type: boolean
|
|
|
|
|
type: object
|
|
|
|
|
type: object
|
|
|
|
|
strategy:
|
2024-02-07 16:14:07 +00:00
|
|
|
description: |-
|
|
|
|
|
Strategy defines the load balancing strategy between the servers.
|
|
|
|
|
RoundRobin is the only supported value at the moment.
|
2023-03-20 14:38:08 +00:00
|
|
|
type: string
|
|
|
|
|
weight:
|
2024-02-07 16:14:07 +00:00
|
|
|
description: |-
|
|
|
|
|
Weight defines the weight and should only be specified when Name references a TraefikService object
|
|
|
|
|
(and to be precise, one that embeds a Weighted Round Robin).
|
2023-03-20 14:38:08 +00:00
|
|
|
type: integer
|
|
|
|
|
required:
|
|
|
|
|
- name
|
|
|
|
|
type: object
|
|
|
|
|
type: array
|
2024-01-23 10:34:05 +00:00
|
|
|
syntax:
|
2024-02-08 13:15:45 +00:00
|
|
|
description: |-
|
|
|
|
|
Syntax defines the router's rule syntax.
|
|
|
|
|
More info: https://doc.traefik.io/traefik/v3.0/routing/routers/#rulesyntax
|
2024-01-23 10:34:05 +00:00
|
|
|
type: string
|
2023-03-20 14:38:08 +00:00
|
|
|
required:
|
|
|
|
|
- kind
|
|
|
|
|
- match
|
|
|
|
|
type: object
|
|
|
|
|
type: array
|
|
|
|
|
tls:
|
2024-02-07 16:14:07 +00:00
|
|
|
description: |-
|
|
|
|
|
TLS defines the TLS configuration.
|
2024-02-08 13:15:45 +00:00
|
|
|
More info: https://doc.traefik.io/traefik/v3.0/routing/routers/#tls
|
2023-03-20 14:38:08 +00:00
|
|
|
properties:
|
|
|
|
|
certResolver:
|
2024-02-07 16:14:07 +00:00
|
|
|
description: |-
|
|
|
|
|
CertResolver defines the name of the certificate resolver to use.
|
|
|
|
|
Cert resolvers have to be configured in the static configuration.
|
2024-02-08 13:15:45 +00:00
|
|
|
More info: https://doc.traefik.io/traefik/v3.0/https/acme/#certificate-resolvers
|
2023-03-20 14:38:08 +00:00
|
|
|
type: string
|
|
|
|
|
domains:
|
2024-02-07 16:14:07 +00:00
|
|
|
description: |-
|
|
|
|
|
Domains defines the list of domains that will be used to issue certificates.
|
2024-02-08 13:15:45 +00:00
|
|
|
More info: https://doc.traefik.io/traefik/v3.0/routing/routers/#domains
|
2023-03-20 14:38:08 +00:00
|
|
|
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
|
|
|
|
|
type: array
|
|
|
|
|
options:
|
2024-02-07 16:14:07 +00:00
|
|
|
description: |-
|
|
|
|
|
Options defines the reference to a TLSOption, that specifies the parameters of the TLS connection.
|
|
|
|
|
If not defined, the `default` TLSOption is used.
|
2024-02-08 13:15:45 +00:00
|
|
|
More info: https://doc.traefik.io/traefik/v3.0/https/tls/#tls-options
|
2023-03-20 14:38:08 +00:00
|
|
|
properties:
|
|
|
|
|
name:
|
2024-02-07 16:14:07 +00:00
|
|
|
description: |-
|
|
|
|
|
Name defines the name of the referenced TLSOption.
|
2024-02-08 13:15:45 +00:00
|
|
|
More info: https://doc.traefik.io/traefik/v3.0/routing/providers/kubernetes-crd/#kind-tlsoption
|
2023-03-20 14:38:08 +00:00
|
|
|
type: string
|
|
|
|
|
namespace:
|
2024-02-07 16:14:07 +00:00
|
|
|
description: |-
|
|
|
|
|
Namespace defines the namespace of the referenced TLSOption.
|
2024-02-08 13:15:45 +00:00
|
|
|
More info: https://doc.traefik.io/traefik/v3.0/routing/providers/kubernetes-crd/#kind-tlsoption
|
2023-03-20 14:38:08 +00:00
|
|
|
type: string
|
|
|
|
|
required:
|
|
|
|
|
- name
|
|
|
|
|
type: object
|
|
|
|
|
secretName:
|
|
|
|
|
description: SecretName is the name of the referenced Kubernetes
|
|
|
|
|
Secret to specify the certificate details.
|
|
|
|
|
type: string
|
|
|
|
|
store:
|
2024-02-07 16:14:07 +00:00
|
|
|
description: |-
|
|
|
|
|
Store defines the reference to the TLSStore, that will be used to store certificates.
|
|
|
|
|
Please note that only `default` TLSStore can be used.
|
2023-03-20 14:38:08 +00:00
|
|
|
properties:
|
|
|
|
|
name:
|
2024-02-07 16:14:07 +00:00
|
|
|
description: |-
|
|
|
|
|
Name defines the name of the referenced TLSStore.
|
2024-02-08 13:15:45 +00:00
|
|
|
More info: https://doc.traefik.io/traefik/v3.0/routing/providers/kubernetes-crd/#kind-tlsstore
|
2023-03-20 14:38:08 +00:00
|
|
|
type: string
|
|
|
|
|
namespace:
|
2024-02-07 16:14:07 +00:00
|
|
|
description: |-
|
|
|
|
|
Namespace defines the namespace of the referenced TLSStore.
|
2024-02-08 13:15:45 +00:00
|
|
|
More info: https://doc.traefik.io/traefik/v3.0/routing/providers/kubernetes-crd/#kind-tlsstore
|
2023-03-20 14:38:08 +00:00
|
|
|
type: string
|
|
|
|
|
required:
|
|
|
|
|
- name
|
|
|
|
|
type: object
|
|
|
|
|
type: object
|
|
|
|
|
required:
|
|
|
|
|
- routes
|
|
|
|
|
type: object
|
|
|
|
|
required:
|
|
|
|
|
- metadata
|
|
|
|
|
- spec
|
|
|
|
|
type: object
|
|
|
|
|
served: true
|
|
|
|
|
storage: true
|
