Documentation ¶
Index ¶
- Constants
- Variables
- type ControllerRevision
- type ControllerRevisionList
- type DaemonSet
- type DaemonSetCondition
- type DaemonSetList
- type DaemonSetSpec
- type DaemonSetStatus
- type DaemonSetUpdateStrategy
- type DaemonSetUpdateStrategyType
- type Deployment
- type DeploymentCondition
- type DeploymentConditionType
- type DeploymentList
- type DeploymentSpec
- type DeploymentStatus
- type DeploymentStrategy
- type DeploymentStrategyType
- type PersistentVolumeClaimRetentionPolicyType
- type PodManagementPolicyType
- type ReplicaSet
- type ReplicaSetCondition
- type ReplicaSetConditionType
- type ReplicaSetList
- type ReplicaSetSpec
- type ReplicaSetStatus
- type RollingUpdateDaemonSet
- type RollingUpdateDeployment
- type RollingUpdateStatefulSetStrategy
- type StatefulSet
- type StatefulSetCondition
- type StatefulSetList
- type StatefulSetOrdinals
- type StatefulSetPersistentVolumeClaimRetentionPolicy
- type StatefulSetSpec
- type StatefulSetStatus
- type StatefulSetUpdateStrategy
- type StatefulSetUpdateStrategyType
Constants ¶
View Source
const GroupName = "apps"
Variables ¶
View Source
var ( GroupVersion = metav1.GroupVersion{Group: GroupName, Version: "v1"} SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes) AddToScheme = SchemeBuilder.AddToScheme SchemaGroupVersion = schema.GroupVersion{Group: GroupName, Version: "v1"} )
Functions ¶
This section is empty.
Types ¶
type ControllerRevision ¶
type ControllerRevision struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata"` // Data is the serialized representation of the state. Data *runtime.RawExtension `json:"data,omitempty"` // Revision indicates the revision of the state represented by Data. Revision int64 `json:"revision"` }
func (*ControllerRevision) DeepCopy ¶
func (in *ControllerRevision) DeepCopy() *ControllerRevision
func (*ControllerRevision) DeepCopyInto ¶
func (in *ControllerRevision) DeepCopyInto(out *ControllerRevision)
func (*ControllerRevision) DeepCopyObject ¶
func (in *ControllerRevision) DeepCopyObject() runtime.Object
type ControllerRevisionList ¶
type ControllerRevisionList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata"` Items []ControllerRevision `json:"items"` }
func (*ControllerRevisionList) DeepCopy ¶
func (in *ControllerRevisionList) DeepCopy() *ControllerRevisionList
func (*ControllerRevisionList) DeepCopyInto ¶
func (in *ControllerRevisionList) DeepCopyInto(out *ControllerRevisionList)
func (*ControllerRevisionList) DeepCopyObject ¶
func (in *ControllerRevisionList) DeepCopyObject() runtime.Object
type DaemonSet ¶
type DaemonSet struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata"` // The desired behavior of this daemon set. // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status Spec *DaemonSetSpec `json:"spec,omitempty"` // 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/sig-architecture/api-conventions.md#spec-and-status Status *DaemonSetStatus `json:"status,omitempty"` }
func (*DaemonSet) DeepCopyInto ¶
func (*DaemonSet) DeepCopyObject ¶
type DaemonSetCondition ¶
type DaemonSetCondition struct { // Type of DaemonSet condition. Type string `json:"type"` // Status of the condition, one of True, False, Unknown. Status corev1.ConditionStatus `json:"status"` // Last time the condition transitioned from one status to another. LastTransitionTime *metav1.Time `json:"lastTransitionTime,omitempty"` // The reason for the condition's last transition. Reason string `json:"reason,omitempty"` // A human readable message indicating details about the transition. Message string `json:"message,omitempty"` }
func (*DaemonSetCondition) DeepCopy ¶
func (in *DaemonSetCondition) DeepCopy() *DaemonSetCondition
func (*DaemonSetCondition) DeepCopyInto ¶
func (in *DaemonSetCondition) DeepCopyInto(out *DaemonSetCondition)
type DaemonSetList ¶
type DaemonSetList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata"` Items []DaemonSet `json:"items"` }
func (*DaemonSetList) DeepCopy ¶
func (in *DaemonSetList) DeepCopy() *DaemonSetList
func (*DaemonSetList) DeepCopyInto ¶
func (in *DaemonSetList) DeepCopyInto(out *DaemonSetList)
func (*DaemonSetList) DeepCopyObject ¶
func (in *DaemonSetList) DeepCopyObject() runtime.Object
type DaemonSetSpec ¶
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,omitempty"` // 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). // The only allowed template.spec.restartPolicy value is "Always". // More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller#pod-template Template corev1.PodTemplateSpec `json:"template"` // An update strategy to replace existing DaemonSet pods with new pods. UpdateStrategy *DaemonSetUpdateStrategy `json:"updateStrategy,omitempty"` // 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). MinReadySeconds int `json:"minReadySeconds,omitempty"` // 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. RevisionHistoryLimit int `json:"revisionHistoryLimit,omitempty"` }
func (*DaemonSetSpec) DeepCopy ¶
func (in *DaemonSetSpec) DeepCopy() *DaemonSetSpec
func (*DaemonSetSpec) DeepCopyInto ¶
func (in *DaemonSetSpec) DeepCopyInto(out *DaemonSetSpec)
type DaemonSetStatus ¶
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 int `json:"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 int `json:"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 int `json:"desiredNumberScheduled"` // numberReady is the number of nodes that should be running the daemon pod and have one // or more of the daemon pod running with a Ready Condition. NumberReady int `json:"numberReady"` // The most recent generation observed by the daemon set controller. ObservedGeneration int64 `json:"observedGeneration,omitempty"` // The total number of nodes that are running updated daemon pod UpdatedNumberScheduled int `json:"updatedNumberScheduled,omitempty"` // 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) NumberAvailable int `json:"numberAvailable,omitempty"` // daemon pod and have none of the daemon pod running and available // (ready for at least spec.minReadySeconds) NumberUnavailable int `json:"numberUnavailable,omitempty"` // 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. CollisionCount int `json:"collisionCount,omitempty"` // Represents the latest available observations of a DaemonSet's current state. Conditions []DaemonSetCondition `json:"conditions"` }
func (*DaemonSetStatus) DeepCopy ¶
func (in *DaemonSetStatus) DeepCopy() *DaemonSetStatus
func (*DaemonSetStatus) DeepCopyInto ¶
func (in *DaemonSetStatus) DeepCopyInto(out *DaemonSetStatus)
type DaemonSetUpdateStrategy ¶
type DaemonSetUpdateStrategy struct { // Type of daemon set update. Can be "RollingUpdate" or "OnDelete". Default is RollingUpdate. Type DaemonSetUpdateStrategyType `json:"type,omitempty"` // Rolling update config params. Present only if type = "RollingUpdate". // --- // to be. Same as Deployment `strategy.rollingUpdate`. // See https://github.com/kubernetes/kubernetes/issues/35345 RollingUpdate *RollingUpdateDaemonSet `json:"rollingUpdate,omitempty"` }
func (*DaemonSetUpdateStrategy) DeepCopy ¶
func (in *DaemonSetUpdateStrategy) DeepCopy() *DaemonSetUpdateStrategy
func (*DaemonSetUpdateStrategy) DeepCopyInto ¶
func (in *DaemonSetUpdateStrategy) DeepCopyInto(out *DaemonSetUpdateStrategy)
type DaemonSetUpdateStrategyType ¶
type DaemonSetUpdateStrategyType string
const ( DaemonSetUpdateStrategyTypeRollingUpdate DaemonSetUpdateStrategyType = "RollingUpdate" DaemonSetUpdateStrategyTypeOnDelete DaemonSetUpdateStrategyType = "OnDelete" )
type Deployment ¶
type Deployment struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata"` // Specification of the desired behavior of the Deployment. Spec *DeploymentSpec `json:"spec,omitempty"` // Most recently observed status of the Deployment. Status *DeploymentStatus `json:"status,omitempty"` }
func (*Deployment) DeepCopy ¶
func (in *Deployment) DeepCopy() *Deployment
func (*Deployment) DeepCopyInto ¶
func (in *Deployment) DeepCopyInto(out *Deployment)
func (*Deployment) DeepCopyObject ¶
func (in *Deployment) DeepCopyObject() runtime.Object
type DeploymentCondition ¶
type DeploymentCondition struct { // Type of deployment condition. Type DeploymentConditionType `json:"type"` // Status of the condition, one of True, False, Unknown. Status corev1.ConditionStatus `json:"status"` // The last time this condition was updated. LastUpdateTime *metav1.Time `json:"lastUpdateTime,omitempty"` // Last time the condition transitioned from one status to another. LastTransitionTime *metav1.Time `json:"lastTransitionTime,omitempty"` // The reason for the condition's last transition. Reason string `json:"reason,omitempty"` // A human readable message indicating details about the transition. Message string `json:"message,omitempty"` }
func (*DeploymentCondition) DeepCopy ¶
func (in *DeploymentCondition) DeepCopy() *DeploymentCondition
func (*DeploymentCondition) DeepCopyInto ¶
func (in *DeploymentCondition) DeepCopyInto(out *DeploymentCondition)
type DeploymentConditionType ¶
type DeploymentConditionType string
const ( DeploymentConditionTypeAvailable DeploymentConditionType = "Available" DeploymentConditionTypeProgressing DeploymentConditionType = "Progressing" DeploymentConditionTypeReplicaFailure DeploymentConditionType = "ReplicaFailure" )
type DeploymentList ¶
type DeploymentList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata"` Items []Deployment `json:"items"` }
func (*DeploymentList) DeepCopy ¶
func (in *DeploymentList) DeepCopy() *DeploymentList
func (*DeploymentList) DeepCopyInto ¶
func (in *DeploymentList) DeepCopyInto(out *DeploymentList)
func (*DeploymentList) DeepCopyObject ¶
func (in *DeploymentList) DeepCopyObject() runtime.Object
type DeploymentSpec ¶
type DeploymentSpec struct { // Number of desired pods. This is a pointer to distinguish between explicit // zero and not specified. Defaults to 1. Replicas int `json:"replicas,omitempty"` // 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,omitempty"` // Template describes the pods that will be created. // The only allowed template.spec.restartPolicy value is "Always". Template corev1.PodTemplateSpec `json:"template"` // The deployment strategy to use to replace existing pods with new ones. Strategy *DeploymentStrategy `json:"strategy,omitempty"` // 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) MinReadySeconds int `json:"minReadySeconds,omitempty"` // 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. RevisionHistoryLimit int `json:"revisionHistoryLimit,omitempty"` // Indicates that the deployment is paused. Paused bool `json:"paused,omitempty"` // 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 int `json:"progressDeadlineSeconds,omitempty"` }
func (*DeploymentSpec) DeepCopy ¶
func (in *DeploymentSpec) DeepCopy() *DeploymentSpec
func (*DeploymentSpec) DeepCopyInto ¶
func (in *DeploymentSpec) DeepCopyInto(out *DeploymentSpec)
type DeploymentStatus ¶
type DeploymentStatus struct { // The generation observed by the deployment controller. ObservedGeneration int64 `json:"observedGeneration,omitempty"` // Total number of non-terminated pods targeted by this deployment (their labels match the selector). Replicas int `json:"replicas,omitempty"` // Total number of non-terminated pods targeted by this deployment that have the desired template spec. UpdatedReplicas int `json:"updatedReplicas,omitempty"` // readyReplicas is the number of pods targeted by this Deployment with a Ready Condition. ReadyReplicas int `json:"readyReplicas,omitempty"` // Total number of available pods (ready for at least minReadySeconds) targeted by this deployment. AvailableReplicas int `json:"availableReplicas,omitempty"` // 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. UnavailableReplicas int `json:"unavailableReplicas,omitempty"` // Represents the latest available observations of a deployment's current state. Conditions []DeploymentCondition `json:"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. CollisionCount int `json:"collisionCount,omitempty"` }
func (*DeploymentStatus) DeepCopy ¶
func (in *DeploymentStatus) DeepCopy() *DeploymentStatus
func (*DeploymentStatus) DeepCopyInto ¶
func (in *DeploymentStatus) DeepCopyInto(out *DeploymentStatus)
type DeploymentStrategy ¶
type DeploymentStrategy struct { // Type of deployment. Can be "Recreate" or "RollingUpdate". Default is RollingUpdate. Type DeploymentStrategyType `json:"type,omitempty"` // Rolling update config params. Present only if DeploymentStrategyType = // RollingUpdate. // --- // to be. RollingUpdate *RollingUpdateDeployment `json:"rollingUpdate,omitempty"` }
func (*DeploymentStrategy) DeepCopy ¶
func (in *DeploymentStrategy) DeepCopy() *DeploymentStrategy
func (*DeploymentStrategy) DeepCopyInto ¶
func (in *DeploymentStrategy) DeepCopyInto(out *DeploymentStrategy)
type DeploymentStrategyType ¶
type DeploymentStrategyType string
const ( DeploymentStrategyTypeRecreate DeploymentStrategyType = "Recreate" DeploymentStrategyTypeRollingUpdate DeploymentStrategyType = "RollingUpdate" )
type PersistentVolumeClaimRetentionPolicyType ¶
type PersistentVolumeClaimRetentionPolicyType string
const ( PersistentVolumeClaimRetentionPolicyTypeRetain PersistentVolumeClaimRetentionPolicyType = "Retain" PersistentVolumeClaimRetentionPolicyTypeDelete PersistentVolumeClaimRetentionPolicyType = "Delete" )
type PodManagementPolicyType ¶
type PodManagementPolicyType string
const ( PodManagementPolicyTypeOrderedReady PodManagementPolicyType = "OrderedReady" PodManagementPolicyTypeParallel PodManagementPolicyType = "Parallel" )
type ReplicaSet ¶
type ReplicaSet struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata"` // Spec defines the specification of the desired behavior of the ReplicaSet. // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status Spec *ReplicaSetSpec `json:"spec,omitempty"` // 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/sig-architecture/api-conventions.md#spec-and-status Status *ReplicaSetStatus `json:"status,omitempty"` }
func (*ReplicaSet) DeepCopy ¶
func (in *ReplicaSet) DeepCopy() *ReplicaSet
func (*ReplicaSet) DeepCopyInto ¶
func (in *ReplicaSet) DeepCopyInto(out *ReplicaSet)
func (*ReplicaSet) DeepCopyObject ¶
func (in *ReplicaSet) DeepCopyObject() runtime.Object
type ReplicaSetCondition ¶
type ReplicaSetCondition struct { // Type of replica set condition. Type ReplicaSetConditionType `json:"type"` // Status of the condition, one of True, False, Unknown. Status corev1.ConditionStatus `json:"status"` // The last time the condition transitioned from one status to another. LastTransitionTime *metav1.Time `json:"lastTransitionTime,omitempty"` // The reason for the condition's last transition. Reason string `json:"reason,omitempty"` // A human readable message indicating details about the transition. Message string `json:"message,omitempty"` }
func (*ReplicaSetCondition) DeepCopy ¶
func (in *ReplicaSetCondition) DeepCopy() *ReplicaSetCondition
func (*ReplicaSetCondition) DeepCopyInto ¶
func (in *ReplicaSetCondition) DeepCopyInto(out *ReplicaSetCondition)
type ReplicaSetConditionType ¶
type ReplicaSetConditionType string
const (
ReplicaSetConditionTypeReplicaFailure ReplicaSetConditionType = "ReplicaFailure"
)
type ReplicaSetList ¶
type ReplicaSetList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata"` Items []ReplicaSet `json:"items"` }
func (*ReplicaSetList) DeepCopy ¶
func (in *ReplicaSetList) DeepCopy() *ReplicaSetList
func (*ReplicaSetList) DeepCopyInto ¶
func (in *ReplicaSetList) DeepCopyInto(out *ReplicaSetList)
func (*ReplicaSetList) DeepCopyObject ¶
func (in *ReplicaSetList) DeepCopyObject() runtime.Object
type ReplicaSetSpec ¶
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 Replicas int `json:"replicas,omitempty"` // 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) MinReadySeconds int `json:"minReadySeconds,omitempty"` // 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,omitempty"` // 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 Template *corev1.PodTemplateSpec `json:"template,omitempty"` }
func (*ReplicaSetSpec) DeepCopy ¶
func (in *ReplicaSetSpec) DeepCopy() *ReplicaSetSpec
func (*ReplicaSetSpec) DeepCopyInto ¶
func (in *ReplicaSetSpec) DeepCopyInto(out *ReplicaSetSpec)
type ReplicaSetStatus ¶
type ReplicaSetStatus struct { // Replicas is the most recently observed number of replicas. // More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller/#what-is-a-replicationcontroller Replicas int `json:"replicas"` // The number of pods that have labels matching the labels of the pod template of the replicaset. FullyLabeledReplicas int `json:"fullyLabeledReplicas,omitempty"` // readyReplicas is the number of pods targeted by this ReplicaSet with a Ready Condition. ReadyReplicas int `json:"readyReplicas,omitempty"` // The number of available replicas (ready for at least minReadySeconds) for this replica set. AvailableReplicas int `json:"availableReplicas,omitempty"` // ObservedGeneration reflects the generation of the most recently observed ReplicaSet. ObservedGeneration int64 `json:"observedGeneration,omitempty"` // Represents the latest available observations of a replica set's current state. Conditions []ReplicaSetCondition `json:"conditions"` }
func (*ReplicaSetStatus) DeepCopy ¶
func (in *ReplicaSetStatus) DeepCopy() *ReplicaSetStatus
func (*ReplicaSetStatus) DeepCopyInto ¶
func (in *ReplicaSetStatus) DeepCopyInto(out *ReplicaSetStatus)
type RollingUpdateDaemonSet ¶
type RollingUpdateDaemonSet struct { // 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 if MaxSurge is 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. MaxUnavailable *utilintstr.IntOrString `json:"maxUnavailable,omitempty"` // The maximum number of nodes with an existing available DaemonSet pod that // can have an updated DaemonSet pod during during an update. // 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 to a minimum of 1. // Default value is 0. // 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 a new pod created before the old pod is marked as deleted. // The update starts by launching new pods on 30% of nodes. Once an updated // pod is available (Ready for at least minReadySeconds) the old DaemonSet pod // on that node is marked deleted. If the old pod becomes unavailable for any // reason (Ready transitions to false, is evicted, or is drained) an updated // pod is immediatedly created on that node without considering surge limits. // Allowing surge implies the possibility that the resources consumed by the // daemonset on any given node can double if the readiness check fails, and // so resource intensive daemonsets should take into account that they may // cause evictions during disruption. MaxSurge *utilintstr.IntOrString `json:"maxSurge,omitempty"` }
func (*RollingUpdateDaemonSet) DeepCopy ¶
func (in *RollingUpdateDaemonSet) DeepCopy() *RollingUpdateDaemonSet
func (*RollingUpdateDaemonSet) DeepCopyInto ¶
func (in *RollingUpdateDaemonSet) DeepCopyInto(out *RollingUpdateDaemonSet)
type RollingUpdateDeployment ¶
type RollingUpdateDeployment struct { // 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. MaxUnavailable *utilintstr.IntOrString `json:"maxUnavailable,omitempty"` // 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. MaxSurge *utilintstr.IntOrString `json:"maxSurge,omitempty"` }
func (*RollingUpdateDeployment) DeepCopy ¶
func (in *RollingUpdateDeployment) DeepCopy() *RollingUpdateDeployment
func (*RollingUpdateDeployment) DeepCopyInto ¶
func (in *RollingUpdateDeployment) DeepCopyInto(out *RollingUpdateDeployment)
type RollingUpdateStatefulSetStrategy ¶
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 int `json:"partition,omitempty"` // 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. MaxUnavailable *utilintstr.IntOrString `json:"maxUnavailable,omitempty"` }
func (*RollingUpdateStatefulSetStrategy) DeepCopy ¶
func (in *RollingUpdateStatefulSetStrategy) DeepCopy() *RollingUpdateStatefulSetStrategy
func (*RollingUpdateStatefulSetStrategy) DeepCopyInto ¶
func (in *RollingUpdateStatefulSetStrategy) DeepCopyInto(out *RollingUpdateStatefulSetStrategy)
type StatefulSet ¶
type StatefulSet struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata"` // Spec defines the desired identities of pods in this set. Spec *StatefulSetSpec `json:"spec,omitempty"` // Status is the current status of Pods in this StatefulSet. This data // may be out of date by some window of time. Status *StatefulSetStatus `json:"status,omitempty"` }
func (*StatefulSet) DeepCopy ¶
func (in *StatefulSet) DeepCopy() *StatefulSet
func (*StatefulSet) DeepCopyInto ¶
func (in *StatefulSet) DeepCopyInto(out *StatefulSet)
func (*StatefulSet) DeepCopyObject ¶
func (in *StatefulSet) DeepCopyObject() runtime.Object
type StatefulSetCondition ¶
type StatefulSetCondition struct { // Type of statefulset condition. Type string `json:"type"` // Status of the condition, one of True, False, Unknown. Status corev1.ConditionStatus `json:"status"` // Last time the condition transitioned from one status to another. LastTransitionTime *metav1.Time `json:"lastTransitionTime,omitempty"` // The reason for the condition's last transition. Reason string `json:"reason,omitempty"` // A human readable message indicating details about the transition. Message string `json:"message,omitempty"` }
func (*StatefulSetCondition) DeepCopy ¶
func (in *StatefulSetCondition) DeepCopy() *StatefulSetCondition
func (*StatefulSetCondition) DeepCopyInto ¶
func (in *StatefulSetCondition) DeepCopyInto(out *StatefulSetCondition)
type StatefulSetList ¶
type StatefulSetList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata"` Items []StatefulSet `json:"items"` }
func (*StatefulSetList) DeepCopy ¶
func (in *StatefulSetList) DeepCopy() *StatefulSetList
func (*StatefulSetList) DeepCopyInto ¶
func (in *StatefulSetList) DeepCopyInto(out *StatefulSetList)
func (*StatefulSetList) DeepCopyObject ¶
func (in *StatefulSetList) DeepCopyObject() runtime.Object
type StatefulSetOrdinals ¶
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). Start int `json:"start"` }
func (*StatefulSetOrdinals) DeepCopy ¶
func (in *StatefulSetOrdinals) DeepCopy() *StatefulSetOrdinals
func (*StatefulSetOrdinals) DeepCopyInto ¶
func (in *StatefulSetOrdinals) DeepCopyInto(out *StatefulSetOrdinals)
type StatefulSetPersistentVolumeClaimRetentionPolicy ¶
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"` // 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"` }
func (*StatefulSetPersistentVolumeClaimRetentionPolicy) DeepCopy ¶
func (in *StatefulSetPersistentVolumeClaimRetentionPolicy) DeepCopy() *StatefulSetPersistentVolumeClaimRetentionPolicy
func (*StatefulSetPersistentVolumeClaimRetentionPolicy) DeepCopyInto ¶
func (in *StatefulSetPersistentVolumeClaimRetentionPolicy) DeepCopyInto(out *StatefulSetPersistentVolumeClaimRetentionPolicy)
type StatefulSetSpec ¶
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. Replicas int `json:"replicas,omitempty"` // 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,omitempty"` // 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". // The only allowed template.spec.restartPolicy value is "Always". Template corev1.PodTemplateSpec `json:"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. VolumeClaimTemplates []corev1.PersistentVolumeClaim `json:"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"` // 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. PodManagementPolicy PodManagementPolicyType `json:"podManagementPolicy,omitempty"` // 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"` // 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 int `json:"revisionHistoryLimit,omitempty"` // 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) MinReadySeconds int `json:"minReadySeconds,omitempty"` // persistentVolumeClaimRetentionPolicy describes the lifecycle of persistent // volume claims created from volumeClaimTemplates. By default, all persistent // volume claims are created as needed and retained until manually deleted. This // policy allows the lifecycle to be altered, for example by deleting persistent // volume claims when their stateful set is deleted, or when their pod is scaled // down. PersistentVolumeClaimRetentionPolicy *StatefulSetPersistentVolumeClaimRetentionPolicy `json:"persistentVolumeClaimRetentionPolicy,omitempty"` // 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. Ordinals *StatefulSetOrdinals `json:"ordinals,omitempty"` }
func (*StatefulSetSpec) DeepCopy ¶
func (in *StatefulSetSpec) DeepCopy() *StatefulSetSpec
func (*StatefulSetSpec) DeepCopyInto ¶
func (in *StatefulSetSpec) DeepCopyInto(out *StatefulSetSpec)
type StatefulSetStatus ¶
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. ObservedGeneration int64 `json:"observedGeneration,omitempty"` // replicas is the number of Pods created by the StatefulSet controller. Replicas int `json:"replicas"` // readyReplicas is the number of pods created for this StatefulSet with a Ready Condition. ReadyReplicas int `json:"readyReplicas,omitempty"` // currentReplicas is the number of Pods created by the StatefulSet controller from the StatefulSet version // indicated by currentRevision. CurrentReplicas int `json:"currentReplicas,omitempty"` // updatedReplicas is the number of Pods created by the StatefulSet controller from the StatefulSet version // indicated by updateRevision. UpdatedReplicas int `json:"updatedReplicas,omitempty"` // currentRevision, if not empty, indicates the version of the StatefulSet used to generate Pods in the // sequence [0,currentReplicas). CurrentRevision string `json:"currentRevision,omitempty"` // 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"` // 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. CollisionCount int `json:"collisionCount,omitempty"` // Represents the latest available observations of a statefulset's current state. Conditions []StatefulSetCondition `json:"conditions"` // Total number of available pods (ready for at least minReadySeconds) targeted by this statefulset. AvailableReplicas int `json:"availableReplicas"` }
func (*StatefulSetStatus) DeepCopy ¶
func (in *StatefulSetStatus) DeepCopy() *StatefulSetStatus
func (*StatefulSetStatus) DeepCopyInto ¶
func (in *StatefulSetStatus) DeepCopyInto(out *StatefulSetStatus)
type StatefulSetUpdateStrategy ¶
type StatefulSetUpdateStrategy struct { // Type indicates the type of the StatefulSetUpdateStrategy. // Default is RollingUpdate. Type StatefulSetUpdateStrategyType `json:"type,omitempty"` // RollingUpdate is used to communicate parameters when Type is RollingUpdateStatefulSetStrategyType. RollingUpdate *RollingUpdateStatefulSetStrategy `json:"rollingUpdate,omitempty"` }
func (*StatefulSetUpdateStrategy) DeepCopy ¶
func (in *StatefulSetUpdateStrategy) DeepCopy() *StatefulSetUpdateStrategy
func (*StatefulSetUpdateStrategy) DeepCopyInto ¶
func (in *StatefulSetUpdateStrategy) DeepCopyInto(out *StatefulSetUpdateStrategy)
type StatefulSetUpdateStrategyType ¶
type StatefulSetUpdateStrategyType string
const ( StatefulSetUpdateStrategyTypeRollingUpdate StatefulSetUpdateStrategyType = "RollingUpdate" StatefulSetUpdateStrategyTypeOnDelete StatefulSetUpdateStrategyType = "OnDelete" )
Click to show internal directories.
Click to hide internal directories.