v1

package
v1.32.0-kw1 Latest Latest
Warning

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

 Go to latest Published: Dec 20, 2024 License: Apache-2.0 Imports: 3 Imported by: 0

Documentation

Index

Constants

View Source 
const GroupName = "discovery.k8s.io"

GroupName is the group name use in this package

Variables

View Source 
var SchemeGroupVersion = schema.GroupVersion{Group: GroupName, Version: "v1"}

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. These are all assumed to be fungible and clients may choose to only use the first element. Refer to: https://issue.k8s.io/106267
	// Required: true
	Addresses []string `json:"addresses"`

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

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

	// hints contains information associated with how an endpoint should be consumed.
	Hints *EndpointHints `json:"hints,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 be lowercase and pass DNS Label (RFC 1123) validation.
	Hostname string `json:"hostname,omitempty"`

	// nodeName represents the name of the Node hosting this endpoint. This can be used to determine endpoints local to a Node.
	NodeName string `json:"nodeName,omitempty"`

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

	// zone is the name of the Zone this endpoint exists in.
	Zone string `json:"zone,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. 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.
	Ready bool `json:"ready,omitempty"`

	// 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.
	Serving bool `json:"serving,omitempty"`

	// 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.
	Terminating bool `json:"terminating,omitempty"`
}

EndpointConditions EndpointConditions represents the current condition of an endpoint.

swagger:model EndpointConditions

type EndpointHints 

type EndpointHints struct {

	// forZones indicates the zone(s) this endpoint should be consumed by to enable topology aware routing.
	ForZones []*ForZone `json:"forZones,omitempty"`
}

EndpointHints EndpointHints provides hints describing how an endpoint should be consumed.

swagger:model EndpointHints

type EndpointPort 

type EndpointPort struct {

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

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

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

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

	// items is the 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

type ForZone 

type ForZone struct {

	// name represents the name of the zone.
	// Required: true
	Name *string `json:"name"`
}

ForZone ForZone provides information about which zones should consume this endpoint.

swagger:model ForZone

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.