Skip to content

apps_v1

ControllerRevision

class lightkube.models.apps_v1.ControllerRevision(revision, apiVersion=None, data=None, kind=None, metadata=None)

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.

parameters

  • revision int - Revision indicates the revision of the state represented by Data.
  • apiVersion str - (optional) APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info
  • data runtime.RawExtension - (optional) Data is the serialized representation of the state.
  • kind str - (optional) Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info
  • metadata meta_v1.ObjectMeta - (optional) Standard object's metadata. More info

ControllerRevisionList

class lightkube.models.apps_v1.ControllerRevisionList(items, apiVersion=None, kind=None, metadata=None)

ControllerRevisionList is a resource containing a list of ControllerRevision objects.

parameters

  • items ControllerRevision - Items is the list of ControllerRevisions
  • apiVersion str - (optional) APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info
  • kind str - (optional) Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info
  • metadata meta_v1.ListMeta - (optional) More info

DaemonSet

class lightkube.models.apps_v1.DaemonSet(apiVersion=None, kind=None, metadata=None, spec=None, status=None)

DaemonSet represents the configuration of a daemon set.

parameters

  • apiVersion str - (optional) APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info
  • kind str - (optional) Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info
  • metadata meta_v1.ObjectMeta - (optional) Standard object's metadata. More info
  • spec DaemonSetSpec - (optional) The desired behavior of this daemon set. More info
  • status DaemonSetStatus - (optional) 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

DaemonSetCondition

class lightkube.models.apps_v1.DaemonSetCondition(status, type, lastTransitionTime=None, message=None, reason=None)

DaemonSetCondition describes the state of a DaemonSet at a certain point.

parameters

  • status str - Status of the condition, one of True, False, Unknown.
  • type str - Type of DaemonSet condition.
  • lastTransitionTime meta_v1.Time - (optional) Last time the condition transitioned from one status to another.
  • message str - (optional) A human readable message indicating details about the transition.
  • reason str - (optional) The reason for the condition's last transition.

DaemonSetList

class lightkube.models.apps_v1.DaemonSetList(items, apiVersion=None, kind=None, metadata=None)

DaemonSetList is a collection of daemon sets.

parameters

  • items DaemonSet - A list of daemon sets.
  • apiVersion str - (optional) APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info
  • kind str - (optional) Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info
  • metadata meta_v1.ListMeta - (optional) Standard list metadata. More info

DaemonSetSpec

class lightkube.models.apps_v1.DaemonSetSpec(selector, template, minReadySeconds=None, revisionHistoryLimit=None, updateStrategy=None)

DaemonSetSpec is the specification of a daemon set.

parameters

  • selector meta_v1.LabelSelector - 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
  • template core_v1.PodTemplateSpec - 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
  • minReadySeconds int - (optional) 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).
  • revisionHistoryLimit int - (optional) 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.
  • updateStrategy DaemonSetUpdateStrategy - (optional) An update strategy to replace existing DaemonSet pods with new pods.

DaemonSetStatus

class lightkube.models.apps_v1.DaemonSetStatus(currentNumberScheduled, desiredNumberScheduled, numberMisscheduled, numberReady, collisionCount=None, conditions=None, numberAvailable=None, numberUnavailable=None, observedGeneration=None, updatedNumberScheduled=None)

DaemonSetStatus represents the current status of a daemon set.

parameters

  • currentNumberScheduled int - The number of nodes that are running at least 1 daemon pod and are supposed to run the daemon pod. More info
  • desiredNumberScheduled int - The total number of nodes that should be running the daemon pod (including nodes correctly running the daemon pod). More info
  • numberMisscheduled int - The number of nodes that are running the daemon pod, but are not supposed to run the daemon pod. More info
  • numberReady int - 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.
  • collisionCount int - (optional) 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.
  • conditions DaemonSetCondition - (optional) Represents the latest available observations of a DaemonSet's current state.
  • numberAvailable int - (optional) 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)
  • numberUnavailable int - (optional) 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)
  • observedGeneration int - (optional) The most recent generation observed by the daemon set controller.
  • updatedNumberScheduled int - (optional) The total number of nodes that are running updated daemon pod

DaemonSetUpdateStrategy

class lightkube.models.apps_v1.DaemonSetUpdateStrategy(rollingUpdate=None, type=None)

DaemonSetUpdateStrategy is a struct used to control the update strategy for a DaemonSet.

