homelab/traefik
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Add HealthCheck for KubernetesCRD ExternalName services

Browse source
This commit is contained in:
Marc Mognol 2024-05-30 17:18:05 +02:00 • committed by GitHub
parent c0a2e6b4b6
commit 7fc56454ea
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
13 changed files with 885 additions and 22 deletions
Download patch file Download diff file Expand all files Collapse all files

201
docs/content/reference/dynamic-configuration/kubernetes-crd-definition-v1.yml
View file

@ -98,6 +98,47 @@ spec:
description: Service defines an upstream HTTP service to proxy
traffic to.
properties:
healthCheck:
description: Healthcheck defines health checks for the
service.
properties:
followRedirects:
type: boolean
headers:
additionalProperties:
type: string
type: object
hostname:
type: string
interval:
description: |-
Duration is a custom type suitable for parsing duration values.
It supports `time.ParseDuration`-compatible values and suffix-less digits; in
the latter case, seconds are assumed.
format: int64
type: integer
method:
type: string
mode:
type: string
path:
type: string
port:
type: integer
scheme:
type: string
status:
type: integer
timeout:
description: |-
Duration is a custom type suitable for parsing duration values.
It supports `time.ParseDuration`-compatible values and suffix-less digits; in
the latter case, seconds are assumed.
format: int64
type: integer
required:
- followRedirects
type: object
kind:
description: Kind defines the kind of the Service.
enum:
@ -919,6 +960,46 @@ spec:
Service defines the reference to a Kubernetes Service that will serve the error page.
More info: https://doc.traefik.io/traefik/v3.0/middlewares/http/errorpages/#service
properties:
healthCheck:
description: Healthcheck defines health checks for the service.
properties:
followRedirects:
type: boolean
headers:
additionalProperties:
type: string
type: object
hostname:
type: string
interval:
description: |-
Duration is a custom type suitable for parsing duration values.
It supports `time.ParseDuration`-compatible values and suffix-less digits; in
the latter case, seconds are assumed.
format: int64
type: integer
method:
type: string
mode:
type: string
path:
type: string
port:
type: integer
scheme:
type: string
status:
type: integer
timeout:
description: |-
Duration is a custom type suitable for parsing duration values.
It supports `time.ParseDuration`-compatible values and suffix-less digits; in
the latter case, seconds are assumed.
format: int64
type: integer
required:
- followRedirects
type: object
kind:
description: Kind defines the kind of the Service.
enum:
@ -2295,6 +2376,46 @@ spec:
mirroring:
description: Mirroring defines the Mirroring service configuration.
properties:
healthCheck:
description: Healthcheck defines health checks for the service.
properties:
followRedirects:
type: boolean
headers:
additionalProperties:
type: string
type: object
hostname:
type: string
interval:
description: |-
Duration is a custom type suitable for parsing duration values.
It supports `time.ParseDuration`-compatible values and suffix-less digits; in
the latter case, seconds are assumed.
format: int64
type: integer
method:
type: string
mode:
type: string
path:
type: string
port:
type: integer
scheme:
type: string
status:
type: integer
timeout:
description: |-
Duration is a custom type suitable for parsing duration values.
It supports `time.ParseDuration`-compatible values and suffix-less digits; in
the latter case, seconds are assumed.
format: int64
type: integer
required:
- followRedirects
type: object
kind:
description: Kind defines the kind of the Service.
enum:
@ -2314,6 +2435,46 @@ spec:
items:
description: MirrorService holds the mirror configuration.
properties:
healthCheck:
description: Healthcheck defines health checks for the service.
properties:
followRedirects:
type: boolean
headers:
additionalProperties:
type: string
type: object
hostname:
type: string
interval:
description: |-
Duration is a custom type suitable for parsing duration values.
It supports `time.ParseDuration`-compatible values and suffix-less digits; in
the latter case, seconds are assumed.
format: int64
type: integer
method:
type: string
mode:
type: string
path:
type: string
port:
type: integer
scheme:
type: string
status:
type: integer
timeout:
description: |-
Duration is a custom type suitable for parsing duration values.
It supports `time.ParseDuration`-compatible values and suffix-less digits; in
the latter case, seconds are assumed.
format: int64
type: integer
required:
- followRedirects
type: object
kind:
description: Kind defines the kind of the Service.
enum:
@ -2548,6 +2709,46 @@ spec:
description: Service defines an upstream HTTP service to proxy
traffic to.
properties:
healthCheck:
description: Healthcheck defines health checks for the service.
properties:
followRedirects:
type: boolean
headers:
additionalProperties:
type: string
type: object
hostname:
type: string
interval:
description: |-
Duration is a custom type suitable for parsing duration values.
It supports `time.ParseDuration`-compatible values and suffix-less digits; in
the latter case, seconds are assumed.
format: int64
type: integer
method:
type: string
mode:
type: string
path:
type: string
port:
type: integer
scheme:
type: string
status:
type: integer
timeout:
description: |-
Duration is a custom type suitable for parsing duration values.
It supports `time.ParseDuration`-compatible values and suffix-less digits; in
the latter case, seconds are assumed.
format: int64
type: integer
required:
- followRedirects
type: object
kind:
description: Kind defines the kind of the Service.
enum:

41
docs/content/reference/dynamic-configuration/traefik.io_ingressroutes.yaml
View file

@ -98,6 +98,47 @@ spec:
description: Service defines an upstream HTTP service to proxy
traffic to.
properties:
healthCheck:
description: Healthcheck defines health checks for the
service.
properties:
followRedirects:
type: boolean
headers:
additionalProperties:
type: string
type: object
hostname:
type: string
interval:
description: |-
Duration is a custom type suitable for parsing duration values.
It supports `time.ParseDuration`-compatible values and suffix-less digits; in
the latter case, seconds are assumed.
format: int64
type: integer
method:
type: string
mode:
type: string
path:
type: string
port:
type: integer
scheme:
type: string
status:
type: integer
timeout:
description: |-
Duration is a custom type suitable for parsing duration values.
It supports `time.ParseDuration`-compatible values and suffix-less digits; in
the latter case, seconds are assumed.
format: int64
type: integer
required:
- followRedirects
type: object
kind:
description: Kind defines the kind of the Service.
enum:

40
docs/content/reference/dynamic-configuration/traefik.io_middlewares.yaml
View file

@ -256,6 +256,46 @@ spec:
Service defines the reference to a Kubernetes Service that will serve the error page.
More info: https://doc.traefik.io/traefik/v3.0/middlewares/http/errorpages/#service
properties:
healthCheck:
description: Healthcheck defines health checks for the service.
properties:
followRedirects:
type: boolean
headers:
additionalProperties:
type: string
type: object
hostname:
type: string
interval:
description: |-
Duration is a custom type suitable for parsing duration values.
It supports `time.ParseDuration`-compatible values and suffix-less digits; in
the latter case, seconds are assumed.
format: int64
type: integer
method:
type: string
mode:
type: string
path:
type: string
port:
type: integer
scheme:
type: string
status:
type: integer
timeout:
description: |-
Duration is a custom type suitable for parsing duration values.
It supports `time.ParseDuration`-compatible values and suffix-less digits; in
the latter case, seconds are assumed.
format: int64
type: integer
required:
- followRedirects
type: object
kind:
description: Kind defines the kind of the Service.
enum:

120
docs/content/reference/dynamic-configuration/traefik.io_traefikservices.yaml
View file

@ -47,6 +47,46 @@ spec:
mirroring:
description: Mirroring defines the Mirroring service configuration.
properties:
healthCheck:
description: Healthcheck defines health checks for the service.
properties:
followRedirects:
type: boolean
headers:
additionalProperties:
type: string
type: object
hostname:
type: string
interval:
description: |-
Duration is a custom type suitable for parsing duration values.
It supports `time.ParseDuration`-compatible values and suffix-less digits; in
the latter case, seconds are assumed.
format: int64
type: integer
method:
type: string
mode:
type: string
path:
type: string
port:
type: integer
scheme:
type: string
status:
type: integer
timeout:
description: |-
Duration is a custom type suitable for parsing duration values.
It supports `time.ParseDuration`-compatible values and suffix-less digits; in
the latter case, seconds are assumed.
format: int64
type: integer
required:
- followRedirects
type: object
kind:
description: Kind defines the kind of the Service.
enum:
@ -66,6 +106,46 @@ spec:
items:
description: MirrorService holds the mirror configuration.
properties:
healthCheck:
description: Healthcheck defines health checks for the service.
properties:
followRedirects:
type: boolean
headers:
additionalProperties:
type: string
type: object
hostname:
type: string
interval:
description: |-
Duration is a custom type suitable for parsing duration values.
It supports `time.ParseDuration`-compatible values and suffix-less digits; in
the latter case, seconds are assumed.
format: int64
type: integer
method:
type: string
mode:
type: string
path:
type: string
port:
type: integer
scheme:
type: string
status:
type: integer
timeout:
description: |-
Duration is a custom type suitable for parsing duration values.
It supports `time.ParseDuration`-compatible values and suffix-less digits; in
the latter case, seconds are assumed.
format: int64
type: integer
required:
- followRedirects
type: object
kind:
description: Kind defines the kind of the Service.
enum:
@ -300,6 +380,46 @@ spec:
description: Service defines an upstream HTTP service to proxy
traffic to.
properties:
healthCheck:
description: Healthcheck defines health checks for the service.
properties:
followRedirects:
type: boolean
headers:
additionalProperties:
type: string
type: object
hostname:
type: string
interval:
description: |-
Duration is a custom type suitable for parsing duration values.
It supports `time.ParseDuration`-compatible values and suffix-less digits; in
the latter case, seconds are assumed.
format: int64
type: integer
method:
type: string
mode:
type: string
path:
type: string
port:
type: integer
scheme:
type: string
status:
type: integer
timeout:
description: |-
Duration is a custom type suitable for parsing duration values.
It supports `time.ParseDuration`-compatible values and suffix-less digits; in
the latter case, seconds are assumed.
format: int64
type: integer
required:
- followRedirects
type: object
kind:
description: Kind defines the kind of the Service.
enum:

