package k8s.io.api.apps.v1beta1

Get desktop application:
View/edit binary Protocol Buffers messages

DEPRECATED - This group version of ControllerRevision is deprecated by apps/v1beta2/ControllerRevision. See the release notes for more information. ControllerRevision implements an immutable snapshot of state data. Clients are responsible for serializing and deserializing the objects that contain their internal state. Once a ControllerRevision has been successfully created, it can not be updated. The API Server will fail validation of all requests that attempt to mutate the Data field. ControllerRevisions may, however, be deleted. Note that, due to its use by both the DaemonSet and StatefulSet controllers for update and rollback, this object is beta. However, it may be subject to name and representation changes in future releases, and clients should not depend on its stability. It is primarily for internal use by controllers.

Used in: ControllerRevisionList

• optional apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1

  Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata +optional

• optional apimachinery.pkg.runtime.RawExtension data = 2

  Data is the serialized representation of the state.

• optional int64 revision = 3

  Revision indicates the revision of the state represented by Data.

ControllerRevisionList is a resource containing a list of ControllerRevision objects.

• optional apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1

  More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata +optional

• repeated ControllerRevision items = 2

  Items is the list of ControllerRevisions

DEPRECATED - This group version of Deployment is deprecated by apps/v1beta2/Deployment. See the release notes for more information. Deployment enables declarative updates for Pods and ReplicaSets.

Used in: DeploymentList

• optional apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1

  Standard object metadata. +optional

• optional DeploymentSpec spec = 2

  Specification of the desired behavior of the Deployment. +optional

• optional DeploymentStatus status = 3

  Most recently observed status of the Deployment. +optional

DeploymentCondition describes the state of a deployment at a certain point.

Used in: DeploymentStatus

• optional string type = 1

  Type of deployment condition.

• optional string status = 2

  Status of the condition, one of True, False, Unknown.

• optional apimachinery.pkg.apis.meta.v1.Time lastUpdateTime = 6

  The last time this condition was updated.

• optional apimachinery.pkg.apis.meta.v1.Time lastTransitionTime = 7

  Last time the condition transitioned from one status to another.

• optional string reason = 4

  The reason for the condition's last transition.

• optional string message = 5

  A human readable message indicating details about the transition.

DeploymentList is a list of Deployments.

• optional apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1

  Standard list metadata. +optional

• repeated Deployment items = 2

  Items is the list of Deployments.

DEPRECATED. DeploymentRollback stores the information required to rollback a deployment.

• optional string name = 1

  Required: This must match the Name of a deployment.

• map<string, string> updatedAnnotations = 2

  The annotations to be updated to a deployment +optional

• optional RollbackConfig rollbackTo = 3

  The config of this deployment rollback.

DeploymentSpec is the specification of the desired behavior of the Deployment.

Used in: Deployment

• optional int32 replicas = 1

  Number of desired pods. This is a pointer to distinguish between explicit zero and not specified. Defaults to 1. +optional

• optional apimachinery.pkg.apis.meta.v1.LabelSelector selector = 2

  Label selector for pods. Existing ReplicaSets whose pods are selected by this will be the ones affected by this deployment. +optional

• optional core.v1.PodTemplateSpec template = 3

  Template describes the pods that will be created.

• optional DeploymentStrategy strategy = 4

  The deployment strategy to use to replace existing pods with new ones. +optional +patchStrategy=retainKeys

• optional int32 minReadySeconds = 5

  Minimum number of seconds for which a newly created pod should be ready without any of its container crashing, for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready) +optional

• optional int32 revisionHistoryLimit = 6

  The number of old ReplicaSets to retain to allow rollback. This is a pointer to distinguish between explicit zero and not specified. Defaults to 2. +optional

• optional bool paused = 7

  Indicates that the deployment is paused. +optional

• optional RollbackConfig rollbackTo = 8

  DEPRECATED. The config this deployment is rolling back to. Will be cleared after rollback is done. +optional

