v1alpha1

package
v1.3.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 24, 2023 License: AGPL-3.0 Imports: 8 Imported by: 1

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (

	// AddToScheme applies the SchemeBuilder functions to a specified scheme.
	AddToScheme = schemeBuilder.AddToScheme
)
View Source
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 API added in v1.2.0

type API struct {
	metav1.TypeMeta `json:",inline"`
	// +optional
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec APISpec `json:"spec,omitempty"`

	// The current status of this API.
	// +optional
	Status APIStatus `json:"status,omitempty"`
}

API defines an API exposed within a portal. +kubebuilder:printcolumn:name="PathPrefix",type=string,JSONPath=`.spec.pathPrefix` +kubebuilder:printcolumn:name="ServiceName",type=string,JSONPath=`.spec.service.name` +kubebuilder:printcolumn:name="ServicePort",type=string,JSONPath=`.spec.service.port.number`

func (*API) DeepCopy added in v1.2.0

func (in *API) DeepCopy() *API

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new API.

func (*API) DeepCopyInto added in v1.2.0

func (in *API) DeepCopyInto(out *API)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*API) DeepCopyObject added in v1.2.0

func (in *API) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type APIAccess added in v1.2.0

type APIAccess struct {
	metav1.TypeMeta `json:",inline"`
	// +optional
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec APIAccessSpec `json:"spec,omitempty"`

	// The current status of this APIAccess.
	// +optional
	Status APIAccessStatus `json:"status,omitempty"`
}

APIAccess defines which group of consumers can access APIs and APICollections. +kubebuilder:resource:scope=Cluster

func (*APIAccess) DeepCopy added in v1.2.0

func (in *APIAccess) DeepCopy() *APIAccess

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new APIAccess.

func (*APIAccess) DeepCopyInto added in v1.2.0

func (in *APIAccess) DeepCopyInto(out *APIAccess)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*APIAccess) DeepCopyObject added in v1.2.0

func (in *APIAccess) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type APIAccessList added in v1.2.0

type APIAccessList struct {
	metav1.TypeMeta `json:",inline"`
	// +optional
	metav1.ListMeta `json:"metadata,omitempty"`

	Items []APIAccess `json:"items"`
}

APIAccessList defines a list of APIAccesses.

func (*APIAccessList) DeepCopy added in v1.2.0

func (in *APIAccessList) DeepCopy() *APIAccessList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new APIAccessList.

func (*APIAccessList) DeepCopyInto added in v1.2.0

func (in *APIAccessList) DeepCopyInto(out *APIAccessList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*APIAccessList) DeepCopyObject added in v1.2.0

