generated.proto 32 KB

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