parameters

  • rollingUpdate RollingUpdateDaemonSet - (optional) Rolling update config params. Present only if type = "RollingUpdate".
  • type str - (optional) Type of daemon set update. Can be "RollingUpdate" or "OnDelete". Default is RollingUpdate.

Deployment

class lightkube.models.apps_v1.Deployment(apiVersion=None, kind=None, metadata=None, spec=None, status=None)

Deployment enables declarative updates for Pods and ReplicaSets.

parameters

  • apiVersion str - (optional) APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info
  • kind str - (optional) Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info
  • metadata meta_v1.ObjectMeta - (optional) Standard object's metadata. More info
  • spec DeploymentSpec - (optional) Specification of the desired behavior of the Deployment.
  • status DeploymentStatus - (optional) Most recently observed status of the Deployment.

DeploymentCondition

class lightkube.models.apps_v1.DeploymentCondition(status, type, lastTransitionTime=None, lastUpdateTime=None, message=None, reason=None)

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

parameters

  • status str - Status of the condition, one of True, False, Unknown.
  • type str - Type of deployment condition.
  • lastTransitionTime meta_v1.Time - (optional) Last time the condition transitioned from one status to another.
  • lastUpdateTime meta_v1.Time - (optional) The last time this condition was updated.
  • message str - (optional) A human readable message indicating details about the transition.
  • reason str - (optional) The reason for the condition's last transition.

DeploymentList

class lightkube.models.apps_v1.DeploymentList(items, apiVersion=None, kind=None, metadata=None)

DeploymentList is a list of Deployments.

parameters

  • items Deployment - Items is the list of Deployments.
  • apiVersion str - (optional) APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info
  • kind str - (optional) Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info
  • metadata meta_v1.ListMeta - (optional) Standard list metadata.

DeploymentSpec

class lightkube.models.apps_v1.DeploymentSpec(selector, template, minReadySeconds=None, paused=None, progressDeadlineSeconds=None, replicas=None, revisionHistoryLimit=None, strategy=None)

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

parameters

  • selector meta_v1.LabelSelector - 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.
  • template core_v1.PodTemplateSpec - Template describes the pods that will be created.
  • minReadySeconds int - (optional) 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)
  • paused bool - (optional) Indicates that the deployment is paused.
  • progressDeadlineSeconds int - (optional) 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.
  • replicas int - (optional) Number of desired pods. This is a pointer to distinguish between explicit zero and not specified. Defaults to 1.
  • revisionHistoryLimit int - (optional) 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.
  • strategy DeploymentStrategy - (optional) The deployment strategy to use to replace existing pods with new ones.

DeploymentStatus

class lightkube.models.apps_v1.DeploymentStatus(availableReplicas=None, collisionCount=None, conditions=None, observedGeneration=None, readyReplicas=None, replicas=None, unavailableReplicas=None, updatedReplicas=None)

DeploymentStatus is the most recently observed status of the Deployment.

parameters

  • availableReplicas int - (optional) Total number of available pods (ready for at least minReadySeconds) targeted by this deployment.
  • collisionCount int - (optional) 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.
  • conditions DeploymentCondition - (optional) Represents the latest available observations of a deployment's current state.
  • observedGeneration int - (optional) The generation observed by the deployment controller.
  • readyReplicas int - (optional) readyReplicas is the number of pods targeted by this Deployment with a Ready Condition.
  • replicas int - (optional) Total number of non-terminated pods targeted by this deployment (their labels match the selector).
  • unavailableReplicas int - (optional) 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.
  • updatedReplicas int - (optional) Total number of non-terminated pods targeted by this deployment that have the desired template spec.

DeploymentStrategy

class lightkube.models.apps_v1.DeploymentStrategy(rollingUpdate=None, type=None)

DeploymentStrategy describes how to replace existing pods with new ones.

parameters

  • rollingUpdate RollingUpdateDeployment - (optional) Rolling update config params. Present only if DeploymentStrategyType = RollingUpdate.
  • type str - (optional) Type of deployment. Can be "Recreate" or "RollingUpdate". Default is RollingUpdate.

ReplicaSet

class lightkube.models.apps_v1.ReplicaSet(apiVersion=None, kind=None, metadata=None, spec=None, status=None)

ReplicaSet ensures that a specified number of pod replicas are running at any given time.

parameters

  • apiVersion str - (optional) APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info
  • kind str - (optional) Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info
  • metadata meta_v1.ObjectMeta - (optional) 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
  • spec ReplicaSetSpec - (optional) Spec defines the specification of the desired behavior of the ReplicaSet. More info
  • status ReplicaSetStatus - (optional) 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

