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 EgressMTLS
 - type GlobalConfiguration
 - type GlobalConfigurationList
 - type GlobalConfigurationSpec
 - type IngressMTLS
 - type JWTAuth
 - type Listener
 - type Policy
 - type PolicyList
 - type PolicySpec
 - type RateLimit
 - type SessionParameters
 - type TransportServer
 - type TransportServerAction
 - type TransportServerHealthCheck
 - type TransportServerList
 - type TransportServerListener
 - type TransportServerMatch
 - type TransportServerSpec
 - type TransportServerStatus
 - type TransportServerTLS
 - type TransportServerUpstream
 - 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 build a scheme SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes) // AddToScheme exported add function 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 ¶
AccessControl defines an access policy based on the source IP of a request.
func (*AccessControl) DeepCopy ¶
func (in *AccessControl) DeepCopy() *AccessControl
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AccessControl.
func (*AccessControl) DeepCopyInto ¶
func (in *AccessControl) DeepCopyInto(out *AccessControl)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type EgressMTLS ¶
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 ¶
func (in *EgressMTLS) DeepCopy() *EgressMTLS
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new EgressMTLS.
func (*EgressMTLS) DeepCopyInto ¶
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 ¶
type GlobalConfiguration struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`
	Spec GlobalConfigurationSpec `json:"spec"`
}
    GlobalConfiguration defines the GlobalConfiguration resource.
func (*GlobalConfiguration) DeepCopy ¶
func (in *GlobalConfiguration) DeepCopy() *GlobalConfiguration
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new GlobalConfiguration.
func (*GlobalConfiguration) DeepCopyInto ¶
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 ¶
func (in *GlobalConfiguration) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type GlobalConfigurationList ¶
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 ¶
func (in *GlobalConfigurationList) DeepCopy() *GlobalConfigurationList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new GlobalConfigurationList.
func (*GlobalConfigurationList) DeepCopyInto ¶
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 ¶
func (in *GlobalConfigurationList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type GlobalConfigurationSpec ¶
type GlobalConfigurationSpec struct {
	Listeners []Listener `json:"listeners"`
}
    GlobalConfigurationSpec is the spec of the GlobalConfiguration resource.
func (*GlobalConfigurationSpec) DeepCopy ¶
func (in *GlobalConfigurationSpec) DeepCopy() *GlobalConfigurationSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new GlobalConfigurationSpec.
func (*GlobalConfigurationSpec) DeepCopyInto ¶
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 ¶
type IngressMTLS struct {
	ClientCertSecret string `json:"clientCertSecret"`
	VerifyClient     string `json:"verifyClient"`
	VerifyDepth      *int   `json:"verifyDepth"`
}
    IngressMTLS defines an Ingress MTLS policy.
func (*IngressMTLS) DeepCopy ¶
func (in *IngressMTLS) DeepCopy() *IngressMTLS
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new IngressMTLS.
func (*IngressMTLS) DeepCopyInto ¶
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 ¶
type JWTAuth struct {
	Realm  string `json:"realm"`
	Secret string `json:"secret"`
	Token  string `json:"token"`
}
    JWTAuth holds JWT authentication configuration.
func (*JWTAuth) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new JWTAuth.
func (*JWTAuth) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Listener ¶
type Listener struct {
	Name     string `json:"name"`
	Port     int    `json:"port"`
	Protocol string `json:"protocol"`
	Ssl      bool   `json:"ssl"`
}
    Listener defines a listener.
func (*Listener) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Listener.
func (*Listener) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Policy ¶
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 ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Policy.
func (*Policy) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Policy) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type PolicyList ¶
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 ¶
func (in *PolicyList) DeepCopy() *PolicyList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PolicyList.
func (*PolicyList) DeepCopyInto ¶
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 ¶
func (in *PolicyList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type PolicySpec ¶
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 ¶
func (in *PolicySpec) DeepCopy() *PolicySpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PolicySpec.
func (*PolicySpec) DeepCopyInto ¶
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 ¶
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 ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RateLimit.
func (*RateLimit) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type SessionParameters ¶
type SessionParameters struct {
	Timeout string `json:"timeout"`
}
    SessionParameters defines session parameters.
func (*SessionParameters) DeepCopy ¶
func (in *SessionParameters) DeepCopy() *SessionParameters
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SessionParameters.
func (*SessionParameters) DeepCopyInto ¶
func (in *SessionParameters) DeepCopyInto(out *SessionParameters)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type TransportServer ¶
type TransportServer struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`
	Spec   TransportServerSpec   `json:"spec"`
	Status TransportServerStatus `json:"status"`
}
    TransportServer defines the TransportServer resource.
func (*TransportServer) DeepCopy ¶
func (in *TransportServer) DeepCopy() *TransportServer
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TransportServer.
func (*TransportServer) DeepCopyInto ¶
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 ¶
func (in *TransportServer) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type TransportServerAction ¶
type TransportServerAction struct {
	Pass string `json:"pass"`
}
    TransportServerAction defines an action.
func (*TransportServerAction) DeepCopy ¶
func (in *TransportServerAction) DeepCopy() *TransportServerAction
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TransportServerAction.
func (*TransportServerAction) DeepCopyInto ¶
func (in *TransportServerAction) DeepCopyInto(out *TransportServerAction)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type TransportServerHealthCheck ¶
type TransportServerHealthCheck struct {
	Enabled  bool                  `json:"enable"`
	Timeout  string                `json:"timeout"`
	Jitter   string                `json:"jitter"`
	Port     int                   `json:"port"`
	Interval string                `json:"interval"`
	Passes   int                   `json:"passes"`
	Fails    int                   `json:"fails"`
	Match    *TransportServerMatch `json:"match"`
}
    TransportServerHealthCheck defines the parameters for active Upstream HealthChecks.
