1/*
2Copyright The Kubernetes Authors.
3
4Licensed under the Apache License, Version 2.0 (the "License");
5you may not use this file except in compliance with the License.
6You may obtain a copy of the License at
7
8 http://www.apache.org/licenses/LICENSE-2.0
9
10Unless required by applicable law or agreed to in writing, software
11distributed under the License is distributed on an "AS IS" BASIS,
12WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13See the License for the specific language governing permissions and
14limitations under the License.
15*/
16
17
18// This file was autogenerated by go-to-protobuf. Do not edit it manually!
19
20syntax = "proto2";
21
22package k8s.io.api.apps.v1beta1;
23
24import "k8s.io/api/core/v1/generated.proto";
25import "k8s.io/apimachinery/pkg/apis/meta/v1/generated.proto";
26import "k8s.io/apimachinery/pkg/runtime/generated.proto";
27import "k8s.io/apimachinery/pkg/runtime/schema/generated.proto";
28import "k8s.io/apimachinery/pkg/util/intstr/generated.proto";
29
30// Package-wide variables from generator "generated".
31option go_package = "k8s.io/api/apps/v1beta1";
32
33// DEPRECATED - This group version of ControllerRevision is deprecated by apps/v1beta2/ControllerRevision. See the
34// release notes for more information.
35// ControllerRevision implements an immutable snapshot of state data. Clients
36// are responsible for serializing and deserializing the objects that contain
37// their internal state.
38// Once a ControllerRevision has been successfully created, it can not be updated.
39// The API Server will fail validation of all requests that attempt to mutate
40// the Data field. ControllerRevisions may, however, be deleted. Note that, due to its use by both
41// the DaemonSet and StatefulSet controllers for update and rollback, this object is beta. However,
42// it may be subject to name and representation changes in future releases, and clients should not
43// depend on its stability. It is primarily for internal use by controllers.
44message ControllerRevision {
45 // Standard object's metadata.
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.ObjectMeta metadata = 1;
49
50 // data is the serialized representation of the state.
51 optional k8s.io.apimachinery.pkg.runtime.RawExtension data = 2;
52
53 // revision indicates the revision of the state represented by Data.
54 optional int64 revision = 3;
55}
56
57// ControllerRevisionList is a resource containing a list of ControllerRevision objects.
58message ControllerRevisionList {
59 // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
60 // +optional
61 optional k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1;
62
63 // Items is the list of ControllerRevisions
64 repeated ControllerRevision items = 2;
65}
66
67// DEPRECATED - This group version of Deployment is deprecated by apps/v1beta2/Deployment. See the release notes for
68// more information.
69// Deployment enables declarative updates for Pods and ReplicaSets.
70message Deployment {
71 // Standard object metadata.
72 // +optional
73 optional k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1;
74
75 // Specification of the desired behavior of the Deployment.
76 // +optional
77 optional DeploymentSpec spec = 2;
78
79 // Most recently observed status of the Deployment.
80 // +optional
81 optional DeploymentStatus status = 3;
82}
83
84// DeploymentCondition describes the state of a deployment at a certain point.
85message DeploymentCondition {
86 // Type of deployment condition.
87 optional string type = 1;
88
89 // Status of the condition, one of True, False, Unknown.
90 optional string status = 2;
91
92 // The last time this condition was updated.
93 optional k8s.io.apimachinery.pkg.apis.meta.v1.Time lastUpdateTime = 6;
94
95 // Last time the condition transitioned from one status to another.
96 optional k8s.io.apimachinery.pkg.apis.meta.v1.Time lastTransitionTime = 7;
97
98 // The reason for the condition's last transition.
99 optional string reason = 4;
100
101 // A human readable message indicating details about the transition.
102 optional string message = 5;
103}
104
105// DeploymentList is a list of Deployments.
106message DeploymentList {
107 // Standard list metadata.
108 // +optional
109 optional k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1;
110
111 // Items is the list of Deployments.
112 repeated Deployment items = 2;
113}
114
115// DEPRECATED.
116// DeploymentRollback stores the information required to rollback a deployment.
117message DeploymentRollback {
118 // Required: This must match the Name of a deployment.
119 optional string name = 1;
120
121 // The annotations to be updated to a deployment
122 // +optional
123 map<string, string> updatedAnnotations = 2;
124
125 // The config of this deployment rollback.
126 optional RollbackConfig rollbackTo = 3;
127}
128
129// DeploymentSpec is the specification of the desired behavior of the Deployment.
130message DeploymentSpec {
131 // replicas is the number of desired pods. This is a pointer to distinguish between explicit
132 // zero and not specified. Defaults to 1.
133 // +optional
134 optional int32 replicas = 1;
135
136 // selector is the label selector for pods. Existing ReplicaSets whose pods are
137 // selected by this will be the ones affected by this deployment.
138 // +optional
139 optional k8s.io.apimachinery.pkg.apis.meta.v1.LabelSelector selector = 2;
140
141 // Template describes the pods that will be created.
142 // The only allowed template.spec.restartPolicy value is "Always".
143 optional k8s.io.api.core.v1.PodTemplateSpec template = 3;
144
145 // The deployment strategy to use to replace existing pods with new ones.
146 // +optional
147 // +patchStrategy=retainKeys
148 optional DeploymentStrategy strategy = 4;
149
150 // minReadySeconds is the minimum number of seconds for which a newly created pod should be ready
151 // without any of its container crashing, for it to be considered available.
152 // Defaults to 0 (pod will be considered available as soon as it is ready)
153 // +optional
154 optional int32 minReadySeconds = 5;
155
156 // revisionHistoryLimit is the number of old ReplicaSets to retain to allow rollback.
157 // This is a pointer to distinguish between explicit zero and not specified.
158 // Defaults to 2.
159 // +optional
160 optional int32 revisionHistoryLimit = 6;
161
162 // paused indicates that the deployment is paused.
163 // +optional
164 optional bool paused = 7;
165
166 // DEPRECATED.
167 // rollbackTo is the config this deployment is rolling back to. Will be cleared after rollback is done.
168 // +optional
169 optional RollbackConfig rollbackTo = 8;
170
171 // progressDeadlineSeconds is the maximum time in seconds for a deployment to make progress before it
172 // is considered to be failed. The deployment controller will continue to
173 // process failed deployments and a condition with a ProgressDeadlineExceeded
174 // reason will be surfaced in the deployment status. Note that progress will
175 // not be estimated during the time a deployment is paused. Defaults to 600s.
176 // +optional
177 optional int32 progressDeadlineSeconds = 9;
178}
179
180// DeploymentStatus is the most recently observed status of the Deployment.
181message DeploymentStatus {
182 // observedGeneration is the generation observed by the deployment controller.
183 // +optional
184 optional int64 observedGeneration = 1;
185
186 // replicas is the total number of non-terminated pods targeted by this deployment (their labels match the selector).
187 // +optional
188 optional int32 replicas = 2;
189
190 // updatedReplicas is the total number of non-terminated pods targeted by this deployment that have the desired template spec.
191 // +optional
192 optional int32 updatedReplicas = 3;
193
194 // readyReplicas is the number of pods targeted by this Deployment controller with a Ready Condition.
195 // +optional
196 optional int32 readyReplicas = 7;
197
198 // Total number of available pods (ready for at least minReadySeconds) targeted by this deployment.
199 // +optional
200 optional int32 availableReplicas = 4;
201
202 // unavailableReplicas is the total number of unavailable pods targeted by this deployment. This is the total number of
203 // pods that are still required for the deployment to have 100% available capacity. They may
204 // either be pods that are running but not yet available or pods that still have not been created.
205 // +optional
206 optional int32 unavailableReplicas = 5;
207
208 // Conditions represent the latest available observations of a deployment's current state.
209 // +patchMergeKey=type
210 // +patchStrategy=merge
211 // +listType=map
212 // +listMapKey=type
213 repeated DeploymentCondition conditions = 6;
214
215 // collisionCount is the count of hash collisions for the Deployment. The Deployment controller uses this
216 // field as a collision avoidance mechanism when it needs to create the name for the
217 // newest ReplicaSet.
218 // +optional
219 optional int32 collisionCount = 8;
220}
221
222// DeploymentStrategy describes how to replace existing pods with new ones.
223message DeploymentStrategy {
224 // Type of deployment. Can be "Recreate" or "RollingUpdate". Default is RollingUpdate.
225 // +optional
226 optional string type = 1;
227
228 // Rolling update config params. Present only if DeploymentStrategyType =
229 // RollingUpdate.
230 // ---
231 // TODO: Update this to follow our convention for oneOf, whatever we decide it
232 // to be.
233 // +optional
234 optional RollingUpdateDeployment rollingUpdate = 2;
235}
236
237// DEPRECATED.
238message RollbackConfig {
239 // The revision to rollback to. If set to 0, rollback to the last revision.
240 // +optional
241 optional int64 revision = 1;
242}
243
244// Spec to control the desired behavior of rolling update.
245message RollingUpdateDeployment {
246 // The maximum number of pods that can be unavailable during the update.
247 // Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%).
248 // Absolute number is calculated from percentage by rounding down.
249 // This can not be 0 if MaxSurge is 0.
250 // Defaults to 25%.
251 // Example: when this is set to 30%, the old ReplicaSet can be scaled down to 70% of desired pods
252 // immediately when the rolling update starts. Once new pods are ready, old ReplicaSet
253 // can be scaled down further, followed by scaling up the new ReplicaSet, ensuring
254 // that the total number of pods available at all times during the update is at
255 // least 70% of desired pods.
256 // +optional
257 optional k8s.io.apimachinery.pkg.util.intstr.IntOrString maxUnavailable = 1;
258
259 // The maximum number of pods that can be scheduled above the desired number of
260 // pods.
261 // Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%).
262 // This can not be 0 if MaxUnavailable is 0.
263 // Absolute number is calculated from percentage by rounding up.
264 // Defaults to 25%.
265 // Example: when this is set to 30%, the new ReplicaSet can be scaled up immediately when
266 // the rolling update starts, such that the total number of old and new pods do not exceed
267 // 130% of desired pods. Once old pods have been killed,
268 // new ReplicaSet can be scaled up further, ensuring that total number of pods running
269 // at any time during the update is at most 130% of desired pods.
270 // +optional
271 optional k8s.io.apimachinery.pkg.util.intstr.IntOrString maxSurge = 2;
272}
273
274// RollingUpdateStatefulSetStrategy is used to communicate parameter for RollingUpdateStatefulSetStrategyType.
275message RollingUpdateStatefulSetStrategy {
276 // Partition indicates the ordinal at which the StatefulSet should be partitioned
277 // for updates. During a rolling update, all pods from ordinal Replicas-1 to
278 // Partition are updated. All pods from ordinal Partition-1 to 0 remain untouched.
279 // This is helpful in being able to do a canary based deployment. The default value is 0.
280 optional int32 partition = 1;
281
282 // maxUnavailable is the maximum number of pods that can be unavailable during the update.
283 // Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%).
284 // Absolute number is calculated from percentage by rounding up. This can not be 0.
285 // Defaults to 1. This field is alpha-level and is only honored by servers that enable the
286 // MaxUnavailableStatefulSet feature. The field applies to all pods in the range 0 to
287 // Replicas-1. That means if there is any unavailable pod in the range 0 to Replicas-1, it
288 // will be counted towards MaxUnavailable.
289 // +optional
290 optional k8s.io.apimachinery.pkg.util.intstr.IntOrString maxUnavailable = 2;
291}
292
293// Scale represents a scaling request for a resource.
294message Scale {
295 // Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata.
296 // +optional
297 optional k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1;
298
299 // spec defines the behavior of the scale. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status.
300 // +optional
301 optional ScaleSpec spec = 2;
302
303 // status defines current status of the scale. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status. Read-only.
304 // +optional
305 optional ScaleStatus status = 3;
306}
307
308// ScaleSpec describes the attributes of a scale subresource
309message ScaleSpec {
310 // replicas is the number of observed instances of the scaled object.
311 // +optional
312 optional int32 replicas = 1;
313}
314
315// ScaleStatus represents the current status of a scale subresource.
316message ScaleStatus {
317 // replias is the actual number of observed instances of the scaled object.
318 optional int32 replicas = 1;
319
320 // selector is a label query over pods that should match the replicas count. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/
321 // +optional
322 map<string, string> selector = 2;
323
324 // targetSelector is the label selector for pods that should match the replicas count. This is a serializated
325 // version of both map-based and more expressive set-based selectors. This is done to
326 // avoid introspection in the clients. The string will be in the same format as the
327 // query-param syntax. If the target type only supports map-based selectors, both this
328 // field and map-based selector field are populated.
329 // More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors
330 // +optional
331 optional string targetSelector = 3;
332}
333
334// DEPRECATED - This group version of StatefulSet is deprecated by apps/v1beta2/StatefulSet. See the release notes for
335// more information.
336// StatefulSet represents a set of pods with consistent identities.
337// Identities are defined as:
338// - Network: A single stable DNS and hostname.
339// - Storage: As many VolumeClaims as requested.
340//
341// The StatefulSet guarantees that a given network identity will always
342// map to the same storage identity.
343message StatefulSet {
344 // +optional
345 optional k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1;
346
347 // Spec defines the desired identities of pods in this set.
348 // +optional
349 optional StatefulSetSpec spec = 2;
350
351 // Status is the current status of Pods in this StatefulSet. This data
352 // may be out of date by some window of time.
353 // +optional
354 optional StatefulSetStatus status = 3;
355}
356
357// StatefulSetCondition describes the state of a statefulset at a certain point.
358message StatefulSetCondition {
359 // Type of statefulset condition.
360 optional string type = 1;
361
362 // Status of the condition, one of True, False, Unknown.
363 optional string status = 2;
364
365 // Last time the condition transitioned from one status to another.
366 // +optional
367 optional k8s.io.apimachinery.pkg.apis.meta.v1.Time lastTransitionTime = 3;
368
369 // The reason for the condition's last transition.
370 // +optional
371 optional string reason = 4;
372
373 // A human readable message indicating details about the transition.
374 // +optional
375 optional string message = 5;
376}
377
378// StatefulSetList is a collection of StatefulSets.
379message StatefulSetList {
380 // +optional
381 optional k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1;
382
383 repeated StatefulSet items = 2;
384}
385
386// StatefulSetOrdinals describes the policy used for replica ordinal assignment
387// in this StatefulSet.
388message StatefulSetOrdinals {
389 // start is the number representing the first replica's index. It may be used
390 // to number replicas from an alternate index (eg: 1-indexed) over the default
391 // 0-indexed names, or to orchestrate progressive movement of replicas from
392 // one StatefulSet to another.
393 // If set, replica indices will be in the range:
394 // [.spec.ordinals.start, .spec.ordinals.start + .spec.replicas).
395 // If unset, defaults to 0. Replica indices will be in the range:
396 // [0, .spec.replicas).
397 // +optional
398 optional int32 start = 1;
399}
400
401// StatefulSetPersistentVolumeClaimRetentionPolicy describes the policy used for PVCs
402// created from the StatefulSet VolumeClaimTemplates.
403message StatefulSetPersistentVolumeClaimRetentionPolicy {
404 // whenDeleted specifies what happens to PVCs created from StatefulSet
405 // VolumeClaimTemplates when the StatefulSet is deleted. The default policy
406 // of `Retain` causes PVCs to not be affected by StatefulSet deletion. The
407 // `Delete` policy causes those PVCs to be deleted.
408 optional string whenDeleted = 1;
409
410 // whenScaled specifies what happens to PVCs created from StatefulSet
411 // VolumeClaimTemplates when the StatefulSet is scaled down. The default
412 // policy of `Retain` causes PVCs to not be affected by a scaledown. The
413 // `Delete` policy causes the associated PVCs for any excess pods above
414 // the replica count to be deleted.
415 optional string whenScaled = 2;
416}
417
418// A StatefulSetSpec is the specification of a StatefulSet.
419message StatefulSetSpec {
420 // replicas is the desired number of replicas of the given Template.
421 // These are replicas in the sense that they are instantiations of the
422 // same Template, but individual replicas also have a consistent identity.
423 // If unspecified, defaults to 1.
424 // TODO: Consider a rename of this field.
425 // +optional
426 optional int32 replicas = 1;
427
428 // selector is a label query over pods that should match the replica count.
429 // If empty, defaulted to labels on the pod template.
430 // More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors
431 // +optional
432 optional k8s.io.apimachinery.pkg.apis.meta.v1.LabelSelector selector = 2;
433
434 // template is the object that describes the pod that will be created if
435 // insufficient replicas are detected. Each pod stamped out by the StatefulSet
436 // will fulfill this Template, but have a unique identity from the rest
437 // of the StatefulSet. Each pod will be named with the format
438 // <statefulsetname>-<podindex>. For example, a pod in a StatefulSet named
439 // "web" with index number "3" would be named "web-3".
440 optional k8s.io.api.core.v1.PodTemplateSpec template = 3;
441
442 // volumeClaimTemplates is a list of claims that pods are allowed to reference.
443 // The StatefulSet controller is responsible for mapping network identities to
444 // claims in a way that maintains the identity of a pod. Every claim in
445 // this list must have at least one matching (by name) volumeMount in one
446 // container in the template. A claim in this list takes precedence over
447 // any volumes in the template, with the same name.
448 // TODO: Define the behavior if a claim already exists with the same name.
449 // +optional
450 // +listType=atomic
451 repeated k8s.io.api.core.v1.PersistentVolumeClaim volumeClaimTemplates = 4;
452
453 // serviceName is the name of the service that governs this StatefulSet.
454 // This service must exist before the StatefulSet, and is responsible for
455 // the network identity of the set. Pods get DNS/hostnames that follow the
456 // pattern: pod-specific-string.serviceName.default.svc.cluster.local
457 // where "pod-specific-string" is managed by the StatefulSet controller.
458 optional string serviceName = 5;
459
460 // podManagementPolicy controls how pods are created during initial scale up,
461 // when replacing pods on nodes, or when scaling down. The default policy is
462 // `OrderedReady`, where pods are created in increasing order (pod-0, then
463 // pod-1, etc) and the controller will wait until each pod is ready before
464 // continuing. When scaling down, the pods are removed in the opposite order.
465 // The alternative policy is `Parallel` which will create pods in parallel
466 // to match the desired scale without waiting, and on scale down will delete
467 // all pods at once.
468 // +optional
469 optional string podManagementPolicy = 6;
470
471 // updateStrategy indicates the StatefulSetUpdateStrategy that will be
472 // employed to update Pods in the StatefulSet when a revision is made to
473 // Template.
474 optional StatefulSetUpdateStrategy updateStrategy = 7;
475
476 // revisionHistoryLimit is the maximum number of revisions that will
477 // be maintained in the StatefulSet's revision history. The revision history
478 // consists of all revisions not represented by a currently applied
479 // StatefulSetSpec version. The default value is 10.
480 optional int32 revisionHistoryLimit = 8;
481
482 // minReadySeconds is the minimum number of seconds for which a newly created pod should be ready
483 // without any of its container crashing for it to be considered available.
484 // Defaults to 0 (pod will be considered available as soon as it is ready)
485 // +optional
486 optional int32 minReadySeconds = 9;
487
488 // PersistentVolumeClaimRetentionPolicy describes the policy used for PVCs created from
489 // the StatefulSet VolumeClaimTemplates. This requires the
490 // StatefulSetAutoDeletePVC feature gate to be enabled, which is alpha.
491 // +optional
492 optional StatefulSetPersistentVolumeClaimRetentionPolicy persistentVolumeClaimRetentionPolicy = 10;
493
494 // ordinals controls the numbering of replica indices in a StatefulSet. The
495 // default ordinals behavior assigns a "0" index to the first replica and
496 // increments the index by one for each additional replica requested. Using
497 // the ordinals field requires the StatefulSetStartOrdinal feature gate to be
498 // enabled, which is beta.
499 // +optional
500 optional StatefulSetOrdinals ordinals = 11;
501}
502
503// StatefulSetStatus represents the current state of a StatefulSet.
504message StatefulSetStatus {
505 // observedGeneration is the most recent generation observed for this StatefulSet. It corresponds to the
506 // StatefulSet's generation, which is updated on mutation by the API Server.
507 // +optional
508 optional int64 observedGeneration = 1;
509
510 // replicas is the number of Pods created by the StatefulSet controller.
511 optional int32 replicas = 2;
512
513 // readyReplicas is the number of pods created by this StatefulSet controller with a Ready Condition.
514 optional int32 readyReplicas = 3;
515
516 // currentReplicas is the number of Pods created by the StatefulSet controller from the StatefulSet version
517 // indicated by currentRevision.
518 optional int32 currentReplicas = 4;
519
520 // updatedReplicas is the number of Pods created by the StatefulSet controller from the StatefulSet version
521 // indicated by updateRevision.
522 optional int32 updatedReplicas = 5;
523
524 // currentRevision, if not empty, indicates the version of the StatefulSet used to generate Pods in the
525 // sequence [0,currentReplicas).
526 optional string currentRevision = 6;
527
528 // updateRevision, if not empty, indicates the version of the StatefulSet used to generate Pods in the sequence
529 // [replicas-updatedReplicas,replicas)
530 optional string updateRevision = 7;
531
532 // collisionCount is the count of hash collisions for the StatefulSet. The StatefulSet controller
533 // uses this field as a collision avoidance mechanism when it needs to create the name for the
534 // newest ControllerRevision.
535 // +optional
536 optional int32 collisionCount = 9;
537
538 // conditions represent the latest available observations of a statefulset's current state.
539 // +optional
540 // +patchMergeKey=type
541 // +patchStrategy=merge
542 // +listType=map
543 // +listMapKey=type
544 repeated StatefulSetCondition conditions = 10;
545
546 // availableReplicas is the total number of available pods (ready for at least minReadySeconds) targeted by this StatefulSet.
547 // +optional
548 optional int32 availableReplicas = 11;
549}
550
551// StatefulSetUpdateStrategy indicates the strategy that the StatefulSet
552// controller will use to perform updates. It includes any additional parameters
553// necessary to perform the update for the indicated strategy.
554message StatefulSetUpdateStrategy {
555 // Type indicates the type of the StatefulSetUpdateStrategy.
556 optional string type = 1;
557
558 // RollingUpdate is used to communicate parameters when Type is RollingUpdateStatefulSetStrategyType.
559 optional RollingUpdateStatefulSetStrategy rollingUpdate = 2;
560}
561
View as plain text