v1alpha1

package
v1.2.4 Latest Latest
Warning

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

 Go to latest Published: Apr 20, 2023 License: Apache-2.0 Imports: 4 Imported by: 6

Documentation

Overview

Package v1alpha1 is the v1alpha1 version of the API.

Package v1alpha1 contains API Schema definitions for the policy.openservicemesh.io v1alpha1 API group

Index

Constants

View Source 
const (
	// KindService is the kind corresponding to a Service resource.
	KindService = "Service"

	// KindAuthenticatedPrincipal is the kind corresponding to an authenticated principal.
	KindAuthenticatedPrincipal = "AuthenticatedPrincipal"

	// KindIPRange is the kind corresponding to an IP address range represented in CIDR notation.
	KindIPRange = "IPRange"
)

Variables

View Source 
var (
	// SchemeGroupVersion is group version used to register API objects in the policy.openservicemesh.io v1alpha1 API group
	SchemeGroupVersion = schema.GroupVersion{
		Group:   "policy.openservicemesh.io",
		Version: "v1alpha1",
	}

	// SchemeBuilder is used to add go types to the GroupVersionKind scheme
	SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes)

	// AddToScheme adds all Resources to the Scheme
	AddToScheme = SchemeBuilder.AddToScheme
)

Functions

func Kind 

func Kind(kind string) schema.GroupKind

Kind takes an unqualified kind and returns back a Group qualified GroupKind

func Resource 

func Resource(resource string) schema.GroupResource

Resource takes an unqualified resource and returns a Group qualified GroupResource

Types

type BackendSpec added in v0.10.0 

type BackendSpec struct {
	// Name defines the name of the backend.
	Name string `json:"name"`

	// Port defines the specification for the backend's port.
	Port PortSpec `json:"port"`

	// TLS defines the specification for the backend's TLS configuration.
	// +optional
	TLS TLSSpec `json:"tls,omitempty"`
}

BackendSpec is the type used to represent a Backend specified in the IngressBackend policy specification.

func (*BackendSpec) DeepCopy added in v0.10.0 

func (in *BackendSpec) DeepCopy() *BackendSpec

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

func (*BackendSpec) DeepCopyInto added in v0.10.0 

func (in *BackendSpec) DeepCopyInto(out *BackendSpec)

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

type ConnectionSettingsSpec added in v1.1.0 

type ConnectionSettingsSpec struct {
	// TCP specifies the TCP level connection settings.
	// Applies to both TCP and HTTP connections.
	// +optional
	TCP *TCPConnectionSettings `json:"tcp,omitempty"`

	// HTTP specifies the HTTP level connection settings.
	// +optional
	HTTP *HTTPConnectionSettings `json:"http,omitempty"`
}

ConnectionSettingsSpec defines the connection settings for an upstream host.

func (*ConnectionSettingsSpec) DeepCopy added in v1.1.0 

func (in *ConnectionSettingsSpec) DeepCopy() *ConnectionSettingsSpec

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

func (*ConnectionSettingsSpec) DeepCopyInto added in v1.1.0 

func (in *ConnectionSettingsSpec) DeepCopyInto(out *ConnectionSettingsSpec)

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

type Egress 

type Egress struct {
	// Object's type metadata
	metav1.TypeMeta `json:",inline"`

	// Object's metadata
	// +optional
	metav1.ObjectMeta `json:"metadata,omitempty"`

	// Spec is the Egress policy specification
	// +optional
	Spec EgressSpec `json:"spec,omitempty"`
}

Egress is the type used to represent an Egress traffic policy. An Egress policy allows applications to access endpoints external to the service mesh or cluster based on the specified rules in the policy. +genclient +genclient:noStatus +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object

func (*Egress) DeepCopy 

func (in *Egress) DeepCopy() *Egress

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

func (*Egress) DeepCopyInto 

func (in *Egress) DeepCopyInto(out *Egress)

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

func (*Egress) DeepCopyObject 

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

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

type EgressList 

type EgressList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata"`

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

EgressList defines the list of Egress objects. +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object

func (*EgressList) DeepCopy 

func (in *EgressList) DeepCopy() *EgressList

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

func (*EgressList) DeepCopyInto 

func (in *EgressList) DeepCopyInto(out *EgressList)

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

func (*EgressList) DeepCopyObject 

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

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

type EgressSourceSpec added in v0.10.0 