func (*TransportServerHealthCheck) DeepCopy ¶
func (in *TransportServerHealthCheck) DeepCopy() *TransportServerHealthCheck
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TransportServerHealthCheck.
func (*TransportServerHealthCheck) DeepCopyInto ¶
func (in *TransportServerHealthCheck) DeepCopyInto(out *TransportServerHealthCheck)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type TransportServerList ¶
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 ¶
func (in *TransportServerList) DeepCopy() *TransportServerList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TransportServerList.
func (*TransportServerList) DeepCopyInto ¶
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 ¶
func (in *TransportServerList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type TransportServerListener ¶
TransportServerListener defines a listener for a TransportServer.
func (*TransportServerListener) DeepCopy ¶
func (in *TransportServerListener) DeepCopy() *TransportServerListener
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TransportServerListener.
func (*TransportServerListener) DeepCopyInto ¶
func (in *TransportServerListener) DeepCopyInto(out *TransportServerListener)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type TransportServerMatch ¶
TransportServerMatch defines the parameters of a custom health check.
func (*TransportServerMatch) DeepCopy ¶
func (in *TransportServerMatch) DeepCopy() *TransportServerMatch
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TransportServerMatch.
func (*TransportServerMatch) DeepCopyInto ¶
func (in *TransportServerMatch) DeepCopyInto(out *TransportServerMatch)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type TransportServerSpec ¶
type TransportServerSpec struct {
	IngressClass       string                    `json:"ingressClassName"`
	TLS                *TransportServerTLS       `json:"tls"`
	Listener           TransportServerListener   `json:"listener"`
	ServerSnippets     string                    `json:"serverSnippets"`
	StreamSnippets     string                    `json:"streamSnippets"`
	Host               string                    `json:"host"`
	Upstreams          []TransportServerUpstream `json:"upstreams"`
	UpstreamParameters *UpstreamParameters       `json:"upstreamParameters"`
	SessionParameters  *SessionParameters        `json:"sessionParameters"`
	Action             *TransportServerAction    `json:"action"`
}
    TransportServerSpec is the spec of the TransportServer resource.
func (*TransportServerSpec) DeepCopy ¶
func (in *TransportServerSpec) DeepCopy() *TransportServerSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TransportServerSpec.
func (*TransportServerSpec) DeepCopyInto ¶
func (in *TransportServerSpec) DeepCopyInto(out *TransportServerSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type TransportServerStatus ¶
type TransportServerStatus struct {
	State   string `json:"state"`
	Reason  string `json:"reason"`
	Message string `json:"message"`
}
    TransportServerStatus defines the status for the TransportServer resource.
func (*TransportServerStatus) DeepCopy ¶
func (in *TransportServerStatus) DeepCopy() *TransportServerStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TransportServerStatus.
func (*TransportServerStatus) DeepCopyInto ¶
func (in *TransportServerStatus) DeepCopyInto(out *TransportServerStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type TransportServerTLS ¶
type TransportServerTLS struct {
	Secret string `json:"secret"`
}
    TransportServerTLS defines TransportServerTLS configuration for a TransportServer.
func (*TransportServerTLS) DeepCopy ¶
func (in *TransportServerTLS) DeepCopy() *TransportServerTLS
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TransportServerTLS.
func (*TransportServerTLS) DeepCopyInto ¶
func (in *TransportServerTLS) DeepCopyInto(out *TransportServerTLS)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type TransportServerUpstream ¶
type TransportServerUpstream struct {
	Name                string                      `json:"name"`
	Service             string                      `json:"service"`
	Port                int                         `json:"port"`
	FailTimeout         string                      `json:"failTimeout"`
	MaxFails            *int                        `json:"maxFails"`
	MaxConns            *int                        `json:"maxConns"`
	HealthCheck         *TransportServerHealthCheck `json:"healthCheck"`
	LoadBalancingMethod string                      `json:"loadBalancingMethod"`
	Backup              *string                     `json:"backup"`
	BackupPort          *int                        `json:"backupPort"`
}
    TransportServerUpstream defines an upstream.
func (*TransportServerUpstream) DeepCopy ¶
func (in *TransportServerUpstream) DeepCopy() *TransportServerUpstream
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TransportServerUpstream.
func (*TransportServerUpstream) DeepCopyInto ¶
func (in *TransportServerUpstream) DeepCopyInto(out *TransportServerUpstream)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type UpstreamParameters ¶
type UpstreamParameters struct {
	UDPRequests  *int `json:"udpRequests"`
	UDPResponses *int `json:"udpResponses"`
	ConnectTimeout      string `json:"connectTimeout"`
	NextUpstream        bool   `json:"nextUpstream"`
	NextUpstreamTimeout string `json:"nextUpstreamTimeout"`
	NextUpstreamTries   int    `json:"nextUpstreamTries"`
}
    UpstreamParameters defines parameters for an upstream.
func (*UpstreamParameters) DeepCopy ¶
func (in *UpstreamParameters) DeepCopy() *UpstreamParameters
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new UpstreamParameters.
func (*UpstreamParameters) DeepCopyInto ¶
func (in *UpstreamParameters) DeepCopyInto(out *UpstreamParameters)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.