Documentation ¶
Index ¶
- Constants
- Variables
- func Kind(kind string) schema.GroupKind
- func Resource(resource string) schema.GroupResource
- type AddressType
- type Endpoint
- func (in *Endpoint) DeepCopy() *Endpoint
- func (in *Endpoint) DeepCopyInto(out *Endpoint)
- 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
- type EndpointConditions
- func (in *EndpointConditions) DeepCopy() *EndpointConditions
- func (in *EndpointConditions) DeepCopyInto(out *EndpointConditions)
- 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
- type EndpointPort
- func (in *EndpointPort) DeepCopy() *EndpointPort
- func (in *EndpointPort) DeepCopyInto(out *EndpointPort)
- 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
- type EndpointSlice
- func (in *EndpointSlice) DeepCopy() *EndpointSlice
- func (in *EndpointSlice) DeepCopyInto(out *EndpointSlice)
- func (in *EndpointSlice) DeepCopyObject() 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
- type EndpointSliceList
- func (in *EndpointSliceList) DeepCopy() *EndpointSliceList
- func (in *EndpointSliceList) DeepCopyInto(out *EndpointSliceList)
- func (in *EndpointSliceList) DeepCopyObject() 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
Constants ¶
const ( // AddressTypeIP represents an IP Address. // This address type has been deprecated and has been replaced by the IPv4 // and IPv6 adddress types. New resources with this address type will be // considered invalid. This will be fully removed in 1.18. // +deprecated AddressTypeIP = AddressType("IP") // 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" )
const GroupName = "discovery.k8s.io"
GroupName is the group name used in this package
Variables ¶
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 )
var SchemeGroupVersion = schema.GroupVersion{Group: GroupName, Version: "v1alpha1"}
SchemeGroupVersion is group version used to register these objects
Functions ¶
func Kind ¶
Kind takes an unqualified kind and returns a Group qualified GroupKind
func Resource ¶
func Resource(resource string) schema.GroupResource
Resource takes an unqualified resource and returns a Group qualified GroupResource
Types ¶
type AddressType ¶
type AddressType string
AddressType represents the type of address referred to by an endpoint.
type Endpoint ¶
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. // +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 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"` // topology contains arbitrary topology information associated with the // endpoint. These key/value pairs must conform with the label format. // https://kubernetes.io/docs/concepts/overview/working-with-objects/labels // Topology may include a maximum of 16 key/value pairs. This includes, but // is not limited to the following well known keys: // * kubernetes.io/hostname: the value indicates the hostname of the node // where the endpoint is located. This should match the corresponding // node label. // * topology.kubernetes.io/zone: the value indicates the zone where the // endpoint is located. This should match the corresponding node label. // * topology.kubernetes.io/region: the value indicates the region where the // endpoint is located. This should match the corresponding node label. // +optional Topology map[string]string `json:"topology,omitempty" protobuf:"bytes,5,opt,name=topology"` }
Endpoint represents a single logical "backend" implementing a service.
func (*Endpoint) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Endpoint.
func (*Endpoint) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Endpoint) MarshalToSizedBuffer ¶
func (*Endpoint) XXX_Marshal ¶
type EndpointConditions ¶
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. // +optional Ready *bool `json:"ready,omitempty" protobuf:"bytes,1,name=ready"` }
EndpointConditions represents the current condition of an endpoint.
func (*EndpointConditions) DeepCopy ¶
func (in *EndpointConditions) DeepCopy() *EndpointConditions
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new EndpointConditions.
func (*EndpointConditions) DeepCopyInto ¶
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 ¶
func (*EndpointConditions) Descriptor() ([]byte, []int)
func (*EndpointConditions) Marshal ¶
func (m *EndpointConditions) Marshal() (dAtA []byte, err error)
func (*EndpointConditions) MarshalTo ¶
func (m *EndpointConditions) MarshalTo(dAtA []byte) (int, error)
func (*EndpointConditions) MarshalToSizedBuffer ¶
func (m *EndpointConditions) MarshalToSizedBuffer(dAtA []byte) (int, error)
func (*EndpointConditions) ProtoMessage ¶
func (*EndpointConditions) ProtoMessage()
func (*EndpointConditions) Reset ¶
func (m *EndpointConditions) Reset()
func (*EndpointConditions) Size ¶
func (m *EndpointConditions) Size() (n int)
func (*EndpointConditions) String ¶
func (this *EndpointConditions) String() string
func (EndpointConditions) SwaggerDoc ¶
func (EndpointConditions) SwaggerDoc() map[string]string
func (*EndpointConditions) Unmarshal ¶
func (m *EndpointConditions) Unmarshal(dAtA []byte) error
func (*EndpointConditions) XXX_DiscardUnknown ¶
func (m *EndpointConditions) XXX_DiscardUnknown()
func (*EndpointConditions) XXX_Marshal ¶
func (m *EndpointConditions) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*EndpointConditions) XXX_Merge ¶
func (m *EndpointConditions) XXX_Merge(src proto.Message)
func (*EndpointConditions) XXX_Size ¶
func (m *EndpointConditions) XXX_Size() int
func (*EndpointConditions) XXX_Unmarshal ¶
func (m *EndpointConditions) XXX_Unmarshal(b []byte) error
type EndpointPort ¶
type EndpointPort struct { // The name of this port. All ports in an EndpointSlice must have a unique // name. If the EndpointSlice is dervied 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"` // 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"` // 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 field follows standard Kubernetes label syntax. // Un-prefixed names are reserved for IANA standard service names (as per // RFC-6335 and http://www.iana.org/assignments/service-names). // Non-standard protocols should use prefixed names. // Default is empty string. AppProtocol *string `json:"appProtocol,omitempty" protobuf:"bytes,4,name=appProtocol"` }
EndpointPort represents a Port used by an EndpointSlice
func (*EndpointPort) DeepCopy ¶
func (in *EndpointPort) DeepCopy() *EndpointPort
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new EndpointPort.
func (*EndpointPort) DeepCopyInto ¶
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 ¶
func (*EndpointPort) Descriptor() ([]byte, []int)
func (*EndpointPort) Marshal ¶
func (m *EndpointPort) Marshal() (dAtA []byte, err error)
func (*EndpointPort) MarshalTo ¶
func (m *EndpointPort) MarshalTo(dAtA []byte) (int, error)
func (*EndpointPort) MarshalToSizedBuffer ¶
func (m *EndpointPort) MarshalToSizedBuffer(dAtA []byte) (int, error)
func (*EndpointPort) ProtoMessage ¶
func (*EndpointPort) ProtoMessage()
func (*EndpointPort) Reset ¶
func (m *EndpointPort) Reset()
func (*EndpointPort) Size ¶
func (m *EndpointPort) Size() (n int)
func (*EndpointPort) String ¶
func (this *EndpointPort) String() string
func (EndpointPort) SwaggerDoc ¶
func (EndpointPort) SwaggerDoc() map[string]string
func (*EndpointPort) Unmarshal ¶
func (m *EndpointPort) Unmarshal(dAtA []byte) error
func (*EndpointPort) XXX_DiscardUnknown ¶
func (m *EndpointPort) XXX_DiscardUnknown()
func (*EndpointPort) XXX_Marshal ¶
func (m *EndpointPort) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*EndpointPort) XXX_Merge ¶
func (m *EndpointPort) XXX_Merge(src proto.Message)
func (*EndpointPort) XXX_Size ¶
func (m *EndpointPort) XXX_Size() int
func (*EndpointPort) XXX_Unmarshal ¶
func (m *EndpointPort) XXX_Unmarshal(b []byte) error
type EndpointSlice ¶
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"` }
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.
func (*EndpointSlice) DeepCopy ¶
func (in *EndpointSlice) DeepCopy() *EndpointSlice
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new EndpointSlice.
func (*EndpointSlice) DeepCopyInto ¶
func (in *EndpointSlice) DeepCopyInto(out *EndpointSlice)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*EndpointSlice) DeepCopyObject ¶
func (in *EndpointSlice) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*EndpointSlice) Descriptor ¶
func (*EndpointSlice) Descriptor() ([]byte, []int)
func (*EndpointSlice) Marshal ¶
func (m *EndpointSlice) Marshal() (dAtA []byte, err error)
func (*EndpointSlice) MarshalTo ¶
func (m *EndpointSlice) MarshalTo(dAtA []byte) (int, error)
func (*EndpointSlice) MarshalToSizedBuffer ¶
func (m *EndpointSlice) MarshalToSizedBuffer(dAtA []byte) (int, error)
func (*EndpointSlice) ProtoMessage ¶
func (*EndpointSlice) ProtoMessage()
func (*EndpointSlice) Reset ¶
func (m *EndpointSlice) Reset()
func (*EndpointSlice) Size ¶
func (m *EndpointSlice) Size() (n int)
func (*EndpointSlice) String ¶
func (this *EndpointSlice) String() string
func (EndpointSlice) SwaggerDoc ¶
func (EndpointSlice) SwaggerDoc() map[string]string
func (*EndpointSlice) Unmarshal ¶
func (m *EndpointSlice) Unmarshal(dAtA []byte) error
func (*EndpointSlice) XXX_DiscardUnknown ¶
func (m *EndpointSlice) XXX_DiscardUnknown()
func (*EndpointSlice) XXX_Marshal ¶
func (m *EndpointSlice) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*EndpointSlice) XXX_Merge ¶
func (m *EndpointSlice) XXX_Merge(src proto.Message)
func (*EndpointSlice) XXX_Size ¶
func (m *EndpointSlice) XXX_Size() int
func (*EndpointSlice) XXX_Unmarshal ¶
func (m *EndpointSlice) XXX_Unmarshal(b []byte) error
type EndpointSliceList ¶
type EndpointSliceList struct { metav1.TypeMeta `json:",inline"` // Standard list metadata. // +optional metav1.ListMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"` // List of endpoint slices // +listType=set Items []EndpointSlice `json:"items" protobuf:"bytes,2,rep,name=items"` }
EndpointSliceList represents a list of endpoint slices
func (*EndpointSliceList) DeepCopy ¶
func (in *EndpointSliceList) DeepCopy() *EndpointSliceList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new EndpointSliceList.
func (*EndpointSliceList) DeepCopyInto ¶
func (in *EndpointSliceList) DeepCopyInto(out *EndpointSliceList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*EndpointSliceList) DeepCopyObject ¶
func (in *EndpointSliceList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*EndpointSliceList) Descriptor ¶
func (*EndpointSliceList) Descriptor() ([]byte, []int)
func (*EndpointSliceList) Marshal ¶
func (m *EndpointSliceList) Marshal() (dAtA []byte, err error)
func (*EndpointSliceList) MarshalTo ¶
func (m *EndpointSliceList) MarshalTo(dAtA []byte) (int, error)
func (*EndpointSliceList) MarshalToSizedBuffer ¶
func (m *EndpointSliceList) MarshalToSizedBuffer(dAtA []byte) (int, error)
func (*EndpointSliceList) ProtoMessage ¶
func (*EndpointSliceList) ProtoMessage()
func (*EndpointSliceList) Reset ¶
func (m *EndpointSliceList) Reset()
func (*EndpointSliceList) Size ¶
func (m *EndpointSliceList) Size() (n int)
func (*EndpointSliceList) String ¶
func (this *EndpointSliceList) String() string
func (EndpointSliceList) SwaggerDoc ¶
func (EndpointSliceList) SwaggerDoc() map[string]string
func (*EndpointSliceList) Unmarshal ¶
func (m *EndpointSliceList) Unmarshal(dAtA []byte) error
func (*EndpointSliceList) XXX_DiscardUnknown ¶
func (m *EndpointSliceList) XXX_DiscardUnknown()
func (*EndpointSliceList) XXX_Marshal ¶
func (m *EndpointSliceList) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*EndpointSliceList) XXX_Merge ¶
func (m *EndpointSliceList) XXX_Merge(src proto.Message)
func (*EndpointSliceList) XXX_Size ¶
func (m *EndpointSliceList) XXX_Size() int
func (*EndpointSliceList) XXX_Unmarshal ¶
func (m *EndpointSliceList) XXX_Unmarshal(b []byte) error