• optional int32 progressDeadlineSeconds = 9

  The maximum time in seconds for a deployment to make progress before it is considered to be failed. The deployment controller will continue to process failed deployments and a condition with a ProgressDeadlineExceeded reason will be surfaced in the deployment status. Note that progress will not be estimated during the time a deployment is paused. Defaults to 600s. +optional

DeploymentStatus is the most recently observed status of the Deployment.

Used in: Deployment

• optional int64 observedGeneration = 1

  The generation observed by the deployment controller. +optional

• optional int32 replicas = 2

  Total number of non-terminated pods targeted by this deployment (their labels match the selector). +optional

• optional int32 updatedReplicas = 3

  Total number of non-terminated pods targeted by this deployment that have the desired template spec. +optional

• optional int32 readyReplicas = 7

  readyReplicas is the number of pods targeted by this Deployment controller with a Ready Condition. +optional

• optional int32 availableReplicas = 4

  Total number of available pods (ready for at least minReadySeconds) targeted by this deployment. +optional

• optional int32 unavailableReplicas = 5

  Total number of unavailable pods targeted by this deployment. This is the total number of pods that are still required for the deployment to have 100% available capacity. They may either be pods that are running but not yet available or pods that still have not been created. +optional

• repeated DeploymentCondition conditions = 6

  Represents the latest available observations of a deployment's current state. +patchMergeKey=type +patchStrategy=merge

• optional int32 collisionCount = 8

  Count of hash collisions for the Deployment. The Deployment controller uses this field as a collision avoidance mechanism when it needs to create the name for the newest ReplicaSet. +optional

DeploymentStrategy describes how to replace existing pods with new ones.

Used in: DeploymentSpec

• optional string type = 1

  Type of deployment. Can be "Recreate" or "RollingUpdate". Default is RollingUpdate. +optional

• optional RollingUpdateDeployment rollingUpdate = 2

  Rolling update config params. Present only if DeploymentStrategyType = RollingUpdate. --- TODO: Update this to follow our convention for oneOf, whatever we decide it to be. +optional

DEPRECATED.

Used in: DeploymentRollback, DeploymentSpec

• optional int64 revision = 1

  The revision to rollback to. If set to 0, rollback to the last revision. +optional

Spec to control the desired behavior of rolling update.

Used in: DeploymentStrategy

• optional apimachinery.pkg.util.intstr.IntOrString maxUnavailable = 1

  The maximum number of pods that can be unavailable during the update. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). Absolute number is calculated from percentage by rounding down. This can not be 0 if MaxSurge is 0. Defaults to 25%. Example: when this is set to 30%, the old ReplicaSet can be scaled down to 70% of desired pods immediately when the rolling update starts. Once new pods are ready, old ReplicaSet can be scaled down further, followed by scaling up the new ReplicaSet, ensuring that the total number of pods available at all times during the update is at least 70% of desired pods. +optional

• optional apimachinery.pkg.util.intstr.IntOrString maxSurge = 2

  The maximum number of pods that can be scheduled above the desired number of pods. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). This can not be 0 if MaxUnavailable is 0. Absolute number is calculated from percentage by rounding up. Defaults to 25%. Example: when this is set to 30%, the new ReplicaSet can be scaled up immediately when the rolling update starts, such that the total number of old and new pods do not exceed 130% of desired pods. Once old pods have been killed, new ReplicaSet can be scaled up further, ensuring that total number of pods running at any time during the update is at most 130% of desired pods. +optional

RollingUpdateStatefulSetStrategy is used to communicate parameter for RollingUpdateStatefulSetStrategyType.

Used in: StatefulSetUpdateStrategy

• optional int32 partition = 1

  Partition indicates the ordinal at which the StatefulSet should be partitioned.

Scale represents a scaling request for a resource.

• optional apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1

  Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. +optional

• optional ScaleSpec spec = 2

  defines the behavior of the scale. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status. +optional

• optional ScaleStatus status = 3

  current status of the scale. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status. Read-only. +optional

ScaleSpec describes the attributes of a scale subresource

Used in: Scale

