generated.proto 37 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879
  1. /*
  2. Copyright The Kubernetes Authors.
  3. Licensed under the Apache License, Version 2.0 (the "License");
  4. you may not use this file except in compliance with the License.
  5. You may obtain a copy of the License at
  6. http://www.apache.org/licenses/LICENSE-2.0
  7. Unless required by applicable law or agreed to in writing, software
  8. distributed under the License is distributed on an "AS IS" BASIS,
  9. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  10. See the License for the specific language governing permissions and
  11. limitations under the License.
  12. */
  13. // This file was autogenerated by go-to-protobuf. Do not edit it manually!
  14. syntax = 'proto2';
  15. package k8s.io.apimachinery.pkg.apis.meta.v1;
  16. import "k8s.io/apimachinery/pkg/runtime/generated.proto";
  17. import "k8s.io/apimachinery/pkg/runtime/schema/generated.proto";
  18. // Package-wide variables from generator "generated".
  19. option go_package = "v1";
  20. // APIGroup contains the name, the supported versions, and the preferred version
  21. // of a group.
  22. message APIGroup {
  23. // name is the name of the group.
  24. optional string name = 1;
  25. // versions are the versions supported in this group.
  26. repeated GroupVersionForDiscovery versions = 2;
  27. // preferredVersion is the version preferred by the API server, which
  28. // probably is the storage version.
  29. // +optional
  30. optional GroupVersionForDiscovery preferredVersion = 3;
  31. // a map of client CIDR to server address that is serving this group.
  32. // This is to help clients reach servers in the most network-efficient way possible.
  33. // Clients can use the appropriate server address as per the CIDR that they match.
  34. // In case of multiple matches, clients should use the longest matching CIDR.
  35. // The server returns only those CIDRs that it thinks that the client can match.
  36. // For example: the master will return an internal IP CIDR only, if the client reaches the server using an internal IP.
  37. // Server looks at X-Forwarded-For header or X-Real-Ip header or request.RemoteAddr (in that order) to get the client IP.
  38. // +optional
  39. repeated ServerAddressByClientCIDR serverAddressByClientCIDRs = 4;
  40. }
  41. // APIGroupList is a list of APIGroup, to allow clients to discover the API at
  42. // /apis.
  43. message APIGroupList {
  44. // groups is a list of APIGroup.
  45. repeated APIGroup groups = 1;
  46. }
  47. // APIResource specifies the name of a resource and whether it is namespaced.
  48. message APIResource {
  49. // name is the plural name of the resource.
  50. optional string name = 1;
  51. // singularName is the singular name of the resource. This allows clients to handle plural and singular opaquely.
  52. // The singularName is more correct for reporting status on a single item and both singular and plural are allowed
  53. // from the kubectl CLI interface.
  54. optional string singularName = 6;
  55. // namespaced indicates if a resource is namespaced or not.
  56. optional bool namespaced = 2;
  57. // group is the preferred group of the resource. Empty implies the group of the containing resource list.
  58. // For subresources, this may have a different value, for example: Scale".
  59. optional string group = 8;
  60. // version is the preferred version of the resource. Empty implies the version of the containing resource list
  61. // For subresources, this may have a different value, for example: v1 (while inside a v1beta1 version of the core resource's group)".
  62. optional string version = 9;
  63. // kind is the kind for the resource (e.g. 'Foo' is the kind for a resource 'foo')
  64. optional string kind = 3;
  65. // verbs is a list of supported kube verbs (this includes get, list, watch, create,
  66. // update, patch, delete, deletecollection, and proxy)
  67. optional Verbs verbs = 4;
  68. // shortNames is a list of suggested short names of the resource.
  69. repeated string shortNames = 5;
  70. // categories is a list of the grouped resources this resource belongs to (e.g. 'all')
  71. repeated string categories = 7;
  72. }
  73. // APIResourceList is a list of APIResource, it is used to expose the name of the
  74. // resources supported in a specific group and version, and if the resource
  75. // is namespaced.
  76. message APIResourceList {
  77. // groupVersion is the group and version this APIResourceList is for.
  78. optional string groupVersion = 1;
  79. // resources contains the name of the resources and if they are namespaced.
  80. repeated APIResource resources = 2;
  81. }
  82. // APIVersions lists the versions that are available, to allow clients to
  83. // discover the API at /api, which is the root path of the legacy v1 API.
  84. //
  85. // +protobuf.options.(gogoproto.goproto_stringer)=false
  86. // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
  87. message APIVersions {
  88. // versions are the api versions that are available.
  89. repeated string versions = 1;
  90. // a map of client CIDR to server address that is serving this group.
  91. // This is to help clients reach servers in the most network-efficient way possible.
  92. // Clients can use the appropriate server address as per the CIDR that they match.
  93. // In case of multiple matches, clients should use the longest matching CIDR.
  94. // The server returns only those CIDRs that it thinks that the client can match.
  95. // For example: the master will return an internal IP CIDR only, if the client reaches the server using an internal IP.
  96. // Server looks at X-Forwarded-For header or X-Real-Ip header or request.RemoteAddr (in that order) to get the client IP.
  97. repeated ServerAddressByClientCIDR serverAddressByClientCIDRs = 2;
  98. }
  99. // CreateOptions may be provided when creating an API object.
  100. message CreateOptions {
  101. // When present, indicates that modifications should not be
  102. // persisted. An invalid or unrecognized dryRun directive will
  103. // result in an error response and no further processing of the
  104. // request. Valid values are:
  105. // - All: all dry run stages will be processed
  106. // +optional
  107. repeated string dryRun = 1;
  108. // If IncludeUninitialized is specified, the object may be
  109. // returned without completing initialization.
  110. optional bool includeUninitialized = 2;
  111. }
  112. // DeleteOptions may be provided when deleting an API object.
  113. message DeleteOptions {
  114. // The duration in seconds before the object should be deleted. Value must be non-negative integer.
  115. // The value zero indicates delete immediately. If this value is nil, the default grace period for the
  116. // specified type will be used.
  117. // Defaults to a per object value if not specified. zero means delete immediately.
  118. // +optional
  119. optional int64 gracePeriodSeconds = 1;
  120. // Must be fulfilled before a deletion is carried out. If not possible, a 409 Conflict status will be
  121. // returned.
  122. // +optional
  123. optional Preconditions preconditions = 2;
  124. // Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7.
  125. // Should the dependent objects be orphaned. If true/false, the "orphan"
  126. // finalizer will be added to/removed from the object's finalizers list.
  127. // Either this field or PropagationPolicy may be set, but not both.
  128. // +optional
  129. optional bool orphanDependents = 3;
  130. // Whether and how garbage collection will be performed.
  131. // Either this field or OrphanDependents may be set, but not both.
  132. // The default policy is decided by the existing finalizer set in the
  133. // metadata.finalizers and the resource-specific default policy.
  134. // Acceptable values are: 'Orphan' - orphan the dependents; 'Background' -
  135. // allow the garbage collector to delete the dependents in the background;
  136. // 'Foreground' - a cascading policy that deletes all dependents in the
  137. // foreground.
  138. // +optional
  139. optional string propagationPolicy = 4;
  140. // When present, indicates that modifications should not be
  141. // persisted. An invalid or unrecognized dryRun directive will
  142. // result in an error response and no further processing of the
  143. // request. Valid values are:
  144. // - All: all dry run stages will be processed
  145. // +optional
  146. repeated string dryRun = 5;
  147. }
  148. // Duration is a wrapper around time.Duration which supports correct
  149. // marshaling to YAML and JSON. In particular, it marshals into strings, which
  150. // can be used as map keys in json.
  151. message Duration {
  152. optional int64 duration = 1;
  153. }
  154. // ExportOptions is the query options to the standard REST get call.
  155. message ExportOptions {
  156. // Should this value be exported. Export strips fields that a user can not specify.
  157. optional bool export = 1;
  158. // Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
  159. optional bool exact = 2;
  160. }
  161. // GetOptions is the standard query options to the standard REST get call.
  162. message GetOptions {
  163. // When specified:
  164. // - if unset, then the result is returned from remote storage based on quorum-read flag;
  165. // - if it's 0, then we simply return what we currently have in cache, no guarantee;
  166. // - if set to non zero, then the result is at least as fresh as given rv.
  167. optional string resourceVersion = 1;
  168. // If true, partially initialized resources are included in the response.
  169. // +optional
  170. optional bool includeUninitialized = 2;
  171. }
  172. // GroupKind specifies a Group and a Kind, but does not force a version. This is useful for identifying
  173. // concepts during lookup stages without having partially valid types
  174. //
  175. // +protobuf.options.(gogoproto.goproto_stringer)=false
  176. message GroupKind {
  177. optional string group = 1;
  178. optional string kind = 2;
  179. }
  180. // GroupResource specifies a Group and a Resource, but does not force a version. This is useful for identifying
  181. // concepts during lookup stages without having partially valid types
  182. //
  183. // +protobuf.options.(gogoproto.goproto_stringer)=false
  184. message GroupResource {
  185. optional string group = 1;
  186. optional string resource = 2;
  187. }
  188. // GroupVersion contains the "group" and the "version", which uniquely identifies the API.
  189. //
  190. // +protobuf.options.(gogoproto.goproto_stringer)=false
  191. message GroupVersion {
  192. optional string group = 1;
  193. optional string version = 2;
  194. }
  195. // GroupVersion contains the "group/version" and "version" string of a version.
  196. // It is made a struct to keep extensibility.
  197. message GroupVersionForDiscovery {
  198. // groupVersion specifies the API group and version in the form "group/version"
  199. optional string groupVersion = 1;
  200. // version specifies the version in the form of "version". This is to save
  201. // the clients the trouble of splitting the GroupVersion.
  202. optional string version = 2;
  203. }
  204. // GroupVersionKind unambiguously identifies a kind. It doesn't anonymously include GroupVersion
  205. // to avoid automatic coersion. It doesn't use a GroupVersion to avoid custom marshalling
  206. //
  207. // +protobuf.options.(gogoproto.goproto_stringer)=false
  208. message GroupVersionKind {
  209. optional string group = 1;
  210. optional string version = 2;
  211. optional string kind = 3;
  212. }
  213. // GroupVersionResource unambiguously identifies a resource. It doesn't anonymously include GroupVersion
  214. // to avoid automatic coersion. It doesn't use a GroupVersion to avoid custom marshalling
  215. //
  216. // +protobuf.options.(gogoproto.goproto_stringer)=false
  217. message GroupVersionResource {
  218. optional string group = 1;
  219. optional string version = 2;
  220. optional string resource = 3;
  221. }
  222. // Initializer is information about an initializer that has not yet completed.
  223. message Initializer {
  224. // name of the process that is responsible for initializing this object.
  225. optional string name = 1;
  226. }
  227. // Initializers tracks the progress of initialization.
  228. message Initializers {
  229. // Pending is a list of initializers that must execute in order before this object is visible.
  230. // When the last pending initializer is removed, and no failing result is set, the initializers
  231. // struct will be set to nil and the object is considered as initialized and visible to all
  232. // clients.
  233. // +patchMergeKey=name
  234. // +patchStrategy=merge
  235. repeated Initializer pending = 1;
  236. // If result is set with the Failure field, the object will be persisted to storage and then deleted,
  237. // ensuring that other clients can observe the deletion.
  238. optional Status result = 2;
  239. }
  240. // A label selector is a label query over a set of resources. The result of matchLabels and
  241. // matchExpressions are ANDed. An empty label selector matches all objects. A null
  242. // label selector matches no objects.
  243. message LabelSelector {
  244. // matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels
  245. // map is equivalent to an element of matchExpressions, whose key field is "key", the
  246. // operator is "In", and the values array contains only "value". The requirements are ANDed.
  247. // +optional
  248. map<string, string> matchLabels = 1;
  249. // matchExpressions is a list of label selector requirements. The requirements are ANDed.
  250. // +optional
  251. repeated LabelSelectorRequirement matchExpressions = 2;
  252. }
  253. // A label selector requirement is a selector that contains values, a key, and an operator that
  254. // relates the key and values.
  255. message LabelSelectorRequirement {
  256. // key is the label key that the selector applies to.
  257. // +patchMergeKey=key
  258. // +patchStrategy=merge
  259. optional string key = 1;
  260. // operator represents a key's relationship to a set of values.
  261. // Valid operators are In, NotIn, Exists and DoesNotExist.
  262. optional string operator = 2;
  263. // values is an array of string values. If the operator is In or NotIn,
  264. // the values array must be non-empty. If the operator is Exists or DoesNotExist,
  265. // the values array must be empty. This array is replaced during a strategic
  266. // merge patch.
  267. // +optional
  268. repeated string values = 3;
  269. }
  270. // List holds a list of objects, which may not be known by the server.
  271. message List {
  272. // Standard list metadata.
  273. // More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
  274. // +optional
  275. optional ListMeta metadata = 1;
  276. // List of objects
  277. repeated k8s.io.apimachinery.pkg.runtime.RawExtension items = 2;
  278. }
  279. // ListMeta describes metadata that synthetic resources must have, including lists and
  280. // various status objects. A resource may have only one of {ObjectMeta, ListMeta}.
  281. message ListMeta {
  282. // selfLink is a URL representing this object.
  283. // Populated by the system.
  284. // Read-only.
  285. // +optional
  286. optional string selfLink = 1;
  287. // String that identifies the server's internal version of this object that
  288. // can be used by clients to determine when objects have changed.
  289. // Value must be treated as opaque by clients and passed unmodified back to the server.
  290. // Populated by the system.
  291. // Read-only.
  292. // More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency
  293. // +optional
  294. optional string resourceVersion = 2;
  295. // continue may be set if the user set a limit on the number of items returned, and indicates that
  296. // the server has more data available. The value is opaque and may be used to issue another request
  297. // to the endpoint that served this list to retrieve the next set of available objects. Continuing a
  298. // consistent list may not be possible if the server configuration has changed or more than a few
  299. // minutes have passed. The resourceVersion field returned when using this continue value will be
  300. // identical to the value in the first response, unless you have received this token from an error
  301. // message.
  302. optional string continue = 3;
  303. }
  304. // ListOptions is the query options to a standard REST list call.
  305. message ListOptions {
  306. // A selector to restrict the list of returned objects by their labels.
  307. // Defaults to everything.
  308. // +optional
  309. optional string labelSelector = 1;
  310. // A selector to restrict the list of returned objects by their fields.
  311. // Defaults to everything.
  312. // +optional
  313. optional string fieldSelector = 2;
  314. // If true, partially initialized resources are included in the response.
  315. // +optional
  316. optional bool includeUninitialized = 6;
  317. // Watch for changes to the described resources and return them as a stream of
  318. // add, update, and remove notifications. Specify resourceVersion.
  319. // +optional
  320. optional bool watch = 3;
  321. // When specified with a watch call, shows changes that occur after that particular version of a resource.
  322. // Defaults to changes from the beginning of history.
  323. // When specified for list:
  324. // - if unset, then the result is returned from remote storage based on quorum-read flag;
  325. // - if it's 0, then we simply return what we currently have in cache, no guarantee;
  326. // - if set to non zero, then the result is at least as fresh as given rv.
  327. // +optional
  328. optional string resourceVersion = 4;
  329. // Timeout for the list/watch call.
  330. // This limits the duration of the call, regardless of any activity or inactivity.
  331. // +optional
  332. optional int64 timeoutSeconds = 5;
  333. // limit is a maximum number of responses to return for a list call. If more items exist, the
  334. // server will set the `continue` field on the list metadata to a value that can be used with the
  335. // same initial query to retrieve the next set of results. Setting a limit may return fewer than
  336. // the requested amount of items (up to zero items) in the event all requested objects are
  337. // filtered out and clients should only use the presence of the continue field to determine whether
  338. // more results are available. Servers may choose not to support the limit argument and will return
  339. // all of the available results. If limit is specified and the continue field is empty, clients may
  340. // assume that no more results are available. This field is not supported if watch is true.
  341. //
  342. // The server guarantees that the objects returned when using continue will be identical to issuing
  343. // a single list call without a limit - that is, no objects created, modified, or deleted after the
  344. // first request is issued will be included in any subsequent continued requests. This is sometimes
  345. // referred to as a consistent snapshot, and ensures that a client that is using limit to receive
  346. // smaller chunks of a very large result can ensure they see all possible objects. If objects are
  347. // updated during a chunked list the version of the object that was present at the time the first list
  348. // result was calculated is returned.
  349. optional int64 limit = 7;
  350. // The continue option should be set when retrieving more results from the server. Since this value is
  351. // server defined, clients may only use the continue value from a previous query result with identical
  352. // query parameters (except for the value of continue) and the server may reject a continue value it
  353. // does not recognize. If the specified continue value is no longer valid whether due to expiration
  354. // (generally five to fifteen minutes) or a configuration change on the server, the server will
  355. // respond with a 410 ResourceExpired error together with a continue token. If the client needs a
  356. // consistent list, it must restart their list without the continue field. Otherwise, the client may
  357. // send another list request with the token received with the 410 error, the server will respond with
  358. // a list starting from the next key, but from the latest snapshot, which is inconsistent from the
  359. // previous list results - objects that are created, modified, or deleted after the first list request
  360. // will be included in the response, as long as their keys are after the "next key".
  361. //
  362. // This field is not supported when watch is true. Clients may start a watch from the last
  363. // resourceVersion value returned by the server and not miss any modifications.
  364. optional string continue = 8;
  365. }
  366. // MicroTime is version of Time with microsecond level precision.
  367. //
  368. // +protobuf.options.marshal=false
  369. // +protobuf.as=Timestamp
  370. // +protobuf.options.(gogoproto.goproto_stringer)=false
  371. message MicroTime {
  372. // Represents seconds of UTC time since Unix epoch
  373. // 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to
  374. // 9999-12-31T23:59:59Z inclusive.
  375. optional int64 seconds = 1;
  376. // Non-negative fractions of a second at nanosecond resolution. Negative
  377. // second values with fractions must still have non-negative nanos values
  378. // that count forward in time. Must be from 0 to 999,999,999
  379. // inclusive. This field may be limited in precision depending on context.
  380. optional int32 nanos = 2;
  381. }
  382. // ObjectMeta is metadata that all persisted resources must have, which includes all objects
  383. // users must create.
  384. message ObjectMeta {
  385. // Name must be unique within a namespace. Is required when creating resources, although
  386. // some resources may allow a client to request the generation of an appropriate name
  387. // automatically. Name is primarily intended for creation idempotence and configuration
  388. // definition.
  389. // Cannot be updated.
  390. // More info: http://kubernetes.io/docs/user-guide/identifiers#names
  391. // +optional
  392. optional string name = 1;
  393. // GenerateName is an optional prefix, used by the server, to generate a unique
  394. // name ONLY IF the Name field has not been provided.
  395. // If this field is used, the name returned to the client will be different
  396. // than the name passed. This value will also be combined with a unique suffix.
  397. // The provided value has the same validation rules as the Name field,
  398. // and may be truncated by the length of the suffix required to make the value
  399. // unique on the server.
  400. //
  401. // If this field is specified and the generated name exists, the server will
  402. // NOT return a 409 - instead, it will either return 201 Created or 500 with Reason
  403. // ServerTimeout indicating a unique name could not be found in the time allotted, and the client
  404. // should retry (optionally after the time indicated in the Retry-After header).
  405. //
  406. // Applied only if Name is not specified.
  407. // More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#idempotency
  408. // +optional
  409. optional string generateName = 2;
  410. // Namespace defines the space within each name must be unique. An empty namespace is
  411. // equivalent to the "default" namespace, but "default" is the canonical representation.
  412. // Not all objects are required to be scoped to a namespace - the value of this field for
  413. // those objects will be empty.
  414. //
  415. // Must be a DNS_LABEL.
  416. // Cannot be updated.
  417. // More info: http://kubernetes.io/docs/user-guide/namespaces
  418. // +optional
  419. optional string namespace = 3;
  420. // SelfLink is a URL representing this object.
  421. // Populated by the system.
  422. // Read-only.
  423. // +optional
  424. optional string selfLink = 4;
  425. // UID is the unique in time and space value for this object. It is typically generated by
  426. // the server on successful creation of a resource and is not allowed to change on PUT
  427. // operations.
  428. //
  429. // Populated by the system.
  430. // Read-only.
  431. // More info: http://kubernetes.io/docs/user-guide/identifiers#uids
  432. // +optional
  433. optional string uid = 5;
  434. // An opaque value that represents the internal version of this object that can
  435. // be used by clients to determine when objects have changed. May be used for optimistic
  436. // concurrency, change detection, and the watch operation on a resource or set of resources.
  437. // Clients must treat these values as opaque and passed unmodified back to the server.
  438. // They may only be valid for a particular resource or set of resources.
  439. //
  440. // Populated by the system.
  441. // Read-only.
  442. // Value must be treated as opaque by clients and .
  443. // More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency
  444. // +optional
  445. optional string resourceVersion = 6;
  446. // A sequence number representing a specific generation of the desired state.
  447. // Populated by the system. Read-only.
  448. // +optional
  449. optional int64 generation = 7;
  450. // CreationTimestamp is a timestamp representing the server time when this object was
  451. // created. It is not guaranteed to be set in happens-before order across separate operations.
  452. // Clients may not set this value. It is represented in RFC3339 form and is in UTC.
  453. //
  454. // Populated by the system.
  455. // Read-only.
  456. // Null for lists.
  457. // More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
  458. // +optional
  459. optional Time creationTimestamp = 8;
  460. // DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This
  461. // field is set by the server when a graceful deletion is requested by the user, and is not
  462. // directly settable by a client. The resource is expected to be deleted (no longer visible
  463. // from resource lists, and not reachable by name) after the time in this field, once the
  464. // finalizers list is empty. As long as the finalizers list contains items, deletion is blocked.
  465. // Once the deletionTimestamp is set, this value may not be unset or be set further into the
  466. // future, although it may be shortened or the resource may be deleted prior to this time.
  467. // For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react
  468. // by sending a graceful termination signal to the containers in the pod. After that 30 seconds,
  469. // the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup,
  470. // remove the pod from the API. In the presence of network partitions, this object may still
  471. // exist after this timestamp, until an administrator or automated process can determine the
  472. // resource is fully terminated.
  473. // If not set, graceful deletion of the object has not been requested.
  474. //
  475. // Populated by the system when a graceful deletion is requested.
  476. // Read-only.
  477. // More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
  478. // +optional
  479. optional Time deletionTimestamp = 9;
  480. // Number of seconds allowed for this object to gracefully terminate before
  481. // it will be removed from the system. Only set when deletionTimestamp is also set.
  482. // May only be shortened.
  483. // Read-only.
  484. // +optional
  485. optional int64 deletionGracePeriodSeconds = 10;
  486. // Map of string keys and values that can be used to organize and categorize
  487. // (scope and select) objects. May match selectors of replication controllers
  488. // and services.
  489. // More info: http://kubernetes.io/docs/user-guide/labels
  490. // +optional
  491. map<string, string> labels = 11;
  492. // Annotations is an unstructured key value map stored with a resource that may be
  493. // set by external tools to store and retrieve arbitrary metadata. They are not
  494. // queryable and should be preserved when modifying objects.
  495. // More info: http://kubernetes.io/docs/user-guide/annotations
  496. // +optional
  497. map<string, string> annotations = 12;
  498. // List of objects depended by this object. If ALL objects in the list have
  499. // been deleted, this object will be garbage collected. If this object is managed by a controller,
  500. // then an entry in this list will point to this controller, with the controller field set to true.
  501. // There cannot be more than one managing controller.
  502. // +optional
  503. // +patchMergeKey=uid
  504. // +patchStrategy=merge
  505. repeated OwnerReference ownerReferences = 13;
  506. // An initializer is a controller which enforces some system invariant at object creation time.
  507. // This field is a list of initializers that have not yet acted on this object. If nil or empty,
  508. // this object has been completely initialized. Otherwise, the object is considered uninitialized
  509. // and is hidden (in list/watch and get calls) from clients that haven't explicitly asked to
  510. // observe uninitialized objects.
  511. //
  512. // When an object is created, the system will populate this list with the current set of initializers.
  513. // Only privileged users may set or modify this list. Once it is empty, it may not be modified further
  514. // by any user.
  515. optional Initializers initializers = 16;
  516. // Must be empty before the object is deleted from the registry. Each entry
  517. // is an identifier for the responsible component that will remove the entry
  518. // from the list. If the deletionTimestamp of the object is non-nil, entries
  519. // in this list can only be removed.
  520. // +optional
  521. // +patchStrategy=merge
  522. repeated string finalizers = 14;
  523. // The name of the cluster which the object belongs to.
  524. // This is used to distinguish resources with same name and namespace in different clusters.
  525. // This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request.
  526. // +optional
  527. optional string clusterName = 15;
  528. }
  529. // OwnerReference contains enough information to let you identify an owning
  530. // object. An owning object must be in the same namespace as the dependent, or
  531. // be cluster-scoped, so there is no namespace field.
  532. message OwnerReference {
  533. // API version of the referent.
  534. optional string apiVersion = 5;
  535. // Kind of the referent.
  536. // More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
  537. optional string kind = 1;
  538. // Name of the referent.
  539. // More info: http://kubernetes.io/docs/user-guide/identifiers#names
  540. optional string name = 3;
  541. // UID of the referent.
  542. // More info: http://kubernetes.io/docs/user-guide/identifiers#uids
  543. optional string uid = 4;
  544. // If true, this reference points to the managing controller.
  545. // +optional
  546. optional bool controller = 6;
  547. // If true, AND if the owner has the "foregroundDeletion" finalizer, then
  548. // the owner cannot be deleted from the key-value store until this
  549. // reference is removed.
  550. // Defaults to false.
  551. // To set this field, a user needs "delete" permission of the owner,
  552. // otherwise 422 (Unprocessable Entity) will be returned.
  553. // +optional
  554. optional bool blockOwnerDeletion = 7;
  555. }
  556. // Patch is provided to give a concrete name and type to the Kubernetes PATCH request body.
  557. message Patch {
  558. }
  559. // Preconditions must be fulfilled before an operation (update, delete, etc.) is carried out.
  560. message Preconditions {
  561. // Specifies the target UID.
  562. // +optional
  563. optional string uid = 1;
  564. }
  565. // RootPaths lists the paths available at root.
  566. // For example: "/healthz", "/apis".
  567. message RootPaths {
  568. // paths are the paths available at root.
  569. repeated string paths = 1;
  570. }
  571. // ServerAddressByClientCIDR helps the client to determine the server address that they should use, depending on the clientCIDR that they match.
  572. message ServerAddressByClientCIDR {
  573. // The CIDR with which clients can match their IP to figure out the server address that they should use.
  574. optional string clientCIDR = 1;
  575. // Address of this server, suitable for a client that matches the above CIDR.
  576. // This can be a hostname, hostname:port, IP or IP:port.
  577. optional string serverAddress = 2;
  578. }
  579. // Status is a return value for calls that don't return other objects.
  580. message Status {
  581. // Standard list metadata.
  582. // More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
  583. // +optional
  584. optional ListMeta metadata = 1;
  585. // Status of the operation.
  586. // One of: "Success" or "Failure".
  587. // More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status
  588. // +optional
  589. optional string status = 2;
  590. // A human-readable description of the status of this operation.
  591. // +optional
  592. optional string message = 3;
  593. // A machine-readable description of why this operation is in the
  594. // "Failure" status. If this value is empty there
  595. // is no information available. A Reason clarifies an HTTP status
  596. // code but does not override it.
  597. // +optional
  598. optional string reason = 4;
  599. // Extended data associated with the reason. Each reason may define its
  600. // own extended details. This field is optional and the data returned
  601. // is not guaranteed to conform to any schema except that defined by
  602. // the reason type.
  603. // +optional
  604. optional StatusDetails details = 5;
  605. // Suggested HTTP return code for this status, 0 if not set.
  606. // +optional
  607. optional int32 code = 6;
  608. }
  609. // StatusCause provides more information about an api.Status failure, including
  610. // cases when multiple errors are encountered.
  611. message StatusCause {
  612. // A machine-readable description of the cause of the error. If this value is
  613. // empty there is no information available.
  614. // +optional
  615. optional string reason = 1;
  616. // A human-readable description of the cause of the error. This field may be
  617. // presented as-is to a reader.
  618. // +optional
  619. optional string message = 2;
  620. // The field of the resource that has caused this error, as named by its JSON
  621. // serialization. May include dot and postfix notation for nested attributes.
  622. // Arrays are zero-indexed. Fields may appear more than once in an array of
  623. // causes due to fields having multiple errors.
  624. // Optional.
  625. //
  626. // Examples:
  627. // "name" - the field "name" on the current resource
  628. // "items[0].name" - the field "name" on the first array entry in "items"
  629. // +optional
  630. optional string field = 3;
  631. }
  632. // StatusDetails is a set of additional properties that MAY be set by the
  633. // server to provide additional information about a response. The Reason
  634. // field of a Status object defines what attributes will be set. Clients
  635. // must ignore fields that do not match the defined type of each attribute,
  636. // and should assume that any attribute may be empty, invalid, or under
  637. // defined.
  638. message StatusDetails {
  639. // The name attribute of the resource associated with the status StatusReason
  640. // (when there is a single name which can be described).
  641. // +optional
  642. optional string name = 1;
  643. // The group attribute of the resource associated with the status StatusReason.
  644. // +optional
  645. optional string group = 2;
  646. // The kind attribute of the resource associated with the status StatusReason.
  647. // On some operations may differ from the requested resource Kind.
  648. // More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
  649. // +optional
  650. optional string kind = 3;
  651. // UID of the resource.
  652. // (when there is a single resource which can be described).
  653. // More info: http://kubernetes.io/docs/user-guide/identifiers#uids
  654. // +optional
  655. optional string uid = 6;
  656. // The Causes array includes more details associated with the StatusReason
  657. // failure. Not all StatusReasons may provide detailed causes.
  658. // +optional
  659. repeated StatusCause causes = 4;
  660. // If specified, the time in seconds before the operation should be retried. Some errors may indicate
  661. // the client must take an alternate action - for those errors this field may indicate how long to wait
  662. // before taking the alternate action.
  663. // +optional
  664. optional int32 retryAfterSeconds = 5;
  665. }
  666. // Time is a wrapper around time.Time which supports correct
  667. // marshaling to YAML and JSON. Wrappers are provided for many
  668. // of the factory methods that the time package offers.
  669. //
  670. // +protobuf.options.marshal=false
  671. // +protobuf.as=Timestamp
  672. // +protobuf.options.(gogoproto.goproto_stringer)=false
  673. message Time {
  674. // Represents seconds of UTC time since Unix epoch
  675. // 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to
  676. // 9999-12-31T23:59:59Z inclusive.
  677. optional int64 seconds = 1;
  678. // Non-negative fractions of a second at nanosecond resolution. Negative
  679. // second values with fractions must still have non-negative nanos values
  680. // that count forward in time. Must be from 0 to 999,999,999
  681. // inclusive. This field may be limited in precision depending on context.
  682. optional int32 nanos = 2;
  683. }
  684. // Timestamp is a struct that is equivalent to Time, but intended for
  685. // protobuf marshalling/unmarshalling. It is generated into a serialization
  686. // that matches Time. Do not use in Go structs.
  687. message Timestamp {
  688. // Represents seconds of UTC time since Unix epoch
  689. // 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to
  690. // 9999-12-31T23:59:59Z inclusive.
  691. optional int64 seconds = 1;
  692. // Non-negative fractions of a second at nanosecond resolution. Negative
  693. // second values with fractions must still have non-negative nanos values
  694. // that count forward in time. Must be from 0 to 999,999,999
  695. // inclusive. This field may be limited in precision depending on context.
  696. optional int32 nanos = 2;
  697. }
  698. // TypeMeta describes an individual object in an API response or request
  699. // with strings representing the type of the object and its API schema version.
  700. // Structures that are versioned or persisted should inline TypeMeta.
  701. //
  702. // +k8s:deepcopy-gen=false
  703. message TypeMeta {
  704. // Kind is a string value representing the REST resource this object represents.
  705. // Servers may infer this from the endpoint the client submits requests to.
  706. // Cannot be updated.
  707. // In CamelCase.
  708. // More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
  709. // +optional
  710. optional string kind = 1;
  711. // APIVersion defines the versioned schema of this representation of an object.
  712. // Servers should convert recognized schemas to the latest internal value, and
  713. // may reject unrecognized values.
  714. // More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
  715. // +optional
  716. optional string apiVersion = 2;
  717. }
  718. // UpdateOptions may be provided when updating an API object.
  719. message UpdateOptions {
  720. // When present, indicates that modifications should not be
  721. // persisted. An invalid or unrecognized dryRun directive will
  722. // result in an error response and no further processing of the
  723. // request. Valid values are:
  724. // - All: all dry run stages will be processed
  725. // +optional
  726. repeated string dryRun = 1;
  727. }
  728. // Verbs masks the value so protobuf can generate
  729. //
  730. // +protobuf.nullable=true
  731. // +protobuf.options.(gogoproto.goproto_stringer)=false
  732. message Verbs {
  733. // items, if empty, will result in an empty slice
  734. repeated string items = 1;
  735. }
  736. // Event represents a single event to a watched resource.
  737. //
  738. // +protobuf=true
  739. // +k8s:deepcopy-gen=true
  740. // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
  741. message WatchEvent {
  742. optional string type = 1;
  743. // Object is:
  744. // * If Type is Added or Modified: the new state of the object.
  745. // * If Type is Deleted: the state of the object immediately before deletion.
  746. // * If Type is Error: *Status is recommended; other types may make sense
  747. // depending on context.
  748. optional k8s.io.apimachinery.pkg.runtime.RawExtension object = 2;
  749. }