blob: 694f6570d8c426b944bfe0a7727fda89f782f81c [file] [log] [blame]
Matteo Scandoloa4285862020-12-01 18:10:10 -08001/*
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 = "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 // 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 // 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 optional k8s.io.api.core.v1.PodTemplateSpec template = 3;
143
144 // The deployment strategy to use to replace existing pods with new ones.
145 // +optional
146 // +patchStrategy=retainKeys
147 optional DeploymentStrategy strategy = 4;
148
149 // Minimum number of seconds for which a newly created pod should be ready
150 // without any of its container crashing, for it to be considered available.
151 // Defaults to 0 (pod will be considered available as soon as it is ready)
152 // +optional
153 optional int32 minReadySeconds = 5;
154
155 // The number of old ReplicaSets to retain to allow rollback.
156 // This is a pointer to distinguish between explicit zero and not specified.
157 // Defaults to 2.
158 // +optional
159 optional int32 revisionHistoryLimit = 6;
160
161 // Indicates that the deployment is paused.
162 // +optional
163 optional bool paused = 7;
164
165 // DEPRECATED.
166 // The config this deployment is rolling back to. Will be cleared after rollback is done.
167 // +optional
168 optional RollbackConfig rollbackTo = 8;
169
170 // The maximum time in seconds for a deployment to make progress before it
171 // is considered to be failed. The deployment controller will continue to
172 // process failed deployments and a condition with a ProgressDeadlineExceeded
173 // reason will be surfaced in the deployment status. Note that progress will
174 // not be estimated during the time a deployment is paused. Defaults to 600s.
175 // +optional
176 optional int32 progressDeadlineSeconds = 9;
177}
178
179// DeploymentStatus is the most recently observed status of the Deployment.
180message DeploymentStatus {
181 // The generation observed by the deployment controller.
182 // +optional
183 optional int64 observedGeneration = 1;
184
185 // Total number of non-terminated pods targeted by this deployment (their labels match the selector).
186 // +optional
187 optional int32 replicas = 2;
188
189 // Total number of non-terminated pods targeted by this deployment that have the desired template spec.
190 // +optional
191 optional int32 updatedReplicas = 3;
192
193 // Total number of ready pods targeted by this deployment.
194 // +optional
195 optional int32 readyReplicas = 7;
196
197 // Total number of available pods (ready for at least minReadySeconds) targeted by this deployment.
198 // +optional
199 optional int32 availableReplicas = 4;
200
201 // Total number of unavailable pods targeted by this deployment. This is the total number of
202 // pods that are still required for the deployment to have 100% available capacity. They may
203 // either be pods that are running but not yet available or pods that still have not been created.
204 // +optional
205 optional int32 unavailableReplicas = 5;
206
207 // Represents the latest available observations of a deployment's current state.
208 // +patchMergeKey=type
209 // +patchStrategy=merge
210 repeated DeploymentCondition conditions = 6;
211
212 // Count of hash collisions for the Deployment. The Deployment controller uses this
213 // field as a collision avoidance mechanism when it needs to create the name for the
214 // newest ReplicaSet.
215 // +optional
216 optional int32 collisionCount = 8;
217}
218
219// DeploymentStrategy describes how to replace existing pods with new ones.
220message DeploymentStrategy {
221 // Type of deployment. Can be "Recreate" or "RollingUpdate". Default is RollingUpdate.
222 // +optional
223 optional string type = 1;
224
225 // Rolling update config params. Present only if DeploymentStrategyType =
226 // RollingUpdate.
227 // ---
228 // TODO: Update this to follow our convention for oneOf, whatever we decide it
229 // to be.
230 // +optional
231 optional RollingUpdateDeployment rollingUpdate = 2;
232}
233
234// DEPRECATED.
235message RollbackConfig {
236 // The revision to rollback to. If set to 0, rollback to the last revision.
237 // +optional
238 optional int64 revision = 1;
239}
240
241// Spec to control the desired behavior of rolling update.
242message RollingUpdateDeployment {
243 // The maximum number of pods that can be unavailable during the update.
244 // Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%).
245 // Absolute number is calculated from percentage by rounding down.
246 // This can not be 0 if MaxSurge is 0.
247 // Defaults to 25%.
248 // Example: when this is set to 30%, the old ReplicaSet can be scaled down to 70% of desired pods
249 // immediately when the rolling update starts. Once new pods are ready, old ReplicaSet
250 // can be scaled down further, followed by scaling up the new ReplicaSet, ensuring
251 // that the total number of pods available at all times during the update is at
252 // least 70% of desired pods.
253 // +optional
254 optional k8s.io.apimachinery.pkg.util.intstr.IntOrString maxUnavailable = 1;
255
256 // The maximum number of pods that can be scheduled above the desired number of
257 // pods.
258 // Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%).
259 // This can not be 0 if MaxUnavailable is 0.
260 // Absolute number is calculated from percentage by rounding up.
261 // Defaults to 25%.
262 // Example: when this is set to 30%, the new ReplicaSet can be scaled up immediately when
263 // the rolling update starts, such that the total number of old and new pods do not exceed
264 // 130% of desired pods. Once old pods have been killed,
265 // new ReplicaSet can be scaled up further, ensuring that total number of pods running
266 // at any time during the update is at most 130% of desired pods.
267 // +optional
268 optional k8s.io.apimachinery.pkg.util.intstr.IntOrString maxSurge = 2;
269}
270
271// RollingUpdateStatefulSetStrategy is used to communicate parameter for RollingUpdateStatefulSetStrategyType.
272message RollingUpdateStatefulSetStrategy {
273 // Partition indicates the ordinal at which the StatefulSet should be
274 // partitioned.
275 optional int32 partition = 1;
276}
277
278// Scale represents a scaling request for a resource.
279message Scale {
280 // Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata.
281 // +optional
282 optional k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1;
283
284 // defines the behavior of the scale. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status.
285 // +optional
286 optional ScaleSpec spec = 2;
287
288 // current status of the scale. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status. Read-only.
289 // +optional
290 optional ScaleStatus status = 3;
291}
292
293// ScaleSpec describes the attributes of a scale subresource
294message ScaleSpec {
295 // desired number of instances for the scaled object.
296 // +optional
297 optional int32 replicas = 1;
298}
299
300// ScaleStatus represents the current status of a scale subresource.
301message ScaleStatus {
302 // actual number of observed instances of the scaled object.
303 optional int32 replicas = 1;
304
305 // label query over pods that should match the replicas count. More info: http://kubernetes.io/docs/user-guide/labels#label-selectors
306 // +optional
307 map<string, string> selector = 2;
308
309 // label selector for pods that should match the replicas count. This is a serializated
310 // version of both map-based and more expressive set-based selectors. This is done to
311 // avoid introspection in the clients. The string will be in the same format as the
312 // query-param syntax. If the target type only supports map-based selectors, both this
313 // field and map-based selector field are populated.
314 // More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors
315 // +optional
316 optional string targetSelector = 3;
317}
318
319// DEPRECATED - This group version of StatefulSet is deprecated by apps/v1beta2/StatefulSet. See the release notes for
320// more information.
321// StatefulSet represents a set of pods with consistent identities.
322// Identities are defined as:
323// - Network: A single stable DNS and hostname.
324// - Storage: As many VolumeClaims as requested.
325// The StatefulSet guarantees that a given network identity will always
326// map to the same storage identity.
327message StatefulSet {
328 // +optional
329 optional k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1;
330
331 // Spec defines the desired identities of pods in this set.
332 // +optional
333 optional StatefulSetSpec spec = 2;
334
335 // Status is the current status of Pods in this StatefulSet. This data
336 // may be out of date by some window of time.
337 // +optional
338 optional StatefulSetStatus status = 3;
339}
340
341// StatefulSetCondition describes the state of a statefulset at a certain point.
342message StatefulSetCondition {
343 // Type of statefulset condition.
344 optional string type = 1;
345
346 // Status of the condition, one of True, False, Unknown.
347 optional string status = 2;
348
349 // Last time the condition transitioned from one status to another.
350 // +optional
351 optional k8s.io.apimachinery.pkg.apis.meta.v1.Time lastTransitionTime = 3;
352
353 // The reason for the condition's last transition.
354 // +optional
355 optional string reason = 4;
356
357 // A human readable message indicating details about the transition.
358 // +optional
359 optional string message = 5;
360}
361
362// StatefulSetList is a collection of StatefulSets.
363message StatefulSetList {
364 // +optional
365 optional k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1;
366
367 repeated StatefulSet items = 2;
368}
369
370// A StatefulSetSpec is the specification of a StatefulSet.
371message StatefulSetSpec {
372 // replicas is the desired number of replicas of the given Template.
373 // These are replicas in the sense that they are instantiations of the
374 // same Template, but individual replicas also have a consistent identity.
375 // If unspecified, defaults to 1.
376 // TODO: Consider a rename of this field.
377 // +optional
378 optional int32 replicas = 1;
379
380 // selector is a label query over pods that should match the replica count.
381 // If empty, defaulted to labels on the pod template.
382 // More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors
383 // +optional
384 optional k8s.io.apimachinery.pkg.apis.meta.v1.LabelSelector selector = 2;
385
386 // template is the object that describes the pod that will be created if
387 // insufficient replicas are detected. Each pod stamped out by the StatefulSet
388 // will fulfill this Template, but have a unique identity from the rest
389 // of the StatefulSet.
390 optional k8s.io.api.core.v1.PodTemplateSpec template = 3;
391
392 // volumeClaimTemplates is a list of claims that pods are allowed to reference.
393 // The StatefulSet controller is responsible for mapping network identities to
394 // claims in a way that maintains the identity of a pod. Every claim in
395 // this list must have at least one matching (by name) volumeMount in one
396 // container in the template. A claim in this list takes precedence over
397 // any volumes in the template, with the same name.
398 // TODO: Define the behavior if a claim already exists with the same name.
399 // +optional
400 repeated k8s.io.api.core.v1.PersistentVolumeClaim volumeClaimTemplates = 4;
401
402 // serviceName is the name of the service that governs this StatefulSet.
403 // This service must exist before the StatefulSet, and is responsible for
404 // the network identity of the set. Pods get DNS/hostnames that follow the
405 // pattern: pod-specific-string.serviceName.default.svc.cluster.local
406 // where "pod-specific-string" is managed by the StatefulSet controller.
407 optional string serviceName = 5;
408
409 // podManagementPolicy controls how pods are created during initial scale up,
410 // when replacing pods on nodes, or when scaling down. The default policy is
411 // `OrderedReady`, where pods are created in increasing order (pod-0, then
412 // pod-1, etc) and the controller will wait until each pod is ready before
413 // continuing. When scaling down, the pods are removed in the opposite order.
414 // The alternative policy is `Parallel` which will create pods in parallel
415 // to match the desired scale without waiting, and on scale down will delete
416 // all pods at once.
417 // +optional
418 optional string podManagementPolicy = 6;
419
420 // updateStrategy indicates the StatefulSetUpdateStrategy that will be
421 // employed to update Pods in the StatefulSet when a revision is made to
422 // Template.
423 optional StatefulSetUpdateStrategy updateStrategy = 7;
424
425 // revisionHistoryLimit is the maximum number of revisions that will
426 // be maintained in the StatefulSet's revision history. The revision history
427 // consists of all revisions not represented by a currently applied
428 // StatefulSetSpec version. The default value is 10.
429 optional int32 revisionHistoryLimit = 8;
430}
431
432// StatefulSetStatus represents the current state of a StatefulSet.
433message StatefulSetStatus {
434 // observedGeneration is the most recent generation observed for this StatefulSet. It corresponds to the
435 // StatefulSet's generation, which is updated on mutation by the API Server.
436 // +optional
437 optional int64 observedGeneration = 1;
438
439 // replicas is the number of Pods created by the StatefulSet controller.
440 optional int32 replicas = 2;
441
442 // readyReplicas is the number of Pods created by the StatefulSet controller that have a Ready Condition.
443 optional int32 readyReplicas = 3;
444
445 // currentReplicas is the number of Pods created by the StatefulSet controller from the StatefulSet version
446 // indicated by currentRevision.
447 optional int32 currentReplicas = 4;
448
449 // updatedReplicas is the number of Pods created by the StatefulSet controller from the StatefulSet version
450 // indicated by updateRevision.
451 optional int32 updatedReplicas = 5;
452
453 // currentRevision, if not empty, indicates the version of the StatefulSet used to generate Pods in the
454 // sequence [0,currentReplicas).
455 optional string currentRevision = 6;
456
457 // updateRevision, if not empty, indicates the version of the StatefulSet used to generate Pods in the sequence
458 // [replicas-updatedReplicas,replicas)
459 optional string updateRevision = 7;
460
461 // collisionCount is the count of hash collisions for the StatefulSet. The StatefulSet controller
462 // uses this field as a collision avoidance mechanism when it needs to create the name for the
463 // newest ControllerRevision.
464 // +optional
465 optional int32 collisionCount = 9;
466
467 // Represents the latest available observations of a statefulset's current state.
468 // +optional
469 // +patchMergeKey=type
470 // +patchStrategy=merge
471 repeated StatefulSetCondition conditions = 10;
472}
473
474// StatefulSetUpdateStrategy indicates the strategy that the StatefulSet
475// controller will use to perform updates. It includes any additional parameters
476// necessary to perform the update for the indicated strategy.
477message StatefulSetUpdateStrategy {
478 // Type indicates the type of the StatefulSetUpdateStrategy.
479 optional string type = 1;
480
481 // RollingUpdate is used to communicate parameters when Type is RollingUpdateStatefulSetStrategyType.
482 optional RollingUpdateStatefulSetStrategy rollingUpdate = 2;
483}
484