func (in *APIAccessList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type APIAccessSpec added in v1.2.0

type APIAccessSpec struct {
	Groups                []string              `json:"groups"`
	APISelector           *metav1.LabelSelector `json:"apiSelector,omitempty"`
	APICollectionSelector *metav1.LabelSelector `json:"apiCollectionSelector,omitempty"`
}

APIAccessSpec configures an APIAccess.

func (*APIAccessSpec) DeepCopy added in v1.2.0

func (in *APIAccessSpec) DeepCopy() *APIAccessSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new APIAccessSpec.

func (*APIAccessSpec) DeepCopyInto added in v1.2.0

func (in *APIAccessSpec) DeepCopyInto(out *APIAccessSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type APIAccessStatus added in v1.2.0

type APIAccessStatus struct {
	Version  string      `json:"version,omitempty"`
	SyncedAt metav1.Time `json:"syncedAt,omitempty"`
	// Hash is a hash representing the APIAccess.
	Hash string `json:"hash,omitempty"`
}

APIAccessStatus is the status of an APIAccess.

func (*APIAccessStatus) DeepCopy added in v1.2.0

func (in *APIAccessStatus) DeepCopy() *APIAccessStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new APIAccessStatus.

func (*APIAccessStatus) DeepCopyInto added in v1.2.0

func (in *APIAccessStatus) DeepCopyInto(out *APIAccessStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type APICollection added in v1.2.0

type APICollection struct {
	metav1.TypeMeta `json:",inline"`
	// +optional
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec APICollectionSpec `json:"spec,omitempty"`

	// The current status of this APICollection.
	// +optional
	Status APICollectionStatus `json:"status,omitempty"`
}

APICollection defines a collection of APIs exposed within an APIPortal. +kubebuilder:printcolumn:name="PathPrefix",type=string,JSONPath=`.spec.pathPrefix` +kubebuilder:printcolumn:name="APISelector",type=string,JSONPath=`.status.apiSelector` +kubebuilder:resource:scope=Cluster

func (*APICollection) DeepCopy added in v1.2.0

func (in *APICollection) DeepCopy() *APICollection

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new APICollection.

func (*APICollection) DeepCopyInto added in v1.2.0

func (in *APICollection) DeepCopyInto(out *APICollection)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*APICollection) DeepCopyObject added in v1.2.0

func (in *APICollection) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type APICollectionList added in v1.2.0

type APICollectionList struct {
	metav1.TypeMeta `json:",inline"`
	// +optional
	metav1.ListMeta `json:"metadata,omitempty"`

	Items []APICollection `json:"items"`
}

APICollectionList defines a list of APICollections.

func (*APICollectionList) DeepCopy added in v1.2.0

func (in *APICollectionList) DeepCopy() *APICollectionList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new APICollectionList.

func (*APICollectionList) DeepCopyInto added in v1.2.0

func (in *APICollectionList) DeepCopyInto(out *APICollectionList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*APICollectionList) DeepCopyObject added in v1.2.0

func (in *APICollectionList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type APICollectionSpec added in v1.2.0

type APICollectionSpec struct {
	// +optional
	PathPrefix string `json:"pathPrefix,omitempty"`
	// APISelector selects the APIs which are member of this APICollection object.
	// Multiple APICollections can select the same set of APIs.
	// This field is NOT optional and follows standard label selector semantics.
	// An empty APISelector matches any API.
	APISelector metav1.LabelSelector `json:"apiSelector"`
}

APICollectionSpec configures an APICollection.

func (*APICollectionSpec) DeepCopy added in v1.2.0

func (in *APICollectionSpec) DeepCopy() *APICollectionSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new APICollectionSpec.

func (*APICollectionSpec) DeepCopyInto added in v1.2.0

func (in *APICollectionSpec) DeepCopyInto(out *APICollectionSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type APICollectionStatus added in v1.2.0

type APICollectionStatus struct {
	APISelector string      `json:"apiSelector,omitempty"`
	Version     string      `json:"version,omitempty"`
	SyncedAt    metav1.Time `json:"syncedAt,omitempty"`
	// Hash is a hash representing the APICollection.
	Hash string `json:"hash,omitempty"`
}

APICollectionStatus is the status of an APICollection.

func (*APICollectionStatus) DeepCopy added in v1.2.0

func (in *APICollectionStatus) DeepCopy() *APICollectionStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new APICollectionStatus.

func (*APICollectionStatus) DeepCopyInto added in v1.2.0

func (in *APICollectionStatus) DeepCopyInto(out *APICollectionStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type APIGateway added in v1.2.0

type APIGateway struct {
	metav1.TypeMeta `json:",inline"`
	// +optional
	metav1.ObjectMeta `json:"metadata,omitempty"`

	// The desired behavior of this APIGateway.
	Spec APIGatewaySpec `json:"spec,omitempty"`

	// The current status of this APIGateway.
	// +optional
	Status APIGatewayStatus `json:"status,omitempty"`
}

APIGateway defines a gateway that exposes APIs. +kubebuilder:printcolumn:name="URLs",type=string,JSONPath=`.status.urls` +kubebuilder:resource:scope=Cluster

func (*APIGateway) DeepCopy added in v1.2.0

func (in *APIGateway) DeepCopy() *APIGateway

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new APIGateway.

func (*APIGateway) DeepCopyInto added in v1.2.0

func (in *APIGateway) DeepCopyInto(out *APIGateway)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*APIGateway) DeepCopyObject added in v1.2.0

func (in *APIGateway) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type APIGatewayList added in v1.2.0

type APIGatewayList struct {
	metav1.TypeMeta `json:",inline"`
	// +optional
	metav1.ListMeta `json:"metadata,omitempty"`

	Items []APIGateway `json:"items"`
}

APIGatewayList defines a list of APIGateway.

func (*APIGatewayList) DeepCopy added in v1.2.0

func (in *APIGatewayList) DeepCopy() *APIGatewayList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new APIGatewayList.

func (*APIGatewayList) DeepCopyInto added in v1.2.0

func (in *APIGatewayList) DeepCopyInto(out *APIGatewayList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*APIGatewayList) DeepCopyObject added in v1.2.0

func (in *APIGatewayList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type APIGatewaySpec added in v1.2.0

type APIGatewaySpec struct {
	// +optional
	APIAccesses []string `json:"apiAccesses,omitempty"`
	// CustomDomains are the custom domains under which the gateway will be exposed.
	// +optional
	CustomDomains []string `json:"customDomains,omitempty"`
}

APIGatewaySpec configures an APIGateway.

func (*APIGatewaySpec) DeepCopy added in v1.2.0

func (in *APIGatewaySpec) DeepCopy() *APIGatewaySpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new APIGatewaySpec.

func (*APIGatewaySpec) DeepCopyInto added in v1.2.0

func (in *APIGatewaySpec) DeepCopyInto(out *APIGatewaySpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type APIGatewayStatus added in v1.2.0

type APIGatewayStatus struct {
	Version  string      `json:"version,omitempty"`
	SyncedAt metav1.Time `json:"syncedAt,omitempty"`

	// URLs are the URLs for accessing the APIGateway.
	URLs string `json:"urls"`

	// HubDomain is the hub generated domain of the APIGateway.
	// +optional
	HubDomain string `json:"hubDomain"`

	// CustomDomains are the custom domains for accessing the exposed APIGateway.
	// +optional
	CustomDomains []string `json:"customDomains,omitempty"`

	// Hash is a hash representing the APIPortal.
	Hash string `json:"hash,omitempty"`
}

APIGatewayStatus is the status of an APIGateway.

func (*APIGatewayStatus) DeepCopy added in v1.2.0

func (in *APIGatewayStatus) DeepCopy() *APIGatewayStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new APIGatewayStatus.

func (*APIGatewayStatus) DeepCopyInto added in v1.2.0

func (in *APIGatewayStatus) DeepCopyInto(out *APIGatewayStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type APIList added in v1.2.0

type APIList struct {
	metav1.TypeMeta `json:",inline"`
	// +optional
	metav1.ListMeta `json:"metadata,omitempty"`

	Items []API `json:"items"`
}

APIList defines a list of APIs.

func (*APIList) DeepCopy added in v1.2.0

func (in *APIList) DeepCopy() *APIList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new APIList.

func (*APIList) DeepCopyInto added in v1.2.0

func (in *APIList) DeepCopyInto(out *APIList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*APIList) DeepCopyObject added in v1.2.0

func (in *APIList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type APIPortal added in v1.2.0

type APIPortal struct {
	metav1.TypeMeta `json:",inline"`
	// +optional
	metav1.ObjectMeta `json:"metadata,omitempty"`

	// The desired behavior of this APIPortal.
	Spec APIPortalSpec `json:"spec,omitempty"`

	// The current status of this APIPortal.
	// +optional
	Status APIPortalStatus `json:"status,omitempty"`
}

APIPortal defines a portal that exposes APIs. +kubebuilder:printcolumn:name="URLs",type=string,JSONPath=`.status.urls` +kubebuilder:resource:scope=Cluster

func (*APIPortal) DeepCopy added in v1.2.0

func (in *APIPortal) DeepCopy() *APIPortal

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new APIPortal.

func (*APIPortal) DeepCopyInto added in v1.2.0

func (in *APIPortal) DeepCopyInto(out *APIPortal)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*APIPortal) DeepCopyObject added in v1.2.0

func (in *APIPortal) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type APIPortalList added in v1.2.0

type APIPortalList struct {
	metav1.TypeMeta `json:",inline"`
	// +optional
	metav1.ListMeta `json:"metadata,omitempty"`

	Items []APIPortal `json:"items"`
}

APIPortalList defines a list of APIPortals.

func (*APIPortalList) DeepCopy added in v1.2.0

func (in *APIPortalList) DeepCopy() *APIPortalList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new APIPortalList.

func (*APIPortalList) DeepCopyInto added in v1.2.0

func (in *APIPortalList) DeepCopyInto(out *APIPortalList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*APIPortalList) DeepCopyObject added in v1.2.0

func (in *APIPortalList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type APIPortalSpec added in v1.2.0

type APIPortalSpec struct {
	// +optional
	Title string `json:"title,omitempty"`
	// +optional
	Description string `json:"description,omitempty"`
	APIGateway  string `json:"apiGateway"`
	// CustomDomains are the custom domains under which the portal will be exposed.
	// +optional
	CustomDomains []string `json:"customDomains,omitempty"`
}

APIPortalSpec configures an APIPortal.

func (*APIPortalSpec) DeepCopy added in v1.2.0

func (in *APIPortalSpec) DeepCopy() *APIPortalSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new APIPortalSpec.

func (*APIPortalSpec) DeepCopyInto added in v1.2.0

func (in *APIPortalSpec) DeepCopyInto(out *APIPortalSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type APIPortalStatus added in v1.2.0

type APIPortalStatus struct {
	Version  string      `json:"version,omitempty"`
	SyncedAt metav1.Time `json:"syncedAt,omitempty"`

	// URLs are the URLs for accessing the APIPortal WebUI.
	URLs string `json:"urls"`

	// HubDomain is the hub generated domain of the APIPortal WebUI.
	// +optional
	HubDomain string `json:"hubDomain"`

	// CustomDomains are the custom domains for accessing the exposed APIPortal WebUI.
	// +optional
	CustomDomains []string `json:"customDomains,omitempty"`

	// Hash is a hash representing the APIPortal.
	Hash string `json:"hash,omitempty"`
}

APIPortalStatus is the status of an APIPortal.

func (*APIPortalStatus) DeepCopy added in v1.2.0

func (in *APIPortalStatus) DeepCopy() *APIPortalStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new APIPortalStatus.

func (*APIPortalStatus) DeepCopyInto added in v1.2.0

func (in *APIPortalStatus) DeepCopyInto(out *APIPortalStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type APIService added in v1.2.0

type APIService struct {
	Name string `json:"name"`
	// port of the referenced service. A port name or port number
	// is required for an APIServiceBackendPort.
	Port        APIServiceBackendPort `json:"port"`
	OpenAPISpec OpenAPISpec           `json:"openApiSpec,omitempty"`
}

APIService configures the service to exposed on the edge.

func (*APIService) DeepCopy added in v1.2.0

func (in *APIService) DeepCopy() *APIService

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new APIService.

func (*APIService) DeepCopyInto added in v1.2.0

func (in *APIService) DeepCopyInto(out *APIService)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type APIServiceBackendPort added in v1.2.0

type APIServiceBackendPort struct {
	// name is the name of the port on the Service.
	// This must be an IANA_SVC_NAME (following RFC6335).
	// This is a mutually exclusive setting with "Number".
	// +optional
	Name string `json:"name"`

	// number is the numerical port number (e.g. 80) on the Service.
	// This is a mutually exclusive setting with "Name".
	// +optional
	Number int32 `json:"number"`
}

APIServiceBackendPort is the service port being referenced.

func (*APIServiceBackendPort) DeepCopy added in v1.2.0

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new APIServiceBackendPort.

func (*APIServiceBackendPort) DeepCopyInto added in v1.2.0

func (in *APIServiceBackendPort) DeepCopyInto(out *APIServiceBackendPort)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type APISpec added in v1.2.0

type APISpec struct {
	PathPrefix string     `json:"pathPrefix"`
	Service    APIService `json:"service"`
}

APISpec configures an API.

func (*APISpec) DeepCopy added in v1.2.0

func (in *APISpec) DeepCopy() *APISpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new APISpec.

func (*APISpec) DeepCopyInto added in v1.2.0

func (in *APISpec) DeepCopyInto(out *APISpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type APIStatus added in v1.2.0

type APIStatus struct {
	Version  string      `json:"version,omitempty"`
	SyncedAt metav1.Time `json:"syncedAt,omitempty"`
	// Hash is a hash representing the API.
	Hash string `json:"hash,omitempty"`
}

APIStatus is the status of an API.

func (*APIStatus) DeepCopy added in v1.2.0

func (in *APIStatus) DeepCopy() *APIStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new APIStatus.

func (*APIStatus) DeepCopyInto added in v1.2.0

func (in *APIStatus) DeepCopyInto(out *APIStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type AccessControlOAuthIntro added in v1.2.0

type AccessControlOAuthIntro struct {
	// +kubebuilder:validation:Required
	ClientConfig AccessControlOAuthIntroClientConfig `json:"clientConfig"`
	// +kubebuilder:validation:Required
	TokenSource    TokenSource       `json:"tokenSource"`
	Claims         string            `json:"claims,omitempty"`
	ForwardHeaders map[string]string `json:"forwardHeaders,omitempty"`
}

AccessControlOAuthIntro configures an OAuth 2.0 Token Introspection access control policy.

func (*AccessControlOAuthIntro) DeepCopy added in v1.2.0

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AccessControlOAuthIntro.

func (*AccessControlOAuthIntro) DeepCopyInto added in v1.2.0

func (in *AccessControlOAuthIntro) DeepCopyInto(out *AccessControlOAuthIntro)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type AccessControlOAuthIntroClientConfig added in v1.2.0

type AccessControlOAuthIntroClientConfig struct {
	HTTPClientConfig `json:",inline"`

	// URL of the Authorization Server.
	// +kubebuilder:validation:Required
	URL string `json:"url"`
	// Auth configures the required authentication to the Authorization Server.
	// +kubebuilder:validation:Required
	Auth AccessControlOAuthIntroClientConfigAuth `json:"auth"`
	// Headers to set when sending requests to the Authorization Server.
	Headers map[string]string `json:"headers,omitempty"`
	// TokenTypeHint is a hint to pass to the Authorization Server.
	// See https://tools.ietf.org/html/rfc7662#section-2.1 for more information.
	TokenTypeHint string `json:"tokenTypeHint,omitempty"`
}

AccessControlOAuthIntroClientConfig configures the OAuth 2.0 client for issuing token introspection requests.

func (*AccessControlOAuthIntroClientConfig) DeepCopy added in v1.2.0

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AccessControlOAuthIntroClientConfig.

func (*AccessControlOAuthIntroClientConfig) DeepCopyInto added in v1.2.0

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type AccessControlOAuthIntroClientConfigAuth added in v1.2.0

type AccessControlOAuthIntroClientConfigAuth struct {
	// Kind sets the kind of authentication that can be used to authenticate requests.
	// The content of the referenced depends on this kind.
	// +kubebuilder:validation:Enum:=Basic;Bearer;Header;Query
	// +kubebuilder:validation:Required
	Kind string `json:"kind"`
	// Secret is the reference to the Kubernetes secrets containing sensitive authentication data.
	// +kubebuilder:validation:Required
	Secret corev1.SecretReference `json:"secret"`
}

AccessControlOAuthIntroClientConfigAuth configures authentication to the Authorization Server.

func (*AccessControlOAuthIntroClientConfigAuth) DeepCopy added in v1.2.0

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AccessControlOAuthIntroClientConfigAuth.

func (*AccessControlOAuthIntroClientConfigAuth) DeepCopyInto added in v1.2.0

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 AccessControlPolicyAPIKey added in v1.2.0

type AccessControlPolicyAPIKey struct {
	// KeySource defines how to extract API keys from requests.
	// +kubebuilder:validation:Required
	KeySource TokenSource `json:"keySource"`
	// Keys define the set of authorized keys to access a protected resource.
	// +kubebuilder:validation:MinItems:=1
	Keys []AccessControlPolicyAPIKeyKey `json:"keys,omitempty"`
	// ForwardHeaders instructs the middleware to forward key metadata as header values upon successful authentication.
	ForwardHeaders map[string]string `json:"forwardHeaders,omitempty"`
}

AccessControlPolicyAPIKey configure an APIKey control policy.

func (*AccessControlPolicyAPIKey) DeepCopy added in v1.2.0

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AccessControlPolicyAPIKey.

func (*AccessControlPolicyAPIKey) DeepCopyInto added in v1.2.0

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type AccessControlPolicyAPIKeyKey added in v1.2.0

type AccessControlPolicyAPIKeyKey struct {
	// ID is the unique identifier of the key.
	// +kubebuilder:validation:Required
	ID string `json:"id"`
	// Value is the SHAKE-256 hash (using 64 bytes) of the API key.
	// +kubebuilder:validation:Required
	Value string `json:"value"`
	// Metadata holds arbitrary metadata for this key, can be used by ForwardHeaders.
	Metadata map[string]string `json:"metadata,omitempty"`
}

AccessControlPolicyAPIKeyKey defines an API key.

func (*AccessControlPolicyAPIKeyKey) DeepCopy added in v1.2.0

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AccessControlPolicyAPIKeyKey.

func (*AccessControlPolicyAPIKeyKey) DeepCopyInto added in v1.2.0

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

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

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AccessControlPolicyBasicAuth.

func (*AccessControlPolicyBasicAuth) DeepCopyInto

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

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

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 AccessControlPolicyOIDC added in v1.2.0

type AccessControlPolicyOIDC 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"`
}

AccessControlPolicyOIDC holds the OIDC authentication configuration.

func (*AccessControlPolicyOIDC) DeepCopy added in v1.2.0

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AccessControlPolicyOIDC.

func (*AccessControlPolicyOIDC) DeepCopyInto added in v1.2.0

func (in *AccessControlPolicyOIDC) DeepCopyInto(out *AccessControlPolicyOIDC)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type AccessControlPolicyOIDCGoogle added in v1.2.0

type AccessControlPolicyOIDCGoogle 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.
	// +kubebuilder:validation:MinItems:=1
	Emails []string `json:"emails,omitempty"`
}

AccessControlPolicyOIDCGoogle holds the Google OIDC authentication configuration.

func (*AccessControlPolicyOIDCGoogle) DeepCopy added in v1.2.0

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AccessControlPolicyOIDCGoogle.

func (*AccessControlPolicyOIDCGoogle) DeepCopyInto added in v1.2.0

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type AccessControlPolicySpec

type AccessControlPolicySpec struct {
	JWT        *AccessControlPolicyJWT        `json:"jwt,omitempty"`
	BasicAuth  *AccessControlPolicyBasicAuth  `json:"basicAuth,omitempty"`
	APIKey     *AccessControlPolicyAPIKey     `json:"apiKey,omitempty"`
	OIDC       *AccessControlPolicyOIDC       `json:"oidc,omitempty"`
	OIDCGoogle *AccessControlPolicyOIDCGoogle `json:"oidcGoogle,omitempty"`
	OAuthIntro *AccessControlOAuthIntro       `json:"oAuthIntro,omitempty"`
}

AccessControlPolicySpec configures an access control policy.

func (*AccessControlPolicySpec) DeepCopy

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

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AccessControlPolicyStatus.

func (*AccessControlPolicyStatus) DeepCopyInto

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

type EdgeIngressService struct {
	Name string `json:"name"`
	Port int    `json:"port"`
}

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"`
	// CustomDomains are the custom domains for accessing the exposed service.
	CustomDomains []string `json:"customDomains,omitempty"`
}

EdgeIngressSpec configures an edgeIngress 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 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 HTTPClientConfig added in v1.2.0

type HTTPClientConfig struct {
	// TLS configures TLS communication with the Authorization Server.
	TLS *HTTPClientConfigTLS `json:"tls,omitempty"`
	// TimeoutSeconds configures the maximum amount of seconds to wait before giving up on requests.
	// +kubebuilder:default:=5
	TimeoutSeconds int `json:"timeoutSeconds,omitempty"`
	// MaxRetries defines the number of retries for introspection requests.
	// +kubebuilder:default:=3
	MaxRetries int `json:"maxRetries,omitempty"`
}

HTTPClientConfig configures HTTP clients.

func (*HTTPClientConfig) DeepCopy added in v1.2.0

func (in *HTTPClientConfig) DeepCopy() *HTTPClientConfig

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new HTTPClientConfig.

func (*HTTPClientConfig) DeepCopyInto added in v1.2.0

func (in *HTTPClientConfig) DeepCopyInto(out *HTTPClientConfig)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type HTTPClientConfigTLS added in v1.2.0

type HTTPClientConfigTLS struct {
	// CABundle sets the CA bundle used to sign the Authorization Server certificate.
	CABundle string `json:"caBundle,omitempty"`
	// InsecureSkipVerify skips the Authorization Server certificate validation.
	// For testing purposes only, do not use in production.
	InsecureSkipVerify bool `json:"insecureSkipVerify,omitempty"`
}

HTTPClientConfigTLS configures TLS for HTTP clients.

func (*HTTPClientConfigTLS) DeepCopy added in v1.2.0

func (in *HTTPClientConfigTLS) DeepCopy() *HTTPClientConfigTLS

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new HTTPClientConfigTLS.

func (*HTTPClientConfigTLS) DeepCopyInto added in v1.2.0

func (in *HTTPClientConfigTLS) DeepCopyInto(out *HTTPClientConfigTLS)

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 OpenAPISpec added in v1.2.0

type OpenAPISpec struct {
	// +optional
	URL string `json:"url,omitempty"`
	// +optional
	Path string `json:"path,omitempty"`
	// +optional
	Port *APIServiceBackendPort `json:"port,omitempty"`
	// +optional
	Protocol string `json:"protocol,omitempty"`
}

OpenAPISpec defines the OpenAPI spec of an API.

func (*OpenAPISpec) DeepCopy added in v1.2.0

func (in *OpenAPISpec) DeepCopy() *OpenAPISpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new OpenAPISpec.

func (*OpenAPISpec) DeepCopyInto added in v1.2.0

func (in *OpenAPISpec) DeepCopyInto(out *OpenAPISpec)

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

func (in *Session) DeepCopy() *Session

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Session.

func (*Session) DeepCopyInto added in v0.6.0

func (in *Session) DeepCopyInto(out *Session)

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.

type TokenSource added in v1.2.0

type TokenSource struct {
	// Header is the name of a header.
	Header string `json:"header,omitempty"`
	// HeaderAuthScheme sets an optional auth scheme when Header is set to "Authorization".
	// If set, this scheme is removed from the token, and all requests not including it are dropped.
	HeaderAuthScheme string `json:"headerAuthScheme,omitempty"`
	// Query is the name of a query parameter.
	Query string `json:"query,omitempty"`
	// Cookie is the name of a cookie.
	Cookie string `json:"cookie,omitempty"`
}

TokenSource describes how to extract tokens from HTTP requests. If multiple sources are set, the order is the following: header > query > cookie.

func (*TokenSource) DeepCopy added in v1.2.0

func (in *TokenSource) DeepCopy() *TokenSource

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TokenSource.

func (*TokenSource) DeepCopyInto added in v1.2.0

func (in *TokenSource) DeepCopyInto(out *TokenSource)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL