v1beta1

Documentation

Index

• Constants
• Variables
• func Resource(resource string) schema.GroupResource
• type Endpoint
• type EndpointConditions
• type EndpointPort
• type EndpointSlice
  • func (v *EndpointSlice) GroupVersionKind() schema.GroupVersionKind
• type EndpointSliceList
  • func (v *EndpointSliceList) GroupVersionKind() schema.GroupVersionKind

Constants

const GroupName = "discovery.k8s.io"

GroupName is the group name use in this package

Variables

var SchemeGroupVersion = schema.GroupVersion{Group: GroupName, Version: "v1beta1"}

SchemeGroupVersion is group version used to register these objects

Functions

func Resource

func Resource(resource string) schema.GroupResource

Resource takes an unqualified resource and returns a Group qualified GroupResource

Types

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.
	// Required: true
	Addresses []string `json:"addresses"`

	// conditions contains information about the current status of the endpoint.
	Conditions *EndpointConditions `json:"conditions,omitempty"`

	// 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.
	Hostname string `json:"hostname,omitempty"`

	// targetRef is a reference to a Kubernetes object that represents this endpoint.
	TargetRef *api_core_v1.ObjectReference `json:"targetRef,omitempty"`

	// 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.
	Topology map[string]string `json:"topology,omitempty"`
}

Endpoint Endpoint represents a single logical "backend" implementing a service.

swagger:model Endpoint

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.
	Ready bool `json:"ready,omitempty"`
}

EndpointConditions EndpointConditions represents the current condition of an endpoint.

swagger:model EndpointConditions

type EndpointPort

type EndpointPort struct {

	// 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 such as mycompany.com/my-custom-protocol.
	AppProtocol string `json:"appProtocol,omitempty"`

	// 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"`

	// 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"`

	// The IP protocol for this port. Must be UDP, TCP, or SCTP. Default is TCP.
	Protocol string `json:"protocol,omitempty"`
}

EndpointPort EndpointPort represents a Port used by an EndpointSlice

swagger:model EndpointPort

type EndpointSlice

type EndpointSlice struct {

	// 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.
	// Required: true
	AddressType *string `json:"addressType"`

	// APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
	APIVersion string `json:"apiVersion,omitempty"`

	// endpoints is a list of unique endpoints in this slice. Each slice may include a maximum of 1000 endpoints.
	// Required: true
	Endpoints []*Endpoint `json:"endpoints"`

	// Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
	Kind string `json:"kind,omitempty"`

	// Standard object's metadata.
	Metadata *apimachinery_pkg_apis_meta_v1.ObjectMeta `json:"metadata,omitempty"`

	// 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.
	Ports []*EndpointPort `json:"ports,omitempty"`
}

EndpointSlice 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.

swagger:model EndpointSlice

func (*EndpointSlice) GroupVersionKind

func (v *EndpointSlice) GroupVersionKind() schema.GroupVersionKind

type EndpointSliceList

type EndpointSliceList struct {

	// APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
	APIVersion string `json:"apiVersion,omitempty"`

	// List of endpoint slices
	// Required: true
	Items []*EndpointSlice `json:"items"`

	// Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
	Kind string `json:"kind,omitempty"`

	// Standard list metadata.
	Metadata *apimachinery_pkg_apis_meta_v1.ListMeta `json:"metadata,omitempty"`
}

EndpointSliceList EndpointSliceList represents a list of endpoint slices

swagger:model EndpointSliceList

func (*EndpointSliceList) GroupVersionKind

func (v *EndpointSliceList) GroupVersionKind() schema.GroupVersionKind