Add documentation main, SANs and plugin CRD fields
This commit is contained in:
parent
9d61cb64a2
commit
03598d395b
8 changed files with 56 additions and 24 deletions
|
@ -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).
|
||||||
|
|
|
@ -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
|
||||||
|
|
|
@ -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
|
||||||
|
|
|
@ -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
|
||||||
|
|
|
@ -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
|
||||||
|
|
|
@ -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,6 +48,8 @@ type MiddlewareSpec struct {
|
||||||
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 defines the middleware plugin configuration.
|
||||||
|
// More info: https://doc.traefik.io/traefik/plugins/
|
||||||
Plugin map[string]apiextensionv1.JSON `json:"plugin,omitempty"`
|
Plugin map[string]apiextensionv1.JSON `json:"plugin,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
|
@ -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 defines the main domain name.
|
||||||
Main string `description:"Default subject name." json:"main,omitempty" toml:"main,omitempty" yaml:"main,omitempty"`
|
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"`
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue