Documentation
¶
Index ¶
- Variables
- func Resource(resource string) schema.GroupResource
- type AccessControlOIDC
- type AccessControlOIDCGoogle
- type AccessControlPolicy
- type AccessControlPolicyBasicAuth
- type AccessControlPolicyJWT
- type AccessControlPolicyList
- type AccessControlPolicySpec
- type AccessControlPolicyStatus
- type EdgeIngress
- type EdgeIngressACP
- type EdgeIngressConnectionStatus
- type EdgeIngressList
- type EdgeIngressService
- type EdgeIngressSpec
- type EdgeIngressStatus
- type IngressClass
- type IngressClassList
- type IngressClassSpec
- type Session
- type StateCookie
Constants ¶
This section is empty.
Variables ¶
var (
// AddToScheme applies the SchemeBuilder functions to a specified scheme.
AddToScheme = schemeBuilder.AddToScheme
)
var SchemeGroupVersion = schema.GroupVersion{
Group: "hub.traefik.io",
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 AccessControlOIDC ¶ added in v0.6.0
type AccessControlOIDC struct { Issuer string `json:"issuer,omitempty"` ClientID string `json:"clientId,omitempty"` Secret *corev1.SecretReference `json:"secret,omitempty"` RedirectURL string `json:"redirectUrl,omitempty"` LogoutURL string `json:"logoutUrl,omitempty"` AuthParams map[string]string `json:"authParams,omitempty"` StateCookie *StateCookie `json:"stateCookie,omitempty"` Session *Session `json:"session,omitempty"` Scopes []string `json:"scopes,omitempty"` ForwardHeaders map[string]string `json:"forwardHeaders,omitempty"` Claims string `json:"claims,omitempty"` }
AccessControlOIDC holds the OIDC authentication configuration.
func (*AccessControlOIDC) DeepCopy ¶ added in v0.6.0
func (in *AccessControlOIDC) DeepCopy() *AccessControlOIDC
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AccessControlOIDC.
func (*AccessControlOIDC) DeepCopyInto ¶ added in v0.6.0
func (in *AccessControlOIDC) DeepCopyInto(out *AccessControlOIDC)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type AccessControlOIDCGoogle ¶ added in v0.6.0
type AccessControlOIDCGoogle struct { ClientID string `json:"clientId,omitempty"` Secret *corev1.SecretReference `json:"secret,omitempty"` RedirectURL string `json:"redirectUrl,omitempty"` LogoutURL string `json:"logoutUrl,omitempty"` AuthParams map[string]string `json:"authParams,omitempty"` StateCookie *StateCookie `json:"stateCookie,omitempty"` Session *Session `json:"session,omitempty"` ForwardHeaders map[string]string `json:"forwardHeaders,omitempty"` // Emails are the allowed emails to connect. Emails []string `json:"emails"` }
AccessControlOIDCGoogle holds the Google OIDC authentication configuration.
func (*AccessControlOIDCGoogle) DeepCopy ¶ added in v0.6.0
func (in *AccessControlOIDCGoogle) DeepCopy() *AccessControlOIDCGoogle
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AccessControlOIDCGoogle.
func (*AccessControlOIDCGoogle) DeepCopyInto ¶ added in v0.6.0
func (in *AccessControlOIDCGoogle) DeepCopyInto(out *AccessControlOIDCGoogle)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type AccessControlPolicy ¶
type AccessControlPolicy struct { metav1.TypeMeta `json:",inline"` // +optional metav1.ObjectMeta `json:"metadata,omitempty"` Spec AccessControlPolicySpec `json:"spec,omitempty"` // The current status of this access control policy. // +optional Status AccessControlPolicyStatus `json:"status,omitempty"` }
AccessControlPolicy defines an access control policy. +kubebuilder:resource:scope=Cluster
func (*AccessControlPolicy) DeepCopy ¶
func (in *AccessControlPolicy) DeepCopy() *AccessControlPolicy
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AccessControlPolicy.
func (*AccessControlPolicy) DeepCopyInto ¶
func (in *AccessControlPolicy) DeepCopyInto(out *AccessControlPolicy)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*AccessControlPolicy) DeepCopyObject ¶
func (in *AccessControlPolicy) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type AccessControlPolicyBasicAuth ¶
type AccessControlPolicyBasicAuth struct { Users []string `json:"users,omitempty"` Realm string `json:"realm,omitempty"` StripAuthorizationHeader bool `json:"stripAuthorizationHeader,omitempty"` ForwardUsernameHeader string `json:"forwardUsernameHeader,omitempty"` }
AccessControlPolicyBasicAuth holds the HTTP basic authentication configuration.
func (*AccessControlPolicyBasicAuth) DeepCopy ¶
func (in *AccessControlPolicyBasicAuth) DeepCopy() *AccessControlPolicyBasicAuth
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AccessControlPolicyBasicAuth.
func (*AccessControlPolicyBasicAuth) DeepCopyInto ¶
func (in *AccessControlPolicyBasicAuth) DeepCopyInto(out *AccessControlPolicyBasicAuth)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type AccessControlPolicyJWT ¶
type AccessControlPolicyJWT struct { SigningSecret string `json:"signingSecret,omitempty"` SigningSecretBase64Encoded bool `json:"signingSecretBase64Encoded,omitempty"` PublicKey string `json:"publicKey,omitempty"` JWKsFile string `json:"jwksFile,omitempty"` JWKsURL string `json:"jwksUrl,omitempty"` StripAuthorizationHeader bool `json:"stripAuthorizationHeader,omitempty"` ForwardHeaders map[string]string `json:"forwardHeaders,omitempty"` TokenQueryKey string `json:"tokenQueryKey,omitempty"` Claims string `json:"claims,omitempty"` }
AccessControlPolicyJWT configures a JWT access control policy.
func (*AccessControlPolicyJWT) DeepCopy ¶
func (in *AccessControlPolicyJWT) DeepCopy() *AccessControlPolicyJWT
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AccessControlPolicyJWT.
func (*AccessControlPolicyJWT) DeepCopyInto ¶
func (in *AccessControlPolicyJWT) DeepCopyInto(out *AccessControlPolicyJWT)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type AccessControlPolicyList ¶
type AccessControlPolicyList struct { metav1.TypeMeta `json:",inline"` // +optional metav1.ListMeta `son:"metadata,omitempty"` Items []AccessControlPolicy `json:"items"` }
AccessControlPolicyList defines a list of access control policy.
func (*AccessControlPolicyList) DeepCopy ¶
func (in *AccessControlPolicyList) DeepCopy() *AccessControlPolicyList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AccessControlPolicyList.
func (*AccessControlPolicyList) DeepCopyInto ¶
func (in *AccessControlPolicyList) DeepCopyInto(out *AccessControlPolicyList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*AccessControlPolicyList) DeepCopyObject ¶
func (in *AccessControlPolicyList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type AccessControlPolicySpec ¶
type AccessControlPolicySpec struct { JWT *AccessControlPolicyJWT `json:"jwt,omitempty"` BasicAuth *AccessControlPolicyBasicAuth `json:"basicAuth,omitempty"` OIDC *AccessControlOIDC `json:"oidc,omitempty"` OIDCGoogle *AccessControlOIDCGoogle `json:"oidcGoogle,omitempty"` }
AccessControlPolicySpec configures an access control policy.
func (*AccessControlPolicySpec) DeepCopy ¶
func (in *AccessControlPolicySpec) DeepCopy() *AccessControlPolicySpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AccessControlPolicySpec.
func (*AccessControlPolicySpec) DeepCopyInto ¶
func (in *AccessControlPolicySpec) DeepCopyInto(out *AccessControlPolicySpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (AccessControlPolicySpec) Hash ¶
func (a AccessControlPolicySpec) Hash() (string, error)
Hash return AccessControlPolicySpec hash.
type AccessControlPolicyStatus ¶
type AccessControlPolicyStatus struct { Version string `json:"version,omitempty"` SyncedAt metav1.Time `json:"syncedAt,omitempty"` SpecHash string `json:"specHash,omitempty"` }
AccessControlPolicyStatus is the status of the access control policy.
func (*AccessControlPolicyStatus) DeepCopy ¶
func (in *AccessControlPolicyStatus) DeepCopy() *AccessControlPolicyStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AccessControlPolicyStatus.
func (*AccessControlPolicyStatus) DeepCopyInto ¶
func (in *AccessControlPolicyStatus) DeepCopyInto(out *AccessControlPolicyStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type EdgeIngress ¶
type EdgeIngress struct { metav1.TypeMeta `json:",inline"` // +optional metav1.ObjectMeta `json:"metadata,omitempty"` // The desired behavior of this edge ingress. Spec EdgeIngressSpec `json:"spec,omitempty"` // The current status of this edge ingress. // +optional Status EdgeIngressStatus `json:"status,omitempty"` }
EdgeIngress defines an edge ingress. +kubebuilder:printcolumn:name="Service",type=string,JSONPath=`.spec.service.name` +kubebuilder:printcolumn:name="Port",type=string,JSONPath=`.spec.service.port` +kubebuilder:printcolumn:name="ACP",type=string,JSONPath=`.spec.acp.name`,priority=1 +kubebuilder:printcolumn:name="URLs",type=string,JSONPath=`.status.urls` +kubebuilder:printcolumn:name="Connection",type=string,JSONPath=`.status.connection`
func (*EdgeIngress) DeepCopy ¶
func (in *EdgeIngress) DeepCopy() *EdgeIngress
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new EdgeIngress.
func (*EdgeIngress) DeepCopyInto ¶
func (in *EdgeIngress) DeepCopyInto(out *EdgeIngress)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*EdgeIngress) DeepCopyObject ¶
func (in *EdgeIngress) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type EdgeIngressACP ¶
type EdgeIngressACP struct {
Name string `json:"name"`
}
EdgeIngressACP configures the ACP to use on the Ingress.
func (*EdgeIngressACP) DeepCopy ¶
func (in *EdgeIngressACP) DeepCopy() *EdgeIngressACP
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new EdgeIngressACP.
func (*EdgeIngressACP) DeepCopyInto ¶
func (in *EdgeIngressACP) DeepCopyInto(out *EdgeIngressACP)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type EdgeIngressConnectionStatus ¶
type EdgeIngressConnectionStatus string
EdgeIngressConnectionStatus is the status of the underlying connection to the edge.
const ( EdgeIngressConnectionDown EdgeIngressConnectionStatus = "DOWN" EdgeIngressConnectionUp EdgeIngressConnectionStatus = "UP" )
Connection statuses.
type EdgeIngressList ¶
type EdgeIngressList struct { metav1.TypeMeta `json:",inline"` // +optional metav1.ListMeta `json:"metadata,omitempty"` Items []EdgeIngress `json:"items"` }
EdgeIngressList defines a list of edge ingress.
func (*EdgeIngressList) DeepCopy ¶
func (in *EdgeIngressList) DeepCopy() *EdgeIngressList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new EdgeIngressList.
func (*EdgeIngressList) DeepCopyInto ¶
func (in *EdgeIngressList) DeepCopyInto(out *EdgeIngressList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*EdgeIngressList) DeepCopyObject ¶
func (in *EdgeIngressList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type EdgeIngressService ¶
EdgeIngressService configures the service to exposed on the edge.
func (*EdgeIngressService) DeepCopy ¶
func (in *EdgeIngressService) DeepCopy() *EdgeIngressService
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new EdgeIngressService.
func (*EdgeIngressService) DeepCopyInto ¶
func (in *EdgeIngressService) DeepCopyInto(out *EdgeIngressService)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type EdgeIngressSpec ¶
type EdgeIngressSpec struct { Service EdgeIngressService `json:"service"` ACP *EdgeIngressACP `json:"acp,omitempty"` }
EdgeIngressSpec configures an access control policy.
func (*EdgeIngressSpec) DeepCopy ¶
func (in *EdgeIngressSpec) DeepCopy() *EdgeIngressSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new EdgeIngressSpec.
func (*EdgeIngressSpec) DeepCopyInto ¶
func (in *EdgeIngressSpec) DeepCopyInto(out *EdgeIngressSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*EdgeIngressSpec) Hash ¶
func (in *EdgeIngressSpec) Hash() (string, error)
Hash generates the hash of the spec.
type EdgeIngressStatus ¶
type EdgeIngressStatus struct { Version string `json:"version,omitempty"` SyncedAt metav1.Time `json:"syncedAt,omitempty"` // Domain is the Domain for accessing the exposed service. Domain string `json:"domain,omitempty"` // CustomDomains are the custom domains for accessing the exposed service. CustomDomains []string `json:"customDomains,omitempty"` // URLs is the list of coma separated URL for accessing the exposed service. URLs string `json:"urls,omitempty"` // Connection is the status of the underlying connection to the edge. Connection EdgeIngressConnectionStatus `json:"connection,omitempty"` // SpecHash is a hash representing the the EdgeIngressSpec SpecHash string `json:"specHash,omitempty"` }
EdgeIngressStatus is the status of the EdgeIngress.
func (*EdgeIngressStatus) DeepCopy ¶
func (in *EdgeIngressStatus) DeepCopy() *EdgeIngressStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new EdgeIngressStatus.
func (*EdgeIngressStatus) DeepCopyInto ¶
func (in *EdgeIngressStatus) DeepCopyInto(out *EdgeIngressStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type IngressClass ¶
type IngressClass struct { metav1.TypeMeta `json:",inline"` // +optional metav1.ObjectMeta `json:"metadata,omitempty"` Spec IngressClassSpec `json:"spec,omitempty"` }
IngressClass defines an ingress class. +kubebuilder:resource:scope=Cluster +kubebuilder:printcolumn:name="Controller",type=string,JSONPath=`.spec.controller` +kubebuilder:printcolumn:name="Is Default",type=string,JSONPath=`.metadata.annotations.ingressclass\.kubernetes\.io/is-default-class` +kubebuilder:printcolumn:name="Age",type=date,JSONPath=`.metadata.creationTimestamp`
func (*IngressClass) DeepCopy ¶
func (in *IngressClass) DeepCopy() *IngressClass
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new IngressClass.
func (*IngressClass) DeepCopyInto ¶
func (in *IngressClass) DeepCopyInto(out *IngressClass)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*IngressClass) DeepCopyObject ¶
func (in *IngressClass) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type IngressClassList ¶
type IngressClassList struct { metav1.TypeMeta `json:",inline"` // +optional metav1.ListMeta `son:"metadata,omitempty"` Items []IngressClass `json:"items"` }
IngressClassList defines a list of ingress class.
func (*IngressClassList) DeepCopy ¶
func (in *IngressClassList) DeepCopy() *IngressClassList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new IngressClassList.
func (*IngressClassList) DeepCopyInto ¶
func (in *IngressClassList) DeepCopyInto(out *IngressClassList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*IngressClassList) DeepCopyObject ¶
func (in *IngressClassList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type IngressClassSpec ¶
type IngressClassSpec struct {
Controller string `json:"controller"`
}
IngressClassSpec configures an ingress class.
func (*IngressClassSpec) DeepCopy ¶
func (in *IngressClassSpec) DeepCopy() *IngressClassSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new IngressClassSpec.
func (*IngressClassSpec) DeepCopyInto ¶
func (in *IngressClassSpec) DeepCopyInto(out *IngressClassSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Session ¶ added in v0.6.0
type Session struct { SameSite string `json:"sameSite,omitempty"` Secure bool `json:"secure,omitempty"` Domain string `json:"domain,omitempty"` Path string `json:"path,omitempty"` Refresh *bool `json:"refresh,omitempty"` }
Session holds session configuration.
func (*Session) DeepCopy ¶ added in v0.6.0
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Session.
func (*Session) DeepCopyInto ¶ added in v0.6.0
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type StateCookie ¶ added in v0.6.0
type StateCookie struct { SameSite string `json:"sameSite,omitempty"` Secure bool `json:"secure,omitempty"` Domain string `json:"domain,omitempty"` Path string `json:"path,omitempty"` }
StateCookie holds state cookie configuration.
func (*StateCookie) DeepCopy ¶ added in v0.6.0
func (in *StateCookie) DeepCopy() *StateCookie
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new StateCookie.
func (*StateCookie) DeepCopyInto ¶ added in v0.6.0
func (in *StateCookie) DeepCopyInto(out *StateCookie)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.