const (
// AddressTypeIPv4 represents an IPv4 Address.
AddressTypeIPv4 = AddressType(v1.IPv4Protocol)
// AddressTypeIPv6 represents an IPv6 Address.
AddressTypeIPv6 = AddressType(v1.IPv6Protocol)
// AddressTypeFQDN represents a FQDN.
AddressTypeFQDN = AddressType("FQDN")
)
const (
// LabelServiceName is used to indicate the name of a Kubernetes service.
LabelServiceName = "kubernetes.io/service-name"
// LabelManagedBy is used to indicate the controller or entity that manages
// an EndpointSlice. This label aims to enable different EndpointSlice
// objects to be managed by different controllers or entities within the
// same cluster. It is highly recommended to configure this label for all
// EndpointSlices.
LabelManagedBy = "endpointslice.kubernetes.io/managed-by"
// LabelSkipMirror can be set to true on an Endpoints resource to indicate
// that the EndpointSliceMirroring controller should not mirror this
// resource with EndpointSlices.
LabelSkipMirror = "endpointslice.kubernetes.io/skip-mirror"
)
GroupName is the group name used in this package
const GroupName = "discovery.k8s.io"
var (
ErrInvalidLengthGenerated = fmt.Errorf("proto: negative length found during unmarshaling")
ErrIntOverflowGenerated = fmt.Errorf("proto: integer overflow")
ErrUnexpectedEndOfGroupGenerated = fmt.Errorf("proto: unexpected end of group")
)
var (
// SchemeBuilder is the scheme builder with scheme init functions to run for this API package
SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes)
// AddToScheme is a common registration function for mapping packaged scoped group & version keys to a scheme
AddToScheme = SchemeBuilder.AddToScheme
)
SchemeGroupVersion is group version used to register these objects
var SchemeGroupVersion = schema.GroupVersion{Group: GroupName, Version: "v1"}
func Kind(kind string) schema.GroupKind
Kind takes an unqualified kind and returns a Group qualified GroupKind
func Resource(resource string) schema.GroupResource
Resource takes an unqualified resource and returns a Group qualified GroupResource
AddressType represents the type of address referred to by an endpoint. +enum
type AddressType string
Endpoint represents a single logical "backend" implementing a service.
type Endpoint struct {
// addresses of this endpoint. The contents of this field are interpreted
// according to the corresponding EndpointSlice addressType field. Consumers
// must handle different types of addresses in the context of their own
// capabilities. This must contain at least one address but no more than
// 100. These are all assumed to be fungible and clients may choose to only
// use the first element. Refer to: https://issue.k8s.io/106267
// +listType=set
Addresses []string `json:"addresses" protobuf:"bytes,1,rep,name=addresses"`
// conditions contains information about the current status of the endpoint.
Conditions EndpointConditions `json:"conditions,omitempty" protobuf:"bytes,2,opt,name=conditions"`
// hostname of this endpoint. This field may be used by consumers of
// endpoints to distinguish endpoints from each other (e.g. in DNS names).
// Multiple endpoints which use the same hostname should be considered
// fungible (e.g. multiple A values in DNS). Must be lowercase and pass DNS
// Label (RFC 1123) validation.
// +optional
Hostname *string `json:"hostname,omitempty" protobuf:"bytes,3,opt,name=hostname"`
// targetRef is a reference to a Kubernetes object that represents this
// endpoint.
// +optional
TargetRef *v1.ObjectReference `json:"targetRef,omitempty" protobuf:"bytes,4,opt,name=targetRef"`
// deprecatedTopology contains topology information part of the v1beta1
// API. This field is deprecated, and will be removed when the v1beta1
// API is removed (no sooner than kubernetes v1.24). While this field can
// hold values, it is not writable through the v1 API, and any attempts to
// write to it will be silently ignored. Topology information can be found
// in the zone and nodeName fields instead.
// +optional
DeprecatedTopology map[string]string `json:"deprecatedTopology,omitempty" protobuf:"bytes,5,opt,name=deprecatedTopology"`
// nodeName represents the name of the Node hosting this endpoint. This can
// be used to determine endpoints local to a Node.
// +optional
NodeName *string `json:"nodeName,omitempty" protobuf:"bytes,6,opt,name=nodeName"`
// zone is the name of the Zone this endpoint exists in.
// +optional
Zone *string `json:"zone,omitempty" protobuf:"bytes,7,opt,name=zone"`
// hints contains information associated with how an endpoint should be
// consumed.
// +optional
Hints *EndpointHints `json:"hints,omitempty" protobuf:"bytes,8,opt,name=hints"`
}
func (in *Endpoint) DeepCopy() *Endpoint
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Endpoint.
func (in *Endpoint) DeepCopyInto(out *Endpoint)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Endpoint) Descriptor() ([]byte, []int)
func (m *Endpoint) Marshal() (dAtA []byte, err error)
func (m *Endpoint) MarshalTo(dAtA []byte) (int, error)
func (m *Endpoint) MarshalToSizedBuffer(dAtA []byte) (int, error)
func (*Endpoint) ProtoMessage()
func (m *Endpoint) Reset()
func (m *Endpoint) Size() (n int)
func (this *Endpoint) String() string
func (Endpoint) SwaggerDoc() map[string]string
func (m *Endpoint) Unmarshal(dAtA []byte) error
func (m *Endpoint) XXX_DiscardUnknown()
func (m *Endpoint) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (m *Endpoint) XXX_Merge(src proto.Message)
func (m *Endpoint) XXX_Size() int
func (m *Endpoint) XXX_Unmarshal(b []byte) error
EndpointConditions represents the current condition of an endpoint.
type EndpointConditions struct {
// ready indicates that this endpoint is prepared to receive traffic,
// according to whatever system is managing the endpoint. A nil value
// indicates an unknown state. In most cases consumers should interpret this
// unknown state as ready. For compatibility reasons, ready should never be
// "true" for terminating endpoints, except when the normal readiness
// behavior is being explicitly overridden, for example when the associated
// Service has set the publishNotReadyAddresses flag.
// +optional
Ready *bool `json:"ready,omitempty" protobuf:"bytes,1,name=ready"`
// serving is identical to ready except that it is set regardless of the
// terminating state of endpoints. This condition should be set to true for
// a ready endpoint that is terminating. If nil, consumers should defer to
// the ready condition.
// +optional
Serving *bool `json:"serving,omitempty" protobuf:"bytes,2,name=serving"`
// terminating indicates that this endpoint is terminating. A nil value
// indicates an unknown state. Consumers should interpret this unknown state
// to mean that the endpoint is not terminating.
// +optional
Terminating *bool `json:"terminating,omitempty" protobuf:"bytes,3,name=terminating"`
}
func (in *EndpointConditions) DeepCopy() *EndpointConditions
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new EndpointConditions.
func (in *EndpointConditions) DeepCopyInto(out *EndpointConditions)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*EndpointConditions) Descriptor() ([]byte, []int)
func (m *EndpointConditions) Marshal() (dAtA []byte, err error)
func (m *EndpointConditions) MarshalTo(dAtA []byte) (int, error)
func (m *EndpointConditions) MarshalToSizedBuffer(dAtA []byte) (int, error)
func (*EndpointConditions) ProtoMessage()
func (m *EndpointConditions) Reset()
func (m *EndpointConditions) Size() (n int)
func (this *EndpointConditions) String() string
func (EndpointConditions) SwaggerDoc() map[string]string
func (m *EndpointConditions) Unmarshal(dAtA []byte) error
func (m *EndpointConditions) XXX_DiscardUnknown()
func (m *EndpointConditions) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (m *EndpointConditions) XXX_Merge(src proto.Message)
func (m *EndpointConditions) XXX_Size() int
func (m *EndpointConditions) XXX_Unmarshal(b []byte) error
EndpointHints provides hints describing how an endpoint should be consumed.
type EndpointHints struct {
// forZones indicates the zone(s) this endpoint should be consumed by to
// enable topology aware routing.
// +listType=atomic
ForZones []ForZone `json:"forZones,omitempty" protobuf:"bytes,1,name=forZones"`
}
func (in *EndpointHints) DeepCopy() *EndpointHints
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new EndpointHints.
func (in *EndpointHints) DeepCopyInto(out *EndpointHints)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*EndpointHints) Descriptor() ([]byte, []int)
func (m *EndpointHints) Marshal() (dAtA []byte, err error)
func (m *EndpointHints) MarshalTo(dAtA []byte) (int, error)
func (m *EndpointHints) MarshalToSizedBuffer(dAtA []byte) (int, error)
func (*EndpointHints) ProtoMessage()
func (m *EndpointHints) Reset()
func (m *EndpointHints) Size() (n int)
func (this *EndpointHints) String() string
func (EndpointHints) SwaggerDoc() map[string]string
func (m *EndpointHints) Unmarshal(dAtA []byte) error
func (m *EndpointHints) XXX_DiscardUnknown()
func (m *EndpointHints) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (m *EndpointHints) XXX_Merge(src proto.Message)
func (m *EndpointHints) XXX_Size() int
func (m *EndpointHints) XXX_Unmarshal(b []byte) error
EndpointPort represents a Port used by an EndpointSlice +structType=atomic
type EndpointPort struct {
// name represents the name of this port. All ports in an EndpointSlice must have a unique name.
// If the EndpointSlice is derived from a Kubernetes service, this corresponds to the Service.ports[].name.
// Name must either be an empty string or pass DNS_LABEL validation:
// * must be no more than 63 characters long.
// * must consist of lower case alphanumeric characters or '-'.
// * must start and end with an alphanumeric character.
// Default is empty string.
Name *string `json:"name,omitempty" protobuf:"bytes,1,name=name"`
// protocol represents the IP protocol for this port.
// Must be UDP, TCP, or SCTP.
// Default is TCP.
Protocol *v1.Protocol `json:"protocol,omitempty" protobuf:"bytes,2,name=protocol"`
// port represents the port number of the endpoint.
// If this is not specified, ports are not restricted and must be
// interpreted in the context of the specific consumer.
Port *int32 `json:"port,omitempty" protobuf:"bytes,3,opt,name=port"`
// The application protocol for this port.
// This is used as a hint for implementations to offer richer behavior for protocols that they understand.
// This field follows standard Kubernetes label syntax.
// Valid values are either:
//
// * Un-prefixed protocol names - reserved for IANA standard service names (as per
// RFC-6335 and https://www.iana.org/assignments/service-names).
//
// * Kubernetes-defined prefixed names:
// * 'kubernetes.io/h2c' - HTTP/2 prior knowledge over cleartext as described in https://www.rfc-editor.org/rfc/rfc9113.html#name-starting-http-2-with-prior-
// * 'kubernetes.io/ws' - WebSocket over cleartext as described in https://www.rfc-editor.org/rfc/rfc6455
// * 'kubernetes.io/wss' - WebSocket over TLS as described in https://www.rfc-editor.org/rfc/rfc6455
//
// * Other protocols should use implementation-defined prefixed names such as
// mycompany.com/my-custom-protocol.
// +optional
AppProtocol *string `json:"appProtocol,omitempty" protobuf:"bytes,4,name=appProtocol"`
}
func (in *EndpointPort) DeepCopy() *EndpointPort
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new EndpointPort.
func (in *EndpointPort) DeepCopyInto(out *EndpointPort)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*EndpointPort) Descriptor() ([]byte, []int)
func (m *EndpointPort) Marshal() (dAtA []byte, err error)
func (m *EndpointPort) MarshalTo(dAtA []byte) (int, error)
func (m *EndpointPort) MarshalToSizedBuffer(dAtA []byte) (int, error)
func (*EndpointPort) ProtoMessage()
func (m *EndpointPort) Reset()
func (m *EndpointPort) Size() (n int)
func (this *EndpointPort) String() string
func (EndpointPort) SwaggerDoc() map[string]string
func (m *EndpointPort) Unmarshal(dAtA []byte) error
func (m *EndpointPort) XXX_DiscardUnknown()
func (m *EndpointPort) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (m *EndpointPort) XXX_Merge(src proto.Message)
func (m *EndpointPort) XXX_Size() int
func (m *EndpointPort) XXX_Unmarshal(b []byte) error
EndpointSlice represents a subset of the endpoints that implement a service. For a given service there may be multiple EndpointSlice objects, selected by labels, which must be joined to produce the full set of endpoints.
type EndpointSlice struct {
metav1.TypeMeta `json:",inline"`
// Standard object's metadata.
// +optional
metav1.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`
// addressType specifies the type of address carried by this EndpointSlice.
// All addresses in this slice must be the same type. This field is
// immutable after creation. The following address types are currently
// supported:
// * IPv4: Represents an IPv4 Address.
// * IPv6: Represents an IPv6 Address.
// * FQDN: Represents a Fully Qualified Domain Name.
AddressType AddressType `json:"addressType" protobuf:"bytes,4,rep,name=addressType"`
// endpoints is a list of unique endpoints in this slice. Each slice may
// include a maximum of 1000 endpoints.
// +listType=atomic
Endpoints []Endpoint `json:"endpoints" protobuf:"bytes,2,rep,name=endpoints"`
// ports specifies the list of network ports exposed by each endpoint in
// this slice. Each port must have a unique name. When ports is empty, it
// indicates that there are no defined ports. When a port is defined with a
// nil port value, it indicates "all ports". Each slice may include a
// maximum of 100 ports.
// +optional
// +listType=atomic
Ports []EndpointPort `json:"ports" protobuf:"bytes,3,rep,name=ports"`
}
func (in *EndpointSlice) DeepCopy() *EndpointSlice
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new EndpointSlice.
func (in *EndpointSlice) DeepCopyInto(out *EndpointSlice)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (in *EndpointSlice) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*EndpointSlice) Descriptor() ([]byte, []int)
func (m *EndpointSlice) Marshal() (dAtA []byte, err error)
func (m *EndpointSlice) MarshalTo(dAtA []byte) (int, error)
func (m *EndpointSlice) MarshalToSizedBuffer(dAtA []byte) (int, error)
func (*EndpointSlice) ProtoMessage()
func (m *EndpointSlice) Reset()
func (m *EndpointSlice) Size() (n int)
func (this *EndpointSlice) String() string
func (EndpointSlice) SwaggerDoc() map[string]string
func (m *EndpointSlice) Unmarshal(dAtA []byte) error
func (m *EndpointSlice) XXX_DiscardUnknown()
func (m *EndpointSlice) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (m *EndpointSlice) XXX_Merge(src proto.Message)
func (m *EndpointSlice) XXX_Size() int
func (m *EndpointSlice) XXX_Unmarshal(b []byte) error
EndpointSliceList represents a list of endpoint slices
type EndpointSliceList struct {
metav1.TypeMeta `json:",inline"`
// Standard list metadata.
// +optional
metav1.ListMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`
// items is the list of endpoint slices
Items []EndpointSlice `json:"items" protobuf:"bytes,2,rep,name=items"`
}
func (in *EndpointSliceList) DeepCopy() *EndpointSliceList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new EndpointSliceList.
func (in *EndpointSliceList) DeepCopyInto(out *EndpointSliceList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (in *EndpointSliceList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*EndpointSliceList) Descriptor() ([]byte, []int)
func (m *EndpointSliceList) Marshal() (dAtA []byte, err error)
func (m *EndpointSliceList) MarshalTo(dAtA []byte) (int, error)
func (m *EndpointSliceList) MarshalToSizedBuffer(dAtA []byte) (int, error)
func (*EndpointSliceList) ProtoMessage()
func (m *EndpointSliceList) Reset()
func (m *EndpointSliceList) Size() (n int)
func (this *EndpointSliceList) String() string
func (EndpointSliceList) SwaggerDoc() map[string]string
func (m *EndpointSliceList) Unmarshal(dAtA []byte) error
func (m *EndpointSliceList) XXX_DiscardUnknown()
func (m *EndpointSliceList) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (m *EndpointSliceList) XXX_Merge(src proto.Message)
func (m *EndpointSliceList) XXX_Size() int
func (m *EndpointSliceList) XXX_Unmarshal(b []byte) error
ForZone provides information about which zones should consume this endpoint.
type ForZone struct {
// name represents the name of the zone.
Name string `json:"name" protobuf:"bytes,1,name=name"`
}
func (in *ForZone) DeepCopy() *ForZone
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ForZone.
func (in *ForZone) DeepCopyInto(out *ForZone)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*ForZone) Descriptor() ([]byte, []int)
func (m *ForZone) Marshal() (dAtA []byte, err error)
func (m *ForZone) MarshalTo(dAtA []byte) (int, error)
func (m *ForZone) MarshalToSizedBuffer(dAtA []byte) (int, error)
func (*ForZone) ProtoMessage()
func (m *ForZone) Reset()
func (m *ForZone) Size() (n int)
func (this *ForZone) String() string
func (ForZone) SwaggerDoc() map[string]string
func (m *ForZone) Unmarshal(dAtA []byte) error
func (m *ForZone) XXX_DiscardUnknown()
func (m *ForZone) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (m *ForZone) XXX_Merge(src proto.Message)
func (m *ForZone) XXX_Size() int
func (m *ForZone) XXX_Unmarshal(b []byte) error