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

Add documentation main, SANs and plugin CRD fields

Browse source
This commit is contained in:
mloiseleur 2022-06-29 11:04:09 +02:00 committed by GitHub
parent 9d61cb64a2
commit 03598d395b
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
8 changed files with 56 additions and 24 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
docs/content/middlewares/http/overview.md
View file

@ -153,3 +153,7 @@ http:
| [Retry](retry.md) | Automatically retries in case of error | Request lifecycle | | [Retry](retry.md) | Automatically retries in case of error | Request lifecycle |
| [StripPrefix](stripprefix.md) | Changes the path of the request | Path Modifier | | [StripPrefix](stripprefix.md) | Changes the path of the request | Path Modifier |
| [StripPrefixRegex](stripprefixregex.md) | Changes the path of the request | Path Modifier | | [StripPrefixRegex](stripprefixregex.md) | Changes the path of the request | Path Modifier |
## Community Middlewares
Please take a look at the community-contributed plugins in the [plugin catalog](https://pilot.traefik.io/plugins).

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

@ -204,8 +204,11 @@ spec:
description: Domain holds a domain name with SANs. description: Domain holds a domain name with SANs.
properties: properties:
main: main:
description: Main defines the main domain name.
type: string type: string
sans: sans:
description: SANs defines the subject alternative domain
names.
items: items:
type: string type: string
type: array type: array
@ -408,8 +411,11 @@ spec:
description: Domain holds a domain name with SANs. description: Domain holds a domain name with SANs.
properties: properties:
main: main:
description: Main defines the main domain name.
type: string type: string
sans: sans:
description: SANs defines the subject alternative domain
names.
items: items:
type: string type: string
type: array type: array
@ -1282,6 +1288,8 @@ spec:
plugin: plugin:
additionalProperties: additionalProperties:
x-kubernetes-preserve-unknown-fields: true x-kubernetes-preserve-unknown-fields: true
description: 'Plugin defines the middleware plugin configuration.
More info: https://doc.traefik.io/traefik/plugins/'
type: object type: object
rateLimit: rateLimit:
description: 'RateLimit holds the rate limit configuration. This middleware description: 'RateLimit holds the rate limit configuration. This middleware

3
docs/content/reference/dynamic-configuration/traefik.containo.us_ingressroutes.yaml
View file

@ -204,8 +204,11 @@ spec:
description: Domain holds a domain name with SANs. description: Domain holds a domain name with SANs.
properties: properties:
main: main:
description: Main defines the main domain name.
type: string type: string
sans: sans:
description: SANs defines the subject alternative domain
names.
items: items:
type: string type: string
type: array type: array

3
docs/content/reference/dynamic-configuration/traefik.containo.us_ingressroutetcps.yaml
View file

@ -143,8 +143,11 @@ spec:
description: Domain holds a domain name with SANs. description: Domain holds a domain name with SANs.
properties: properties:
main: main:
description: Main defines the main domain name.
type: string type: string
sans: sans:
description: SANs defines the subject alternative domain
names.
items: items:
type: string type: string
type: array type: array

2
docs/content/reference/dynamic-configuration/traefik.containo.us_middlewares.yaml
View file

@ -711,6 +711,8 @@ spec:
plugin: plugin:
additionalProperties: additionalProperties:
x-kubernetes-preserve-unknown-fields: true x-kubernetes-preserve-unknown-fields: true
description: 'Plugin defines the middleware plugin configuration.
More info: https://doc.traefik.io/traefik/plugins/'
type: object type: object
rateLimit: rateLimit:
description: 'RateLimit holds the rate limit configuration. This middleware description: 'RateLimit holds the rate limit configuration. This middleware

8
integration/fixtures/k8s/01-traefik-crd.yml
View file

@ -204,8 +204,11 @@ spec:
description: Domain holds a domain name with SANs. description: Domain holds a domain name with SANs.
properties: properties:
main: main:
description: Main defines the main domain name.
type: string type: string
sans: sans:
description: SANs defines the subject alternative domain
names.
items: items:
type: string type: string
type: array type: array
@ -408,8 +411,11 @@ spec:
description: Domain holds a domain name with SANs. description: Domain holds a domain name with SANs.
properties: properties:
main: main:
description: Main defines the main domain name.
type: string type: string
sans: sans:
description: SANs defines the subject alternative domain
names.
items: items:
type: string type: string
type: array type: array
@ -1282,6 +1288,8 @@ spec:
plugin: plugin:
additionalProperties: additionalProperties:
x-kubernetes-preserve-unknown-fields: true x-kubernetes-preserve-unknown-fields: true
description: 'Plugin defines the middleware plugin configuration.
More info: https://doc.traefik.io/traefik/plugins/'
type: object type: object
rateLimit: rateLimit:
description: 'RateLimit holds the rate limit configuration. This middleware description: 'RateLimit holds the rate limit configuration. This middleware

48
pkg/provider/kubernetes/crd/traefik/v1alpha1/middleware.go
View file

@ -26,29 +26,31 @@ type Middleware struct {
// MiddlewareSpec defines the desired state of a Middleware. // MiddlewareSpec defines the desired state of a Middleware.
type MiddlewareSpec struct { type MiddlewareSpec struct {
AddPrefix *dynamic.AddPrefix `json:"addPrefix,omitempty"` AddPrefix *dynamic.AddPrefix `json:"addPrefix,omitempty"`
StripPrefix *dynamic.StripPrefix `json:"stripPrefix,omitempty"` StripPrefix *dynamic.StripPrefix `json:"stripPrefix,omitempty"`
StripPrefixRegex *dynamic.StripPrefixRegex `json:"stripPrefixRegex,omitempty"` StripPrefixRegex *dynamic.StripPrefixRegex `json:"stripPrefixRegex,omitempty"`
ReplacePath *dynamic.ReplacePath `json:"replacePath,omitempty"` ReplacePath *dynamic.ReplacePath `json:"replacePath,omitempty"`
ReplacePathRegex *dynamic.ReplacePathRegex `json:"replacePathRegex,omitempty"` ReplacePathRegex *dynamic.ReplacePathRegex `json:"replacePathRegex,omitempty"`
Chain *Chain `json:"chain,omitempty"` Chain *Chain `json:"chain,omitempty"`
IPWhiteList *dynamic.IPWhiteList `json:"ipWhiteList,omitempty"` IPWhiteList *dynamic.IPWhiteList `json:"ipWhiteList,omitempty"`
Headers *dynamic.Headers `json:"headers,omitempty"` Headers *dynamic.Headers `json:"headers,omitempty"`
Errors *ErrorPage `json:"errors,omitempty"` Errors *ErrorPage `json:"errors,omitempty"`
RateLimit *RateLimit `json:"rateLimit,omitempty"` RateLimit *RateLimit `json:"rateLimit,omitempty"`
RedirectRegex *dynamic.RedirectRegex `json:"redirectRegex,omitempty"` RedirectRegex *dynamic.RedirectRegex `json:"redirectRegex,omitempty"`
RedirectScheme *dynamic.RedirectScheme `json:"redirectScheme,omitempty"` RedirectScheme *dynamic.RedirectScheme `json:"redirectScheme,omitempty"`
BasicAuth *BasicAuth `json:"basicAuth,omitempty"` BasicAuth *BasicAuth `json:"basicAuth,omitempty"`
DigestAuth *DigestAuth `json:"digestAuth,omitempty"` DigestAuth *DigestAuth `json:"digestAuth,omitempty"`
ForwardAuth *ForwardAuth `json:"forwardAuth,omitempty"` ForwardAuth *ForwardAuth `json:"forwardAuth,omitempty"`
InFlightReq *dynamic.InFlightReq `json:"inFlightReq,omitempty"` InFlightReq *dynamic.InFlightReq `json:"inFlightReq,omitempty"`
Buffering *dynamic.Buffering `json:"buffering,omitempty"` Buffering *dynamic.Buffering `json:"buffering,omitempty"`
CircuitBreaker *dynamic.CircuitBreaker `json:"circuitBreaker,omitempty"` CircuitBreaker *dynamic.CircuitBreaker `json:"circuitBreaker,omitempty"`
Compress *dynamic.Compress `json:"compress,omitempty"` Compress *dynamic.Compress `json:"compress,omitempty"`
PassTLSClientCert *dynamic.PassTLSClientCert `json:"passTLSClientCert,omitempty"` PassTLSClientCert *dynamic.PassTLSClientCert `json:"passTLSClientCert,omitempty"`
Retry *Retry `json:"retry,omitempty"` Retry *Retry `json:"retry,omitempty"`
ContentType *dynamic.ContentType `json:"contentType,omitempty"` ContentType *dynamic.ContentType `json:"contentType,omitempty"`
Plugin map[string]apiextensionv1.JSON `json:"plugin,omitempty"` // Plugin defines the middleware plugin configuration.
// More info: https://doc.traefik.io/traefik/plugins/
Plugin map[string]apiextensionv1.JSON `json:"plugin,omitempty"`
} }
// +k8s:deepcopy-gen=true // +k8s:deepcopy-gen=true

4
pkg/types/domains.go
View file

@ -8,7 +8,9 @@ import (
// Domain holds a domain name with SANs. // Domain holds a domain name with SANs.
type Domain struct { type Domain struct {
Main string `description:"Default subject name." json:"main,omitempty" toml:"main,omitempty" yaml:"main,omitempty"` // Main defines the main domain name.
Main string `description:"Default subject name." json:"main,omitempty" toml:"main,omitempty" yaml:"main,omitempty"`
// SANs defines the subject alternative domain names.
SANs []string `description:"Subject alternative names." json:"sans,omitempty" toml:"sans,omitempty" yaml:"sans,omitempty"` SANs []string `description:"Subject alternative names." json:"sans,omitempty" toml:"sans,omitempty" yaml:"sans,omitempty"`
} }