type EgressSourceSpec struct {
	// Kind defines the kind for the source in the Egress policy, ex. ServiceAccount.
	Kind string `json:"kind"`

	// Name defines the name of the source for the given Kind.
	Name string `json:"name"`

	// Namespace defines the namespace for the given source.
	Namespace string `json:"namespace"`
}

EgressSourceSpec is the type used to represent the Source in the list of Sources specified in an Egress policy specification.

func (*EgressSourceSpec) DeepCopy added in v0.10.0 

func (in *EgressSourceSpec) DeepCopy() *EgressSourceSpec

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

func (*EgressSourceSpec) DeepCopyInto added in v0.10.0 

func (in *EgressSourceSpec) DeepCopyInto(out *EgressSourceSpec)

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

type EgressSpec 

type EgressSpec struct {
	// Sources defines the list of sources the Egress policy applies to.
	Sources []EgressSourceSpec `json:"sources"`

	// Hosts defines the list of external hosts the Egress policy will allow
	// access to.
	//
	// - For HTTP traffic, the HTTP Host/Authority header is matched against the
	// list of Hosts specified.
	//
	// - For HTTPS traffic, the Server Name Indication (SNI) indicated by the client
	// in the TLS handshake is matched against the list of Hosts specified.
	//
	// - For non-HTTP(s) based protocols, the Hosts field is ignored.
	// +optional
	Hosts []string `json:"hosts,omitempty"`

	// IPAddresses defines the list of external IP address ranges the Egress policy
	// applies to. The destination IP address of the traffic is matched against the
	// list of IPAddresses specified as a CIDR range.
	// +optional
	IPAddresses []string `json:"ipAddresses,omitempty"`

	// Ports defines the list of ports the Egress policy is applies to.
	// The destination port of the traffic is matched against the list of Ports specified.
	Ports []PortSpec `json:"ports"`

	// Matches defines the list of object references the Egress policy should match on.
	// +optional
	Matches []corev1.TypedLocalObjectReference `json:"matches,omitempty"`
}

EgressSpec is the type used to represent the Egress policy specification.

func (*EgressSpec) DeepCopy 

func (in *EgressSpec) DeepCopy() *EgressSpec

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

func (*EgressSpec) DeepCopyInto 

func (in *EgressSpec) DeepCopyInto(out *EgressSpec)

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

type HTTPConnectionSettings added in v1.1.0 

type HTTPConnectionSettings struct {
	// MaxRequests specifies the maximum number of parallel requests
	// allowed to the upstream host.
	// Defaults to 4294967295 (2^32 - 1) if not specified.
	// +optional
	MaxRequests *uint32 `json:"maxRequests,omitempty"`

	// MaxRequestsPerConnection specifies the maximum number of requests
	// per connection allowed to the upstream host.
	// Defaults to unlimited if not specified.
	// +optional
	MaxRequestsPerConnection *uint32 `json:"maxRequestsPerConnection,omitempty"`

	// MaxPendingRequests specifies the maximum number of pending HTTP
	// requests allowed to the upstream host. For HTTP/2 connections,
	// if `maxRequestsPerConnection` is not configured, all requests will
	// be multiplexed over the same connection so this circuit breaker
	// will only be hit when no connection is already established.
	// Defaults to 4294967295 (2^32 - 1) if not specified.
	// +optional
	MaxPendingRequests *uint32 `json:"maxPendingRequests,omitempty"`

	// MaxRetries specifies the maximum number of parallel retries
	// allowed to the upstream host.
	// Defaults to 4294967295 (2^32 - 1) if not specified.
	// +optional
	MaxRetries *uint32 `json:"maxRetries,omitempty"`
}

HTTPConnectionSettings defines the HTTP connection settings for an upstream host.

func (*HTTPConnectionSettings) DeepCopy added in v1.1.0 

func (in *HTTPConnectionSettings) DeepCopy() *HTTPConnectionSettings

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

func (*HTTPConnectionSettings) DeepCopyInto added in v1.1.0 

func (in *HTTPConnectionSettings) DeepCopyInto(out *HTTPConnectionSettings)

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

type HTTPHeaderValue added in v1.2.0 

type HTTPHeaderValue struct {
	// Name defines the name of the HTTP header.
	Name string `json:"name"`

	// Value defines the value of the header corresponding to the name key.
	Value string `json:"value"`
}

