| /* |
| Copyright 2017 The Kubernetes Authors. |
| |
| Licensed under the Apache License, Version 2.0 (the "License"); |
| you may not use this file except in compliance with the License. |
| You may obtain a copy of the License at |
| |
| http://www.apache.org/licenses/LICENSE-2.0 |
| |
| Unless required by applicable law or agreed to in writing, software |
| distributed under the License is distributed on an "AS IS" BASIS, |
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| See the License for the specific language governing permissions and |
| limitations under the License. |
| */ |
| |
| package v1beta2 |
| |
| import ( |
| "k8s.io/api/core/v1" |
| metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" |
| runtime "k8s.io/apimachinery/pkg/runtime" |
| "k8s.io/apimachinery/pkg/util/intstr" |
| ) |
| |
| const ( |
| ControllerRevisionHashLabelKey = "controller-revision-hash" |
| StatefulSetRevisionLabel = ControllerRevisionHashLabelKey |
| DeprecatedRollbackTo = "deprecated.deployment.rollback.to" |
| DeprecatedTemplateGeneration = "deprecated.daemonset.template.generation" |
| StatefulSetPodNameLabel = "statefulset.kubernetes.io/pod-name" |
| ) |
| |
| // ScaleSpec describes the attributes of a scale subresource |
| type ScaleSpec struct { |
| // desired number of instances for the scaled object. |
| // +optional |
| Replicas int32 `json:"replicas,omitempty" protobuf:"varint,1,opt,name=replicas"` |
| } |
| |
| // ScaleStatus represents the current status of a scale subresource. |
| type ScaleStatus struct { |
| // actual number of observed instances of the scaled object. |
| Replicas int32 `json:"replicas" protobuf:"varint,1,opt,name=replicas"` |
| |
| // label query over pods that should match the replicas count. More info: http://kubernetes.io/docs/user-guide/labels#label-selectors |
| // +optional |
| Selector map[string]string `json:"selector,omitempty" protobuf:"bytes,2,rep,name=selector"` |
| |
| // 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 |
| TargetSelector string `json:"targetSelector,omitempty" protobuf:"bytes,3,opt,name=targetSelector"` |
| } |
| |
| // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object |
| |
| // Scale represents a scaling request for a resource. |
| type Scale struct { |
| metav1.TypeMeta `json:",inline"` |
| // Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata. |
| // +optional |
| metav1.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"` |
| |
| // defines the behavior of the scale. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status. |
| // +optional |
| Spec ScaleSpec `json:"spec,omitempty" protobuf:"bytes,2,opt,name=spec"` |
| |
| // current status of the scale. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status. Read-only. |
| // +optional |
| Status ScaleStatus `json:"status,omitempty" protobuf:"bytes,3,opt,name=status"` |
| } |
| |
| // +genclient |
| // +genclient:method=GetScale,verb=get,subresource=scale,result=Scale |
| // +genclient:method=UpdateScale,verb=update,subresource=scale,input=Scale,result=Scale |
| // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object |
| |
| // DEPRECATED - This group version of StatefulSet is deprecated by apps/v1/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. |
| type StatefulSet struct { |
| metav1.TypeMeta `json:",inline"` |
| // +optional |
| metav1.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"` |
| |
| // Spec defines the desired identities of pods in this set. |
| // +optional |
| Spec StatefulSetSpec `json:"spec,omitempty" protobuf:"bytes,2,opt,name=spec"` |
| |
| // Status is the current status of Pods in this StatefulSet. This data |
| // may be out of date by some window of time. |
| // +optional |
| Status StatefulSetStatus `json:"status,omitempty" protobuf:"bytes,3,opt,name=status"` |
| } |
| |
| // PodManagementPolicyType defines the policy for creating pods under a stateful set. |
| type PodManagementPolicyType string |
| |
| const ( |
| // OrderedReadyPodManagement will create pods in strictly increasing order on |
| // scale up and strictly decreasing order on scale down, progressing only when |
| // the previous pod is ready or terminated. At most one pod will be changed |
| // at any time. |
| OrderedReadyPodManagement PodManagementPolicyType = "OrderedReady" |
| // ParallelPodManagement will create and delete pods as soon as the stateful set |
| // replica count is changed, and will not wait for pods to be ready or complete |
| // termination. |
| ParallelPodManagement = "Parallel" |
| ) |
| |
| // 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. |
| type StatefulSetUpdateStrategy struct { |
| // Type indicates the type of the StatefulSetUpdateStrategy. |
| // Default is RollingUpdate. |
| // +optional |
| Type StatefulSetUpdateStrategyType `json:"type,omitempty" protobuf:"bytes,1,opt,name=type,casttype=StatefulSetStrategyType"` |
| // RollingUpdate is used to communicate parameters when Type is RollingUpdateStatefulSetStrategyType. |
| // +optional |
| RollingUpdate *RollingUpdateStatefulSetStrategy `json:"rollingUpdate,omitempty" protobuf:"bytes,2,opt,name=rollingUpdate"` |
| } |
| |
| // StatefulSetUpdateStrategyType is a string enumeration type that enumerates |
| // all possible update strategies for the StatefulSet controller. |
| type StatefulSetUpdateStrategyType string |
| |
| const ( |
| // RollingUpdateStatefulSetStrategyType indicates that update will be |
| // applied to all Pods in the StatefulSet with respect to the StatefulSet |
| // ordering constraints. When a scale operation is performed with this |
| // strategy, new Pods will be created from the specification version indicated |
| // by the StatefulSet's updateRevision. |
| RollingUpdateStatefulSetStrategyType = "RollingUpdate" |
| // OnDeleteStatefulSetStrategyType triggers the legacy behavior. Version |
| // tracking and ordered rolling restarts are disabled. Pods are recreated |
| // from the StatefulSetSpec when they are manually deleted. When a scale |
| // operation is performed with this strategy,specification version indicated |
| // by the StatefulSet's currentRevision. |
| OnDeleteStatefulSetStrategyType = "OnDelete" |
| ) |
| |
| // RollingUpdateStatefulSetStrategy is used to communicate parameter for RollingUpdateStatefulSetStrategyType. |
| type RollingUpdateStatefulSetStrategy struct { |
| // Partition indicates the ordinal at which the StatefulSet should be |
| // partitioned. |
| // Default value is 0. |
| // +optional |
| Partition *int32 `json:"partition,omitempty" protobuf:"varint,1,opt,name=partition"` |
| } |
| |
| // A StatefulSetSpec is the specification of a StatefulSet. |
| type StatefulSetSpec struct { |
| // 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 |
| Replicas *int32 `json:"replicas,omitempty" protobuf:"varint,1,opt,name=replicas"` |
| |
| // selector is a label query over pods that should match the replica count. |
| // It must match the pod template's labels. |
| // More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors |
| Selector *metav1.LabelSelector `json:"selector" protobuf:"bytes,2,opt,name=selector"` |
| |
| // 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. |
| Template v1.PodTemplateSpec `json:"template" protobuf:"bytes,3,opt,name=template"` |
| |
| // 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 |
| VolumeClaimTemplates []v1.PersistentVolumeClaim `json:"volumeClaimTemplates,omitempty" protobuf:"bytes,4,rep,name=volumeClaimTemplates"` |
| |
| // 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. |
| ServiceName string `json:"serviceName" protobuf:"bytes,5,opt,name=serviceName"` |
| |
| // 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 |
| PodManagementPolicy PodManagementPolicyType `json:"podManagementPolicy,omitempty" protobuf:"bytes,6,opt,name=podManagementPolicy,casttype=PodManagementPolicyType"` |
| |
| // updateStrategy indicates the StatefulSetUpdateStrategy that will be |
| // employed to update Pods in the StatefulSet when a revision is made to |
| // Template. |
| UpdateStrategy StatefulSetUpdateStrategy `json:"updateStrategy,omitempty" protobuf:"bytes,7,opt,name=updateStrategy"` |
| |
| // 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. |
| RevisionHistoryLimit *int32 `json:"revisionHistoryLimit,omitempty" protobuf:"varint,8,opt,name=revisionHistoryLimit"` |
| } |
| |
| // StatefulSetStatus represents the current state of a StatefulSet. |
| type StatefulSetStatus struct { |
| // 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 |
| ObservedGeneration int64 `json:"observedGeneration,omitempty" protobuf:"varint,1,opt,name=observedGeneration"` |
| |
| // replicas is the number of Pods created by the StatefulSet controller. |
| Replicas int32 `json:"replicas" protobuf:"varint,2,opt,name=replicas"` |
| |
| // readyReplicas is the number of Pods created by the StatefulSet controller that have a Ready Condition. |
| ReadyReplicas int32 `json:"readyReplicas,omitempty" protobuf:"varint,3,opt,name=readyReplicas"` |
| |
| // currentReplicas is the number of Pods created by the StatefulSet controller from the StatefulSet version |
| // indicated by currentRevision. |
| CurrentReplicas int32 `json:"currentReplicas,omitempty" protobuf:"varint,4,opt,name=currentReplicas"` |
| |
| // updatedReplicas is the number of Pods created by the StatefulSet controller from the StatefulSet version |
| // indicated by updateRevision. |
| UpdatedReplicas int32 `json:"updatedReplicas,omitempty" protobuf:"varint,5,opt,name=updatedReplicas"` |
| |
| // currentRevision, if not empty, indicates the version of the StatefulSet used to generate Pods in the |
| // sequence [0,currentReplicas). |
| CurrentRevision string `json:"currentRevision,omitempty" protobuf:"bytes,6,opt,name=currentRevision"` |
| |
| // updateRevision, if not empty, indicates the version of the StatefulSet used to generate Pods in the sequence |
| // [replicas-updatedReplicas,replicas) |
| UpdateRevision string `json:"updateRevision,omitempty" protobuf:"bytes,7,opt,name=updateRevision"` |
| |
| // 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 |
| CollisionCount *int32 `json:"collisionCount,omitempty" protobuf:"varint,9,opt,name=collisionCount"` |
| |
| // Represents the latest available observations of a statefulset's current state. |
| // +optional |
| // +patchMergeKey=type |
| // +patchStrategy=merge |
| Conditions []StatefulSetCondition `json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,10,rep,name=conditions"` |
| } |
| |
| type StatefulSetConditionType string |
| |
| // StatefulSetCondition describes the state of a statefulset at a certain point. |
| type StatefulSetCondition struct { |
| // Type of statefulset condition. |
| Type StatefulSetConditionType `json:"type" protobuf:"bytes,1,opt,name=type,casttype=StatefulSetConditionType"` |
| // Status of the condition, one of True, False, Unknown. |
| Status v1.ConditionStatus `json:"status" protobuf:"bytes,2,opt,name=status,casttype=k8s.io/api/core/v1.ConditionStatus"` |
| // Last time the condition transitioned from one status to another. |
| // +optional |
| LastTransitionTime metav1.Time `json:"lastTransitionTime,omitempty" protobuf:"bytes,3,opt,name=lastTransitionTime"` |
| // The reason for the condition's last transition. |
| // +optional |
| Reason string `json:"reason,omitempty" protobuf:"bytes,4,opt,name=reason"` |
| // A human readable message indicating details about the transition. |
| // +optional |
| Message string `json:"message,omitempty" protobuf:"bytes,5,opt,name=message"` |
| } |
| |
| // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object |
| |
| // StatefulSetList is a collection of StatefulSets. |
| type StatefulSetList struct { |
| metav1.TypeMeta `json:",inline"` |
| // +optional |
| metav1.ListMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"` |
| Items []StatefulSet `json:"items" protobuf:"bytes,2,rep,name=items"` |
| } |
| |
| // +genclient |
| // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object |
| |
| // DEPRECATED - This group version of Deployment is deprecated by apps/v1/Deployment. See the release notes for |
| // more information. |
| // Deployment enables declarative updates for Pods and ReplicaSets. |
| type Deployment struct { |
| metav1.TypeMeta `json:",inline"` |
| // Standard object metadata. |
| // +optional |
| metav1.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"` |
| |
| // Specification of the desired behavior of the Deployment. |
| // +optional |
| Spec DeploymentSpec `json:"spec,omitempty" protobuf:"bytes,2,opt,name=spec"` |
| |
| // Most recently observed status of the Deployment. |
| // +optional |
| Status DeploymentStatus `json:"status,omitempty" protobuf:"bytes,3,opt,name=status"` |
| } |
| |
| // DeploymentSpec is the specification of the desired behavior of the Deployment. |
| type DeploymentSpec struct { |
| // Number of desired pods. This is a pointer to distinguish between explicit |
| // zero and not specified. Defaults to 1. |
| // +optional |
| Replicas *int32 `json:"replicas,omitempty" protobuf:"varint,1,opt,name=replicas"` |
| |
| // Label selector for pods. Existing ReplicaSets whose pods are |
| // selected by this will be the ones affected by this deployment. |
| // It must match the pod template's labels. |
| Selector *metav1.LabelSelector `json:"selector" protobuf:"bytes,2,opt,name=selector"` |
| |
| // Template describes the pods that will be created. |
| Template v1.PodTemplateSpec `json:"template" protobuf:"bytes,3,opt,name=template"` |
| |
| // The deployment strategy to use to replace existing pods with new ones. |
| // +optional |
| // +patchStrategy=retainKeys |
| Strategy DeploymentStrategy `json:"strategy,omitempty" patchStrategy:"retainKeys" protobuf:"bytes,4,opt,name=strategy"` |
| |
| // 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 |
| MinReadySeconds int32 `json:"minReadySeconds,omitempty" protobuf:"varint,5,opt,name=minReadySeconds"` |
| |
| // The number of old ReplicaSets to retain to allow rollback. |
| // This is a pointer to distinguish between explicit zero and not specified. |
| // Defaults to 10. |
| // +optional |
| RevisionHistoryLimit *int32 `json:"revisionHistoryLimit,omitempty" protobuf:"varint,6,opt,name=revisionHistoryLimit"` |
| |
| // Indicates that the deployment is paused. |
| // +optional |
| Paused bool `json:"paused,omitempty" protobuf:"varint,7,opt,name=paused"` |
| |
| // 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. |
| ProgressDeadlineSeconds *int32 `json:"progressDeadlineSeconds,omitempty" protobuf:"varint,9,opt,name=progressDeadlineSeconds"` |
| } |
| |
| const ( |
| // DefaultDeploymentUniqueLabelKey is the default key of the selector that is added |
| // to existing ReplicaSets (and label key that is added to its pods) to prevent the existing ReplicaSets |
| // to select new pods (and old pods being select by new ReplicaSet). |
| DefaultDeploymentUniqueLabelKey string = "pod-template-hash" |
| ) |
| |
| // DeploymentStrategy describes how to replace existing pods with new ones. |
| type DeploymentStrategy struct { |
| // Type of deployment. Can be "Recreate" or "RollingUpdate". Default is RollingUpdate. |
| // +optional |
| Type DeploymentStrategyType `json:"type,omitempty" protobuf:"bytes,1,opt,name=type,casttype=DeploymentStrategyType"` |
| |
| // 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 |
| RollingUpdate *RollingUpdateDeployment `json:"rollingUpdate,omitempty" protobuf:"bytes,2,opt,name=rollingUpdate"` |
| } |
| |
| type DeploymentStrategyType string |
| |
| const ( |
| // Kill all existing pods before creating new ones. |
| RecreateDeploymentStrategyType DeploymentStrategyType = "Recreate" |
| |
| // Replace the old ReplicaSets by new one using rolling update i.e gradually scale down the old ReplicaSets and scale up the new one. |
| RollingUpdateDeploymentStrategyType DeploymentStrategyType = "RollingUpdate" |
| ) |
| |
| // Spec to control the desired behavior of rolling update. |
| type RollingUpdateDeployment struct { |
| // 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 |
| MaxUnavailable *intstr.IntOrString `json:"maxUnavailable,omitempty" protobuf:"bytes,1,opt,name=maxUnavailable"` |
| |
| // 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 atmost 130% of desired pods. |
| // +optional |
| MaxSurge *intstr.IntOrString `json:"maxSurge,omitempty" protobuf:"bytes,2,opt,name=maxSurge"` |
| } |
| |
| // DeploymentStatus is the most recently observed status of the Deployment. |
| type DeploymentStatus struct { |
| // The generation observed by the deployment controller. |
| // +optional |
| ObservedGeneration int64 `json:"observedGeneration,omitempty" protobuf:"varint,1,opt,name=observedGeneration"` |
| |
| // Total number of non-terminated pods targeted by this deployment (their labels match the selector). |
| // +optional |
| Replicas int32 `json:"replicas,omitempty" protobuf:"varint,2,opt,name=replicas"` |
| |
| // Total number of non-terminated pods targeted by this deployment that have the desired template spec. |
| // +optional |
| UpdatedReplicas int32 `json:"updatedReplicas,omitempty" protobuf:"varint,3,opt,name=updatedReplicas"` |
| |
| // Total number of ready pods targeted by this deployment. |
| // +optional |
| ReadyReplicas int32 `json:"readyReplicas,omitempty" protobuf:"varint,7,opt,name=readyReplicas"` |
| |
| // Total number of available pods (ready for at least minReadySeconds) targeted by this deployment. |
| // +optional |
| AvailableReplicas int32 `json:"availableReplicas,omitempty" protobuf:"varint,4,opt,name=availableReplicas"` |
| |
| // 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 |
| UnavailableReplicas int32 `json:"unavailableReplicas,omitempty" protobuf:"varint,5,opt,name=unavailableReplicas"` |
| |
| // Represents the latest available observations of a deployment's current state. |
| // +patchMergeKey=type |
| // +patchStrategy=merge |
| Conditions []DeploymentCondition `json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,6,rep,name=conditions"` |
| |
| // 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 |
| CollisionCount *int32 `json:"collisionCount,omitempty" protobuf:"varint,8,opt,name=collisionCount"` |
| } |
| |
| type DeploymentConditionType string |
| |
| // These are valid conditions of a deployment. |
| const ( |
| // Available means the deployment is available, ie. at least the minimum available |
| // replicas required are up and running for at least minReadySeconds. |
| DeploymentAvailable DeploymentConditionType = "Available" |
| // Progressing means the deployment is progressing. Progress for a deployment is |
| // considered when a new replica set is created or adopted, and when new pods scale |
| // up or old pods scale down. Progress is not estimated for paused deployments or |
| // when progressDeadlineSeconds is not specified. |
| DeploymentProgressing DeploymentConditionType = "Progressing" |
| // ReplicaFailure is added in a deployment when one of its pods fails to be created |
| // or deleted. |
| DeploymentReplicaFailure DeploymentConditionType = "ReplicaFailure" |
| ) |
| |
| // DeploymentCondition describes the state of a deployment at a certain point. |
| type DeploymentCondition struct { |
| // Type of deployment condition. |
| Type DeploymentConditionType `json:"type" protobuf:"bytes,1,opt,name=type,casttype=DeploymentConditionType"` |
| // Status of the condition, one of True, False, Unknown. |
| Status v1.ConditionStatus `json:"status" protobuf:"bytes,2,opt,name=status,casttype=k8s.io/api/core/v1.ConditionStatus"` |
| // The last time this condition was updated. |
| LastUpdateTime metav1.Time `json:"lastUpdateTime,omitempty" protobuf:"bytes,6,opt,name=lastUpdateTime"` |
| // Last time the condition transitioned from one status to another. |
| LastTransitionTime metav1.Time `json:"lastTransitionTime,omitempty" protobuf:"bytes,7,opt,name=lastTransitionTime"` |
| // The reason for the condition's last transition. |
| Reason string `json:"reason,omitempty" protobuf:"bytes,4,opt,name=reason"` |
| // A human readable message indicating details about the transition. |
| Message string `json:"message,omitempty" protobuf:"bytes,5,opt,name=message"` |
| } |
| |
| // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object |
| |
| // DeploymentList is a list of Deployments. |
| type DeploymentList struct { |
| metav1.TypeMeta `json:",inline"` |
| // Standard list metadata. |
| // +optional |
| metav1.ListMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"` |
| |
| // Items is the list of Deployments. |
| Items []Deployment `json:"items" protobuf:"bytes,2,rep,name=items"` |
| } |
| |
| // DaemonSetUpdateStrategy is a struct used to control the update strategy for a DaemonSet. |
| type DaemonSetUpdateStrategy struct { |
| // Type of daemon set update. Can be "RollingUpdate" or "OnDelete". Default is RollingUpdate. |
| // +optional |
| Type DaemonSetUpdateStrategyType `json:"type,omitempty" protobuf:"bytes,1,opt,name=type"` |
| |
| // Rolling update config params. Present only if type = "RollingUpdate". |
| //--- |
| // TODO: Update this to follow our convention for oneOf, whatever we decide it |
| // to be. Same as Deployment `strategy.rollingUpdate`. |
| // See https://github.com/kubernetes/kubernetes/issues/35345 |
| // +optional |
| RollingUpdate *RollingUpdateDaemonSet `json:"rollingUpdate,omitempty" protobuf:"bytes,2,opt,name=rollingUpdate"` |
| } |
| |
| type DaemonSetUpdateStrategyType string |
| |
| const ( |
| // Replace the old daemons by new ones using rolling update i.e replace them on each node one after the other. |
| RollingUpdateDaemonSetStrategyType DaemonSetUpdateStrategyType = "RollingUpdate" |
| |
| // Replace the old daemons only when it's killed |
| OnDeleteDaemonSetStrategyType DaemonSetUpdateStrategyType = "OnDelete" |
| ) |
| |
| // Spec to control the desired behavior of daemon set rolling update. |
| type RollingUpdateDaemonSet struct { |
| // The maximum number of DaemonSet pods that can be unavailable during the |
| // update. Value can be an absolute number (ex: 5) or a percentage of total |
| // number of DaemonSet pods at the start of the update (ex: 10%). Absolute |
| // number is calculated from percentage by rounding up. |
| // This cannot be 0. |
| // Default value is 1. |
| // Example: when this is set to 30%, at most 30% of the total number of nodes |
| // that should be running the daemon pod (i.e. status.desiredNumberScheduled) |
| // can have their pods stopped for an update at any given |
| // time. The update starts by stopping at most 30% of those DaemonSet pods |
| // and then brings up new DaemonSet pods in their place. Once the new pods |
| // are available, it then proceeds onto other DaemonSet pods, thus ensuring |
| // that at least 70% of original number of DaemonSet pods are available at |
| // all times during the update. |
| // +optional |
| MaxUnavailable *intstr.IntOrString `json:"maxUnavailable,omitempty" protobuf:"bytes,1,opt,name=maxUnavailable"` |
| } |
| |
| // DaemonSetSpec is the specification of a daemon set. |
| type DaemonSetSpec struct { |
| // A label query over pods that are managed by the daemon set. |
| // Must match in order to be controlled. |
| // It must match the pod template's labels. |
| // More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors |
| Selector *metav1.LabelSelector `json:"selector" protobuf:"bytes,1,opt,name=selector"` |
| |
| // An object that describes the pod that will be created. |
| // The DaemonSet will create exactly one copy of this pod on every node |
| // that matches the template's node selector (or on every node if no node |
| // selector is specified). |
| // More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller#pod-template |
| Template v1.PodTemplateSpec `json:"template" protobuf:"bytes,2,opt,name=template"` |
| |
| // An update strategy to replace existing DaemonSet pods with new pods. |
| // +optional |
| UpdateStrategy DaemonSetUpdateStrategy `json:"updateStrategy,omitempty" protobuf:"bytes,3,opt,name=updateStrategy"` |
| |
| // The minimum number of seconds for which a newly created DaemonSet 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 |
| MinReadySeconds int32 `json:"minReadySeconds,omitempty" protobuf:"varint,4,opt,name=minReadySeconds"` |
| |
| // The number of old history to retain to allow rollback. |
| // This is a pointer to distinguish between explicit zero and not specified. |
| // Defaults to 10. |
| // +optional |
| RevisionHistoryLimit *int32 `json:"revisionHistoryLimit,omitempty" protobuf:"varint,6,opt,name=revisionHistoryLimit"` |
| } |
| |
| // DaemonSetStatus represents the current status of a daemon set. |
| type DaemonSetStatus struct { |
| // The number of nodes that are running at least 1 |
| // daemon pod and are supposed to run the daemon pod. |
| // More info: https://kubernetes.io/docs/concepts/workloads/controllers/daemonset/ |
| CurrentNumberScheduled int32 `json:"currentNumberScheduled" protobuf:"varint,1,opt,name=currentNumberScheduled"` |
| |
| // The number of nodes that are running the daemon pod, but are |
| // not supposed to run the daemon pod. |
| // More info: https://kubernetes.io/docs/concepts/workloads/controllers/daemonset/ |
| NumberMisscheduled int32 `json:"numberMisscheduled" protobuf:"varint,2,opt,name=numberMisscheduled"` |
| |
| // The total number of nodes that should be running the daemon |
| // pod (including nodes correctly running the daemon pod). |
| // More info: https://kubernetes.io/docs/concepts/workloads/controllers/daemonset/ |
| DesiredNumberScheduled int32 `json:"desiredNumberScheduled" protobuf:"varint,3,opt,name=desiredNumberScheduled"` |
| |
| // The number of nodes that should be running the daemon pod and have one |
| // or more of the daemon pod running and ready. |
| NumberReady int32 `json:"numberReady" protobuf:"varint,4,opt,name=numberReady"` |
| |
| // The most recent generation observed by the daemon set controller. |
| // +optional |
| ObservedGeneration int64 `json:"observedGeneration,omitempty" protobuf:"varint,5,opt,name=observedGeneration"` |
| |
| // The total number of nodes that are running updated daemon pod |
| // +optional |
| UpdatedNumberScheduled int32 `json:"updatedNumberScheduled,omitempty" protobuf:"varint,6,opt,name=updatedNumberScheduled"` |
| |
| // The number of nodes that should be running the |
| // daemon pod and have one or more of the daemon pod running and |
| // available (ready for at least spec.minReadySeconds) |
| // +optional |
| NumberAvailable int32 `json:"numberAvailable,omitempty" protobuf:"varint,7,opt,name=numberAvailable"` |
| |
| // The number of nodes that should be running the |
| // daemon pod and have none of the daemon pod running and available |
| // (ready for at least spec.minReadySeconds) |
| // +optional |
| NumberUnavailable int32 `json:"numberUnavailable,omitempty" protobuf:"varint,8,opt,name=numberUnavailable"` |
| |
| // Count of hash collisions for the DaemonSet. The DaemonSet controller |
| // uses this field as a collision avoidance mechanism when it needs to |
| // create the name for the newest ControllerRevision. |
| // +optional |
| CollisionCount *int32 `json:"collisionCount,omitempty" protobuf:"varint,9,opt,name=collisionCount"` |
| |
| // Represents the latest available observations of a DaemonSet's current state. |
| // +optional |
| // +patchMergeKey=type |
| // +patchStrategy=merge |
| Conditions []DaemonSetCondition `json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,10,rep,name=conditions"` |
| } |
| |
| type DaemonSetConditionType string |
| |
| // TODO: Add valid condition types of a DaemonSet. |
| |
| // DaemonSetCondition describes the state of a DaemonSet at a certain point. |
| type DaemonSetCondition struct { |
| // Type of DaemonSet condition. |
| Type DaemonSetConditionType `json:"type" protobuf:"bytes,1,opt,name=type,casttype=DaemonSetConditionType"` |
| // Status of the condition, one of True, False, Unknown. |
| Status v1.ConditionStatus `json:"status" protobuf:"bytes,2,opt,name=status,casttype=k8s.io/api/core/v1.ConditionStatus"` |
| // Last time the condition transitioned from one status to another. |
| // +optional |
| LastTransitionTime metav1.Time `json:"lastTransitionTime,omitempty" protobuf:"bytes,3,opt,name=lastTransitionTime"` |
| // The reason for the condition's last transition. |
| // +optional |
| Reason string `json:"reason,omitempty" protobuf:"bytes,4,opt,name=reason"` |
| // A human readable message indicating details about the transition. |
| // +optional |
| Message string `json:"message,omitempty" protobuf:"bytes,5,opt,name=message"` |
| } |
| |
| // +genclient |
| // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object |
| |
| // DEPRECATED - This group version of DaemonSet is deprecated by apps/v1/DaemonSet. See the release notes for |
| // more information. |
| // DaemonSet represents the configuration of a daemon set. |
| type DaemonSet struct { |
| metav1.TypeMeta `json:",inline"` |
| // Standard object's metadata. |
| // More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
| // +optional |
| metav1.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"` |
| |
| // The desired behavior of this daemon set. |
| // More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status |
| // +optional |
| Spec DaemonSetSpec `json:"spec,omitempty" protobuf:"bytes,2,opt,name=spec"` |
| |
| // The current status of this daemon set. This data may be |
| // out of date by some window of time. |
| // Populated by the system. |
| // Read-only. |
| // More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status |
| // +optional |
| Status DaemonSetStatus `json:"status,omitempty" protobuf:"bytes,3,opt,name=status"` |
| } |
| |
| const ( |
| // DefaultDaemonSetUniqueLabelKey is the default label key that is added |
| // to existing DaemonSet pods to distinguish between old and new |
| // DaemonSet pods during DaemonSet template updates. |
| DefaultDaemonSetUniqueLabelKey = ControllerRevisionHashLabelKey |
| ) |
| |
| // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object |
| |
| // DaemonSetList is a collection of daemon sets. |
| type DaemonSetList struct { |
| metav1.TypeMeta `json:",inline"` |
| // Standard list metadata. |
| // More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
| // +optional |
| metav1.ListMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"` |
| |
| // A list of daemon sets. |
| Items []DaemonSet `json:"items" protobuf:"bytes,2,rep,name=items"` |
| } |
| |
| // +genclient |
| // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object |
| |
| // DEPRECATED - This group version of ReplicaSet is deprecated by apps/v1/ReplicaSet. See the release notes for |
| // more information. |
| // ReplicaSet ensures that a specified number of pod replicas are running at any given time. |
| type ReplicaSet struct { |
| metav1.TypeMeta `json:",inline"` |
| |
| // If the Labels of a ReplicaSet are empty, they are defaulted to |
| // be the same as the Pod(s) that the ReplicaSet manages. |
| // Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
| // +optional |
| metav1.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"` |
| |
| // Spec defines the specification of the desired behavior of the ReplicaSet. |
| // More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status |
| // +optional |
| Spec ReplicaSetSpec `json:"spec,omitempty" protobuf:"bytes,2,opt,name=spec"` |
| |
| // Status is the most recently observed status of the ReplicaSet. |
| // This data may be out of date by some window of time. |
| // Populated by the system. |
| // Read-only. |
| // More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status |
| // +optional |
| Status ReplicaSetStatus `json:"status,omitempty" protobuf:"bytes,3,opt,name=status"` |
| } |
| |
| // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object |
| |
| // ReplicaSetList is a collection of ReplicaSets. |
| type ReplicaSetList struct { |
| metav1.TypeMeta `json:",inline"` |
| // Standard list metadata. |
| // More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds |
| // +optional |
| metav1.ListMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"` |
| |
| // List of ReplicaSets. |
| // More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller |
| Items []ReplicaSet `json:"items" protobuf:"bytes,2,rep,name=items"` |
| } |
| |
| // ReplicaSetSpec is the specification of a ReplicaSet. |
| type ReplicaSetSpec struct { |
| // Replicas is the number of desired replicas. |
| // This is a pointer to distinguish between explicit zero and unspecified. |
| // Defaults to 1. |
| // More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller/#what-is-a-replicationcontroller |
| // +optional |
| Replicas *int32 `json:"replicas,omitempty" protobuf:"varint,1,opt,name=replicas"` |
| |
| // 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 |
| MinReadySeconds int32 `json:"minReadySeconds,omitempty" protobuf:"varint,4,opt,name=minReadySeconds"` |
| |
| // Selector is a label query over pods that should match the replica count. |
| // Label keys and values that must match in order to be controlled by this replica set. |
| // It must match the pod template's labels. |
| // More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors |
| Selector *metav1.LabelSelector `json:"selector" protobuf:"bytes,2,opt,name=selector"` |
| |
| // Template is the object that describes the pod that will be created if |
| // insufficient replicas are detected. |
| // More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller#pod-template |
| // +optional |
| Template v1.PodTemplateSpec `json:"template,omitempty" protobuf:"bytes,3,opt,name=template"` |
| } |
| |
| // ReplicaSetStatus represents the current status of a ReplicaSet. |
| type ReplicaSetStatus struct { |
| // Replicas is the most recently oberved number of replicas. |
| // More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller/#what-is-a-replicationcontroller |
| Replicas int32 `json:"replicas" protobuf:"varint,1,opt,name=replicas"` |
| |
| // The number of pods that have labels matching the labels of the pod template of the replicaset. |
| // +optional |
| FullyLabeledReplicas int32 `json:"fullyLabeledReplicas,omitempty" protobuf:"varint,2,opt,name=fullyLabeledReplicas"` |
| |
| // The number of ready replicas for this replica set. |
| // +optional |
| ReadyReplicas int32 `json:"readyReplicas,omitempty" protobuf:"varint,4,opt,name=readyReplicas"` |
| |
| // The number of available replicas (ready for at least minReadySeconds) for this replica set. |
| // +optional |
| AvailableReplicas int32 `json:"availableReplicas,omitempty" protobuf:"varint,5,opt,name=availableReplicas"` |
| |
| // ObservedGeneration reflects the generation of the most recently observed ReplicaSet. |
| // +optional |
| ObservedGeneration int64 `json:"observedGeneration,omitempty" protobuf:"varint,3,opt,name=observedGeneration"` |
| |
| // Represents the latest available observations of a replica set's current state. |
| // +optional |
| // +patchMergeKey=type |
| // +patchStrategy=merge |
| Conditions []ReplicaSetCondition `json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,6,rep,name=conditions"` |
| } |
| |
| type ReplicaSetConditionType string |
| |
| // These are valid conditions of a replica set. |
| const ( |
| // ReplicaSetReplicaFailure is added in a replica set when one of its pods fails to be created |
| // due to insufficient quota, limit ranges, pod security policy, node selectors, etc. or deleted |
| // due to kubelet being down or finalizers are failing. |
| ReplicaSetReplicaFailure ReplicaSetConditionType = "ReplicaFailure" |
| ) |
| |
| // ReplicaSetCondition describes the state of a replica set at a certain point. |
| type ReplicaSetCondition struct { |
| // Type of replica set condition. |
| Type ReplicaSetConditionType `json:"type" protobuf:"bytes,1,opt,name=type,casttype=ReplicaSetConditionType"` |
| // Status of the condition, one of True, False, Unknown. |
| Status v1.ConditionStatus `json:"status" protobuf:"bytes,2,opt,name=status,casttype=k8s.io/api/core/v1.ConditionStatus"` |
| // The last time the condition transitioned from one status to another. |
| // +optional |
| LastTransitionTime metav1.Time `json:"lastTransitionTime,omitempty" protobuf:"bytes,3,opt,name=lastTransitionTime"` |
| // The reason for the condition's last transition. |
| // +optional |
| Reason string `json:"reason,omitempty" protobuf:"bytes,4,opt,name=reason"` |
| // A human readable message indicating details about the transition. |
| // +optional |
| Message string `json:"message,omitempty" protobuf:"bytes,5,opt,name=message"` |
| } |
| |
| // +genclient |
| // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object |
| |
| // DEPRECATED - This group version of ControllerRevision is deprecated by apps/v1/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. |
| type ControllerRevision struct { |
| metav1.TypeMeta `json:",inline"` |
| // Standard object's metadata. |
| // More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
| // +optional |
| metav1.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"` |
| |
| // Data is the serialized representation of the state. |
| Data runtime.RawExtension `json:"data,omitempty" protobuf:"bytes,2,opt,name=data"` |
| |
| // Revision indicates the revision of the state represented by Data. |
| Revision int64 `json:"revision" protobuf:"varint,3,opt,name=revision"` |
| } |
| |
| // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object |
| |
| // ControllerRevisionList is a resource containing a list of ControllerRevision objects. |
| type ControllerRevisionList struct { |
| metav1.TypeMeta `json:",inline"` |
| |
| // More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata |
| // +optional |
| metav1.ListMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"` |
| |
| // Items is the list of ControllerRevisions |
| Items []ControllerRevision `json:"items" protobuf:"bytes,2,rep,name=items"` |
| } |