ReplicaSetCondition

class lightkube.models.apps_v1.ReplicaSetCondition(status, type, lastTransitionTime=None, message=None, reason=None)

ReplicaSetCondition describes the state of a replica set at a certain point.

parameters

  • status str - Status of the condition, one of True, False, Unknown.
  • type str - Type of replica set condition.
  • lastTransitionTime meta_v1.Time - (optional) The last time the condition transitioned from one status to another.
  • message str - (optional) A human readable message indicating details about the transition.
  • reason str - (optional) The reason for the condition's last transition.

ReplicaSetList

class lightkube.models.apps_v1.ReplicaSetList(items, apiVersion=None, kind=None, metadata=None)

ReplicaSetList is a collection of ReplicaSets.

parameters

  • items ReplicaSet - List of ReplicaSets. More info
  • apiVersion str - (optional) APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info
  • kind str - (optional) Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info
  • metadata meta_v1.ListMeta - (optional) Standard list metadata. More info

ReplicaSetSpec

class lightkube.models.apps_v1.ReplicaSetSpec(selector, minReadySeconds=None, replicas=None, template=None)

ReplicaSetSpec is the specification of a ReplicaSet.

parameters

  • selector meta_v1.LabelSelector - 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
  • minReadySeconds int - (optional) 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)
  • replicas int - (optional) Replicas is the number of desired replicas. This is a pointer to distinguish between explicit zero and unspecified. Defaults to 1. More info
  • template core_v1.PodTemplateSpec - (optional) Template is the object that describes the pod that will be created if insufficient replicas are detected. More info

ReplicaSetStatus

class lightkube.models.apps_v1.ReplicaSetStatus(replicas, availableReplicas=None, conditions=None, fullyLabeledReplicas=None, observedGeneration=None, readyReplicas=None)

ReplicaSetStatus represents the current status of a ReplicaSet.

parameters

  • replicas int - Replicas is the most recently oberved number of replicas. More info
  • availableReplicas int - (optional) The number of available replicas (ready for at least minReadySeconds) for this replica set.
  • conditions ReplicaSetCondition - (optional) Represents the latest available observations of a replica set's current state.
  • fullyLabeledReplicas int - (optional) The number of pods that have labels matching the labels of the pod template of the replicaset.
  • observedGeneration int - (optional) ObservedGeneration reflects the generation of the most recently observed ReplicaSet.
  • readyReplicas int - (optional) readyReplicas is the number of pods targeted by this ReplicaSet with a Ready Condition.

RollingUpdateDaemonSet

class lightkube.models.apps_v1.RollingUpdateDaemonSet(maxSurge=None, maxUnavailable=None)

Spec to control the desired behavior of daemon set rolling update.

parameters

  • maxSurge util_intstr.IntOrString - (optional) 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. This is beta field and enabled/disabled by DaemonSetUpdateSurge feature gate.
  • maxUnavailable util_intstr.IntOrString - (optional) 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 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.

RollingUpdateDeployment

class lightkube.models.apps_v1.RollingUpdateDeployment(maxSurge=None, maxUnavailable=None)

Spec to control the desired behavior of rolling update.

parameters

  • maxSurge util_intstr.IntOrString - (optional) 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.
  • maxUnavailable util_intstr.IntOrString - (optional) 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.

RollingUpdateStatefulSetStrategy

class lightkube.models.apps_v1.RollingUpdateStatefulSetStrategy(partition=None)

RollingUpdateStatefulSetStrategy is used to communicate parameter for RollingUpdateStatefulSetStrategyType.

parameters

  • partition int - (optional) Partition indicates the ordinal at which the StatefulSet should be partitioned. Default value is 0.

StatefulSet

class lightkube.models.apps_v1.StatefulSet(apiVersion=None, kind=None, metadata=None, spec=None, status=None)

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.

parameters

  • apiVersion str - (optional) APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info
  • kind str - (optional) Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info
  • metadata meta_v1.ObjectMeta - (optional) Standard object's metadata. More info
  • spec StatefulSetSpec - (optional) Spec defines the desired identities of pods in this set.
  • status StatefulSetStatus - (optional) Status is the current status of Pods in this StatefulSet. This data may be out of date by some window of time.

StatefulSetCondition

class lightkube.models.apps_v1.StatefulSetCondition(status, type, lastTransitionTime=None, message=None, reason=None)

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

