Documentation ¶
Overview ¶
Package v1beta1 contains API Schema definitions for the configuration.konghq.com v1beta1 API group. +kubebuilder:object:generate=true +groupName=configuration.konghq.com
Index ¶
- Variables
- func Resource(resource string) schema.GroupResource
- type IngressBackend
- type IngressRule
- type IngressTLS
- type KongConsumerGroup
- type KongConsumerGroupList
- type KongConsumerGroupStatus
- type TCPIngress
- type TCPIngressList
- type TCPIngressSpec
- type TCPIngressStatus
- type UDPIngress
- type UDPIngressList
- type UDPIngressRule
- type UDPIngressSpec
- type UDPIngressStatus
Constants ¶
This section is empty.
Variables ¶
var ( // GroupVersion is group version used to register these objects. GroupVersion = schema.GroupVersion{Group: "configuration.konghq.com", Version: "v1beta1"} // SchemeGroupVersion is a convenience var for generated clientsets. SchemeGroupVersion = GroupVersion // SchemeBuilder is used to add go types to the GroupVersionKind scheme. SchemeBuilder = &scheme.Builder{GroupVersion: GroupVersion} // AddToScheme adds the types in this group-version to the given scheme. AddToScheme = SchemeBuilder.AddToScheme )
Functions ¶
func Resource ¶
func Resource(resource string) schema.GroupResource
Resource takes an unqualified resource and returns a Group qualified GroupResource.
Types ¶
type IngressBackend ¶
type IngressBackend struct { // Specifies the name of the referenced service. // +kubebuilder:validation:Required // +kubebuilder:validation:MinLength=1 ServiceName string `json:"serviceName"` // Specifies the port of the referenced service. // +kubebuilder:validation:Minimum=1 // +kubebuilder:validation:Maximum=65535 // +kubebuilder:validation:Format=int32 // +kubebuilder:validation:Required ServicePort int `json:"servicePort"` }
IngressBackend describes all endpoints for a given service and port.
func (*IngressBackend) DeepCopy ¶
func (in *IngressBackend) DeepCopy() *IngressBackend
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new IngressBackend.
func (*IngressBackend) DeepCopyInto ¶
func (in *IngressBackend) DeepCopyInto(out *IngressBackend)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type IngressRule ¶
type IngressRule struct { // Host is the fully qualified domain name of a network host, as defined // by RFC 3986. // If a Host is not specified, then port-based TCP routing is performed. Kong // doesn't care about the content of the TCP stream in this case. // If a Host is specified, the protocol must be TLS over TCP. // A plain-text TCP request cannot be routed based on Host. It can only // be routed based on Port. Host string `json:"host,omitempty"` // Port is the port on which to accept TCP or TLS over TCP sessions and // route. It is a required field. If a Host is not specified, the requested // are routed based only on Port. // +kubebuilder:validation:Minimum=1 // +kubebuilder:validation:Maximum=65535 // +kubebuilder:validation:Format=int32 // +kubebuilder:validation:Required Port int `json:"port,omitempty"` // Backend defines the referenced service endpoint to which the traffic // will be forwarded to. // +kubebuilder:validation:Required Backend IngressBackend `json:"backend"` }
IngressRule represents a rule to apply against incoming requests. Matching is performed based on an (optional) SNI and port.
func (*IngressRule) DeepCopy ¶
func (in *IngressRule) DeepCopy() *IngressRule
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new IngressRule.
func (*IngressRule) DeepCopyInto ¶
func (in *IngressRule) DeepCopyInto(out *IngressRule)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type IngressTLS ¶
type IngressTLS struct { // Hosts are a list of hosts included in the TLS certificate. The values in // this list must match the name/s used in the tlsSecret. Defaults to the // wildcard host setting for the loadbalancer controller fulfilling this // Ingress, if left unspecified. Hosts []string `json:"hosts,omitempty"` // SecretName is the name of the secret used to terminate SSL traffic. SecretName string `json:"secretName,omitempty"` }
IngressTLS describes the transport layer security.
func (*IngressTLS) DeepCopy ¶
func (in *IngressTLS) DeepCopy() *IngressTLS
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new IngressTLS.
func (*IngressTLS) DeepCopyInto ¶
func (in *IngressTLS) DeepCopyInto(out *IngressTLS)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type KongConsumerGroup ¶ added in v2.11.0
type KongConsumerGroup struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` // Status represents the current status of the KongConsumer resource. Status KongConsumerGroupStatus `json:"status,omitempty"` }
KongConsumerGroup is the Schema for the kongconsumergroups API.
func (*KongConsumerGroup) DeepCopy ¶ added in v2.11.0
func (in *KongConsumerGroup) DeepCopy() *KongConsumerGroup
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new KongConsumerGroup.
func (*KongConsumerGroup) DeepCopyInto ¶ added in v2.11.0
func (in *KongConsumerGroup) DeepCopyInto(out *KongConsumerGroup)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*KongConsumerGroup) DeepCopyObject ¶ added in v2.11.0
func (in *KongConsumerGroup) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type KongConsumerGroupList ¶ added in v2.11.0
type KongConsumerGroupList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` Items []KongConsumerGroup `json:"items"` }
KongConsumerGroupList contains a list of KongConsumerGroups.
func (*KongConsumerGroupList) DeepCopy ¶ added in v2.11.0
func (in *KongConsumerGroupList) DeepCopy() *KongConsumerGroupList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new KongConsumerGroupList.
func (*KongConsumerGroupList) DeepCopyInto ¶ added in v2.11.0
func (in *KongConsumerGroupList) DeepCopyInto(out *KongConsumerGroupList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*KongConsumerGroupList) DeepCopyObject ¶ added in v2.11.0
func (in *KongConsumerGroupList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type KongConsumerGroupStatus ¶ added in v2.11.0
type KongConsumerGroupStatus struct { // Conditions describe the current conditions of the KongConsumerGroup. // // Known condition types are: // // * "Programmed" // // +listType=map // +listMapKey=type // +kubebuilder:validation:MaxItems=8 // +kubebuilder:default={{type: "Programmed", status: "Unknown", reason:"Pending", message:"Waiting for controller", lastTransitionTime: "1970-01-01T00:00:00Z"}} Conditions []metav1.Condition `json:"conditions,omitempty"` }
KongConsumerGroupStatus represents the current status of the KongConsumerGroup resource.
func (*KongConsumerGroupStatus) DeepCopy ¶ added in v2.11.0
func (in *KongConsumerGroupStatus) DeepCopy() *KongConsumerGroupStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new KongConsumerGroupStatus.
func (*KongConsumerGroupStatus) DeepCopyInto ¶ added in v2.11.0
func (in *KongConsumerGroupStatus) DeepCopyInto(out *KongConsumerGroupStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type TCPIngress ¶
type TCPIngress struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` // Spec is the TCPIngress specification. Spec TCPIngressSpec `json:"spec,omitempty"` Status TCPIngressStatus `json:"status,omitempty"` }
TCPIngress is the Schema for the tcpingresses API.
func (*TCPIngress) DeepCopy ¶
func (in *TCPIngress) DeepCopy() *TCPIngress
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TCPIngress.
func (*TCPIngress) DeepCopyInto ¶
func (in *TCPIngress) DeepCopyInto(out *TCPIngress)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*TCPIngress) DeepCopyObject ¶
func (in *TCPIngress) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type TCPIngressList ¶
type TCPIngressList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` Items []TCPIngress `json:"items"` }
TCPIngressList contains a list of TCPIngress.
func (*TCPIngressList) DeepCopy ¶
func (in *TCPIngressList) DeepCopy() *TCPIngressList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TCPIngressList.
func (*TCPIngressList) DeepCopyInto ¶
func (in *TCPIngressList) DeepCopyInto(out *TCPIngressList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*TCPIngressList) DeepCopyObject ¶
func (in *TCPIngressList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type TCPIngressSpec ¶
type TCPIngressSpec struct { // A list of rules used to configure the Ingress. Rules []IngressRule `json:"rules,omitempty"` // TLS configuration. This is similar to the `tls` section in the // Ingress resource in networking.v1beta1 group. // The mapping of SNIs to TLS cert-key pair defined here will be // used for HTTP Ingress rules as well. Once can define the mapping in // this resource or the original Ingress resource, both have the same // effect. TLS []IngressTLS `json:"tls,omitempty"` }
TCPIngressSpec defines the desired state of TCPIngress.
func (*TCPIngressSpec) DeepCopy ¶
func (in *TCPIngressSpec) DeepCopy() *TCPIngressSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TCPIngressSpec.
func (*TCPIngressSpec) DeepCopyInto ¶
func (in *TCPIngressSpec) DeepCopyInto(out *TCPIngressSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type TCPIngressStatus ¶
type TCPIngressStatus struct { // LoadBalancer contains the current status of the load-balancer. LoadBalancer corev1.LoadBalancerStatus `json:"loadBalancer,omitempty"` }
TCPIngressStatus defines the observed state of TCPIngress.
func (*TCPIngressStatus) DeepCopy ¶
func (in *TCPIngressStatus) DeepCopy() *TCPIngressStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TCPIngressStatus.
func (*TCPIngressStatus) DeepCopyInto ¶
func (in *TCPIngressStatus) DeepCopyInto(out *TCPIngressStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type UDPIngress ¶
type UDPIngress struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` // Spec is the UDPIngress specification. Spec UDPIngressSpec `json:"spec,omitempty"` Status UDPIngressStatus `json:"status,omitempty"` }
UDPIngress is the Schema for the udpingresses API.
func (*UDPIngress) DeepCopy ¶
func (in *UDPIngress) DeepCopy() *UDPIngress
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new UDPIngress.
func (*UDPIngress) DeepCopyInto ¶
func (in *UDPIngress) DeepCopyInto(out *UDPIngress)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*UDPIngress) DeepCopyObject ¶
func (in *UDPIngress) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type UDPIngressList ¶
type UDPIngressList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` Items []UDPIngress `json:"items"` }
UDPIngressList contains a list of UDPIngress.
func (*UDPIngressList) DeepCopy ¶
func (in *UDPIngressList) DeepCopy() *UDPIngressList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new UDPIngressList.
func (*UDPIngressList) DeepCopyInto ¶
func (in *UDPIngressList) DeepCopyInto(out *UDPIngressList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*UDPIngressList) DeepCopyObject ¶
func (in *UDPIngressList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type UDPIngressRule ¶
type UDPIngressRule struct { // Port indicates the port for the Kong proxy to accept incoming traffic // on, which will then be routed to the service Backend. // +kubebuilder:validation:Minimum=1 // +kubebuilder:validation:Maximum=65535 // +kubebuilder:validation:Format=int32 // +kubebuilder:validation:Required Port int `json:"port"` // Backend defines the Kubernetes service which accepts traffic from the // listening Port defined above. // +kubebuilder:validation:Required Backend IngressBackend `json:"backend"` }
UDPIngressRule represents a rule to apply against incoming requests wherein no Host matching is available for request routing, only the port is used to match requests.
func (*UDPIngressRule) DeepCopy ¶
func (in *UDPIngressRule) DeepCopy() *UDPIngressRule
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new UDPIngressRule.
func (*UDPIngressRule) DeepCopyInto ¶
func (in *UDPIngressRule) DeepCopyInto(out *UDPIngressRule)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type UDPIngressSpec ¶
type UDPIngressSpec struct { // A list of rules used to configure the Ingress. Rules []UDPIngressRule `json:"rules,omitempty"` }
UDPIngressSpec defines the desired state of UDPIngress.
func (*UDPIngressSpec) DeepCopy ¶
func (in *UDPIngressSpec) DeepCopy() *UDPIngressSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new UDPIngressSpec.
func (*UDPIngressSpec) DeepCopyInto ¶
func (in *UDPIngressSpec) DeepCopyInto(out *UDPIngressSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type UDPIngressStatus ¶
type UDPIngressStatus struct { // LoadBalancer contains the current status of the load-balancer. LoadBalancer corev1.LoadBalancerStatus `json:"loadBalancer,omitempty"` }
UDPIngressStatus defines the observed state of UDPIngress.
func (*UDPIngressStatus) DeepCopy ¶
func (in *UDPIngressStatus) DeepCopy() *UDPIngressStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new UDPIngressStatus.
func (*UDPIngressStatus) DeepCopyInto ¶
func (in *UDPIngressStatus) DeepCopyInto(out *UDPIngressStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.