• optional int32 replicas = 1

  desired number of instances for the scaled object. +optional

ScaleStatus represents the current status of a scale subresource.

Used in: Scale

• optional int32 replicas = 1

  actual number of observed instances of the scaled object.

• map<string, string> selector = 2

  label query over pods that should match the replicas count. More info: http://kubernetes.io/docs/user-guide/labels#label-selectors +optional

• optional string targetSelector = 3

  label selector for pods that should match the replicas count. This is a serializated version of both map-based and more expressive set-based selectors. This is done to avoid introspection in the clients. The string will be in the same format as the query-param syntax. If the target type only supports map-based selectors, both this field and map-based selector field are populated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors +optional

DEPRECATED - This group version of StatefulSet is deprecated by apps/v1beta2/StatefulSet. See the release notes for more information. StatefulSet represents a set of pods with consistent identities. Identities are defined as: - Network: A single stable DNS and hostname. - Storage: As many VolumeClaims as requested. The StatefulSet guarantees that a given network identity will always map to the same storage identity.

Used in: StatefulSetList

• optional apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1

  +optional

• optional StatefulSetSpec spec = 2

  Spec defines the desired identities of pods in this set. +optional

• optional StatefulSetStatus status = 3

  Status is the current status of Pods in this StatefulSet. This data may be out of date by some window of time. +optional

StatefulSetCondition describes the state of a statefulset at a certain point.

Used in: StatefulSetStatus

• optional string type = 1

  Type of statefulset condition.

• optional string status = 2

  Status of the condition, one of True, False, Unknown.

• optional apimachinery.pkg.apis.meta.v1.Time lastTransitionTime = 3

  Last time the condition transitioned from one status to another. +optional

• optional string reason = 4

  The reason for the condition's last transition. +optional

• optional string message = 5

  A human readable message indicating details about the transition. +optional

StatefulSetList is a collection of StatefulSets.

• optional apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1

  +optional

• repeated StatefulSet items = 2

StatefulSetPersistentVolumeClaimRetentionPolicy describes the policy used for PVCs created from the StatefulSet VolumeClaimTemplates.

Used in: StatefulSetSpec

• optional string whenDeleted = 1

  WhenDeleted specifies what happens to PVCs created from StatefulSet VolumeClaimTemplates when the StatefulSet is deleted. The default policy of `Retain` causes PVCs to not be affected by StatefulSet deletion. The `Delete` policy causes those PVCs to be deleted.

• optional string whenScaled = 2

  WhenScaled specifies what happens to PVCs created from StatefulSet VolumeClaimTemplates when the StatefulSet is scaled down. The default policy of `Retain` causes PVCs to not be affected by a scaledown. The `Delete` policy causes the associated PVCs for any excess pods above the replica count to be deleted.

A StatefulSetSpec is the specification of a StatefulSet.

Used in: StatefulSet

• optional int32 replicas = 1

  replicas is the desired number of replicas of the given Template. These are replicas in the sense that they are instantiations of the same Template, but individual replicas also have a consistent identity. If unspecified, defaults to 1. TODO: Consider a rename of this field. +optional

• optional apimachinery.pkg.apis.meta.v1.LabelSelector selector = 2

  selector is a label query over pods that should match the replica count. If empty, defaulted to labels on the pod template. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors +optional

• optional core.v1.PodTemplateSpec template = 3

  template is the object that describes the pod that will be created if insufficient replicas are detected. Each pod stamped out by the StatefulSet will fulfill this Template, but have a unique identity from the rest of the StatefulSet.

• repeated core.v1.PersistentVolumeClaim volumeClaimTemplates = 4

  volumeClaimTemplates is a list of claims that pods are allowed to reference. The StatefulSet controller is responsible for mapping network identities to claims in a way that maintains the identity of a pod. Every claim in this list must have at least one matching (by name) volumeMount in one container in the template. A claim in this list takes precedence over any volumes in the template, with the same name. TODO: Define the behavior if a claim already exists with the same name. +optional