parameters

  • status str - Status of the condition, one of True, False, Unknown.
  • type str - Type of statefulset condition.
  • lastTransitionTime meta_v1.Time - (optional) Last time the condition transitioned from one status to another.
  • message str - (optional) A human readable message indicating details about the transition.
  • reason str - (optional) The reason for the condition's last transition.

StatefulSetList

class lightkube.models.apps_v1.StatefulSetList(items, apiVersion=None, kind=None, metadata=None)

StatefulSetList is a collection of StatefulSets.

parameters

  • items StatefulSet - Items is the list of stateful sets.
  • apiVersion str - (optional) APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info
  • kind str - (optional) Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info
  • metadata meta_v1.ListMeta - (optional) Standard list's metadata. More info

StatefulSetPersistentVolumeClaimRetentionPolicy

class lightkube.models.apps_v1.StatefulSetPersistentVolumeClaimRetentionPolicy(whenDeleted=None, whenScaled=None)

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

parameters

  • whenDeleted str - (optional) 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.
  • whenScaled str - (optional) 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.

StatefulSetSpec

class lightkube.models.apps_v1.StatefulSetSpec(selector, serviceName, template, minReadySeconds=None, persistentVolumeClaimRetentionPolicy=None, podManagementPolicy=None, replicas=None, revisionHistoryLimit=None, updateStrategy=None, volumeClaimTemplates=None)

A StatefulSetSpec is the specification of a StatefulSet.

parameters

  • selector meta_v1.LabelSelector - selector is a label query over pods that should match the replica count. It must match the pod template's labels. More info
  • serviceName str - 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.
  • template core_v1.PodTemplateSpec - 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.
  • minReadySeconds int - (optional) Minimum number of seconds for which a newly created pod should be ready without any of its container crashing for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready) This is an alpha field and requires enabling StatefulSetMinReadySeconds feature gate.
  • persistentVolumeClaimRetentionPolicy StatefulSetPersistentVolumeClaimRetentionPolicy - (optional) 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. This requires the StatefulSetAutoDeletePVC feature gate to be enabled, which is alpha. +optional
  • podManagementPolicy str - (optional) 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.
  • replicas int - (optional) 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.
  • revisionHistoryLimit int - (optional) 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.
  • updateStrategy StatefulSetUpdateStrategy - (optional) updateStrategy indicates the StatefulSetUpdateStrategy that will be employed to update Pods in the StatefulSet when a revision is made to Template.
  • volumeClaimTemplates core_v1.PersistentVolumeClaim - (optional) 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.

StatefulSetStatus

class lightkube.models.apps_v1.StatefulSetStatus(replicas, availableReplicas=None, collisionCount=None, conditions=None, currentReplicas=None, currentRevision=None, observedGeneration=None, readyReplicas=None, updateRevision=None, updatedReplicas=None)

StatefulSetStatus represents the current state of a StatefulSet.

parameters

  • replicas int - replicas is the number of Pods created by the StatefulSet controller.
  • availableReplicas int - (optional) Total number of available pods (ready for at least minReadySeconds) targeted by this statefulset. This is a beta field and enabled/disabled by StatefulSetMinReadySeconds feature gate.
  • collisionCount int - (optional) 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.
  • conditions StatefulSetCondition - (optional) Represents the latest available observations of a statefulset's current state.
  • currentReplicas int - (optional) currentReplicas is the number of Pods created by the StatefulSet controller from the StatefulSet version indicated by currentRevision.
  • currentRevision str - (optional) currentRevision, if not empty, indicates the version of the StatefulSet used to generate Pods in the sequence [0,currentReplicas).
  • observedGeneration int - (optional) 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.
  • readyReplicas int - (optional) readyReplicas is the number of pods created for this StatefulSet with a Ready Condition.
  • updateRevision str - (optional) updateRevision, if not empty, indicates the version of the StatefulSet used to generate Pods in the sequence [replicas-updatedReplicas,replicas)
  • updatedReplicas int - (optional) updatedReplicas is the number of Pods created by the StatefulSet controller from the StatefulSet version indicated by updateRevision.

StatefulSetUpdateStrategy

class lightkube.models.apps_v1.StatefulSetUpdateStrategy(rollingUpdate=None, type=None)

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.

parameters

  • rollingUpdate RollingUpdateStatefulSetStrategy - (optional) RollingUpdate is used to communicate parameters when Type is RollingUpdateStatefulSetStrategyType.
  • type str - (optional) Type indicates the type of the StatefulSetUpdateStrategy. Default is RollingUpdate.