Documentation ¶
Overview ¶
Package v1alpha1 is the v1alpha1 version of the API. +groupName=traefik.containo.us
Index ¶
- Constants
- Variables
- func Kind(kind string) schema.GroupKind
- func Resource(resource string) schema.GroupResource
- type ClientCA
- type HealthCheck
- type IngressRoute
- type IngressRouteList
- type IngressRouteSpec
- type IngressRouteTCP
- type IngressRouteTCPList
- type IngressRouteTCPSpec
- type Middleware
- type MiddlewareList
- type MiddlewareRef
- type Route
- type RouteTCP
- type Service
- type ServiceTCP
- type TLS
- type TLSOption
- type TLSOptionList
- type TLSOptionRef
- type TLSOptionSpec
- type TLSOptionTCPRef
- type TLSTCP
Constants ¶
const GroupName = "traefik.containo.us"
GroupName is the group name for Traefik.
Variables ¶
var ( // SchemeBuilder collects the scheme builder functions. SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes) // AddToScheme applies the SchemeBuilder functions to a specified scheme. AddToScheme = SchemeBuilder.AddToScheme )
var SchemeGroupVersion = schema.GroupVersion{Group: GroupName, Version: "v1alpha1"}
SchemeGroupVersion is group version used to register these objects.
Functions ¶
func Resource ¶
func Resource(resource string) schema.GroupResource
Resource takes an unqualified resource and returns a Group qualified GroupResource.
Types ¶
type ClientCA ¶
type ClientCA struct { // SecretName is the name of the referenced Kubernetes Secret to specify the // certificate details. SecretNames []string `json:"secretnames"` // Optional indicates if ClientCA are mandatory or have just to be analyzed if provided Optional bool `json:"optional"` }
ClientCA defines traefik CA files for an entryPoint and it indicates if they are mandatory or have just to be analyzed if provided
func (*ClientCA) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ClientCA.
func (*ClientCA) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type HealthCheck ¶
type HealthCheck struct { Path string `json:"path"` Host string `json:"host,omitempty"` Scheme string `json:"scheme"` IntervalSeconds int64 `json:"intervalSeconds"` TimeoutSeconds int64 `json:"timeoutSeconds"` Headers map[string]string `json:"headers"` }
HealthCheck is the HealthCheck definition.
func (*HealthCheck) DeepCopy ¶
func (in *HealthCheck) DeepCopy() *HealthCheck
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new HealthCheck.
func (*HealthCheck) DeepCopyInto ¶
func (in *HealthCheck) DeepCopyInto(out *HealthCheck)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type IngressRoute ¶
type IngressRoute struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata"` Spec IngressRouteSpec `json:"spec"` }
IngressRoute is an Ingress CRD specification.
func (*IngressRoute) DeepCopy ¶
func (in *IngressRoute) DeepCopy() *IngressRoute
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new IngressRoute.
func (*IngressRoute) DeepCopyInto ¶
func (in *IngressRoute) DeepCopyInto(out *IngressRoute)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*IngressRoute) DeepCopyObject ¶
func (in *IngressRoute) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type IngressRouteList ¶
type IngressRouteList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata"` Items []IngressRoute `json:"items"` }
IngressRouteList is a list of IngressRoutes.
func (*IngressRouteList) DeepCopy ¶
func (in *IngressRouteList) DeepCopy() *IngressRouteList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new IngressRouteList.
func (*IngressRouteList) DeepCopyInto ¶
func (in *IngressRouteList) DeepCopyInto(out *IngressRouteList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*IngressRouteList) DeepCopyObject ¶
func (in *IngressRouteList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type IngressRouteSpec ¶
type IngressRouteSpec struct { Routes []Route `json:"routes"` EntryPoints []string `json:"entryPoints"` TLS *TLS `json:"tls,omitempty"` }
IngressRouteSpec is a specification for a IngressRouteSpec resource.
func (*IngressRouteSpec) DeepCopy ¶
func (in *IngressRouteSpec) DeepCopy() *IngressRouteSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new IngressRouteSpec.
func (*IngressRouteSpec) DeepCopyInto ¶
func (in *IngressRouteSpec) DeepCopyInto(out *IngressRouteSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type IngressRouteTCP ¶
type IngressRouteTCP struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata"` Spec IngressRouteTCPSpec `json:"spec"` }
IngressRouteTCP is an Ingress CRD specification.
func (*IngressRouteTCP) DeepCopy ¶
func (in *IngressRouteTCP) DeepCopy() *IngressRouteTCP
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new IngressRouteTCP.
func (*IngressRouteTCP) DeepCopyInto ¶
func (in *IngressRouteTCP) DeepCopyInto(out *IngressRouteTCP)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*IngressRouteTCP) DeepCopyObject ¶
func (in *IngressRouteTCP) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type IngressRouteTCPList ¶
type IngressRouteTCPList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata"` Items []IngressRouteTCP `json:"items"` }
IngressRouteTCPList is a list of IngressRoutes.
func (*IngressRouteTCPList) DeepCopy ¶
func (in *IngressRouteTCPList) DeepCopy() *IngressRouteTCPList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new IngressRouteTCPList.
func (*IngressRouteTCPList) DeepCopyInto ¶
func (in *IngressRouteTCPList) DeepCopyInto(out *IngressRouteTCPList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*IngressRouteTCPList) DeepCopyObject ¶
func (in *IngressRouteTCPList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type IngressRouteTCPSpec ¶
type IngressRouteTCPSpec struct { Routes []RouteTCP `json:"routes"` EntryPoints []string `json:"entryPoints"` TLS *TLSTCP `json:"tls,omitempty"` }
IngressRouteTCPSpec is a specification for a IngressRouteTCPSpec resource.
func (*IngressRouteTCPSpec) DeepCopy ¶
func (in *IngressRouteTCPSpec) DeepCopy() *IngressRouteTCPSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new IngressRouteTCPSpec.
func (*IngressRouteTCPSpec) DeepCopyInto ¶
func (in *IngressRouteTCPSpec) DeepCopyInto(out *IngressRouteTCPSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Middleware ¶
type Middleware struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata"` Spec config.Middleware `json:"spec"` }
Middleware is a specification for a Middleware resource.
func (*Middleware) DeepCopy ¶
func (in *Middleware) DeepCopy() *Middleware
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Middleware.
func (*Middleware) DeepCopyInto ¶
func (in *Middleware) DeepCopyInto(out *Middleware)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Middleware) DeepCopyObject ¶
func (in *Middleware) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type MiddlewareList ¶
type MiddlewareList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata"` Items []Middleware `json:"items"` }
MiddlewareList is a list of Middleware resources.
func (*MiddlewareList) DeepCopy ¶
func (in *MiddlewareList) DeepCopy() *MiddlewareList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MiddlewareList.
func (*MiddlewareList) DeepCopyInto ¶
func (in *MiddlewareList) DeepCopyInto(out *MiddlewareList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*MiddlewareList) DeepCopyObject ¶
func (in *MiddlewareList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type MiddlewareRef ¶
MiddlewareRef is a ref to the Middleware resources.
func (*MiddlewareRef) DeepCopy ¶
func (in *MiddlewareRef) DeepCopy() *MiddlewareRef
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MiddlewareRef.
func (*MiddlewareRef) DeepCopyInto ¶
func (in *MiddlewareRef) DeepCopyInto(out *MiddlewareRef)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Route ¶
type Route struct { Match string `json:"match"` Kind string `json:"kind"` Priority int `json:"priority"` Services []Service `json:"services,omitempty"` Middlewares []MiddlewareRef `json:"middlewares"` }
Route contains the set of routes.
func (*Route) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Route.
func (*Route) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type RouteTCP ¶
type RouteTCP struct { Match string `json:"match"` Services []ServiceTCP `json:"services,omitempty"` }
RouteTCP contains the set of routes.
func (*RouteTCP) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RouteTCP.
func (*RouteTCP) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Service ¶
type Service struct { Name string `json:"name"` Port int32 `json:"port"` HealthCheck *HealthCheck `json:"healthCheck,omitempty"` Strategy string `json:"strategy,omitempty"` }
Service defines an upstream to proxy traffic.
func (*Service) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Service.
func (*Service) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ServiceTCP ¶
ServiceTCP defines an upstream to proxy traffic.
func (*ServiceTCP) DeepCopy ¶
func (in *ServiceTCP) DeepCopy() *ServiceTCP
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ServiceTCP.
func (*ServiceTCP) DeepCopyInto ¶
func (in *ServiceTCP) DeepCopyInto(out *ServiceTCP)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type TLS ¶
type TLS struct { // SecretName is the name of the referenced Kubernetes Secret to specify the // certificate details. SecretName string `json:"secretName"` // Options is a reference to a TLSOption, that specifies the parameters of the TLS connection. Options *TLSOptionRef `json:"options"` }
TLS contains the TLS certificates configuration of the routes. To enable Let's Encrypt, use an empty TLS struct, e.g. in YAML:
tls: {} # inline format
tls:
secretName: # block format
func (*TLS) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TLS.
func (*TLS) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type TLSOption ¶
type TLSOption struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata"` Spec TLSOptionSpec `json:"spec"` }
TLSOption is a specification for a TLSOption resource.
func (*TLSOption) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TLSOption.
func (*TLSOption) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*TLSOption) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type TLSOptionList ¶
type TLSOptionList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata"` Items []TLSOption `json:"items"` }
TLSOptionList is a list of TLSOption resources.
func (*TLSOptionList) DeepCopy ¶
func (in *TLSOptionList) DeepCopy() *TLSOptionList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TLSOptionList.
func (*TLSOptionList) DeepCopyInto ¶
func (in *TLSOptionList) DeepCopyInto(out *TLSOptionList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*TLSOptionList) DeepCopyObject ¶
func (in *TLSOptionList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type TLSOptionRef ¶
TLSOptionRef is a ref to the TLSOption resources.
func (*TLSOptionRef) DeepCopy ¶
func (in *TLSOptionRef) DeepCopy() *TLSOptionRef
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TLSOptionRef.
func (*TLSOptionRef) DeepCopyInto ¶
func (in *TLSOptionRef) DeepCopyInto(out *TLSOptionRef)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type TLSOptionSpec ¶
type TLSOptionSpec struct { MinVersion string `json:"minversion"` CipherSuites []string `json:"ciphersuites"` ClientCA ClientCA `json:"clientca"` SniStrict bool `json:"snistrict"` }
TLSOptionSpec configures TLS for an entry point
func (*TLSOptionSpec) DeepCopy ¶
func (in *TLSOptionSpec) DeepCopy() *TLSOptionSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TLSOptionSpec.
func (*TLSOptionSpec) DeepCopyInto ¶
func (in *TLSOptionSpec) DeepCopyInto(out *TLSOptionSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type TLSOptionTCPRef ¶
TLSOptionTCPRef is a ref to the TLSOption resources.
func (*TLSOptionTCPRef) DeepCopy ¶
func (in *TLSOptionTCPRef) DeepCopy() *TLSOptionTCPRef
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TLSOptionTCPRef.
func (*TLSOptionTCPRef) DeepCopyInto ¶
func (in *TLSOptionTCPRef) DeepCopyInto(out *TLSOptionTCPRef)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type TLSTCP ¶
type TLSTCP struct { // SecretName is the name of the referenced Kubernetes Secret to specify the // certificate details. SecretName string `json:"secretName"` Passthrough bool `json:"passthrough"` // Options is a reference to a TLSOption, that specifies the parameters of the TLS connection. Options *TLSOptionTCPRef `json:"options"` }
TLSTCP contains the TLS certificates configuration of the routes. To enable Let's Encrypt, use an empty TLS struct, e.g. in YAML:
tls: {} # inline format
tls:
secretName: # block format
func (*TLSTCP) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TLSTCP.
func (*TLSTCP) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.