48
docs/content/routing/providers/kubernetes-crd.md
View file

@ -342,6 +342,9 @@ Register the `IngressRoute` [kind](../../reference/dynamic-configuration/kuberne
flushInterval: 1ms
scheme: https
serversTransport: transport # [10]
healthCheck: # [11]
path: /health
interval: 15s
sticky:
cookie:
httpOnly: true
@ -351,17 +354,17 @@ Register the `IngressRoute` [kind](../../reference/dynamic-configuration/kuberne
maxAge: 42
strategy: RoundRobin
weight: 10
nativeLB: true # [11]
nodePortLB: true # [12]
tls: # [13]
secretName: supersecret # [14]
options: # [15]
name: opt # [16]
namespace: default # [17]
certResolver: foo # [18]
domains: # [19]
- main: example.net # [20]
sans: # [21]
nativeLB: true # [12]
nodePortLB: true # [13]
tls: # [14]
secretName: supersecret # [15]
options: # [16]
name: opt # [17]
namespace: default # [18]
certResolver: foo # [19]
domains: # [20]
- main: example.net # [21]
sans: # [22]
- a.example.net
- b.example.net
```
@ -378,17 +381,18 @@ Register the `IngressRoute` [kind](../../reference/dynamic-configuration/kuberne
| [8] | `routes[n].services` | List of any combination of [TraefikService](#kind-traefikservice) and reference to a [Kubernetes service](https://kubernetes.io/docs/concepts/services-networking/service/) (See below for `ExternalName Service` setup) |
| [9] | `services[n].port` | Defines the port of a [Kubernetes service](https://kubernetes.io/docs/concepts/services-networking/service/). This can be a reference to a named port. |
| [10] | `services[n].serversTransport` | Defines the reference to a [ServersTransport](#kind-serverstransport). The ServersTransport namespace is assumed to be the [Kubernetes service](https://kubernetes.io/docs/concepts/services-networking/service/) namespace (see [ServersTransport reference](#serverstransport-reference)). |
| [11] | `services[n].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. |
| [12] | `services[n].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. |
| [13] | `tls` | Defines [TLS](../routers/index.md#tls) certificate configuration |
| [14] | `tls.secretName` | Defines the [secret](https://kubernetes.io/docs/concepts/configuration/secret/) name used to store the certificate (in the `IngressRoute` namespace) |
| [15] | `tls.options` | Defines the reference to a [TLSOption](#kind-tlsoption) |
| [16] | `options.name` | Defines the [TLSOption](#kind-tlsoption) name |
| [17] | `options.namespace` | Defines the [TLSOption](#kind-tlsoption) namespace |
| [18] | `tls.certResolver` | Defines the reference to a [CertResolver](../routers/index.md#certresolver) |
| [19] | `tls.domains` | List of [domains](../routers/index.md#domains) |
| [20] | `domains[n].main` | Defines the main domain name |
| [21] | `domains[n].sans` | List of SANs (alternative domains) |
| [11] | `services[n].healthCheck` | Defines the HealthCheck when service references a [Kubernetes service](https://kubernetes.io/docs/concepts/services-networking/service/) of type ExternalName. |
| [12] | `services[n].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. |
| [13] | `services[n].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. |
| [14] | `tls` | Defines [TLS](../routers/index.md#tls) certificate configuration |
| [15] | `tls.secretName` | Defines the [secret](https://kubernetes.io/docs/concepts/configuration/secret/) name used to store the certificate (in the `IngressRoute` namespace) |
| [16] | `tls.options` | Defines the reference to a [TLSOption](#kind-tlsoption) |
| [17] | `options.name` | Defines the [TLSOption](#kind-tlsoption) name |
| [18] | `options.namespace` | Defines the [TLSOption](#kind-tlsoption) namespace |
| [19] | `tls.certResolver` | Defines the reference to a [CertResolver](../routers/index.md#certresolver) |
| [20] | `tls.domains` | List of [domains](../routers/index.md#domains) |
| [21] | `domains[n].main` | Defines the main domain name |
| [22] | `domains[n].sans` | List of SANs (alternative domains) |
??? example "Declaring an IngressRoute"