generated.proto 31 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752
  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.api.apps.v1beta2;
  16. import "k8s.io/api/core/v1/generated.proto";
  17. import "k8s.io/apimachinery/pkg/apis/meta/v1/generated.proto";
  18. import "k8s.io/apimachinery/pkg/runtime/generated.proto";
  19. import "k8s.io/apimachinery/pkg/runtime/schema/generated.proto";
  20. import "k8s.io/apimachinery/pkg/util/intstr/generated.proto";
  21. // Package-wide variables from generator "generated".
  22. option go_package = "v1beta2";
  23. // DEPRECATED - This group version of ControllerRevision is deprecated by apps/v1/ControllerRevision. See the
  24. // release notes for more information.
  25. // ControllerRevision implements an immutable snapshot of state data. Clients
  26. // are responsible for serializing and deserializing the objects that contain
  27. // their internal state.
  28. // Once a ControllerRevision has been successfully created, it can not be updated.
  29. // The API Server will fail validation of all requests that attempt to mutate
  30. // the Data field. ControllerRevisions may, however, be deleted. Note that, due to its use by both
  31. // the DaemonSet and StatefulSet controllers for update and rollback, this object is beta. However,
  32. // it may be subject to name and representation changes in future releases, and clients should not
  33. // depend on its stability. It is primarily for internal use by controllers.
  34. message ControllerRevision {
  35. // Standard object's metadata.
  36. // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
  37. // +optional
  38. optional k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1;
  39. // Data is the serialized representation of the state.
  40. optional k8s.io.apimachinery.pkg.runtime.RawExtension data = 2;
  41. // Revision indicates the revision of the state represented by Data.
  42. optional int64 revision = 3;
  43. }
  44. // ControllerRevisionList is a resource containing a list of ControllerRevision objects.
  45. message ControllerRevisionList {
  46. // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
  47. // +optional
  48. optional k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1;
  49. // Items is the list of ControllerRevisions
  50. repeated ControllerRevision items = 2;
  51. }
  52. // DEPRECATED - This group version of DaemonSet is deprecated by apps/v1/DaemonSet. See the release notes for
  53. // more information.
  54. // DaemonSet represents the configuration of a daemon set.
  55. message DaemonSet {
  56. // Standard object's metadata.
  57. // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
  58. // +optional
  59. optional k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1;
  60. // The desired behavior of this daemon set.
  61. // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
  62. // +optional
  63. optional DaemonSetSpec spec = 2;
  64. // The current status of this daemon set. This data may be
  65. // out of date by some window of time.
  66. // Populated by the system.
  67. // Read-only.
  68. // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
  69. // +optional
  70. optional DaemonSetStatus status = 3;
  71. }
  72. // DaemonSetCondition describes the state of a DaemonSet at a certain point.
  73. message DaemonSetCondition {
  74. // Type of DaemonSet condition.
  75. optional string type = 1;
  76. // Status of the condition, one of True, False, Unknown.
  77. optional string status = 2;
  78. // Last time the condition transitioned from one status to another.
  79. // +optional
  80. optional k8s.io.apimachinery.pkg.apis.meta.v1.Time lastTransitionTime = 3;
  81. // The reason for the condition's last transition.
  82. // +optional
  83. optional string reason = 4;
  84. // A human readable message indicating details about the transition.
  85. // +optional
  86. optional string message = 5;
  87. }
  88. // DaemonSetList is a collection of daemon sets.
  89. message DaemonSetList {
  90. // Standard list metadata.
  91. // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
  92. // +optional
  93. optional k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1;
  94. // A list of daemon sets.
  95. repeated DaemonSet items = 2;
  96. }
  97. // DaemonSetSpec is the specification of a daemon set.
  98. message DaemonSetSpec {
  99. // A label query over pods that are managed by the daemon set.
  100. // Must match in order to be controlled.
  101. // It must match the pod template's labels.
  102. // More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors
  103. optional k8s.io.apimachinery.pkg.apis.meta.v1.LabelSelector selector = 1;
  104. // An object that describes the pod that will be created.
  105. // The DaemonSet will create exactly one copy of this pod on every node
  106. // that matches the template's node selector (or on every node if no node
  107. // selector is specified).
  108. // More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller#pod-template
  109. optional k8s.io.api.core.v1.PodTemplateSpec template = 2;
  110. // An update strategy to replace existing DaemonSet pods with new pods.
  111. // +optional
  112. optional DaemonSetUpdateStrategy updateStrategy = 3;
  113. // The minimum number of seconds for which a newly created DaemonSet pod should
  114. // be ready without any of its container crashing, for it to be considered
  115. // available. Defaults to 0 (pod will be considered available as soon as it
  116. // is ready).
  117. // +optional
  118. optional int32 minReadySeconds = 4;
  119. // The number of old history to retain to allow rollback.
  120. // This is a pointer to distinguish between explicit zero and not specified.
  121. // Defaults to 10.
  122. // +optional
  123. optional int32 revisionHistoryLimit = 6;
  124. }
  125. // DaemonSetStatus represents the current status of a daemon set.
  126. message DaemonSetStatus {
  127. // The number of nodes that are running at least 1
  128. // daemon pod and are supposed to run the daemon pod.
  129. // More info: https://kubernetes.io/docs/concepts/workloads/controllers/daemonset/
  130. optional int32 currentNumberScheduled = 1;
  131. // The number of nodes that are running the daemon pod, but are
  132. // not supposed to run the daemon pod.
  133. // More info: https://kubernetes.io/docs/concepts/workloads/controllers/daemonset/
  134. optional int32 numberMisscheduled = 2;
  135. // The total number of nodes that should be running the daemon
  136. // pod (including nodes correctly running the daemon pod).
  137. // More info: https://kubernetes.io/docs/concepts/workloads/controllers/daemonset/
  138. optional int32 desiredNumberScheduled = 3;
  139. // The number of nodes that should be running the daemon pod and have one
  140. // or more of the daemon pod running and ready.
  141. optional int32 numberReady = 4;
  142. // The most recent generation observed by the daemon set controller.
  143. // +optional
  144. optional int64 observedGeneration = 5;
  145. // The total number of nodes that are running updated daemon pod
  146. // +optional
  147. optional int32 updatedNumberScheduled = 6;
  148. // The number of nodes that should be running the
  149. // daemon pod and have one or more of the daemon pod running and
  150. // available (ready for at least spec.minReadySeconds)
  151. // +optional
  152. optional int32 numberAvailable = 7;
  153. // The number of nodes that should be running the
  154. // daemon pod and have none of the daemon pod running and available
  155. // (ready for at least spec.minReadySeconds)
  156. // +optional
  157. optional int32 numberUnavailable = 8;
  158. // Count of hash collisions for the DaemonSet. The DaemonSet controller
  159. // uses this field as a collision avoidance mechanism when it needs to
  160. // create the name for the newest ControllerRevision.
  161. // +optional
  162. optional int32 collisionCount = 9;
  163. // Represents the latest available observations of a DaemonSet's current state.
  164. // +optional
  165. // +patchMergeKey=type
  166. // +patchStrategy=merge
  167. repeated DaemonSetCondition conditions = 10;
  168. }
  169. // DaemonSetUpdateStrategy is a struct used to control the update strategy for a DaemonSet.
  170. message DaemonSetUpdateStrategy {
  171. // Type of daemon set update. Can be "RollingUpdate" or "OnDelete". Default is RollingUpdate.
  172. // +optional
  173. optional string type = 1;
  174. // Rolling update config params. Present only if type = "RollingUpdate".
  175. // ---
  176. // TODO: Update this to follow our convention for oneOf, whatever we decide it
  177. // to be. Same as Deployment `strategy.rollingUpdate`.
  178. // See https://github.com/kubernetes/kubernetes/issues/35345
  179. // +optional
  180. optional RollingUpdateDaemonSet rollingUpdate = 2;
  181. }
  182. // DEPRECATED - This group version of Deployment is deprecated by apps/v1/Deployment. See the release notes for
  183. // more information.
  184. // Deployment enables declarative updates for Pods and ReplicaSets.
  185. message Deployment {
  186. // Standard object metadata.
  187. // +optional
  188. optional k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1;
  189. // Specification of the desired behavior of the Deployment.
  190. // +optional
  191. optional DeploymentSpec spec = 2;
  192. // Most recently observed status of the Deployment.
  193. // +optional
  194. optional DeploymentStatus status = 3;
  195. }
  196. // DeploymentCondition describes the state of a deployment at a certain point.
  197. message DeploymentCondition {
  198. // Type of deployment condition.
  199. optional string type = 1;
  200. // Status of the condition, one of True, False, Unknown.
  201. optional string status = 2;
  202. // The last time this condition was updated.
  203. optional k8s.io.apimachinery.pkg.apis.meta.v1.Time lastUpdateTime = 6;
  204. // Last time the condition transitioned from one status to another.
  205. optional k8s.io.apimachinery.pkg.apis.meta.v1.Time lastTransitionTime = 7;
  206. // The reason for the condition's last transition.
  207. optional string reason = 4;
  208. // A human readable message indicating details about the transition.
  209. optional string message = 5;
  210. }
  211. // DeploymentList is a list of Deployments.
  212. message DeploymentList {
  213. // Standard list metadata.
  214. // +optional
  215. optional k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1;
  216. // Items is the list of Deployments.
  217. repeated Deployment items = 2;
  218. }
  219. // DeploymentSpec is the specification of the desired behavior of the Deployment.
  220. message DeploymentSpec {
  221. // Number of desired pods. This is a pointer to distinguish between explicit
  222. // zero and not specified. Defaults to 1.
  223. // +optional
  224. optional int32 replicas = 1;
  225. // Label selector for pods. Existing ReplicaSets whose pods are
  226. // selected by this will be the ones affected by this deployment.
  227. // It must match the pod template's labels.
  228. optional k8s.io.apimachinery.pkg.apis.meta.v1.LabelSelector selector = 2;
  229. // Template describes the pods that will be created.
  230. optional k8s.io.api.core.v1.PodTemplateSpec template = 3;
  231. // The deployment strategy to use to replace existing pods with new ones.
  232. // +optional
  233. // +patchStrategy=retainKeys
  234. optional DeploymentStrategy strategy = 4;
  235. // Minimum number of seconds for which a newly created pod should be ready
  236. // without any of its container crashing, for it to be considered available.
  237. // Defaults to 0 (pod will be considered available as soon as it is ready)
  238. // +optional
  239. optional int32 minReadySeconds = 5;
  240. // The number of old ReplicaSets to retain to allow rollback.
  241. // This is a pointer to distinguish between explicit zero and not specified.
  242. // Defaults to 10.
  243. // +optional
  244. optional int32 revisionHistoryLimit = 6;
  245. // Indicates that the deployment is paused.
  246. // +optional
  247. optional bool paused = 7;
  248. // The maximum time in seconds for a deployment to make progress before it
  249. // is considered to be failed. The deployment controller will continue to
  250. // process failed deployments and a condition with a ProgressDeadlineExceeded
  251. // reason will be surfaced in the deployment status. Note that progress will
  252. // not be estimated during the time a deployment is paused. Defaults to 600s.
  253. optional int32 progressDeadlineSeconds = 9;
  254. }
  255. // DeploymentStatus is the most recently observed status of the Deployment.
  256. message DeploymentStatus {
  257. // The generation observed by the deployment controller.
  258. // +optional
  259. optional int64 observedGeneration = 1;
  260. // Total number of non-terminated pods targeted by this deployment (their labels match the selector).
  261. // +optional
  262. optional int32 replicas = 2;
  263. // Total number of non-terminated pods targeted by this deployment that have the desired template spec.
  264. // +optional
  265. optional int32 updatedReplicas = 3;
  266. // Total number of ready pods targeted by this deployment.
  267. // +optional
  268. optional int32 readyReplicas = 7;
  269. // Total number of available pods (ready for at least minReadySeconds) targeted by this deployment.
  270. // +optional
  271. optional int32 availableReplicas = 4;
  272. // Total number of unavailable pods targeted by this deployment. This is the total number of
  273. // pods that are still required for the deployment to have 100% available capacity. They may
  274. // either be pods that are running but not yet available or pods that still have not been created.
  275. // +optional
  276. optional int32 unavailableReplicas = 5;
  277. // Represents the latest available observations of a deployment's current state.
  278. // +patchMergeKey=type
  279. // +patchStrategy=merge
  280. repeated DeploymentCondition conditions = 6;
  281. // Count of hash collisions for the Deployment. The Deployment controller uses this
  282. // field as a collision avoidance mechanism when it needs to create the name for the
  283. // newest ReplicaSet.
  284. // +optional
  285. optional int32 collisionCount = 8;
  286. }
  287. // DeploymentStrategy describes how to replace existing pods with new ones.
  288. message DeploymentStrategy {
  289. // Type of deployment. Can be "Recreate" or "RollingUpdate". Default is RollingUpdate.
  290. // +optional
  291. optional string type = 1;
  292. // Rolling update config params. Present only if DeploymentStrategyType =
  293. // RollingUpdate.
  294. // ---
  295. // TODO: Update this to follow our convention for oneOf, whatever we decide it
  296. // to be.
  297. // +optional
  298. optional RollingUpdateDeployment rollingUpdate = 2;
  299. }
  300. // DEPRECATED - This group version of ReplicaSet is deprecated by apps/v1/ReplicaSet. See the release notes for
  301. // more information.
  302. // ReplicaSet ensures that a specified number of pod replicas are running at any given time.
  303. message ReplicaSet {
  304. // If the Labels of a ReplicaSet are empty, they are defaulted to
  305. // be the same as the Pod(s) that the ReplicaSet manages.
  306. // Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
  307. // +optional
  308. optional k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1;
  309. // Spec defines the specification of the desired behavior of the ReplicaSet.
  310. // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
  311. // +optional
  312. optional ReplicaSetSpec spec = 2;
  313. // Status is the most recently observed status of the ReplicaSet.
  314. // This data may be out of date by some window of time.
  315. // Populated by the system.
  316. // Read-only.
  317. // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
  318. // +optional
  319. optional ReplicaSetStatus status = 3;
  320. }
  321. // ReplicaSetCondition describes the state of a replica set at a certain point.
  322. message ReplicaSetCondition {
  323. // Type of replica set condition.
  324. optional string type = 1;
  325. // Status of the condition, one of True, False, Unknown.
  326. optional string status = 2;
  327. // The last time the condition transitioned from one status to another.
  328. // +optional
  329. optional k8s.io.apimachinery.pkg.apis.meta.v1.Time lastTransitionTime = 3;
  330. // The reason for the condition's last transition.
  331. // +optional
  332. optional string reason = 4;
  333. // A human readable message indicating details about the transition.
  334. // +optional
  335. optional string message = 5;
  336. }
  337. // ReplicaSetList is a collection of ReplicaSets.
  338. message ReplicaSetList {
  339. // Standard list metadata.
  340. // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
  341. // +optional
  342. optional k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1;
  343. // List of ReplicaSets.
  344. // More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller
  345. repeated ReplicaSet items = 2;
  346. }
  347. // ReplicaSetSpec is the specification of a ReplicaSet.
  348. message ReplicaSetSpec {
  349. // Replicas is the number of desired replicas.
  350. // This is a pointer to distinguish between explicit zero and unspecified.
  351. // Defaults to 1.
  352. // More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller/#what-is-a-replicationcontroller
  353. // +optional
  354. optional int32 replicas = 1;
  355. // Minimum number of seconds for which a newly created pod should be ready
  356. // without any of its container crashing, for it to be considered available.
  357. // Defaults to 0 (pod will be considered available as soon as it is ready)
  358. // +optional
  359. optional int32 minReadySeconds = 4;
  360. // Selector is a label query over pods that should match the replica count.
  361. // Label keys and values that must match in order to be controlled by this replica set.
  362. // It must match the pod template's labels.
  363. // More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors
  364. optional k8s.io.apimachinery.pkg.apis.meta.v1.LabelSelector selector = 2;
  365. // Template is the object that describes the pod that will be created if
  366. // insufficient replicas are detected.
  367. // More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller#pod-template
  368. // +optional
  369. optional k8s.io.api.core.v1.PodTemplateSpec template = 3;
  370. }
  371. // ReplicaSetStatus represents the current status of a ReplicaSet.
  372. message ReplicaSetStatus {
  373. // Replicas is the most recently oberved number of replicas.
  374. // More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller/#what-is-a-replicationcontroller
  375. optional int32 replicas = 1;
  376. // The number of pods that have labels matching the labels of the pod template of the replicaset.
  377. // +optional
  378. optional int32 fullyLabeledReplicas = 2;
  379. // The number of ready replicas for this replica set.
  380. // +optional
  381. optional int32 readyReplicas = 4;
  382. // The number of available replicas (ready for at least minReadySeconds) for this replica set.
  383. // +optional
  384. optional int32 availableReplicas = 5;
  385. // ObservedGeneration reflects the generation of the most recently observed ReplicaSet.
  386. // +optional
  387. optional int64 observedGeneration = 3;
  388. // Represents the latest available observations of a replica set's current state.
  389. // +optional
  390. // +patchMergeKey=type
  391. // +patchStrategy=merge
  392. repeated ReplicaSetCondition conditions = 6;
  393. }
  394. // Spec to control the desired behavior of daemon set rolling update.
  395. message RollingUpdateDaemonSet {
  396. // The maximum number of DaemonSet pods that can be unavailable during the
  397. // update. Value can be an absolute number (ex: 5) or a percentage of total
  398. // number of DaemonSet pods at the start of the update (ex: 10%). Absolute
  399. // number is calculated from percentage by rounding up.
  400. // This cannot be 0.
  401. // Default value is 1.
  402. // Example: when this is set to 30%, at most 30% of the total number of nodes
  403. // that should be running the daemon pod (i.e. status.desiredNumberScheduled)
  404. // can have their pods stopped for an update at any given
  405. // time. The update starts by stopping at most 30% of those DaemonSet pods
  406. // and then brings up new DaemonSet pods in their place. Once the new pods
  407. // are available, it then proceeds onto other DaemonSet pods, thus ensuring
  408. // that at least 70% of original number of DaemonSet pods are available at
  409. // all times during the update.
  410. // +optional
  411. optional k8s.io.apimachinery.pkg.util.intstr.IntOrString maxUnavailable = 1;
  412. }
  413. // Spec to control the desired behavior of rolling update.
  414. message RollingUpdateDeployment {
  415. // The maximum number of pods that can be unavailable during the update.
  416. // Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%).
  417. // Absolute number is calculated from percentage by rounding down.
  418. // This can not be 0 if MaxSurge is 0.
  419. // Defaults to 25%.
  420. // Example: when this is set to 30%, the old ReplicaSet can be scaled down to 70% of desired pods
  421. // immediately when the rolling update starts. Once new pods are ready, old ReplicaSet
  422. // can be scaled down further, followed by scaling up the new ReplicaSet, ensuring
  423. // that the total number of pods available at all times during the update is at
  424. // least 70% of desired pods.
  425. // +optional
  426. optional k8s.io.apimachinery.pkg.util.intstr.IntOrString maxUnavailable = 1;
  427. // The maximum number of pods that can be scheduled above the desired number of
  428. // pods.
  429. // Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%).
  430. // This can not be 0 if MaxUnavailable is 0.
  431. // Absolute number is calculated from percentage by rounding up.
  432. // Defaults to 25%.
  433. // Example: when this is set to 30%, the new ReplicaSet can be scaled up immediately when
  434. // the rolling update starts, such that the total number of old and new pods do not exceed
  435. // 130% of desired pods. Once old pods have been killed,
  436. // new ReplicaSet can be scaled up further, ensuring that total number of pods running
  437. // at any time during the update is at most 130% of desired pods.
  438. // +optional
  439. optional k8s.io.apimachinery.pkg.util.intstr.IntOrString maxSurge = 2;
  440. }
  441. // RollingUpdateStatefulSetStrategy is used to communicate parameter for RollingUpdateStatefulSetStrategyType.
  442. message RollingUpdateStatefulSetStrategy {
  443. // Partition indicates the ordinal at which the StatefulSet should be
  444. // partitioned.
  445. // Default value is 0.
  446. // +optional
  447. optional int32 partition = 1;
  448. }
  449. // Scale represents a scaling request for a resource.
  450. message Scale {
  451. // Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata.
  452. // +optional
  453. optional k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1;
  454. // defines the behavior of the scale. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status.
  455. // +optional
  456. optional ScaleSpec spec = 2;
  457. // current status of the scale. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status. Read-only.
  458. // +optional
  459. optional ScaleStatus status = 3;
  460. }
  461. // ScaleSpec describes the attributes of a scale subresource
  462. message ScaleSpec {
  463. // desired number of instances for the scaled object.
  464. // +optional
  465. optional int32 replicas = 1;
  466. }
  467. // ScaleStatus represents the current status of a scale subresource.
  468. message ScaleStatus {
  469. // actual number of observed instances of the scaled object.
  470. optional int32 replicas = 1;
  471. // label query over pods that should match the replicas count. More info: http://kubernetes.io/docs/user-guide/labels#label-selectors
  472. // +optional
  473. map<string, string> selector = 2;
  474. // label selector for pods that should match the replicas count. This is a serializated
  475. // version of both map-based and more expressive set-based selectors. This is done to
  476. // avoid introspection in the clients. The string will be in the same format as the
  477. // query-param syntax. If the target type only supports map-based selectors, both this
  478. // field and map-based selector field are populated.
  479. // More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors
  480. // +optional
  481. optional string targetSelector = 3;
  482. }
  483. // DEPRECATED - This group version of StatefulSet is deprecated by apps/v1/StatefulSet. See the release notes for
  484. // more information.
  485. // StatefulSet represents a set of pods with consistent identities.
  486. // Identities are defined as:
  487. // - Network: A single stable DNS and hostname.
  488. // - Storage: As many VolumeClaims as requested.
  489. // The StatefulSet guarantees that a given network identity will always
  490. // map to the same storage identity.
  491. message StatefulSet {
  492. // +optional
  493. optional k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1;
  494. // Spec defines the desired identities of pods in this set.
  495. // +optional
  496. optional StatefulSetSpec spec = 2;
  497. // Status is the current status of Pods in this StatefulSet. This data
  498. // may be out of date by some window of time.
  499. // +optional
  500. optional StatefulSetStatus status = 3;
  501. }
  502. // StatefulSetCondition describes the state of a statefulset at a certain point.
  503. message StatefulSetCondition {
  504. // Type of statefulset condition.
  505. optional string type = 1;
  506. // Status of the condition, one of True, False, Unknown.
  507. optional string status = 2;
  508. // Last time the condition transitioned from one status to another.
  509. // +optional
  510. optional k8s.io.apimachinery.pkg.apis.meta.v1.Time lastTransitionTime = 3;
  511. // The reason for the condition's last transition.
  512. // +optional
  513. optional string reason = 4;
  514. // A human readable message indicating details about the transition.
  515. // +optional
  516. optional string message = 5;
  517. }
  518. // StatefulSetList is a collection of StatefulSets.
  519. message StatefulSetList {
  520. // +optional
  521. optional k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1;
  522. repeated StatefulSet items = 2;
  523. }
  524. // A StatefulSetSpec is the specification of a StatefulSet.
  525. message StatefulSetSpec {
  526. // replicas is the desired number of replicas of the given Template.
  527. // These are replicas in the sense that they are instantiations of the
  528. // same Template, but individual replicas also have a consistent identity.
  529. // If unspecified, defaults to 1.
  530. // TODO: Consider a rename of this field.
  531. // +optional
  532. optional int32 replicas = 1;
  533. // selector is a label query over pods that should match the replica count.
  534. // It must match the pod template's labels.
  535. // More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors
  536. optional k8s.io.apimachinery.pkg.apis.meta.v1.LabelSelector selector = 2;
  537. // template is the object that describes the pod that will be created if
  538. // insufficient replicas are detected. Each pod stamped out by the StatefulSet
  539. // will fulfill this Template, but have a unique identity from the rest
  540. // of the StatefulSet.
  541. optional k8s.io.api.core.v1.PodTemplateSpec template = 3;
  542. // volumeClaimTemplates is a list of claims that pods are allowed to reference.
  543. // The StatefulSet controller is responsible for mapping network identities to
  544. // claims in a way that maintains the identity of a pod. Every claim in
  545. // this list must have at least one matching (by name) volumeMount in one
  546. // container in the template. A claim in this list takes precedence over
  547. // any volumes in the template, with the same name.
  548. // TODO: Define the behavior if a claim already exists with the same name.
  549. // +optional
  550. repeated k8s.io.api.core.v1.PersistentVolumeClaim volumeClaimTemplates = 4;
  551. // serviceName is the name of the service that governs this StatefulSet.
  552. // This service must exist before the StatefulSet, and is responsible for
  553. // the network identity of the set. Pods get DNS/hostnames that follow the
  554. // pattern: pod-specific-string.serviceName.default.svc.cluster.local
  555. // where "pod-specific-string" is managed by the StatefulSet controller.
  556. optional string serviceName = 5;
  557. // podManagementPolicy controls how pods are created during initial scale up,
  558. // when replacing pods on nodes, or when scaling down. The default policy is
  559. // `OrderedReady`, where pods are created in increasing order (pod-0, then
  560. // pod-1, etc) and the controller will wait until each pod is ready before
  561. // continuing. When scaling down, the pods are removed in the opposite order.
  562. // The alternative policy is `Parallel` which will create pods in parallel
  563. // to match the desired scale without waiting, and on scale down will delete
  564. // all pods at once.
  565. // +optional
  566. optional string podManagementPolicy = 6;
  567. // updateStrategy indicates the StatefulSetUpdateStrategy that will be
  568. // employed to update Pods in the StatefulSet when a revision is made to
  569. // Template.
  570. optional StatefulSetUpdateStrategy updateStrategy = 7;
  571. // revisionHistoryLimit is the maximum number of revisions that will
  572. // be maintained in the StatefulSet's revision history. The revision history
  573. // consists of all revisions not represented by a currently applied
  574. // StatefulSetSpec version. The default value is 10.
  575. optional int32 revisionHistoryLimit = 8;
  576. }
  577. // StatefulSetStatus represents the current state of a StatefulSet.
  578. message StatefulSetStatus {
  579. // observedGeneration is the most recent generation observed for this StatefulSet. It corresponds to the
  580. // StatefulSet's generation, which is updated on mutation by the API Server.
  581. // +optional
  582. optional int64 observedGeneration = 1;
  583. // replicas is the number of Pods created by the StatefulSet controller.
  584. optional int32 replicas = 2;
  585. // readyReplicas is the number of Pods created by the StatefulSet controller that have a Ready Condition.
  586. optional int32 readyReplicas = 3;
  587. // currentReplicas is the number of Pods created by the StatefulSet controller from the StatefulSet version
  588. // indicated by currentRevision.
  589. optional int32 currentReplicas = 4;
  590. // updatedReplicas is the number of Pods created by the StatefulSet controller from the StatefulSet version
  591. // indicated by updateRevision.
  592. optional int32 updatedReplicas = 5;
  593. // currentRevision, if not empty, indicates the version of the StatefulSet used to generate Pods in the
  594. // sequence [0,currentReplicas).
  595. optional string currentRevision = 6;
  596. // updateRevision, if not empty, indicates the version of the StatefulSet used to generate Pods in the sequence
  597. // [replicas-updatedReplicas,replicas)
  598. optional string updateRevision = 7;
  599. // collisionCount is the count of hash collisions for the StatefulSet. The StatefulSet controller
  600. // uses this field as a collision avoidance mechanism when it needs to create the name for the
  601. // newest ControllerRevision.
  602. // +optional
  603. optional int32 collisionCount = 9;
  604. // Represents the latest available observations of a statefulset's current state.
  605. // +optional
  606. // +patchMergeKey=type
  607. // +patchStrategy=merge
  608. repeated StatefulSetCondition conditions = 10;
  609. }
  610. // StatefulSetUpdateStrategy indicates the strategy that the StatefulSet
  611. // controller will use to perform updates. It includes any additional parameters
  612. // necessary to perform the update for the indicated strategy.
  613. message StatefulSetUpdateStrategy {
  614. // Type indicates the type of the StatefulSetUpdateStrategy.
  615. // Default is RollingUpdate.
  616. // +optional
  617. optional string type = 1;
  618. // RollingUpdate is used to communicate parameters when Type is RollingUpdateStatefulSetStrategyType.
  619. // +optional
  620. optional RollingUpdateStatefulSetStrategy rollingUpdate = 2;
  621. }