v1

package
v1.14.0 Latest Latest
Warning

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

 Go to latest Published: Apr 1, 2021 License: Apache-2.0 Imports: 5 Imported by: 34

Documentation

Overview

Package v1 is the v1 version of the API. +groupName=projectcontour.io

Package v1 holds the specification for the projectcontour.io Custom Resource Definitions (CRDs).

In building this CRD, we've inadvertently overloaded the word "Condition", so we've tried to make this spec clear as to which types of condition are which.

`MatchConditions` are used by `Routes` and `Includes` to specify rules to match requests against for either routing or inclusion.

`DetailedConditions` are used in the `Status` of these objects to hold information about the relevant state of the object and the world around it.

`SubConditions` are used underneath `DetailedConditions` to give more detail to errors or warnings.

+groupName=projectcontour.io

Index

Constants

View Source 
const (
	// ValidConditionType describes an valid condition.
	ValidConditionType = "Valid"

	// ConditionTypeAuthError describes an error condition related to Auth.
	ConditionTypeAuthError = "AuthError"

	// ConditionTypeCORSError describes an error condition related to CORS.
	ConditionTypeCORSError = "CORSError"

	// ConditionTypeIncludeError describes an error condition with
	// inclusion of another HTTPProxy resource.
	ConditionTypeIncludeError = "IncludeError"

	// ConditionTypeOrphanedError describes an error condition
	// with an HTTPProxy resource which is not part of a delegation chain.
	ConditionTypeOrphanedError = "Orphaned"

	// ConditionTypePrefixReplaceError describes an error condition with
	// an HTTPProxy path prefix replacement issue.
	ConditionTypePrefixReplaceError = "PrefixReplaceError"

	// ConditionTypeRootNamespaceError describes an error condition
	// with an HTTPProxy resource created in non-root namespace.
	ConditionTypeRootNamespaceError = "RootNamespaceError"

	// ConditionTypeRouteError describes an error condition that
	// relates to Routes within an HTTPProxy.
	ConditionTypeRouteError = "RouteError"

	// ConditionTypeServiceError describes an error condition that
	// relates to a Service error within an HTTPProxy.
	ConditionTypeServiceError = "ServiceError"

	// ConditionTypeSpecError describes an error condition that
	// relates to the Spec of an HTTPProxy resource.
	ConditionTypeSpecError = "SpecError"

	// ConditionTypeTCPProxyIncludeError describes an error condition
	// with inclusion of another HTTPProxy TCP Proxy resource.
	ConditionTypeTCPProxyIncludeError = "TCPProxyIncludeError"

	// ConditionTypeTCPProxyError describes an error condition relating
	// to a TCP Proxy HTTPProxy resource.
	ConditionTypeTCPProxyError = "TCPProxyError"

	// ConditionTypeTLSError describes an error condition relating
	// to TLS configuration.
	ConditionTypeTLSError = "TLSError"

	// ConditionTypeVirtualHostError describes an error condition relating
	// to the VirtualHost configuration section of an HTTPProxy resource.
	ConditionTypeVirtualHostError = "VirtualHostError"
)
View Source 
const (
	// GroupName is the group name for the Contour API
	GroupName = "projectcontour.io"
)
View Source 
const LongMessageLength = 32760

LongMessageLength specifies the maximum size any message field should be. This is enforced on the apiserver side by CRD validation requirements.

Variables

View Source 
var (
	// GroupVersion is group version used to register these objects
	GroupVersion = schema.GroupVersion{Group: GroupName, Version: "v1"}

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

	// AddToScheme adds the types in this group-version to the given scheme.
	AddToScheme = SchemeBuilder.AddToScheme
)
View Source 
var HTTPProxyGVR = GroupVersion.WithResource("httpproxies")
View Source 
var SchemeGroupVersion = GroupVersion

SchemeGroupVersion is a compatibility name for the GroupVersion. New code should use GroupVersion.

View Source 
var TLSCertificateDelegationGVR = GroupVersion.WithResource("tlscertificatedelegations")

Functions

func AddKnownTypes added in v1.2.0 

func AddKnownTypes(scheme *runtime.Scheme) error

AddKnownTypes is exported for backwards compatibility with third parties who depend on this symbol, but all new code should use AddToScheme.

func Resource 

func Resource(resource string) schema.GroupResource

Resource gets an Contour GroupResource for a specified resource

Types

type AuthorizationPolicy added in v1.9.0 

type AuthorizationPolicy struct {
	// When true, this field disables client request authentication
	// for the scope of the policy.
	//
	// +optional
	Disabled bool `json:"disabled,omitempty"`

	// Context is a set of key/value pairs that are sent to the
	// authentication server in the check request. If a context
	// is provided at an enclosing scope, the entries are merged
	// such that the inner scope overrides matching keys from the
	// outer scope.
	//
	// +optional
	Context map[string]string `json:"context,omitempty"`
}

AuthorizationPolicy modifies how client requests are authenticated.

func (*AuthorizationPolicy) DeepCopy added in v1.9.0 

func (in *AuthorizationPolicy) DeepCopy() *AuthorizationPolicy

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

func (*AuthorizationPolicy) DeepCopyInto added in v1.9.0 

func (in *AuthorizationPolicy) DeepCopyInto(out *AuthorizationPolicy)

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

type AuthorizationServer added in v1.9.0 

type AuthorizationServer struct {
	// ExtensionServiceRef specifies the extension resource that will authorize client requests.
	//
	// +required
	ExtensionServiceRef ExtensionServiceReference `json:"extensionRef"`

	// AuthPolicy sets a default authorization policy for client requests.
	// This policy will be used unless overridden by individual routes.
	//
	// +optional
	AuthPolicy *AuthorizationPolicy `json:"authPolicy,omitempty"`

	// ResponseTimeout configures maximum time to wait for a check response from the authorization server.
	// Timeout durations are expressed in the Go [Duration format](https://godoc.org/time#ParseDuration).
	// Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h".
	// The string "infinity" is also a valid input and specifies no timeout.
	//
	// +optional
	// +kubebuilder:validation:Pattern=`^(((\d*(\.\d*)?h)|(\d*(\.\d*)?m)|(\d*(\.\d*)?s)|(\d*(\.\d*)?ms)|(\d*(\.\d*)?us)|(\d*(\.\d*)?µs)|(\d*(\.\d*)?ns))+|infinity|infinite)$`
	ResponseTimeout string `json:"responseTimeout,omitempty"`

	// If FailOpen is true, the client request is forwarded to the upstream service
	// even if the authorization server fails to respond. This field should not be
	// set in most cases. It is intended for use only while migrating applications
	// from internal authorization to Contour external authorization.
	//
	// +optional
	FailOpen bool `json:"failOpen,omitempty"`
}

AuthorizationServer configures an external server to authenticate client requests. The external server must implement the v3 Envoy external authorization GRPC protocol (https://www.envoyproxy.io/docs/envoy/latest/api-v3/service/auth/v3/external_auth.proto).

func (*AuthorizationServer) DeepCopy added in v1.9.0 

func (in *AuthorizationServer) DeepCopy() *AuthorizationServer

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

func (*AuthorizationServer) DeepCopyInto added in v1.9.0 

func (in *AuthorizationServer) DeepCopyInto(out *AuthorizationServer)

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

type CORSHeaderValue added in v1.9.0 

type CORSHeaderValue string

CORSHeaderValue specifies the value of the string headers returned by a cross-domain request. +kubebuilder:validation:Pattern="^[a-zA-Z0-9!#$%&'*+.^_`|~-]+$"

type CORSPolicy added in v1.9.0 

type CORSPolicy struct {
	// Specifies whether the resource allows credentials.
	//  +optional
	AllowCredentials bool `json:"allowCredentials,omitempty"`
	// AllowOrigin specifies the origins that will be allowed to do CORS requests. "*" means
	// allow any origin.
	// +kubebuilder:validation:Required
	AllowOrigin []string `json:"allowOrigin"`
	// AllowMethods specifies the content for the *access-control-allow-methods* header.
	// +kubebuilder:validation:Required
	AllowMethods []CORSHeaderValue `json:"allowMethods"`
	// AllowHeaders specifies the content for the *access-control-allow-headers* header.
	//  +optional
	AllowHeaders []CORSHeaderValue `json:"allowHeaders,omitempty"`
	// ExposeHeaders Specifies the content for the *access-control-expose-headers* header.
	//  +optional
	ExposeHeaders []CORSHeaderValue `json:"exposeHeaders,omitempty"`
	// MaxAge indicates for how long the results of a preflight request can be cached.
	// MaxAge durations are expressed in the Go [Duration format](https://godoc.org/time#ParseDuration).
	// Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h".
	// Only positive values are allowed while 0 disables the cache requiring a preflight OPTIONS
	// check for all cross-origin requests.
	//  +optional
	MaxAge string `json:"maxAge,omitempty"`
}

CORSPolicy allows setting the CORS policy

func (*CORSPolicy) DeepCopy added in v1.9.0 

func (in *CORSPolicy) DeepCopy() *CORSPolicy

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

func (*CORSPolicy) DeepCopyInto added in v1.9.0 

func (in *CORSPolicy) DeepCopyInto(out *CORSPolicy)

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

type CertificateDelegation 

type CertificateDelegation struct {

	// required, the name of a secret in the current namespace.
	SecretName string `json:"secretName"`

	// required, the namespaces the authority to reference the
	// the secret will be delegated to.
	// If TargetNamespaces is nil or empty, the CertificateDelegation'
	// is ignored. If the TargetNamespace list contains the character, "*"
	// the secret will be delegated to all namespaces.
	TargetNamespaces []string `json:"targetNamespaces"`
}

CertificateDelegation maps the authority to reference a secret in the current namespace to a set of namespaces.

func (*CertificateDelegation) DeepCopy 

func (in *CertificateDelegation) DeepCopy() *CertificateDelegation

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

func (*CertificateDelegation) DeepCopyInto 

func (in *CertificateDelegation) DeepCopyInto(out *CertificateDelegation)

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

type Condition 

type Condition = metav1.Condition

Condition is a type alias for the k8s.io/apimachinery/pkg/apis/meta/v1 Condition type to maintain API compatibility. +k8s:deepcopy-gen=false

type ConditionStatus added in v1.7.0 

type ConditionStatus = metav1.ConditionStatus

ConditionStatus is a type alias for the k8s.io/apimachinery/pkg/apis/meta/v1 ConditionStatus type to maintain API compatibility. +k8s:deepcopy-gen=false 

const (
	ConditionTrue    ConditionStatus = metav1.ConditionTrue
	ConditionFalse   ConditionStatus = metav1.ConditionFalse
	ConditionUnknown ConditionStatus = metav1.ConditionUnknown
)

These are valid condition statuses. "ConditionTrue" means a resource is in the condition. "ConditionFalse" means a resource is not in the condition. "ConditionUnknown" means kubernetes can't decide if a resource is in the condition or not. In the future, we could add other intermediate conditions, e.g. ConditionDegraded. These are retained here for API compatibility.

type DetailedCondition added in v1.7.0 

type DetailedCondition struct {
	Condition `json:",inline"`
	// Errors contains a slice of relevant error subconditions for this object.
	//
	// Subconditions are expected to appear when relevant (when there is a error), and disappear when not relevant.
	// An empty slice here indicates no errors.
	// +optional
	Errors []SubCondition `json:"errors,omitempty"`
	// Warnings contains a slice of relevant warning subconditions for this object.
	//
	// Subconditions are expected to appear when relevant (when there is a warning), and disappear when not relevant.
	// An empty slice here indicates no warnings.
	// +optional
	Warnings []SubCondition `json:"warnings,omitempty"`
}

DetailedCondition is an extension of the normal Kubernetes conditions, with two extra fields to hold sub-conditions, which provide more detailed reasons for the state (True or False) of the condition.

`errors` holds information about sub-conditions which are fatal to that condition and render its state False.

`warnings` holds information about sub-conditions which are not fatal to that condition and do not force the state to be False.

Remember that Conditions have a type, a status, and a reason.

The type is the type of the condition, the most important one in this CRD set is `Valid`. `Valid` is a positive-polarity condition: when it is `status: true` there are no problems.

In more detail, `status: true` means that the object is has been ingested into Contour with no errors. `warnings` may still be present, and will be indicated in the Reason field. There must be zero entries in the `errors` slice in this case.

`Valid`, `status: false` means that the object has had one or more fatal errors during processing into Contour. 

The details of the errors will be present under the `errors` field. There must be at least one error in the `errors`

slice if `status` is `false`.

For DetailedConditions of types other than `Valid`, the Condition must be in the negative polarity. When they have `status` `true`, there is an error. There must be at least one entry in the `errors` Subcondition slice. When they have `status` `false`, there are no serious errors, and there must be zero entries in the `errors` slice. In either case, there may be entries in the `warnings` slice.

Regardless of the polarity, the `reason` and `message` fields must be updated with either the detail of the reason (if there is one and only one entry in total across both the `errors` and `warnings` slices), or `MultipleReasons` if there is more than one entry.

func (*DetailedCondition) AddError added in v1.9.0 

func (dc *DetailedCondition) AddError(errorType, reason, message string)

AddError adds an error-level Subcondition to the DetailedCondition. AddError will also update the DetailedCondition's state to take into account the error that's present. If a SubCondition with the given errorType exists, will overwrite the details.

func (*DetailedCondition) AddErrorf added in v1.9.0 

func (dc *DetailedCondition) AddErrorf(errorType, reason, formatmsg string, args ...interface{})

AddErrorf adds an error-level Subcondition to the DetailedCondition, using fmt.Sprintf on the formatmsg and args params. If a SubCondition with the given errorType exists, will overwrite the details.

func (*DetailedCondition) AddWarning added in v1.9.0 

func (dc *DetailedCondition) AddWarning(warnType, reason, message string)

AddWarning adds an warning-level Subcondition to the DetailedCondition. If a SubCondition with the given warnType exists, will overwrite the details. Note that adding warnings does not update the DetailedCondition Reason or Message.

func (*DetailedCondition) AddWarningf added in v1.9.0 

func (dc *DetailedCondition) AddWarningf(warnType, reason, formatmsg string, args ...interface{})

AddWarningf adds an warning-level Subcondition to the DetailedCondition, using fmt.Sprintf on the formatmsg and args params. If a SubCondition with the given errorType exists, will overwrite the details. Note that adding warnings does not update the DetailedCondition Reason or Message.

func (*DetailedCondition) DeepCopy added in v1.7.0 

func (in *DetailedCondition) DeepCopy() *DetailedCondition

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

func (*DetailedCondition) DeepCopyInto added in v1.7.0 

func (in *DetailedCondition) DeepCopyInto(out *DetailedCondition)

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

func (*DetailedCondition) GetError added in v1.9.0 

func (dc *DetailedCondition) GetError(errorType string) (SubCondition, bool)

GetError gets an error of the given errorType. Similar to a hash lookup, will return true in the second value if a match is found, and false otherwise.

func (*DetailedCondition) GetWarning added in v1.9.0 

func (dc *DetailedCondition) GetWarning(warnType string) (SubCondition, bool)

GetWarning gets an warning of the given warnType. Similar to a hash lookup, will return true in the second value if a match is found, and false otherwise.

func (*DetailedCondition) IsPositivePolarity added in v1.9.0 

func (dc *DetailedCondition) IsPositivePolarity() bool

IsPositivePolarity returns true if the DetailedCondition is a positive-polarity condition like `Valid` or `Ready`, and false otherwise.

type DownstreamValidation added in v1.4.0 

type DownstreamValidation struct {
	// Name of a Kubernetes secret that contains a CA certificate bundle.
	// The client certificate must validate against the certificates in the bundle.
	// +kubebuilder:validation:Required
	// +kubebuilder:validation:MinLength=1
	CACertificate string `json:"caSecret"`
}

DownstreamValidation defines how to verify the client certificate.

func (*DownstreamValidation) DeepCopy added in v1.4.0 

func (in *DownstreamValidation) DeepCopy() *DownstreamValidation

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

func (*DownstreamValidation) DeepCopyInto added in v1.4.0 

func (in *DownstreamValidation) DeepCopyInto(out *DownstreamValidation)

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

type ExtensionServiceReference added in v1.9.0 

type ExtensionServiceReference struct {
	// API version of the referent.
	// If this field is not specified, the default "projectcontour.io/v1alpha1" will be used
	//
	// +optional
	// +kubebuilder:validation:MinLength=1
	APIVersion string `json:"apiVersion,omitempty" protobuf:"bytes,5,opt,name=apiVersion"`

	// Namespace of the referent.
	// If this field is not specifies, the namespace of the resource that targets the referent will be used.
	//
	// More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/
	//
	// +optional
	// +kubebuilder:validation:MinLength=1
	Namespace string `json:"namespace,omitempty" protobuf:"bytes,2,opt,name=namespace"`

	// Name of the referent.
	//
	// More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
	//
	// +required
	// +kubebuilder:validation:MinLength=1
	Name string `json:"name,omitempty" protobuf:"bytes,3,opt,name=name"`
}

ExtensionServiceReference names an ExtensionService resource.

func (*ExtensionServiceReference) DeepCopy added in v1.9.0 

func (in *ExtensionServiceReference) DeepCopy() *ExtensionServiceReference

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

func (*ExtensionServiceReference) DeepCopyInto added in v1.9.0 

func (in *ExtensionServiceReference) DeepCopyInto(out *ExtensionServiceReference)

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

type GenericKeyDescriptor added in v1.13.0 

type GenericKeyDescriptor struct {
	// Key defines the key of the descriptor entry. If not set, the
	// key is set to "generic_key".
	// +optional
	Key string `json:"key,omitempty"`

	// Value defines the value of the descriptor entry.
	// +required
	// +kubebuilder:validation:MinLength=1
	Value string `json:"value,omitempty"`
}

GenericKeyDescriptor defines a descriptor entry with a static key and value.

func (*GenericKeyDescriptor) DeepCopy added in v1.13.0 

func (in *GenericKeyDescriptor) DeepCopy() *GenericKeyDescriptor

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

func (*GenericKeyDescriptor) DeepCopyInto added in v1.13.0 

func (in *GenericKeyDescriptor) DeepCopyInto(out *GenericKeyDescriptor)

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

type GlobalRateLimitPolicy added in v1.13.0 

type GlobalRateLimitPolicy struct {
	// Descriptors defines the list of descriptors that will
	// be generated and sent to the rate limit service. Each
	// descriptor contains 1+ key-value pair entries.
	// +required
	// +kubebuilder:validation:MinItems=1
	Descriptors []RateLimitDescriptor `json:"descriptors,omitempty"`
}

GlobalRateLimitPolicy defines global rate limiting parameters.

func (*GlobalRateLimitPolicy) DeepCopy added in v1.13.0 

func (in *GlobalRateLimitPolicy) DeepCopy() *GlobalRateLimitPolicy

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

func (*GlobalRateLimitPolicy) DeepCopyInto added in v1.13.0 

func (in *GlobalRateLimitPolicy) DeepCopyInto(out *GlobalRateLimitPolicy)

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

type HTTPHealthCheckPolicy 

type HTTPHealthCheckPolicy struct {
	// HTTP endpoint used to perform health checks on upstream service
	Path string `json:"path"`
	// The value of the host header in the HTTP health check request.
	// If left empty (default value), the name "contour-envoy-healthcheck"
	// will be used.
	Host string `json:"host,omitempty"`
	// The interval (seconds) between health checks
	// +optional
	IntervalSeconds int64 `json:"intervalSeconds"`
	// The time to wait (seconds) for a health check response
	// +optional
	TimeoutSeconds int64 `json:"timeoutSeconds"`
	// The number of unhealthy health checks required before a host is marked unhealthy
	// +optional
	// +kubebuilder:validation:Minimum=0
	UnhealthyThresholdCount int64 `json:"unhealthyThresholdCount"`
	// The number of healthy health checks required before a host is marked healthy
	// +optional
	// +kubebuilder:validation:Minimum=0
	HealthyThresholdCount int64 `json:"healthyThresholdCount"`
}

HTTPHealthCheckPolicy defines health checks on the upstream service.

func (*HTTPHealthCheckPolicy) DeepCopy 

func (in *HTTPHealthCheckPolicy) DeepCopy() *HTTPHealthCheckPolicy

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

func (*HTTPHealthCheckPolicy) DeepCopyInto 

func (in *HTTPHealthCheckPolicy) DeepCopyInto(out *HTTPHealthCheckPolicy)

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

type HTTPProxy 

type HTTPProxy struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata"`

	Spec HTTPProxySpec `json:"spec"`
	// Status is a container for computed information about the HTTPProxy.
	// +optional
	Status HTTPProxyStatus `json:"status,omitempty"`
}

HTTPProxy is an Ingress CRD specification. +k8s:openapi-gen=true +kubebuilder:printcolumn:name="FQDN",type="string",JSONPath=".spec.virtualhost.fqdn",description="Fully qualified domain name" +kubebuilder:printcolumn:name="TLS Secret",type="string",JSONPath=".spec.virtualhost.tls.secretName",description="Secret with TLS credentials" +kubebuilder:printcolumn:name="Status",type="string",JSONPath=".status.currentStatus",description="The current status of the HTTPProxy" +kubebuilder:printcolumn:name="Status Description",type="string",JSONPath=".status.description",description="Description of the current status" +kubebuilder:resource:scope=Namespaced,path=httpproxies,shortName=proxy;proxies,singular=httpproxy +kubebuilder:subresource:status

func (*HTTPProxy) DeepCopy 

func (in *HTTPProxy) DeepCopy() *HTTPProxy

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

func (*HTTPProxy) DeepCopyInto 

func (in *HTTPProxy) DeepCopyInto(out *HTTPProxy)

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

func (*HTTPProxy) DeepCopyObject 

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

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

type HTTPProxyList 

type HTTPProxyList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata"`
	Items           []HTTPProxy `json:"items"`
}

HTTPProxyList is a list of HTTPProxies.

func (*HTTPProxyList) DeepCopy 

func (in *HTTPProxyList) DeepCopy() *HTTPProxyList

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

func (*HTTPProxyList) DeepCopyInto 

func (in *HTTPProxyList) DeepCopyInto(out *HTTPProxyList)

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

func (*HTTPProxyList) DeepCopyObject 

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

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

type HTTPProxySpec 

type HTTPProxySpec struct {
	// Virtualhost appears at most once. If it is present, the object is considered
	// to be a "root" HTTPProxy.
	// +optional
	VirtualHost *VirtualHost `json:"virtualhost,omitempty"`
	// Routes are the ingress routes. If TCPProxy is present, Routes is ignored.
	//  +optional
	Routes []Route `json:"routes,omitempty"`
	// TCPProxy holds TCP proxy information.
	// +optional
	TCPProxy *TCPProxy `json:"tcpproxy,omitempty"`
	// Includes allow for specific routing configuration to be included from another HTTPProxy,
	// possibly in another namespace.
	// +optional
	Includes []Include `json:"includes,omitempty"`
}

HTTPProxySpec defines the spec of the CRD.

func (*HTTPProxySpec) DeepCopy 

func (in *HTTPProxySpec) DeepCopy() *HTTPProxySpec

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

func (*HTTPProxySpec) DeepCopyInto 

func (in *HTTPProxySpec) DeepCopyInto(out *HTTPProxySpec)

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

type HTTPProxyStatus added in v1.7.0 

type HTTPProxyStatus struct {
	// +optional
	CurrentStatus string `json:"currentStatus,omitempty"`
	// +optional
	Description string `json:"description,omitempty"`
	// +optional
	// LoadBalancer contains the current status of the load balancer.
	LoadBalancer corev1.LoadBalancerStatus `json:"loadBalancer,omitempty"`
	// +optional
	// Conditions contains information about the current status of the HTTPProxy,
	// in an upstream-friendly container.
	//
	// Contour will update a single condition, `Valid`, that is in normal-true polarity.
	// That is, when `currentStatus` is `valid`, the `Valid` condition will be `status: true`,
	// and vice versa.
	//
	// Contour will leave untouched any other Conditions set in this block,
	// in case some other controller wants to add a Condition.
	//
	// If you are another controller owner and wish to add a condition, you *should*
	// namespace your condition with a label, like `controller.domain.com/ConditionName`.
	// +patchMergeKey=type
	// +patchStrategy=merge
	// +listType=map
	// +listMapKey=type
	Conditions []DetailedCondition `json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type"`
}

HTTPProxyStatus reports the current state of the HTTPProxy.

func (*HTTPProxyStatus) DeepCopy added in v1.7.0 

func (in *HTTPProxyStatus) DeepCopy() *HTTPProxyStatus

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

func (*HTTPProxyStatus) DeepCopyInto added in v1.7.0 

func (in *HTTPProxyStatus) DeepCopyInto(out *HTTPProxyStatus)

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

func (*HTTPProxyStatus) GetConditionFor added in v1.9.0 

func (status *HTTPProxyStatus) GetConditionFor(condType string) *DetailedCondition

GetConditionFor returns the a pointer to the condition for a given type, or nil if there are none currently present.

type HeaderHashOptions added in v1.12.0 

type HeaderHashOptions struct {
	// HeaderName is the name of the HTTP request header that will be used to
	// calculate the hash key. If the header specified is not present on a
	// request, no hash will be produced.
	// +kubebuilder:validation:Required
	// +kubebuilder:validation:MinLength=1
	HeaderName string `json:"headerName,omitempty"`
}

HeaderHashOptions contains options to configure a HTTP request header hash policy, used in request attribute hash based load balancing.

func (*HeaderHashOptions) DeepCopy added in v1.12.0 

func (in *HeaderHashOptions) DeepCopy() *HeaderHashOptions

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

func (*HeaderHashOptions) DeepCopyInto added in v1.12.0 

func (in *HeaderHashOptions) DeepCopyInto(out *HeaderHashOptions)

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

type HeaderMatchCondition added in v1.7.0 

type HeaderMatchCondition struct {
	// Name is the name of the header to match against. Name is required.
	// Header names are case insensitive.
	Name string `json:"name"`

	// Present specifies that condition is true when the named header
	// is present, regardless of its value. Note that setting Present
	// to false does not make the condition true if the named header
	// is absent.
	// +optional
	Present bool `json:"present,omitempty"`

	// Contains specifies a substring that must be present in
	// the header value.
	// +optional
	Contains string `json:"contains,omitempty"`

	// NotContains specifies a substring that must not be present
	// in the header value.
	// +optional
	NotContains string `json:"notcontains,omitempty"`

	// Exact specifies a string that the header value must be equal to.
	// +optional
	Exact string `json:"exact,omitempty"`

	// NoExact specifies a string that the header value must not be
	// equal to. The condition is true if the header has any other value.
	// +optional
	NotExact string `json:"notexact,omitempty"`
}

HeaderMatchCondition specifies how to conditionally match against HTTP headers. The Name field is required, but only one of the remaining fields should be be provided.

func (*HeaderMatchCondition) DeepCopy added in v1.7.0 

func (in *HeaderMatchCondition) DeepCopy() *HeaderMatchCondition

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

func (*HeaderMatchCondition) DeepCopyInto added in v1.7.0 

func (in *HeaderMatchCondition) DeepCopyInto(out *HeaderMatchCondition)

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

type HeaderValue added in v1.1.0 

type HeaderValue struct {
	// Name represents a key of a header
	// +kubebuilder:validation:Required
	// +kubebuilder:validation:MinLength=1
	Name string `json:"name"`
	// Value represents the value of a header specified by a key
	// +kubebuilder:validation:Required
	// +kubebuilder:validation:MinLength=1
	Value string `json:"value"`
}

HeaderValue represents a header name/value pair

func (*HeaderValue) DeepCopy added in v1.1.0 

func (in *HeaderValue) DeepCopy() *HeaderValue

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

func (*HeaderValue) DeepCopyInto added in v1.1.0 

func (in *HeaderValue) DeepCopyInto(out *HeaderValue)

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

type HeadersPolicy added in v1.1.0 

type HeadersPolicy struct {
	// Set specifies a list of HTTP header values that will be set in the HTTP header.
	// If the header does not exist it will be added, otherwise it will be overwritten with the new value.
	// +optional
	Set []HeaderValue `json:"set,omitempty"`
	// Remove specifies a list of HTTP header names to remove.
	// +optional
	Remove []string `json:"remove,omitempty"`
}

HeadersPolicy defines how headers are managed during forwarding. The `Host` header is treated specially and if set in a HTTP response will be used as the SNI server name when forwarding over TLS. It is an error to attempt to set the `Host` header in a HTTP response.

func (*HeadersPolicy) DeepCopy added in v1.1.0 

func (in *HeadersPolicy) DeepCopy() *HeadersPolicy

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

func (*HeadersPolicy) DeepCopyInto added in v1.1.0 

func (in *HeadersPolicy) DeepCopyInto(out *HeadersPolicy)

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

type Include 

type Include struct {
	// Name of the HTTPProxy
	Name string `json:"name"`
	// Namespace of the HTTPProxy to include. Defaults to the current namespace if not supplied.
	// +optional
	Namespace string `json:"namespace,omitempty"`
	// Conditions are a set of rules that are applied to included HTTPProxies.
	// In effect, they are added onto the Conditions of included HTTPProxy Route
	// structs.
	// When applied, they are merged using AND, with one exception:
	// There can be only one Prefix MatchCondition per Conditions slice.
	// More than one Prefix, or contradictory Conditions, will make the
	// include invalid.
	// +optional
	Conditions []MatchCondition `json:"conditions,omitempty"`
}

Include describes a set of policies that can be applied to an HTTPProxy in a namespace.

func (*Include) DeepCopy 

func (in *Include) DeepCopy() *Include

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

func (*Include) DeepCopyInto 

func (in *Include) DeepCopyInto(out *Include)

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

type LoadBalancerPolicy 

type LoadBalancerPolicy struct {
	// Strategy specifies the policy used to balance requests
	// across the pool of backend pods. Valid policy names are
	// `Random`, `RoundRobin`, `WeightedLeastRequest`, `Cookie`,
	// and `RequestHash`. If an unknown strategy name is specified
	// or no policy is supplied, the default `RoundRobin` policy
	// is used.
	Strategy string `json:"strategy,omitempty"`

	// RequestHashPolicies contains a list of hash policies to apply when the
	// `RequestHash` load balancing strategy is chosen. If an element of the
	// supplied list of hash policies is invalid, it will be ignored. If the
	// list of hash policies is empty after validation, the load balancing
	// strategy will fall back the the default `RoundRobin`.
	RequestHashPolicies []RequestHashPolicy `json:"requestHashPolicies,omitempty"`
}

LoadBalancerPolicy defines the load balancing policy.

func (*LoadBalancerPolicy) DeepCopy 

func (in *LoadBalancerPolicy) DeepCopy() *LoadBalancerPolicy

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

func (*LoadBalancerPolicy) DeepCopyInto 

func (in *LoadBalancerPolicy) DeepCopyInto(out *LoadBalancerPolicy)

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

type LocalRateLimitPolicy added in v1.12.0 

type LocalRateLimitPolicy struct {
	// Requests defines how many requests per unit of time should
	// be allowed before rate limiting occurs.
	// +required
	// +kubebuilder:validation:Minimum=1
	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".
	// +kubebuilder:validation:Enum=second;minute;hour
	// +required
	Unit string `json:"unit"`

	// Burst defines the number of requests above the requests per
	// unit that should be allowed within a short period of time.
	// +optional
	Burst uint32 `json:"burst,omitempty"`

	// ResponseStatusCode is the HTTP status code to use for responses
	// to rate-limited requests. Codes must be in the 400-599 range
	// (inclusive). If not specified, the Envoy default of 429 (Too
	// Many Requests) is used.
	// +optional
	// +kubebuilder:validation:Minimum=400
	// +kubebuilder:validation:Maximum=599
	ResponseStatusCode uint32 `json:"responseStatusCode,omitempty"`

	// ResponseHeadersToAdd is an optional list of response headers to
	// set when a request is rate-limited.
	// +optional
	ResponseHeadersToAdd []HeaderValue `json:"responseHeadersToAdd,omitempty"`
}

LocalRateLimitPolicy defines local rate limiting parameters.

func (*LocalRateLimitPolicy) DeepCopy added in v1.12.0 

func (in *LocalRateLimitPolicy) DeepCopy() *LocalRateLimitPolicy

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

func (*LocalRateLimitPolicy) DeepCopyInto added in v1.12.0 

func (in *LocalRateLimitPolicy) DeepCopyInto(out *LocalRateLimitPolicy)

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

type MatchCondition added in v1.7.0 

type MatchCondition struct {
	// Prefix defines a prefix match for a request.
	// +optional
	Prefix string `json:"prefix,omitempty"`

	// Header specifies the header condition to match.
	// +optional
	Header *HeaderMatchCondition `json:"header,omitempty"`
}

MatchCondition are a general holder for matching rules for HTTPProxies. One of Prefix or Header must be provided.

func (*MatchCondition) DeepCopy added in v1.7.0 

func (in *MatchCondition) DeepCopy() *MatchCondition

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

func (*MatchCondition) DeepCopyInto added in v1.7.0 

func (in *MatchCondition) DeepCopyInto(out *MatchCondition)

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

type PathRewritePolicy added in v1.1.0 

type PathRewritePolicy struct {
	// ReplacePrefix describes how the path prefix should be replaced.
	// +optional
	ReplacePrefix []ReplacePrefix `json:"replacePrefix,omitempty"`
}

PathRewritePolicy specifies how a request URL path should be rewritten. This rewriting takes place after a request is routed and has no subsequent effects on the proxy's routing decision. No HTTP headers or body content is rewritten.

Exactly one field in this struct may be specified.

func (*PathRewritePolicy) DeepCopy added in v1.1.0 

func (in *PathRewritePolicy) DeepCopy() *PathRewritePolicy

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

func (*PathRewritePolicy) DeepCopyInto added in v1.1.0 

func (in *PathRewritePolicy) DeepCopyInto(out *PathRewritePolicy)

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

type RateLimitDescriptor added in v1.13.0 

type RateLimitDescriptor struct {
	// Entries is the list of key-value pair generators.
	// +required
	// +kubebuilder:validation:MinItems=1
	Entries []RateLimitDescriptorEntry `json:"entries,omitempty"`
}

RateLimitDescriptor defines a list of key-value pair generators.

func (*RateLimitDescriptor) DeepCopy added in v1.13.0 

func (in *RateLimitDescriptor) DeepCopy() *RateLimitDescriptor

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

func (*RateLimitDescriptor) DeepCopyInto added in v1.13.0 

func (in *RateLimitDescriptor) DeepCopyInto(out *RateLimitDescriptor)

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

type RateLimitDescriptorEntry added in v1.13.0 

type RateLimitDescriptorEntry struct {
	// GenericKey defines a descriptor entry with a static key and value.
	// +optional
	GenericKey *GenericKeyDescriptor `json:"genericKey,omitempty"`

	// RequestHeader defines a descriptor entry that's populated only if
	// a given header is present on the request. The descriptor key is static,
	// and the descriptor value is equal to the value of the header.
	// +optional
	RequestHeader *RequestHeaderDescriptor `json:"requestHeader,omitempty"`

	// RemoteAddress defines a descriptor entry with a key of "remote_address"
	// and a value equal to the client's IP address (from x-forwarded-for).
	// +optional
	RemoteAddress *RemoteAddressDescriptor `json:"remoteAddress,omitempty"`
}

RateLimitDescriptorEntry is a key-value pair generator. Exactly one field on this struct must be non-nil.

func (*RateLimitDescriptorEntry) DeepCopy added in v1.13.0 

func (in *RateLimitDescriptorEntry) DeepCopy() *RateLimitDescriptorEntry

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

func (*RateLimitDescriptorEntry) DeepCopyInto added in v1.13.0 

func (in *RateLimitDescriptorEntry) DeepCopyInto(out *RateLimitDescriptorEntry)

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

type RateLimitPolicy added in v1.12.0 

type RateLimitPolicy struct {
	// Local defines local rate limiting parameters, i.e. parameters
	// for rate limiting that occurs within each Envoy pod as requests
	// are handled.
	// +optional
	Local *LocalRateLimitPolicy `json:"local,omitempty"`

	// Global defines global rate limiting parameters, i.e. parameters
	// defining descriptors that are sent to an external rate limit
	// service (RLS) for a rate limit decision on each request.
	// +optional
	Global *GlobalRateLimitPolicy `json:"global,omitempty"`
}

RateLimitPolicy defines rate limiting parameters.

func (*RateLimitPolicy) DeepCopy added in v1.12.0 

func (in *RateLimitPolicy) DeepCopy() *RateLimitPolicy

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

func (*RateLimitPolicy) DeepCopyInto added in v1.12.0 

func (in *RateLimitPolicy) DeepCopyInto(out *RateLimitPolicy)

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

type RemoteAddressDescriptor added in v1.13.0 

type RemoteAddressDescriptor struct{}

RemoteAddressDescriptor defines a descriptor entry with a key of "remote_address" and a value equal to the client's IP address (from x-forwarded-for).

func (*RemoteAddressDescriptor) DeepCopy added in v1.13.0 

func (in *RemoteAddressDescriptor) DeepCopy() *RemoteAddressDescriptor

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

func (*RemoteAddressDescriptor) DeepCopyInto added in v1.13.0 

func (in *RemoteAddressDescriptor) DeepCopyInto(out *RemoteAddressDescriptor)

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

type ReplacePrefix added in v1.1.0 

type ReplacePrefix struct {
	// Prefix specifies the URL path prefix to be replaced.
	//
	// If Prefix is specified, it must exactly match the MatchCondition
	// prefix that is rendered by the chain of including HTTPProxies
	// and only that path prefix will be replaced by Replacement.
	// This allows HTTPProxies that are included through multiple
	// roots to only replace specific path prefixes, leaving others
	// unmodified.
	//
	// If Prefix is not specified, all routing prefixes rendered
	// by the include chain will be replaced.
	//
	// +optional
	// +kubebuilder:validation:MinLength=1
	Prefix string `json:"prefix,omitempty"`

	// Replacement is the string that the routing path prefix
	// will be replaced with. This must not be empty.
	//
	// +kubebuilder:validation:Required
	// +kubebuilder:validation:MinLength=1
	Replacement string `json:"replacement"`
}

ReplacePrefix describes a path prefix replacement.

func (*ReplacePrefix) DeepCopy added in v1.1.0 

func (in *ReplacePrefix) DeepCopy() *ReplacePrefix

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

func (*ReplacePrefix) DeepCopyInto added in v1.1.0 

func (in *ReplacePrefix) DeepCopyInto(out *ReplacePrefix)

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

type RequestHashPolicy added in v1.12.0 

type RequestHashPolicy struct {
	// Terminal is a flag that allows for short-circuiting computing of a hash
	// for a given request. If set to true, and the request attribute specified
	// in the attribute hash options is present, no further hash policies will
	// be used to calculate a hash for the request.
	Terminal bool `json:"terminal,omitempty"`

	// HeaderHashOptions should be set when request header hash based load
	// balancing is desired. It must be the only hash option field set,
	// otherwise this request hash policy object will be ignored.
	// +kubebuilder:validation:Required
	HeaderHashOptions *HeaderHashOptions `json:"headerHashOptions,omitempty"`
}

RequestHashPolicy contains configuration for an individual hash policy on a request attribute.

func (*RequestHashPolicy) DeepCopy added in v1.12.0 

func (in *RequestHashPolicy) DeepCopy() *RequestHashPolicy

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

func (*RequestHashPolicy) DeepCopyInto added in v1.12.0 

func (in *RequestHashPolicy) DeepCopyInto(out *RequestHashPolicy)

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

type RequestHeaderDescriptor added in v1.13.0 

type RequestHeaderDescriptor struct {
	// HeaderName defines the name of the header to look for on the request.
	// +required
	// +kubebuilder:validation:MinLength=1
	HeaderName string `json:"headerName,omitempty"`

	// DescriptorKey defines the key to use on the descriptor entry.
	// +required
	// +kubebuilder:validation:MinLength=1
	DescriptorKey string `json:"descriptorKey,omitempty"`
}

RequestHeaderDescriptor defines a descriptor entry that's populated only if a given header is present on the request. The value of the descriptor entry is equal to the value of the header (if present).

func (*RequestHeaderDescriptor) DeepCopy added in v1.13.0 

func (in *RequestHeaderDescriptor) DeepCopy() *RequestHeaderDescriptor

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

func (*RequestHeaderDescriptor) DeepCopyInto added in v1.13.0 

func (in *RequestHeaderDescriptor) DeepCopyInto(out *RequestHeaderDescriptor)

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

type RetryOn added in v1.7.0 

type RetryOn string

RetryOn is a string type alias with validation to ensure that the value is valid. +kubebuilder:validation:Enum="5xx";gateway-error;reset;connect-failure;retriable-4xx;refused-stream;retriable-status-codes;retriable-headers;cancelled;deadline-exceeded;internal;resource-exhausted;unavailable

type RetryPolicy 

type RetryPolicy struct {
	// NumRetries is maximum allowed number of retries.
	// If not supplied, the number of retries is one.
	// +optional
	// +kubebuilder:validation:Minimum=0
	NumRetries int64 `json:"count"`
	// PerTryTimeout specifies the timeout per retry attempt.
	// Ignored if NumRetries is not supplied.
	// +optional
	// +kubebuilder:validation:Pattern=`^(((\d*(\.\d*)?h)|(\d*(\.\d*)?m)|(\d*(\.\d*)?s)|(\d*(\.\d*)?ms)|(\d*(\.\d*)?us)|(\d*(\.\d*)?µs)|(\d*(\.\d*)?ns))+|infinity|infinite)$`
	PerTryTimeout string `json:"perTryTimeout,omitempty"`
	// RetryOn specifies the conditions on which to retry a request.
	//
	// Supported [HTTP conditions](https://www.envoyproxy.io/docs/envoy/latest/configuration/http/http_filters/router_filter#x-envoy-retry-on):
	//
	// - `5xx`
	// - `gateway-error`
	// - `reset`
	// - `connect-failure`
	// - `retriable-4xx`
	// - `refused-stream`
	// - `retriable-status-codes`
	// - `retriable-headers`
	//
	// Supported [gRPC conditions](https://www.envoyproxy.io/docs/envoy/latest/configuration/http/http_filters/router_filter#x-envoy-retry-grpc-on):
	//
	// - `cancelled`
	// - `deadline-exceeded`
	// - `internal`
	// - `resource-exhausted`
	// - `unavailable`
	// +optional
	RetryOn []RetryOn `json:"retryOn,omitempty"`
	// RetriableStatusCodes specifies the HTTP status codes that should be retried.
	//
	// This field is only respected when you include `retriable-status-codes` in the `RetryOn` field.
	// +optional
	RetriableStatusCodes []uint32 `json:"retriableStatusCodes,omitempty"`
}

RetryPolicy defines the attributes associated with retrying policy.

func (*RetryPolicy) DeepCopy 

func (in *RetryPolicy) DeepCopy() *RetryPolicy

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

func (*RetryPolicy) DeepCopyInto 

func (in *RetryPolicy) DeepCopyInto(out *RetryPolicy)

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

type Route 

type Route struct {
	// Conditions are a set of rules that are applied to a Route.
	// When applied, they are merged using AND, with one exception:
	// There can be only one Prefix MatchCondition per Conditions slice.
	// More than one Prefix, or contradictory Conditions, will make the
	// route invalid.
	// +optional
	Conditions []MatchCondition `json:"conditions,omitempty"`
	// Services are the services to proxy traffic.
	// +kubebuilder:validation:MinItems=1
	// +kubebuilder:validation:Required
	Services []Service `json:"services"`
	// Enables websocket support for the route.
	// +optional
	EnableWebsockets bool `json:"enableWebsockets,omitempty"`
	// Allow this path to respond to insecure requests over HTTP which are normally
	// not permitted when a `virtualhost.tls` block is present.
	// +optional
	PermitInsecure bool `json:"permitInsecure,omitempty"`
	// AuthPolicy updates the authorization policy that was set
	// on the root HTTPProxy object for client requests that
	// match this route.
	// +optional
	AuthPolicy *AuthorizationPolicy `json:"authPolicy,omitempty"`
	// The timeout policy for this route.
	// +optional
	TimeoutPolicy *TimeoutPolicy `json:"timeoutPolicy,omitempty"`
	// The retry policy for this route.
	// +optional
	RetryPolicy *RetryPolicy `json:"retryPolicy,omitempty"`
	// The health check policy for this route.
	// +optional
	HealthCheckPolicy *HTTPHealthCheckPolicy `json:"healthCheckPolicy,omitempty"`
	// The load balancing policy for this route.
	// +optional
	LoadBalancerPolicy *LoadBalancerPolicy `json:"loadBalancerPolicy,omitempty"`
	// The policy for rewriting the path of the request URL
	// after the request has been routed to a Service.
	//
	// +optional
	PathRewritePolicy *PathRewritePolicy `json:"pathRewritePolicy,omitempty"`
	// The policy for managing request headers during proxying.
	// +optional
	RequestHeadersPolicy *HeadersPolicy `json:"requestHeadersPolicy,omitempty"`
	// The policy for managing response headers during proxying.
	// Rewriting the 'Host' header is not supported.
	// +optional
	ResponseHeadersPolicy *HeadersPolicy `json:"responseHeadersPolicy,omitempty"`
	// The policy for rate limiting on the route.
	// +optional
	RateLimitPolicy *RateLimitPolicy `json:"rateLimitPolicy,omitempty"`
}

Route contains the set of routes for a virtual host.

func (*Route) AuthorizationContext added in v1.9.0 

func (r *Route) AuthorizationContext(parent map[string]string) map[string]string

AuthorizationContext merges the parent context entries with the context from this Route. Common keys from the parent map will be overwritten by keys from the route. The parent map may be nil.

func (*Route) DeepCopy 

func (in *Route) DeepCopy() *Route

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

func (*Route) DeepCopyInto 

func (in *Route) DeepCopyInto(out *Route)

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

func (*Route) GetPrefixReplacements added in v1.1.0 

func (r *Route) GetPrefixReplacements() []ReplacePrefix

GetPrefixReplacements returns replacement prefixes from the path rewrite policy (if any).

type Service 

type Service struct {
	// Name is the name of Kubernetes service to proxy traffic.
	// Names defined here will be used to look up corresponding endpoints which contain the ips to route.
	Name string `json:"name"`
	// Port (defined as Integer) to proxy traffic to since a service can have multiple defined.
	//
	// +required
	// +kubebuilder:validation:Minimum=1
	// +kubebuilder:validation:Maximum=65536
	// +kubebuilder:validation:ExclusiveMinimum=false
	// +kubebuilder:validation:ExclusiveMaximum=true
	Port int `json:"port"`
	// Protocol may be used to specify (or override) the protocol used to reach this Service.
	// Values may be tls, h2, h2c. If omitted, protocol-selection falls back on Service annotations.
	// +kubebuilder:validation:Enum=h2;h2c;tls
	// +optional
	Protocol *string `json:"protocol,omitempty"`
	// Weight defines percentage of traffic to balance traffic
	// +optional
	// +kubebuilder:validation:Minimum=0
	Weight int64 `json:"weight,omitempty"`
	// UpstreamValidation defines how to verify the backend service's certificate
	// +optional
	UpstreamValidation *UpstreamValidation `json:"validation,omitempty"`
	// If Mirror is true the Service will receive a read only mirror of the traffic for this route.
	Mirror bool `json:"mirror,omitempty"`
	// The policy for managing request headers during proxying.
	// Rewriting the 'Host' header is not supported.
	// +optional
	RequestHeadersPolicy *HeadersPolicy `json:"requestHeadersPolicy,omitempty"`
	// The policy for managing response headers during proxying.
	// Rewriting the 'Host' header is not supported.
	// +optional
	ResponseHeadersPolicy *HeadersPolicy `json:"responseHeadersPolicy,omitempty"`
}

Service defines an Kubernetes Service to proxy traffic.

func (*Service) DeepCopy 

func (in *Service) DeepCopy() *Service

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

func (*Service) DeepCopyInto 

func (in *Service) DeepCopyInto(out *Service)

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

type SubCondition added in v1.7.0 

type SubCondition struct {
	// Type of condition in `CamelCase` or in `foo.example.com/CamelCase`.
	//
	// This must be in abnormal-true polarity, that is, `ErrorFound` or `controller.io/ErrorFound`.
	//
	// The regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)
	// +required
	// +kubebuilder:validation:Required
	// +kubebuilder:validation:Pattern=`^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$`
	// +kubebuilder:validation:MaxLength=316
	Type string `json:"type" protobuf:"bytes,1,opt,name=type"`
	// Status of the condition, one of True, False, Unknown.
	// +required
	// +kubebuilder:validation:Required
	// +kubebuilder:validation:Enum=True;False;Unknown
	Status ConditionStatus `json:"status" protobuf:"bytes,2,opt,name=status"`
	// Reason contains a programmatic identifier indicating the reason for the condition's last transition.
	// Producers of specific condition types may define expected values and meanings for this field,
	// and whether the values are considered a guaranteed API.
	//
	// The value should be a CamelCase string.
	//
	// This field may not be empty.
	// +required
	// +kubebuilder:validation:Required
	// +kubebuilder:validation:MaxLength=1024
	// +kubebuilder:validation:MinLength=1
	// +kubebuilder:validation:Pattern=`^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$`
	Reason string `json:"reason" protobuf:"bytes,3,opt,name=reason"`
	// Message is a human readable message indicating details about the transition.
	//
	// This may be an empty string.
	//
	// +required
	// +kubebuilder:validation:Required
	// +kubebuilder:validation:MaxLength=32768
	Message string `json:"message" protobuf:"bytes,4,opt,name=message"`
}

SubCondition is a Condition-like type intended for use as a subcondition inside a DetailedCondition.

It contains a subset of the Condition fields.

It is intended for warnings and errors, so `type` names should use abnormal-true polarity, that is, they should be of the form "ErrorPresent: true".

The expected lifecycle for these errors is that they should only be present when the error or warning is, and should be removed when they are not relevant.

func (*SubCondition) DeepCopy added in v1.7.0 

func (in *SubCondition) DeepCopy() *SubCondition

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

func (*SubCondition) DeepCopyInto added in v1.7.0 

func (in *SubCondition) DeepCopyInto(out *SubCondition)

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

type TCPHealthCheckPolicy added in v1.2.0 

type TCPHealthCheckPolicy struct {
	// The interval (seconds) between health checks
	// +optional
	IntervalSeconds int64 `json:"intervalSeconds"`
	// The time to wait (seconds) for a health check response
	// +optional
	TimeoutSeconds int64 `json:"timeoutSeconds"`
	// The number of unhealthy health checks required before a host is marked unhealthy
	// +optional
	UnhealthyThresholdCount uint32 `json:"unhealthyThresholdCount"`
	// The number of healthy health checks required before a host is marked healthy
	// +optional
	HealthyThresholdCount uint32 `json:"healthyThresholdCount"`
}

TCPHealthCheckPolicy defines health checks on the upstream service.

func (*TCPHealthCheckPolicy) DeepCopy added in v1.2.0 

func (in *TCPHealthCheckPolicy) DeepCopy() *TCPHealthCheckPolicy

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

func (*TCPHealthCheckPolicy) DeepCopyInto added in v1.2.0 

func (in *TCPHealthCheckPolicy) DeepCopyInto(out *TCPHealthCheckPolicy)

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

type TCPProxy 

type TCPProxy struct {
	// The load balancing policy for the backend services. Note that the
	// `Cookie` and `RequestHash` load balancing strategies cannot be used
	// here.
	// +optional
	LoadBalancerPolicy *LoadBalancerPolicy `json:"loadBalancerPolicy,omitempty"`
	// Services are the services to proxy traffic
	// +optional
	Services []Service `json:"services"`
	// Include specifies that this tcpproxy should be delegated to another HTTPProxy.
	// +optional
	Include *TCPProxyInclude `json:"include,omitempty"`
	// IncludesDeprecated allow for specific routing configuration to be appended to another HTTPProxy in another namespace.
	//
	// Exists due to a mistake when developing HTTPProxy and the field was marked plural
	// when it should have been singular. This field should stay to not break backwards compatibility to v1 users.
	// +optional
	IncludesDeprecated *TCPProxyInclude `json:"includes,omitempty"`
	// The health check policy for this tcp proxy
	// +optional
	HealthCheckPolicy *TCPHealthCheckPolicy `json:"healthCheckPolicy,omitempty"`
}

TCPProxy contains the set of services to proxy TCP connections.

func (*TCPProxy) DeepCopy 

func (in *TCPProxy) DeepCopy() *TCPProxy

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

func (*TCPProxy) DeepCopyInto 

func (in *TCPProxy) DeepCopyInto(out *TCPProxy)

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

type TCPProxyInclude 

type TCPProxyInclude struct {
	// Name of the child HTTPProxy
	Name string `json:"name"`
	// Namespace of the HTTPProxy to include. Defaults to the current namespace if not supplied.
	// +optional
	Namespace string `json:"namespace,omitempty"`
}

TCPProxyInclude describes a target HTTPProxy document which contains the TCPProxy details.

func (*TCPProxyInclude) DeepCopy 

func (in *TCPProxyInclude) DeepCopy() *TCPProxyInclude

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

func (*TCPProxyInclude) DeepCopyInto 

func (in *TCPProxyInclude) DeepCopyInto(out *TCPProxyInclude)

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

type TLS 

type TLS struct {
	// SecretName is the name of a TLS secret in the current namespace.
	// Either SecretName or Passthrough must be specified, but not both.
	// If specified, the named secret must contain a matching certificate
	// for the virtual host's FQDN.
	SecretName string `json:"secretName,omitempty"`
	// MinimumProtocolVersion is the minimum TLS version this vhost should
	// negotiate. Valid options are `1.2` (default) and `1.3`. Any other value
	// defaults to TLS 1.2.
	// +optional
	MinimumProtocolVersion string `json:"minimumProtocolVersion,omitempty"`
	// Passthrough defines whether the encrypted TLS handshake will be
	// passed through to the backing cluster. Either Passthrough or
	// SecretName must be specified, but not both.
	// +optional
	Passthrough bool `json:"passthrough,omitempty"`
	// ClientValidation defines how to verify the client certificate
	// when an external client establishes a TLS connection to Envoy.
	//
	// This setting:
	//
	// 1. Enables TLS client certificate validation.
	// 2. Requires clients to present a TLS certificate (i.e. not optional validation).
	// 3. Specifies how the client certificate will be validated.
	// +optional
	ClientValidation *DownstreamValidation `json:"clientValidation,omitempty"`

	// EnableFallbackCertificate defines if the vhost should allow a default certificate to
	// be applied which handles all requests which don't match the SNI defined in this vhost.
	EnableFallbackCertificate bool `json:"enableFallbackCertificate,omitempty"`
}

TLS describes tls properties. The SNI names that will be matched on are described in the HTTPProxy's Spec.VirtualHost.Fqdn field.

func (*TLS) DeepCopy 

func (in *TLS) DeepCopy() *TLS

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

func (*TLS) DeepCopyInto 

func (in *TLS) DeepCopyInto(out *TLS)

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

type TLSCertificateDelegation 

