1/*
2Copyright The Kubernetes Authors.
3
4Licensed under the Apache License, Version 2.0 (the "License");
5you may not use this file except in compliance with the License.
6You may obtain a copy of the License at
7
8 http://www.apache.org/licenses/LICENSE-2.0
9
10Unless required by applicable law or agreed to in writing, software
11distributed under the License is distributed on an "AS IS" BASIS,
12WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13See the License for the specific language governing permissions and
14limitations under the License.
15*/
16
17
18// This file was autogenerated by go-to-protobuf. Do not edit it manually!
19
20syntax = "proto2";
21
22package k8s.io.api.discovery.v1beta1;
23
24import "k8s.io/api/core/v1/generated.proto";
25import "k8s.io/apimachinery/pkg/apis/meta/v1/generated.proto";
26import "k8s.io/apimachinery/pkg/runtime/generated.proto";
27import "k8s.io/apimachinery/pkg/runtime/schema/generated.proto";
28
29// Package-wide variables from generator "generated".
30option go_package = "k8s.io/api/discovery/v1beta1";
31
32// Endpoint represents a single logical "backend" implementing a service.
33message Endpoint {
34 // addresses of this endpoint. The contents of this field are interpreted
35 // according to the corresponding EndpointSlice addressType field. Consumers
36 // must handle different types of addresses in the context of their own
37 // capabilities. This must contain at least one address but no more than
38 // 100. These are all assumed to be fungible and clients may choose to only
39 // use the first element. Refer to: https://issue.k8s.io/106267
40 // +listType=set
41 repeated string addresses = 1;
42
43 // conditions contains information about the current status of the endpoint.
44 optional EndpointConditions conditions = 2;
45
46 // hostname of this endpoint. This field may be used by consumers of
47 // endpoints to distinguish endpoints from each other (e.g. in DNS names).
48 // Multiple endpoints which use the same hostname should be considered
49 // fungible (e.g. multiple A values in DNS). Must be lowercase and pass DNS
50 // Label (RFC 1123) validation.
51 // +optional
52 optional string hostname = 3;
53
54 // targetRef is a reference to a Kubernetes object that represents this
55 // endpoint.
56 // +optional
57 optional k8s.io.api.core.v1.ObjectReference targetRef = 4;
58
59 // topology contains arbitrary topology information associated with the
60 // endpoint. These key/value pairs must conform with the label format.
61 // https://kubernetes.io/docs/concepts/overview/working-with-objects/labels
62 // Topology may include a maximum of 16 key/value pairs. This includes, but
63 // is not limited to the following well known keys:
64 // * kubernetes.io/hostname: the value indicates the hostname of the node
65 // where the endpoint is located. This should match the corresponding
66 // node label.
67 // * topology.kubernetes.io/zone: the value indicates the zone where the
68 // endpoint is located. This should match the corresponding node label.
69 // * topology.kubernetes.io/region: the value indicates the region where the
70 // endpoint is located. This should match the corresponding node label.
71 // This field is deprecated and will be removed in future api versions.
72 // +optional
73 map<string, string> topology = 5;
74
75 // nodeName represents the name of the Node hosting this endpoint. This can
76 // be used to determine endpoints local to a Node.
77 // +optional
78 optional string nodeName = 6;
79
80 // hints contains information associated with how an endpoint should be
81 // consumed.
82 // +featureGate=TopologyAwareHints
83 // +optional
84 optional EndpointHints hints = 7;
85}
86
87// EndpointConditions represents the current condition of an endpoint.
88message EndpointConditions {
89 // ready indicates that this endpoint is prepared to receive traffic,
90 // according to whatever system is managing the endpoint. A nil value
91 // indicates an unknown state. In most cases consumers should interpret this
92 // unknown state as ready. For compatibility reasons, ready should never be
93 // "true" for terminating endpoints.
94 // +optional
95 optional bool ready = 1;
96
97 // serving is identical to ready except that it is set regardless of the
98 // terminating state of endpoints. This condition should be set to true for
99 // a ready endpoint that is terminating. If nil, consumers should defer to
100 // the ready condition.
101 // +optional
102 optional bool serving = 2;
103
104 // terminating indicates that this endpoint is terminating. A nil value
105 // indicates an unknown state. Consumers should interpret this unknown state
106 // to mean that the endpoint is not terminating.
107 // +optional
108 optional bool terminating = 3;
109}
110
111// EndpointHints provides hints describing how an endpoint should be consumed.
112message EndpointHints {
113 // forZones indicates the zone(s) this endpoint should be consumed by to
114 // enable topology aware routing. May contain a maximum of 8 entries.
115 // +listType=atomic
116 repeated ForZone forZones = 1;
117}
118
119// EndpointPort represents a Port used by an EndpointSlice
120message EndpointPort {
121 // name represents the name of this port. All ports in an EndpointSlice must have a unique name.
122 // If the EndpointSlice is derived from a Kubernetes service, this corresponds to the Service.ports[].name.
123 // Name must either be an empty string or pass DNS_LABEL validation:
124 // * must be no more than 63 characters long.
125 // * must consist of lower case alphanumeric characters or '-'.
126 // * must start and end with an alphanumeric character.
127 // Default is empty string.
128 optional string name = 1;
129
130 // protocol represents the IP protocol for this port.
131 // Must be UDP, TCP, or SCTP.
132 // Default is TCP.
133 optional string protocol = 2;
134
135 // port represents the port number of the endpoint.
136 // If this is not specified, ports are not restricted and must be
137 // interpreted in the context of the specific consumer.
138 optional int32 port = 3;
139
140 // appProtocol represents the application protocol for this port.
141 // This field follows standard Kubernetes label syntax.
142 // Un-prefixed names are reserved for IANA standard service names (as per
143 // RFC-6335 and https://www.iana.org/assignments/service-names).
144 // Non-standard protocols should use prefixed names such as
145 // mycompany.com/my-custom-protocol.
146 // +optional
147 optional string appProtocol = 4;
148}
149
150// EndpointSlice represents a subset of the endpoints that implement a service.
151// For a given service there may be multiple EndpointSlice objects, selected by
152// labels, which must be joined to produce the full set of endpoints.
153message EndpointSlice {
154 // Standard object's metadata.
155 // +optional
156 optional k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1;
157
158 // addressType specifies the type of address carried by this EndpointSlice.
159 // All addresses in this slice must be the same type. This field is
160 // immutable after creation. The following address types are currently
161 // supported:
162 // * IPv4: Represents an IPv4 Address.
163 // * IPv6: Represents an IPv6 Address.
164 // * FQDN: Represents a Fully Qualified Domain Name.
165 optional string addressType = 4;
166
167 // endpoints is a list of unique endpoints in this slice. Each slice may
168 // include a maximum of 1000 endpoints.
169 // +listType=atomic
170 repeated Endpoint endpoints = 2;
171
172 // ports specifies the list of network ports exposed by each endpoint in
173 // this slice. Each port must have a unique name. When ports is empty, it
174 // indicates that there are no defined ports. When a port is defined with a
175 // nil port value, it indicates "all ports". Each slice may include a
176 // maximum of 100 ports.
177 // +optional
178 // +listType=atomic
179 repeated EndpointPort ports = 3;
180}
181
182// EndpointSliceList represents a list of endpoint slices
183message EndpointSliceList {
184 // Standard list metadata.
185 // +optional
186 optional k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1;
187
188 // items is the list of endpoint slices
189 repeated EndpointSlice items = 2;
190}
191
192// ForZone provides information about which zones should consume this endpoint.
193message ForZone {
194 // name represents the name of the zone.
195 optional string name = 1;
196}
197
View as plain text