mirror of
https://github.com/ceph/ceph-csi.git
synced 2024-10-19 05:39:51 +00:00
e727bd351e
updating kubernetes to 1.30 release Signed-off-by: Madhu Rajanna <madhupr007@gmail.com>
693 lines
35 KiB
Go
693 lines
35 KiB
Go
/*
|
|
Copyright 2016 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 v1beta1
|
|
|
|
import (
|
|
v1 "k8s.io/api/core/v1"
|
|
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
|
|
"k8s.io/apimachinery/pkg/runtime"
|
|
"k8s.io/apimachinery/pkg/util/intstr"
|
|
)
|
|
|
|
const (
|
|
ControllerRevisionHashLabelKey = "controller-revision-hash"
|
|
StatefulSetRevisionLabel = ControllerRevisionHashLabelKey
|
|
StatefulSetPodNameLabel = "statefulset.kubernetes.io/pod-name"
|
|
)
|
|
|
|
// ScaleSpec describes the attributes of a scale subresource
|
|
type ScaleSpec struct {
|
|
// replicas is the number of observed instances of 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 {
|
|
// replias is the actual number of observed instances of the scaled object.
|
|
Replicas int32 `json:"replicas" protobuf:"varint,1,opt,name=replicas"`
|
|
|
|
// 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/
|
|
// +optional
|
|
Selector map[string]string `json:"selector,omitempty" protobuf:"bytes,2,rep,name=selector"`
|
|
|
|
// targetSelector is the 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
|
|
// +k8s:prerelease-lifecycle-gen:introduced=1.6
|
|
// +k8s:prerelease-lifecycle-gen:deprecated=1.8
|
|
// +k8s:prerelease-lifecycle-gen:removed=1.16
|
|
// +k8s:prerelease-lifecycle-gen:replacement=autoscaling,v1,Scale
|
|
|
|
// 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/sig-architecture/api-conventions.md#metadata.
|
|
// +optional
|
|
metav1.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`
|
|
|
|
// spec defines the behavior of the scale. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status.
|
|
// +optional
|
|
Spec ScaleSpec `json:"spec,omitempty" protobuf:"bytes,2,opt,name=spec"`
|
|
|
|
// 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.
|
|
// +optional
|
|
Status ScaleStatus `json:"status,omitempty" protobuf:"bytes,3,opt,name=status"`
|
|
}
|
|
|
|
// +genclient
|
|
// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
|
|
// +k8s:prerelease-lifecycle-gen:introduced=1.5
|
|
// +k8s:prerelease-lifecycle-gen:deprecated=1.8
|
|
// +k8s:prerelease-lifecycle-gen:removed=1.16
|
|
// +k8s:prerelease-lifecycle-gen:replacement=apps,v1,StatefulSet
|
|
|
|
// 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.
|
|
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 PodManagementPolicyType = "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.
|
|
Type StatefulSetUpdateStrategyType `json:"type,omitempty" protobuf:"bytes,1,opt,name=type,casttype=StatefulSetStrategyType"`
|
|
// RollingUpdate is used to communicate parameters when Type is RollingUpdateStatefulSetStrategyType.
|
|
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 StatefulSetUpdateStrategyType = "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 StatefulSetUpdateStrategyType = "OnDelete"
|
|
)
|
|
|
|
// RollingUpdateStatefulSetStrategy is used to communicate parameter for RollingUpdateStatefulSetStrategyType.
|
|
type RollingUpdateStatefulSetStrategy struct {
|
|
// Partition indicates the ordinal at which the StatefulSet should be partitioned
|
|
// for updates. During a rolling update, all pods from ordinal Replicas-1 to
|
|
// Partition are updated. All pods from ordinal Partition-1 to 0 remain untouched.
|
|
// This is helpful in being able to do a canary based deployment. The default value is 0.
|
|
Partition *int32 `json:"partition,omitempty" protobuf:"varint,1,opt,name=partition"`
|
|
// maxUnavailable is 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 up. This can not be 0.
|
|
// Defaults to 1. This field is alpha-level and is only honored by servers that enable the
|
|
// MaxUnavailableStatefulSet feature. The field applies to all pods in the range 0 to
|
|
// Replicas-1. That means if there is any unavailable pod in the range 0 to Replicas-1, it
|
|
// will be counted towards MaxUnavailable.
|
|
// +optional
|
|
MaxUnavailable *intstr.IntOrString `json:"maxUnavailable,omitempty" protobuf:"varint,2,opt,name=maxUnavailable"`
|
|
}
|
|
|
|
// PersistentVolumeClaimRetentionPolicyType is a string enumeration of the policies that will determine
|
|
// when volumes from the VolumeClaimTemplates will be deleted when the controlling StatefulSet is
|
|
// deleted or scaled down.
|
|
type PersistentVolumeClaimRetentionPolicyType string
|
|
|
|
const (
|
|
// RetainPersistentVolumeClaimRetentionPolicyType is the default
|
|
// PersistentVolumeClaimRetentionPolicy and specifies that
|
|
// PersistentVolumeClaims associated with StatefulSet VolumeClaimTemplates
|
|
// will not be deleted.
|
|
RetainPersistentVolumeClaimRetentionPolicyType PersistentVolumeClaimRetentionPolicyType = "Retain"
|
|
// RetentionPersistentVolumeClaimRetentionPolicyType specifies that
|
|
// PersistentVolumeClaims associated with StatefulSet VolumeClaimTemplates
|
|
// will be deleted in the scenario specified in
|
|
// StatefulSetPersistentVolumeClaimRetentionPolicy.
|
|
RetentionPersistentVolumeClaimRetentionPolicyType PersistentVolumeClaimRetentionPolicyType = "Delete"
|
|
)
|
|
|
|
// StatefulSetPersistentVolumeClaimRetentionPolicy describes the policy used for PVCs
|
|
// created from the StatefulSet VolumeClaimTemplates.
|
|
type StatefulSetPersistentVolumeClaimRetentionPolicy struct {
|
|
// 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.
|
|
WhenDeleted PersistentVolumeClaimRetentionPolicyType `json:"whenDeleted,omitempty" protobuf:"bytes,1,opt,name=whenDeleted,casttype=PersistentVolumeClaimRetentionPolicyType"`
|
|
// 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.
|
|
WhenScaled PersistentVolumeClaimRetentionPolicyType `json:"whenScaled,omitempty" protobuf:"bytes,2,opt,name=whenScaled,casttype=PersistentVolumeClaimRetentionPolicyType"`
|
|
}
|
|
|
|
// StatefulSetOrdinals describes the policy used for replica ordinal assignment
|
|
// in this StatefulSet.
|
|
type StatefulSetOrdinals struct {
|
|
// start is the number representing the first replica's index. It may be used
|
|
// to number replicas from an alternate index (eg: 1-indexed) over the default
|
|
// 0-indexed names, or to orchestrate progressive movement of replicas from
|
|
// one StatefulSet to another.
|
|
// If set, replica indices will be in the range:
|
|
// [.spec.ordinals.start, .spec.ordinals.start + .spec.replicas).
|
|
// If unset, defaults to 0. Replica indices will be in the range:
|
|
// [0, .spec.replicas).
|
|
// +optional
|
|
Start int32 `json:"start" protobuf:"varint,1,opt,name=start"`
|
|
}
|
|
|
|
// 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.
|
|
// If empty, defaulted to labels on the pod template.
|
|
// More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors
|
|
// +optional
|
|
Selector *metav1.LabelSelector `json:"selector,omitempty" 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. Each pod will be named with the format
|
|
// <statefulsetname>-<podindex>. For example, a pod in a StatefulSet named
|
|
// "web" with index number "3" would be named "web-3".
|
|
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
|
|
// +listType=atomic
|
|
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"`
|
|
|
|
// minReadySeconds is the 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,9,opt,name=minReadySeconds"`
|
|
|
|
// 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
|
|
PersistentVolumeClaimRetentionPolicy *StatefulSetPersistentVolumeClaimRetentionPolicy `json:"persistentVolumeClaimRetentionPolicy,omitempty" protobuf:"bytes,10,opt,name=persistentVolumeClaimRetentionPolicy"`
|
|
|
|
// ordinals controls the numbering of replica indices in a StatefulSet. The
|
|
// default ordinals behavior assigns a "0" index to the first replica and
|
|
// increments the index by one for each additional replica requested. Using
|
|
// the ordinals field requires the StatefulSetStartOrdinal feature gate to be
|
|
// enabled, which is beta.
|
|
// +optional
|
|
Ordinals *StatefulSetOrdinals `json:"ordinals,omitempty" protobuf:"bytes,11,opt,name=ordinals"`
|
|
}
|
|
|
|
// 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 this StatefulSet controller with 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"`
|
|
|
|
// conditions represent the latest available observations of a statefulset's current state.
|
|
// +optional
|
|
// +patchMergeKey=type
|
|
// +patchStrategy=merge
|
|
// +listType=map
|
|
// +listMapKey=type
|
|
Conditions []StatefulSetCondition `json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,10,rep,name=conditions"`
|
|
|
|
// availableReplicas is the total number of available pods (ready for at least minReadySeconds) targeted by this StatefulSet.
|
|
// +optional
|
|
AvailableReplicas int32 `json:"availableReplicas" protobuf:"varint,11,opt,name=availableReplicas"`
|
|
}
|
|
|
|
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
|
|
// +k8s:prerelease-lifecycle-gen:introduced=1.5
|
|
// +k8s:prerelease-lifecycle-gen:deprecated=1.8
|
|
// +k8s:prerelease-lifecycle-gen:removed=1.16
|
|
// +k8s:prerelease-lifecycle-gen:replacement=apps,v1,StatefulSetList
|
|
|
|
// 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
|
|
// +k8s:prerelease-lifecycle-gen:introduced=1.6
|
|
// +k8s:prerelease-lifecycle-gen:deprecated=1.8
|
|
// +k8s:prerelease-lifecycle-gen:removed=1.16
|
|
// +k8s:prerelease-lifecycle-gen:replacement=apps,v1,Deployment
|
|
|
|
// 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.
|
|
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 {
|
|
// replicas is the 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"`
|
|
|
|
// selector is the label selector for pods. Existing ReplicaSets whose pods are
|
|
// selected by this will be the ones affected by this deployment.
|
|
// +optional
|
|
Selector *metav1.LabelSelector `json:"selector,omitempty" protobuf:"bytes,2,opt,name=selector"`
|
|
|
|
// Template describes the pods that will be created.
|
|
// The only allowed template.spec.restartPolicy value is "Always".
|
|
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"`
|
|
|
|
// minReadySeconds is the 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"`
|
|
|
|
// revisionHistoryLimit is 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
|
|
RevisionHistoryLimit *int32 `json:"revisionHistoryLimit,omitempty" protobuf:"varint,6,opt,name=revisionHistoryLimit"`
|
|
|
|
// paused indicates that the deployment is paused.
|
|
// +optional
|
|
Paused bool `json:"paused,omitempty" protobuf:"varint,7,opt,name=paused"`
|
|
|
|
// DEPRECATED.
|
|
// rollbackTo is the config this deployment is rolling back to. Will be cleared after rollback is done.
|
|
// +optional
|
|
RollbackTo *RollbackConfig `json:"rollbackTo,omitempty" protobuf:"bytes,8,opt,name=rollbackTo"`
|
|
|
|
// progressDeadlineSeconds is 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
|
|
ProgressDeadlineSeconds *int32 `json:"progressDeadlineSeconds,omitempty" protobuf:"varint,9,opt,name=progressDeadlineSeconds"`
|
|
}
|
|
|
|
// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
|
|
// +k8s:prerelease-lifecycle-gen:introduced=1.6
|
|
// +k8s:prerelease-lifecycle-gen:deprecated=1.8
|
|
// +k8s:prerelease-lifecycle-gen:removed=1.16
|
|
// +k8s:prerelease-lifecycle-gen:replacement=apps,v1,DeploymentRollback
|
|
|
|
// DEPRECATED.
|
|
// DeploymentRollback stores the information required to rollback a deployment.
|
|
type DeploymentRollback struct {
|
|
metav1.TypeMeta `json:",inline"`
|
|
// Required: This must match the Name of a deployment.
|
|
Name string `json:"name" protobuf:"bytes,1,opt,name=name"`
|
|
// The annotations to be updated to a deployment
|
|
// +optional
|
|
UpdatedAnnotations map[string]string `json:"updatedAnnotations,omitempty" protobuf:"bytes,2,rep,name=updatedAnnotations"`
|
|
// The config of this deployment rollback.
|
|
RollbackTo RollbackConfig `json:"rollbackTo" protobuf:"bytes,3,opt,name=rollbackTo"`
|
|
}
|
|
|
|
// DEPRECATED.
|
|
type RollbackConfig struct {
|
|
// The revision to rollback to. If set to 0, rollback to the last revision.
|
|
// +optional
|
|
Revision int64 `json:"revision,omitempty" protobuf:"varint,1,opt,name=revision"`
|
|
}
|
|
|
|
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 at most 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 {
|
|
// observedGeneration is the generation observed by the deployment controller.
|
|
// +optional
|
|
ObservedGeneration int64 `json:"observedGeneration,omitempty" protobuf:"varint,1,opt,name=observedGeneration"`
|
|
|
|
// replicas is the 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"`
|
|
|
|
// updatedReplicas is the 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"`
|
|
|
|
// readyReplicas is the number of pods targeted by this Deployment controller with a Ready Condition.
|
|
// +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"`
|
|
|
|
// unavailableReplicas is the 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"`
|
|
|
|
// Conditions represent the latest available observations of a deployment's current state.
|
|
// +patchMergeKey=type
|
|
// +patchStrategy=merge
|
|
// +listType=map
|
|
// +listMapKey=type
|
|
Conditions []DeploymentCondition `json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,6,rep,name=conditions"`
|
|
|
|
// collisionCount is the 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
|
|
// +k8s:prerelease-lifecycle-gen:introduced=1.6
|
|
// +k8s:prerelease-lifecycle-gen:deprecated=1.8
|
|
// +k8s:prerelease-lifecycle-gen:removed=1.16
|
|
// +k8s:prerelease-lifecycle-gen:replacement=apps,v1,DeploymentList
|
|
|
|
// 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"`
|
|
}
|
|
|
|
// +genclient
|
|
// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
|
|
// +k8s:prerelease-lifecycle-gen:introduced=1.7
|
|
// +k8s:prerelease-lifecycle-gen:deprecated=1.8
|
|
// +k8s:prerelease-lifecycle-gen:removed=1.16
|
|
// +k8s:prerelease-lifecycle-gen:replacement=apps,v1,ControllerRevision
|
|
|
|
// 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.
|
|
type ControllerRevision struct {
|
|
metav1.TypeMeta `json:",inline"`
|
|
// Standard object's metadata.
|
|
// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/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
|
|
// +k8s:prerelease-lifecycle-gen:introduced=1.7
|
|
// +k8s:prerelease-lifecycle-gen:deprecated=1.8
|
|
// +k8s:prerelease-lifecycle-gen:removed=1.16
|
|
// +k8s:prerelease-lifecycle-gen:replacement=apps,v1,ControllerRevisionList
|
|
|
|
// 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/sig-architecture/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"`
|
|
}
|