• optional string serviceName = 5

  serviceName is the name of the service that governs this StatefulSet. This service must exist before the StatefulSet, and is responsible for the network identity of the set. Pods get DNS/hostnames that follow the pattern: pod-specific-string.serviceName.default.svc.cluster.local where "pod-specific-string" is managed by the StatefulSet controller.

• optional string podManagementPolicy = 6

  podManagementPolicy controls how pods are created during initial scale up, when replacing pods on nodes, or when scaling down. The default policy is `OrderedReady`, where pods are created in increasing order (pod-0, then pod-1, etc) and the controller will wait until each pod is ready before continuing. When scaling down, the pods are removed in the opposite order. The alternative policy is `Parallel` which will create pods in parallel to match the desired scale without waiting, and on scale down will delete all pods at once. +optional

• optional StatefulSetUpdateStrategy updateStrategy = 7

  updateStrategy indicates the StatefulSetUpdateStrategy that will be employed to update Pods in the StatefulSet when a revision is made to Template.

• optional int32 revisionHistoryLimit = 8

  revisionHistoryLimit is the maximum number of revisions that will be maintained in the StatefulSet's revision history. The revision history consists of all revisions not represented by a currently applied StatefulSetSpec version. The default value is 10.

• optional int32 minReadySeconds = 9

  Minimum number of seconds for which a newly created pod should be ready without any of its container crashing for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready) This is an alpha field and requires enabling StatefulSetMinReadySeconds feature gate. +optional

• optional StatefulSetPersistentVolumeClaimRetentionPolicy persistentVolumeClaimRetentionPolicy = 10

  PersistentVolumeClaimRetentionPolicy describes the policy used for PVCs created from the StatefulSet VolumeClaimTemplates. This requires the StatefulSetAutoDeletePVC feature gate to be enabled, which is alpha. +optional

StatefulSetStatus represents the current state of a StatefulSet.

Used in: StatefulSet

• optional int64 observedGeneration = 1

  observedGeneration is the most recent generation observed for this StatefulSet. It corresponds to the StatefulSet's generation, which is updated on mutation by the API Server. +optional

• optional int32 replicas = 2

  replicas is the number of Pods created by the StatefulSet controller.

• optional int32 readyReplicas = 3

  readyReplicas is the number of pods created by this StatefulSet controller with a Ready Condition.

• optional int32 currentReplicas = 4

  currentReplicas is the number of Pods created by the StatefulSet controller from the StatefulSet version indicated by currentRevision.

• optional int32 updatedReplicas = 5

  updatedReplicas is the number of Pods created by the StatefulSet controller from the StatefulSet version indicated by updateRevision.

• optional string currentRevision = 6

  currentRevision, if not empty, indicates the version of the StatefulSet used to generate Pods in the sequence [0,currentReplicas).

• optional string updateRevision = 7

  updateRevision, if not empty, indicates the version of the StatefulSet used to generate Pods in the sequence [replicas-updatedReplicas,replicas)

• optional int32 collisionCount = 9

  collisionCount is the count of hash collisions for the StatefulSet. The StatefulSet controller uses this field as a collision avoidance mechanism when it needs to create the name for the newest ControllerRevision. +optional

• repeated StatefulSetCondition conditions = 10

  Represents the latest available observations of a statefulset's current state. +optional +patchMergeKey=type +patchStrategy=merge

• optional int32 availableReplicas = 11

  Total number of available pods (ready for at least minReadySeconds) targeted by this StatefulSet. This is a beta field and enabled/disabled by StatefulSetMinReadySeconds feature gate.

StatefulSetUpdateStrategy indicates the strategy that the StatefulSet controller will use to perform updates. It includes any additional parameters necessary to perform the update for the indicated strategy.

Used in: StatefulSetSpec

• optional string type = 1

  Type indicates the type of the StatefulSetUpdateStrategy.

• optional RollingUpdateStatefulSetStrategy rollingUpdate = 2

  RollingUpdate is used to communicate parameters when Type is RollingUpdateStatefulSetStrategyType.