type TLSCertificateDelegation struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata"`

	Spec TLSCertificateDelegationSpec `json:"spec"`
	// +optional
	Status TLSCertificateDelegationStatus `json:"status,omitempty"`
}

TLSCertificateDelegation is an TLS Certificate Delegation CRD specification. See design/tls-certificate-delegation.md for details. +k8s:openapi-gen=true +kubebuilder:resource:scope=Namespaced,path=tlscertificatedelegations,shortName=tlscerts,singular=tlscertificatedelegation +kubebuilder:subresource:status

func (*TLSCertificateDelegation) DeepCopy 

func (in *TLSCertificateDelegation) DeepCopy() *TLSCertificateDelegation

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

func (*TLSCertificateDelegation) DeepCopyInto 

func (in *TLSCertificateDelegation) DeepCopyInto(out *TLSCertificateDelegation)

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

func (*TLSCertificateDelegation) DeepCopyObject 

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

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

type TLSCertificateDelegationList 

type TLSCertificateDelegationList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata"`
	Items           []TLSCertificateDelegation `json:"items"`
}

TLSCertificateDelegationList is a list of TLSCertificateDelegations.

func (*TLSCertificateDelegationList) DeepCopy 

func (in *TLSCertificateDelegationList) DeepCopy() *TLSCertificateDelegationList

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

func (*TLSCertificateDelegationList) DeepCopyInto 

func (in *TLSCertificateDelegationList) DeepCopyInto(out *TLSCertificateDelegationList)

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

func (*TLSCertificateDelegationList) DeepCopyObject 

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

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

type TLSCertificateDelegationSpec 

type TLSCertificateDelegationSpec struct {
	Delegations []CertificateDelegation `json:"delegations"`
}

TLSCertificateDelegationSpec defines the spec of the CRD

func (*TLSCertificateDelegationSpec) DeepCopy 

func (in *TLSCertificateDelegationSpec) DeepCopy() *TLSCertificateDelegationSpec

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

func (*TLSCertificateDelegationSpec) DeepCopyInto 

func (in *TLSCertificateDelegationSpec) DeepCopyInto(out *TLSCertificateDelegationSpec)

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

type TLSCertificateDelegationStatus added in v1.7.0 

type TLSCertificateDelegationStatus struct {
	// +optional
	// Conditions contains information about the current status of the HTTPProxy,
	// in an upstream-friendly container.
	//
	// Contour will update a single condition, `Valid`, that is in normal-true polarity.
	// That is, when `currentStatus` is `valid`, the `Valid` condition will be `status: true`,
	// and vice versa.
	//
	// Contour will leave untouched any other Conditions set in this block,
	// in case some other controller wants to add a Condition.
	//
	// If you are another controller owner and wish to add a condition, you *should*
	// namespace your condition with a label, like `controller.domain.com\ConditionName`.
	// +patchMergeKey=type
	// +patchStrategy=merge
	// +listType=map
	// +listMapKey=type
	Conditions []DetailedCondition `json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type"`
}

TLSCertificateDelegationStatus allows for the status of the delegation to be presented to the user.

func (*TLSCertificateDelegationStatus) DeepCopy added in v1.7.0 

func (in *TLSCertificateDelegationStatus) DeepCopy() *TLSCertificateDelegationStatus

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

func (*TLSCertificateDelegationStatus) DeepCopyInto added in v1.7.0 

func (in *TLSCertificateDelegationStatus) DeepCopyInto(out *TLSCertificateDelegationStatus)

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

type TimeoutPolicy 

type TimeoutPolicy struct {
	// Timeout for receiving a response from the server after processing a request from client.
	// If not supplied, Envoy's default value of 15s applies.
	// +optional
	// +kubebuilder:validation:Pattern=`^(((\d*(\.\d*)?h)|(\d*(\.\d*)?m)|(\d*(\.\d*)?s)|(\d*(\.\d*)?ms)|(\d*(\.\d*)?us)|(\d*(\.\d*)?µs)|(\d*(\.\d*)?ns))+|infinity|infinite)$`
	Response string `json:"response,omitempty"`

	// Timeout after which, if there are no active requests for this route, the connection between
	// Envoy and the backend or Envoy and the external client will be closed.
	// If not specified, there is no per-route idle timeout, though a connection manager-wide
	// stream_idle_timeout default of 5m still applies.
	// +optional
	// +kubebuilder:validation:Pattern=`^(((\d*(\.\d*)?h)|(\d*(\.\d*)?m)|(\d*(\.\d*)?s)|(\d*(\.\d*)?ms)|(\d*(\.\d*)?us)|(\d*(\.\d*)?µs)|(\d*(\.\d*)?ns))+|infinity|infinite)$`
	Idle string `json:"idle,omitempty"`
}

TimeoutPolicy configures timeouts that are used for handling network requests.

TimeoutPolicy durations are expressed in the Go [Duration format](https://godoc.org/time#ParseDuration). Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The string "infinity" is also a valid input and specifies no timeout. A value of "0s" will be treated as if the field were not set, i.e. by using Envoy's default behavior.

Example input values: "300ms", "5s", "1m".

func (*TimeoutPolicy) DeepCopy 

func (in *TimeoutPolicy) DeepCopy() *TimeoutPolicy

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

func (*TimeoutPolicy) DeepCopyInto 

func (in *TimeoutPolicy) DeepCopyInto(out *TimeoutPolicy)

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

type UpstreamValidation 

type UpstreamValidation struct {
	// Name of the Kubernetes secret be used to validate the certificate presented by the backend
	CACertificate string `json:"caSecret"`
	// Key which is expected to be present in the 'subjectAltName' of the presented certificate
	SubjectName string `json:"subjectName"`
}

UpstreamValidation defines how to verify the backend service's certificate

func (*UpstreamValidation) DeepCopy 

func (in *UpstreamValidation) DeepCopy() *UpstreamValidation

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

func (*UpstreamValidation) DeepCopyInto 

func (in *UpstreamValidation) DeepCopyInto(out *UpstreamValidation)

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

type VirtualHost 

type VirtualHost struct {
	// The fully qualified domain name of the root of the ingress tree
	// all leaves of the DAG rooted at this object relate to the fqdn.
	Fqdn string `json:"fqdn"`

	// If present the fields describes TLS properties of the virtual
	// host. The SNI names that will be matched on are described in fqdn,
	// the tls.secretName secret must contain a certificate that itself
	// contains a name that matches the FQDN.
	//
	// +optional
	TLS *TLS `json:"tls,omitempty"`

	// This field configures an extension service to perform
	// authorization for this virtual host. Authorization can
	// only be configured on virtual hosts that have TLS enabled.
	// If the TLS configuration requires client certificate
	///validation, the client certificate is always included in the
	// authentication check request.
	//
	// +optional
	Authorization *AuthorizationServer `json:"authorization,omitempty"`
	// Specifies the cross-origin policy to apply to the VirtualHost.
	// +optional
	CORSPolicy *CORSPolicy `json:"corsPolicy,omitempty"`
	// The policy for rate limiting on the virtual host.
	// +optional
	RateLimitPolicy *RateLimitPolicy `json:"rateLimitPolicy,omitempty"`
}

VirtualHost appears at most once. If it is present, the object is considered to be a "root".

func (*VirtualHost) AuthorizationConfigured added in v1.9.0 

func (v *VirtualHost) AuthorizationConfigured() bool

AuthorizationConfigured returns whether authorization is configured on this virtual host.

func (*VirtualHost) AuthorizationContext added in v1.9.0 

func (v *VirtualHost) AuthorizationContext() map[string]string

AuthorizationContext returns the authorization policy context (if present).

func (*VirtualHost) DeepCopy 

func (in *VirtualHost) DeepCopy() *VirtualHost

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

func (*VirtualHost) DeepCopyInto 

func (in *VirtualHost) DeepCopyInto(out *VirtualHost)

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

func (*VirtualHost) DisableAuthorization added in v1.9.0 

func (v *VirtualHost) DisableAuthorization() bool

DisableAuthorization returns true if this virtual host disables authorization. If an authorization server is present, the default policy is to not disable.

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.