Documentation
¶
Overview ¶
Package v1alpha1 is the v1alpha1 version of the API.
Index ¶
- Constants
- Variables
- func Kind(kind string) schema.GroupKind
- func Resource(resource string) schema.GroupResource
- type AccessControl
- type Action
- type EgressMTLS
- type GlobalConfiguration
- type GlobalConfigurationList
- type GlobalConfigurationSpec
- type IngressMTLS
- type JWTAuth
- type Listener
- type Policy
- type PolicyList
- type PolicySpec
- type RateLimit
- type TransportServer
- type TransportServerList
- type TransportServerListener
- type TransportServerSpec
- type Upstream
- type UpstreamParameters
Constants ¶
const ( // TLSPassthroughListenerName is the name of a built-in TLS Passthrough listener. TLSPassthroughListenerName = "tls-passthrough" // TLSPassthroughListenerProtocol is the protocol of a built-in TLS Passthrough listener. TLSPassthroughListenerProtocol = "TLS_PASSTHROUGH" )
Variables ¶
var ( SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes) AddToScheme = SchemeBuilder.AddToScheme )
var SchemeGroupVersion = schema.GroupVersion{Group: configuration.GroupName, Version: "v1alpha1"}
SchemeGroupVersion is group version used to register these object.
Functions ¶
func Resource ¶
func Resource(resource string) schema.GroupResource
Resource takes an unqualified resource and returns a Group qualified GroupResource.
Types ¶
type AccessControl ¶ added in v1.8.0
AccessControl defines an access policy based on the source IP of a request.
func (*AccessControl) DeepCopy ¶ added in v1.8.0
func (in *AccessControl) DeepCopy() *AccessControl
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AccessControl.
func (*AccessControl) DeepCopyInto ¶ added in v1.8.0
func (in *AccessControl) DeepCopyInto(out *AccessControl)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Action ¶ added in v1.7.0
type Action struct {
Pass string `json:"pass"`
}
Action defines an action.
func (*Action) DeepCopy ¶ added in v1.7.0
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Action.
func (*Action) DeepCopyInto ¶ added in v1.7.0
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type EgressMTLS ¶ added in v1.9.0
type EgressMTLS struct {
TLSSecret string `json:"tlsSecret"`
VerifyServer bool `json:"verifyServer"`
VerifyDepth *int `json:"verifyDepth"`
Protocols string `json:"protocols"`
SessionReuse *bool `json:"sessionReuse"`
Ciphers string `json:"ciphers"`
TrustedCertSecret string `json:"trustedCertSecret"`
ServerName bool `json:"serverName"`
SSLName string `json:"sslName"`
}
EgressMTLS defines an Egress MTLS policy.
func (*EgressMTLS) DeepCopy ¶ added in v1.9.0
func (in *EgressMTLS) DeepCopy() *EgressMTLS
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new EgressMTLS.
func (*EgressMTLS) DeepCopyInto ¶ added in v1.9.0
func (in *EgressMTLS) DeepCopyInto(out *EgressMTLS)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type GlobalConfiguration ¶ added in v1.7.0
type GlobalConfiguration struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`
Spec GlobalConfigurationSpec `json:"spec"`
}
GlobalConfiguration defines the GlobalConfiguration resource.
func (*GlobalConfiguration) DeepCopy ¶ added in v1.7.0
func (in *GlobalConfiguration) DeepCopy() *GlobalConfiguration
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new GlobalConfiguration.
func (*GlobalConfiguration) DeepCopyInto ¶ added in v1.7.0
func (in *GlobalConfiguration) DeepCopyInto(out *GlobalConfiguration)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*GlobalConfiguration) DeepCopyObject ¶ added in v1.7.0
func (in *GlobalConfiguration) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type GlobalConfigurationList ¶ added in v1.7.0
type GlobalConfigurationList struct {
metav1.TypeMeta `json:",inline"`
metav1.ListMeta `json:"metadata"`
Items []GlobalConfiguration `json:"items"`
}
GlobalConfigurationList is a list of the GlobalConfiguration resources.
func (*GlobalConfigurationList) DeepCopy ¶ added in v1.7.0
func (in *GlobalConfigurationList) DeepCopy() *GlobalConfigurationList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new GlobalConfigurationList.
func (*GlobalConfigurationList) DeepCopyInto ¶ added in v1.7.0
func (in *GlobalConfigurationList) DeepCopyInto(out *GlobalConfigurationList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*GlobalConfigurationList) DeepCopyObject ¶ added in v1.7.0
func (in *GlobalConfigurationList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type GlobalConfigurationSpec ¶ added in v1.7.0
type GlobalConfigurationSpec struct {
Listeners []Listener `json:"listeners"`
}
GlobalConfigurationSpec is the spec of the GlobalConfiguration resource.
func (*GlobalConfigurationSpec) DeepCopy ¶ added in v1.7.0
func (in *GlobalConfigurationSpec) DeepCopy() *GlobalConfigurationSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new GlobalConfigurationSpec.
func (*GlobalConfigurationSpec) DeepCopyInto ¶ added in v1.7.0
func (in *GlobalConfigurationSpec) DeepCopyInto(out *GlobalConfigurationSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type IngressMTLS ¶ added in v1.9.0
type IngressMTLS struct {
ClientCertSecret string `json:"clientCertSecret"`
VerifyClient string `json:"verifyClient"`
VerifyDepth *int `json:"verifyDepth"`
}
IngressMTLS defines an Ingress MTLS policy.
func (*IngressMTLS) DeepCopy ¶ added in v1.9.0
func (in *IngressMTLS) DeepCopy() *IngressMTLS
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new IngressMTLS.
func (*IngressMTLS) DeepCopyInto ¶ added in v1.9.0
func (in *IngressMTLS) DeepCopyInto(out *IngressMTLS)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type JWTAuth ¶ added in v1.9.0
type JWTAuth struct {
Realm string `json:"realm"`
Secret string `json:"secret"`
Token string `json:"token"`
}
JWTAuth holds JWT authentication configuration.
func (*JWTAuth) DeepCopy ¶ added in v1.9.0
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new JWTAuth.
func (*JWTAuth) DeepCopyInto ¶ added in v1.9.0
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Listener ¶ added in v1.7.0
type Listener struct {
Name string `json:"name"`
Port int `json:"port"`
Protocol string `json:"protocol"`
}
Listener defines a listener.
func (*Listener) DeepCopy ¶ added in v1.7.0
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Listener.
func (*Listener) DeepCopyInto ¶ added in v1.7.0
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Policy ¶ added in v1.8.0
type Policy struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`
Spec PolicySpec `json:"spec"`
}
Policy defines a Policy for VirtualServer and VirtualServerRoute resources.
func (*Policy) DeepCopy ¶ added in v1.8.0
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Policy.
func (*Policy) DeepCopyInto ¶ added in v1.8.0
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Policy) DeepCopyObject ¶ added in v1.8.0
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type PolicyList ¶ added in v1.8.0
type PolicyList struct {
metav1.TypeMeta `json:",inline"`
metav1.ListMeta `json:"metadata"`
Items []Policy `json:"items"`
}
PolicyList is a list of the Policy resources.
func (*PolicyList) DeepCopy ¶ added in v1.8.0
func (in *PolicyList) DeepCopy() *PolicyList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PolicyList.
func (*PolicyList) DeepCopyInto ¶ added in v1.8.0
func (in *PolicyList) DeepCopyInto(out *PolicyList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*PolicyList) DeepCopyObject ¶ added in v1.8.0
func (in *PolicyList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type PolicySpec ¶ added in v1.8.0
type PolicySpec struct {
AccessControl *AccessControl `json:"accessControl"`
RateLimit *RateLimit `json:"rateLimit"`
JWTAuth *JWTAuth `json:"jwt"`
IngressMTLS *IngressMTLS `json:"ingressMTLS"`
EgressMTLS *EgressMTLS `json:"egressMTLS"`
}
PolicySpec is the spec of the Policy resource. The spec includes multiple fields, where each field represents a different policy. Only one policy (field) is allowed.
func (*PolicySpec) DeepCopy ¶ added in v1.8.0
func (in *PolicySpec) DeepCopy() *PolicySpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PolicySpec.
func (*PolicySpec) DeepCopyInto ¶ added in v1.8.0
func (in *PolicySpec) DeepCopyInto(out *PolicySpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type RateLimit ¶ added in v1.9.0
type RateLimit struct {
Rate string `json:"rate"`
Key string `json:"key"`
Delay *int `json:"delay"`
NoDelay *bool `json:"noDelay"`
Burst *int `json:"burst"`
ZoneSize string `json:"zoneSize"`
DryRun *bool `json:"dryRun"`
LogLevel string `json:"logLevel"`
RejectCode *int `json:"rejectCode"`
}
RateLimit defines a rate limit policy.
func (*RateLimit) DeepCopy ¶ added in v1.9.0
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RateLimit.
func (*RateLimit) DeepCopyInto ¶ added in v1.9.0
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type TransportServer ¶ added in v1.7.0
type TransportServer struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`
Spec TransportServerSpec `json:"spec"`
}
TransportServer defines the TransportServer resource.
func (*TransportServer) DeepCopy ¶ added in v1.7.0
func (in *TransportServer) DeepCopy() *TransportServer
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TransportServer.
func (*TransportServer) DeepCopyInto ¶ added in v1.7.0
func (in *TransportServer) DeepCopyInto(out *TransportServer)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*TransportServer) DeepCopyObject ¶ added in v1.7.0
func (in *TransportServer) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type TransportServerList ¶ added in v1.7.0
type TransportServerList struct {
metav1.TypeMeta `json:",inline"`
metav1.ListMeta `json:"metadata"`
Items []TransportServer `json:"items"`
}
TransportServerList is a list of the TransportServer resources.
func (*TransportServerList) DeepCopy ¶ added in v1.7.0
func (in *TransportServerList) DeepCopy() *TransportServerList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TransportServerList.
func (*TransportServerList) DeepCopyInto ¶ added in v1.7.0
func (in *TransportServerList) DeepCopyInto(out *TransportServerList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*TransportServerList) DeepCopyObject ¶ added in v1.7.0
func (in *TransportServerList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type TransportServerListener ¶ added in v1.7.0
TransportServerListener defines a listener for a TransportServer.
func (*TransportServerListener) DeepCopy ¶ added in v1.7.0
func (in *TransportServerListener) DeepCopy() *TransportServerListener
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TransportServerListener.
func (*TransportServerListener) DeepCopyInto ¶ added in v1.7.0
func (in *TransportServerListener) DeepCopyInto(out *TransportServerListener)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type TransportServerSpec ¶ added in v1.7.0
type TransportServerSpec struct {
Listener TransportServerListener `json:"listener"`
Host string `json:"host"`
Upstreams []Upstream `json:"upstreams"`
UpstreamParameters *UpstreamParameters `json:"upstreamParameters"`
Action *Action `json:"action"`
}
TransportServerSpec is the spec of the TransportServer resource.
func (*TransportServerSpec) DeepCopy ¶ added in v1.7.0
func (in *TransportServerSpec) DeepCopy() *TransportServerSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TransportServerSpec.
func (*TransportServerSpec) DeepCopyInto ¶ added in v1.7.0
func (in *TransportServerSpec) DeepCopyInto(out *TransportServerSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Upstream ¶
type Upstream struct {
Name string `json:"name"`
Service string `json:"service"`
Port int `json:"port"`
}
Upstream defines an upstream.
func (*Upstream) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Upstream.
func (*Upstream) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type UpstreamParameters ¶ added in v1.7.0
type UpstreamParameters struct {
UDPRequests *int `json:"udpRequests"`
UDPResponses *int `json:"udpResponses"`
}
UpstreamParameters defines parameters for an upstream.
func (*UpstreamParameters) DeepCopy ¶ added in v1.7.0
func (in *UpstreamParameters) DeepCopy() *UpstreamParameters
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new UpstreamParameters.
func (*UpstreamParameters) DeepCopyInto ¶ added in v1.7.0
func (in *UpstreamParameters) DeepCopyInto(out *UpstreamParameters)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.