HTTPHeaderValue defines an HTTP header name/value pair

func (*HTTPHeaderValue) DeepCopy added in v1.2.0 

func (in *HTTPHeaderValue) DeepCopy() *HTTPHeaderValue

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

func (*HTTPHeaderValue) DeepCopyInto added in v1.2.0 

func (in *HTTPHeaderValue) DeepCopyInto(out *HTTPHeaderValue)

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

type HTTPLocalRateLimitSpec added in v1.2.0 

type HTTPLocalRateLimitSpec struct {
	// Requests defines the number of requests allowed
	// per unit of time before rate limiting occurs.
	Requests uint32 `json:"requests"`

	// Unit defines the period of time within which requests
	// over the limit will be rate limited.
	// Valid values are "second", "minute" and "hour".
	Unit string `json:"unit"`

	// Burst defines the number of requests above the baseline
	// rate that are allowed in a short period of time.
	// +optional
	Burst uint32 `json:"burst,omitempty"`

	// ResponseStatusCode defines the HTTP status code to use for responses
	// to rate limited requests. Code must be in the 400-599 (inclusive)
	// error range. If not specified, a default of 429 (Too Many Requests) is used.
	// See https://www.envoyproxy.io/docs/envoy/latest/api-v3/type/v3/http_status.proto#enum-type-v3-statuscode
	// for the list of HTTP status codes supported by Envoy.
	// +optional
	ResponseStatusCode uint32 `json:"responseStatusCode,omitempty"`

	// ResponseHeadersToAdd defines the list of HTTP headers that should be
	// added to each response for requests that have been rate limited.
	// +optional
	ResponseHeadersToAdd []HTTPHeaderValue `json:"responseHeadersToAdd,omitempty"`
}

HTTPLocalRateLimitSpec defines the local rate limiting specification for the upstream host at the HTTP level.

func (*HTTPLocalRateLimitSpec) DeepCopy added in v1.2.0 

func (in *HTTPLocalRateLimitSpec) DeepCopy() *HTTPLocalRateLimitSpec

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

func (*HTTPLocalRateLimitSpec) DeepCopyInto added in v1.2.0 

func (in *HTTPLocalRateLimitSpec) DeepCopyInto(out *HTTPLocalRateLimitSpec)

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

type HTTPPerRouteRateLimitSpec added in v1.2.0 

type HTTPPerRouteRateLimitSpec struct {
	// Local defines the local rate limiting specification
	// applied per HTTP route.
	Local *HTTPLocalRateLimitSpec `json:"local,omitempty"`
}

HTTPPerRouteRateLimitSpec defines the rate limiting specification per HTTP route.

func (*HTTPPerRouteRateLimitSpec) DeepCopy added in v1.2.0 

func (in *HTTPPerRouteRateLimitSpec) DeepCopy() *HTTPPerRouteRateLimitSpec

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

func (*HTTPPerRouteRateLimitSpec) DeepCopyInto added in v1.2.0 

func (in *HTTPPerRouteRateLimitSpec) DeepCopyInto(out *HTTPPerRouteRateLimitSpec)

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

type HTTPRouteSpec added in v1.2.0 

type HTTPRouteSpec struct {
	// Path defines the HTTP path.
	Path string `json:"path"`

	// RateLimit defines the HTTP rate limiting specification for
	// the specified HTTP route.
	RateLimit *HTTPPerRouteRateLimitSpec `json:"rateLimit,omitempty"`
}

HTTPRouteSpec defines the settings correspondng to an HTTP route

func (*HTTPRouteSpec) DeepCopy added in v1.2.0 

func (in *HTTPRouteSpec) DeepCopy() *HTTPRouteSpec

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

func (*HTTPRouteSpec) DeepCopyInto added in v1.2.0 

func (in *HTTPRouteSpec) DeepCopyInto(out *HTTPRouteSpec)

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

type IngressBackend added in v0.10.0 

type IngressBackend struct {
	// Object's type metadata
	metav1.TypeMeta `json:",inline"`

	// Object's metadata
	// +optional
	metav1.ObjectMeta `json:"metadata,omitempty"`

	// Spec is the Ingress backend policy specification
	// +optional
	Spec IngressBackendSpec `json:"spec,omitempty"`

	// Status is the status of the IngressBackend configuration.
	// +optional
	Status IngressBackendStatus `json:"status,omitempty"`
}

IngressBackend is the type used to represent an Ingress backend policy. An Ingress backend policy authorizes one or more backends to accept ingress traffic from one or more sources. +genclient +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object

func (*IngressBackend) DeepCopy added in v0.10.0 

func (in *IngressBackend) DeepCopy() *IngressBackend

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

func (*IngressBackend) DeepCopyInto added in v0.10.0 

func (in *IngressBackend) DeepCopyInto(out *IngressBackend)

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

func (*IngressBackend) DeepCopyObject added in v0.10.0 

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

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

type IngressBackendList added in v0.10.0 

type IngressBackendList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata"`

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

IngressBackendList defines the list of IngressBackend objects. +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object

func (*IngressBackendList) DeepCopy added in v0.10.0 

func (in *IngressBackendList) DeepCopy() *IngressBackendList

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

func (*IngressBackendList) DeepCopyInto added in v0.10.0 

func (in *IngressBackendList) DeepCopyInto(out *IngressBackendList)

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

func (*IngressBackendList) DeepCopyObject added in v0.10.0 

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

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

type IngressBackendSpec added in v0.10.0 

type IngressBackendSpec struct {
	// Backends defines the list of backends the IngressBackend policy applies to.
	Backends []BackendSpec `json:"backends"`

	// Sources defines the list of sources the IngressBackend policy applies to.
	Sources []IngressSourceSpec `json:"sources"`

	// Matches defines the list of object references the IngressBackend policy should match on.
	// +optional
	Matches []corev1.TypedLocalObjectReference `json:"matches,omitempty"`
}

IngressBackendSpec is the type used to represent the IngressBackend policy specification.

func (*IngressBackendSpec) DeepCopy added in v0.10.0 

func (in *IngressBackendSpec) DeepCopy() *IngressBackendSpec

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

func (*IngressBackendSpec) DeepCopyInto added in v0.10.0 

func (in *IngressBackendSpec) DeepCopyInto(out *IngressBackendSpec)

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

type IngressBackendStatus added in v0.10.0 

type IngressBackendStatus struct {
	// CurrentStatus defines the current status of an IngressBackend resource.
	// +optional
	CurrentStatus string `json:"currentStatus,omitempty"`

	// Reason defines the reason for the current status of an IngressBackend resource.
	// +optional
	Reason string `json:"reason,omitempty"`
}

IngressBackendStatus is the type used to represent the status of an IngressBackend resource.

func (*IngressBackendStatus) DeepCopy added in v0.10.0 

func (in *IngressBackendStatus) DeepCopy() *IngressBackendStatus

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

func (*IngressBackendStatus) DeepCopyInto added in v0.10.0 

func (in *IngressBackendStatus) DeepCopyInto(out *IngressBackendStatus)

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

type IngressSourceSpec added in v0.10.0 

type IngressSourceSpec struct {
	// Kind defines the kind for the source in the IngressBackend policy.
	// Must be one of: Service, AuthenticatedPrincipal, IPRange
	Kind string `json:"kind"`

	// Name defines the name of the source for the given Kind.
	Name string `json:"name"`

	// Namespace defines the namespace for the given source.
	// +optional
	Namespace string `json:"namespace,omitempty"`
}

IngressSourceSpec is the type used to represent the Source in the list of Sources specified in an IngressBackend policy specification.

func (*IngressSourceSpec) DeepCopy added in v0.10.0 

func (in *IngressSourceSpec) DeepCopy() *IngressSourceSpec

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

func (*IngressSourceSpec) DeepCopyInto added in v0.10.0 

func (in *IngressSourceSpec) DeepCopyInto(out *IngressSourceSpec)

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

type LocalRateLimitSpec added in v1.2.0 

type LocalRateLimitSpec struct {
	// TCP defines the local rate limiting specification at the network
	// level. This is a token bucket rate limiter where each connection
	// consumes a single token. If the token is available, the connection
	// will be allowed. If no tokens are available, the connection will be
	// immediately closed.
	// +optional
	TCP *TCPLocalRateLimitSpec `json:"tcp,omitempty"`

	// HTTP defines the local rate limiting specification for HTTP traffic.
	// This is a token bucket rate limiter where each request consumes
	// a single token. If the token is available, the request will be
	// allowed. If no tokens are available, the request will receive the
	// configured rate limit status.
	HTTP *HTTPLocalRateLimitSpec `json:"http,omitempty"`
}

LocalRateLimitSpec defines the local rate limiting specification for the upstream host.

func (*LocalRateLimitSpec) DeepCopy added in v1.2.0 

func (in *LocalRateLimitSpec) DeepCopy() *LocalRateLimitSpec

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

func (*LocalRateLimitSpec) DeepCopyInto added in v1.2.0 

func (in *LocalRateLimitSpec) DeepCopyInto(out *LocalRateLimitSpec)

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

type PortSpec 

type PortSpec struct {
	// Number defines the port number.
	Number int `json:"number"`

	// Protocol defines the protocol served by the port.
	Protocol string `json:"protocol"`
}

PortSpec is the type used to represent the Port in the list of Ports specified in an Egress policy specification.

func (*PortSpec) DeepCopy 

func (in *PortSpec) DeepCopy() *PortSpec

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

func (*PortSpec) DeepCopyInto 

func (in *PortSpec) DeepCopyInto(out *PortSpec)

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

type RateLimitSpec added in v1.2.0 

type RateLimitSpec struct {
	// Local specified the local rate limiting specification
	// for the upstream host.
	// Local rate limiting is enforced directly by the upstream
	// host without any involvement of a global rate limiting service.
	// This is applied as a token bucket rate limiter.
	// +optional
	Local *LocalRateLimitSpec `json:"local,omitempty"`
}

RateLimitSpec defines the rate limiting specification for the upstream host.

func (*RateLimitSpec) DeepCopy added in v1.2.0 

func (in *RateLimitSpec) DeepCopy() *RateLimitSpec

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

func (*RateLimitSpec) DeepCopyInto added in v1.2.0 

func (in *RateLimitSpec) DeepCopyInto(out *RateLimitSpec)

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

type Retry added in v1.1.0 

type Retry struct {
	// Object's type metadata
	metav1.TypeMeta `json:",inline"`

	// Object's metadata
	// +optional
	metav1.ObjectMeta `json:"metadata,omitempty"`

	// Spec is the Retry policy specification
	// +optional
	Spec RetrySpec `json:"spec,omitempty"`
}

Retry is the type used to represent a Retry policy. A Retry policy authorizes retries to failed attempts for outbound traffic from one service source to one or more destination services. +genclient +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object

func (*Retry) DeepCopy added in v1.1.0 

func (in *Retry) DeepCopy() *Retry

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

func (*Retry) DeepCopyInto added in v1.1.0 

func (in *Retry) DeepCopyInto(out *Retry)

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

func (*Retry) DeepCopyObject added in v1.1.0 

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

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

type RetryList added in v1.1.0 

type RetryList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata"`

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

RetryList defines the list of Retry objects. +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object

func (*RetryList) DeepCopy added in v1.1.0 

func (in *RetryList) DeepCopy() *RetryList

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

func (*RetryList) DeepCopyInto added in v1.1.0 

func (in *RetryList) DeepCopyInto(out *RetryList)

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

func (*RetryList) DeepCopyObject added in v1.1.0 

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

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

type RetryPolicySpec added in v1.1.0 

type RetryPolicySpec struct {
	// RetryOn defines the policies to retry on, delimited by comma.
	RetryOn string `json:"retryOn"`

	// PerTryTimeout defines the time allowed for a retry before it's considered a failed attempt.
	// +optional
	PerTryTimeout *metav1.Duration `json:"perTryTimeout"`

	// NumRetries defines the max number of retries to attempt.
	// +optional
	NumRetries *uint32 `json:"numRetries"`

	// RetryBackoffBaseInterval defines the base interval for exponential retry backoff.
	// +optional
	RetryBackoffBaseInterval *metav1.Duration `json:"retryBackoffBaseInterval"`
}

RetryPolicySpec is the type used to represent the retry policy specified in the Retry policy specification.

func (*RetryPolicySpec) DeepCopy added in v1.1.0 

func (in *RetryPolicySpec) DeepCopy() *RetryPolicySpec

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

func (*RetryPolicySpec) DeepCopyInto added in v1.1.0 

func (in *RetryPolicySpec) DeepCopyInto(out *RetryPolicySpec)

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

type RetrySpec added in v1.1.0 

type RetrySpec struct {
	// Source defines the source the Retry policy applies to.
	Source RetrySrcDstSpec `json:"source"`

	// Destinations defines the list of destinations the Retry policy applies to.
	Destinations []RetrySrcDstSpec `json:"destinations"`

	// RetryPolicy defines the retry policy the Retry policy applies.
	RetryPolicy RetryPolicySpec `json:"retryPolicy"`
}

RetrySpec is the type used to represent the Retry policy specification.

func (*RetrySpec) DeepCopy added in v1.1.0 

func (in *RetrySpec) DeepCopy() *RetrySpec

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

func (*RetrySpec) DeepCopyInto added in v1.1.0 

func (in *RetrySpec) DeepCopyInto(out *RetrySpec)

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

type RetrySrcDstSpec added in v1.1.0 

type RetrySrcDstSpec struct {
	// Kind defines the kind for the Src/Dst in the Retry policy.
	Kind string `json:"kind"`

	// Name defines the name of the Src/Dst for the given Kind.
	Name string `json:"name"`

	// Namespace defines the namespace for the given Src/Dst.
	Namespace string `json:"namespace"`
}

RetrySrcDstSpec is the type used to represent the Destination in the list of Destinations and the Source specified in the Retry policy specification.

func (*RetrySrcDstSpec) DeepCopy added in v1.1.0 

func (in *RetrySrcDstSpec) DeepCopy() *RetrySrcDstSpec

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

func (*RetrySrcDstSpec) DeepCopyInto added in v1.1.0 

func (in *RetrySrcDstSpec) DeepCopyInto(out *RetrySrcDstSpec)

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

type TCPConnectionSettings added in v1.1.0 

type TCPConnectionSettings struct {
	// MaxConnections specifies the maximum number of TCP connections
	// allowed to the upstream host.
	// Defaults to 4294967295 (2^32 - 1) if not specified.
	// +optional
	MaxConnections *uint32 `json:"maxConnections,omitempty"`

	// ConnectTimeout specifies the TCP connection timeout.
	// Defaults to 5s if not specified.
	// +optional
	ConnectTimeout *metav1.Duration `json:"connectTimeout,omitempty"`
}

TCPConnectionSettings defines the TCP connection settings for an upstream host.

func (*TCPConnectionSettings) DeepCopy added in v1.1.0 

func (in *TCPConnectionSettings) DeepCopy() *TCPConnectionSettings

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

func (*TCPConnectionSettings) DeepCopyInto added in v1.1.0 

func (in *TCPConnectionSettings) DeepCopyInto(out *TCPConnectionSettings)

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

type TCPLocalRateLimitSpec added in v1.2.0 

type TCPLocalRateLimitSpec struct {
	// Connections defines the number of connections allowed
	// per unit of time before rate limiting occurs.
	Connections uint32 `json:"connections"`

	// Unit defines the period of time within which connections
	// over the limit will be rate limited.
	// Valid values are "second", "minute" and "hour".
	Unit string `json:"unit"`

	// Burst defines the number of connections above the baseline
	// rate that are allowed in a short period of time.
	// +optional
	Burst uint32 `json:"burst,omitempty"`
}

TCPLocalRateLimitSpec defines the local rate limiting specification for the upstream host at the TCP level.

func (*TCPLocalRateLimitSpec) DeepCopy added in v1.2.0 

func (in *TCPLocalRateLimitSpec) DeepCopy() *TCPLocalRateLimitSpec

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

func (*TCPLocalRateLimitSpec) DeepCopyInto added in v1.2.0 

func (in *TCPLocalRateLimitSpec) DeepCopyInto(out *TCPLocalRateLimitSpec)

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

type TLSSpec added in v0.10.0 

type TLSSpec struct {
	// SkipClientCertValidation defines whether the backend should skip validating the
	// certificate presented by the client.
	SkipClientCertValidation bool `json:"skipClientCertValidation"`

	// SNIHosts defines the SNI hostnames that the backend allows the client to connect to.
	// +optional
	SNIHosts []string `json:"sniHosts,omitempty"`
}

TLSSpec is the type used to represent the backend's TLS configuration.

func (*TLSSpec) DeepCopy added in v0.10.0 

func (in *TLSSpec) DeepCopy() *TLSSpec

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

func (*TLSSpec) DeepCopyInto added in v0.10.0 

func (in *TLSSpec) DeepCopyInto(out *TLSSpec)

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

type UpstreamTrafficSetting added in v1.1.0 

type UpstreamTrafficSetting struct {
	// Object's type metadata
	metav1.TypeMeta `json:",inline"`

	// Object's metadata
	// +optional
	metav1.ObjectMeta `json:"metadata,omitempty"`

	// Spec is the UpstreamTrafficSetting policy specification
	// +optional
	Spec UpstreamTrafficSettingSpec `json:"spec,omitempty"`

	// Status is the status of the UpstreamTrafficSetting resource.
	// +optional
	Status UpstreamTrafficSettingStatus `json:"status,omitempty"`
}

UpstreamTrafficSetting defines the settings applicable to traffic destined to an upstream host. +genclient +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object

func (*UpstreamTrafficSetting) DeepCopy added in v1.1.0 

func (in *UpstreamTrafficSetting) DeepCopy() *UpstreamTrafficSetting

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

func (*UpstreamTrafficSetting) DeepCopyInto added in v1.1.0 

func (in *UpstreamTrafficSetting) DeepCopyInto(out *UpstreamTrafficSetting)

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

func (*UpstreamTrafficSetting) DeepCopyObject added in v1.1.0 

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

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

type UpstreamTrafficSettingList added in v1.1.0 

type UpstreamTrafficSettingList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata"`

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

UpstreamTrafficSettingList defines the list of UpstreamTrafficSetting objects. +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object

func (*UpstreamTrafficSettingList) DeepCopy added in v1.1.0 

func (in *UpstreamTrafficSettingList) DeepCopy() *UpstreamTrafficSettingList

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

func (*UpstreamTrafficSettingList) DeepCopyInto added in v1.1.0 

func (in *UpstreamTrafficSettingList) DeepCopyInto(out *UpstreamTrafficSettingList)

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

func (*UpstreamTrafficSettingList) DeepCopyObject added in v1.1.0 

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

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

type UpstreamTrafficSettingSpec added in v1.1.0 

type UpstreamTrafficSettingSpec struct {
	// Host the upstream traffic is directed to.
	// Must either be an FQDN corresponding to the upstream service
	// or the name of the upstream service. If only the service name
	// is specified, the FQDN is derived from the service name and
	// the namespace of the UpstreamTrafficSetting rule.
	Host string `json:"host"`

	// ConnectionSettings specifies the connection settings for traffic
	// directed to the upstream host.
	// +optional
	ConnectionSettings *ConnectionSettingsSpec `json:"connectionSettings,omitempty"`

	// RateLimit specifies the rate limit settings for the traffic
	// directed to the upstream host.
	// If HTTP rate limiting is specified, the rate limiting is applied
	// at the VirtualHost level applicable to all routes within the
	// VirtualHost.
	// +optional
	RateLimit *RateLimitSpec `json:"rateLimit,omitempty"`

	// HTTPRoutes defines the list of HTTP routes settings
	// for the upstream host. Settings are applied at a per
	// route level.
	// +optional
	HTTPRoutes []HTTPRouteSpec `json:"httpRoutes,omitempty"`
}

UpstreamTrafficSettingSpec defines the upstream traffic setting specification.

func (*UpstreamTrafficSettingSpec) DeepCopy added in v1.1.0 

func (in *UpstreamTrafficSettingSpec) DeepCopy() *UpstreamTrafficSettingSpec

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

func (*UpstreamTrafficSettingSpec) DeepCopyInto added in v1.1.0 

func (in *UpstreamTrafficSettingSpec) DeepCopyInto(out *UpstreamTrafficSettingSpec)

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

type UpstreamTrafficSettingStatus added in v1.1.0 

type UpstreamTrafficSettingStatus struct {
	// CurrentStatus defines the current status of an UpstreamTrafficSetting resource.
	// +optional
	CurrentStatus string `json:"currentStatus,omitempty"`

	// Reason defines the reason for the current status of an UpstreamTrafficSetting resource.
	// +optional
	Reason string `json:"reason,omitempty"`
}

UpstreamTrafficSettingStatus defines the status of an UpstreamTrafficSetting resource.

func (*UpstreamTrafficSettingStatus) DeepCopy added in v1.1.0 

func (in *UpstreamTrafficSettingStatus) DeepCopy() *UpstreamTrafficSettingStatus

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

func (*UpstreamTrafficSettingStatus) DeepCopyInto added in v1.1.0 

func (in *UpstreamTrafficSettingStatus) DeepCopyInto(out *UpstreamTrafficSettingStatus)

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

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.