Skip to main content

StatefulSet

Struct StatefulSet 

Source
pub struct StatefulSet {
    pub metadata: ObjectMeta,
    pub spec: Option<StatefulSetSpec>,
    pub status: Option<StatefulSetStatus>,
}
Expand description

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.

Fields§

§metadata: ObjectMeta

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

§spec: Option<StatefulSetSpec>

Spec defines the desired identities of pods in this set.

§status: Option<StatefulSetStatus>

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

Trait Implementations§

Source§

impl Clone for StatefulSet

Source§

fn clone(&self) -> StatefulSet

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for StatefulSet

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter. Read more
Source§

impl DeepMerge for StatefulSet

Source§

fn merge_from(&mut self, other: StatefulSet)

Merge other into self.
Source§

impl Default for StatefulSet

Source§

fn default() -> StatefulSet

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for StatefulSet

Source§

fn deserialize<D>( deserializer: D, ) -> Result<StatefulSet, <D as Deserializer<'de>>::Error>
where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl ListableResource for StatefulSet

Source§

const LIST_KIND: &'static str = "StatefulSetList"

The kind of the list type of the resource. Read more
Source§

impl Metadata for StatefulSet

Source§

type Ty = ObjectMeta

The type of the metadata object.
Source§

fn metadata(&self) -> &<StatefulSet as Metadata>::Ty

Gets a reference to the metadata of this resource value.
Source§

fn metadata_mut(&mut self) -> &mut <StatefulSet as Metadata>::Ty

Gets a mutable reference to the metadata of this resource value.
Source§

impl PartialEq for StatefulSet

Source§

fn eq(&self, other: &StatefulSet) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Resource for StatefulSet

Source§

const API_VERSION: &'static str = "apps/v1"

The API version of the resource. This is a composite of Resource::GROUP and Resource::VERSION (eg "apiextensions.k8s.io/v1beta1") or just the version for resources without a group (eg "v1"). Read more
Source§

const GROUP: &'static str = "apps"

The group of the resource, or the empty string if the resource doesn’t have a group.
Source§

const KIND: &'static str = "StatefulSet"

The kind of the resource. Read more
Source§

const VERSION: &'static str = "v1"

The version of the resource.
Source§

const URL_PATH_SEGMENT: &'static str = "statefulsets"

The URL path segment used to construct URLs related to this resource. Read more
Source§

type Scope = NamespaceResourceScope

Indicates whether the resource is namespace-scoped or cluster-scoped or a subresource. Read more
Source§

impl Serialize for StatefulSet

Source§

fn serialize<S>( &self, serializer: S, ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>
where S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StatefulSetExt for StatefulSet

Source§

fn new(name: impl ToString) -> Self

Create a new StatefulSet with the given name. Read more
Source§

fn with_labels( name: impl ToString, labels: impl IntoIterator<Item = (impl ToString, impl ToString)>, ) -> Self

Create a new StatefulSet with the given name and labels. Read more
Source§

fn spec(self, spec: StatefulSetSpec) -> Self

Set the spec for the StatefulSet. Read more
Source§

fn replicas(self, replicas: i32) -> Self

Set the number of replicas for the StatefulSet. Read more
Source§

fn min_ready_seconds(self, seconds: i32) -> Self

Set the minimum ready seconds for the StatefulSet. Read more
Source§

fn selector(self, selector: LabelSelector) -> Self

Set the selector for the StatefulSet. Read more
Source§

fn match_labels( self, match_labels: impl IntoIterator<Item = (impl ToString, impl ToString)>, ) -> Self

Set the matchLabels for the StatefulSet’s selector. Read more
Source§

fn service_name(self, service_name: impl ToString) -> Self

Set the service name for the StatefulSet. Read more
Source§

fn revision_history_limit(self, limit: i32) -> Self

Set the revision history limit for the StatefulSet. Read more
Source§

fn template(self, template: PodTemplateSpec) -> Self

Set the pod template spec for the StatefulSet. Read more
Source§

fn ordinals(self, start: i32) -> Self

Set the starting ordinal for the StatefulSet. Read more
Source§

fn update_strategy(self, strategy: StatefulSetUpdateStrategy) -> Self

Set the update strategy for the StatefulSet. Read more
Source§

fn pod_management_policy(self, policy: impl ToString) -> Self

Set the pod management policy for the StatefulSet. Read more
Source§

fn ordered_ready(self) -> Self

Set the pod management policy to “OrderedReady” (default). Read more
Source§

fn parallel(self) -> Self

Set the pod management policy to “Parallel”. Read more
Source§

fn volume_claim_templates( self, templates: impl IntoIterator<Item = PersistentVolumeClaim>, ) -> Self

Set the volume claim templates for the StatefulSet. Read more
Source§

fn persistent_volume_claim_retention_policy( self, policy: StatefulSetPersistentVolumeClaimRetentionPolicy, ) -> Self

Set the persistent volume claim retention policy for the StatefulSet. Read more
Source§

impl StatefulSetGetExt for StatefulSet

Source§

fn spec(&self) -> Option<&StatefulSetSpec>

Source§

fn status(&self) -> Option<&StatefulSetStatus>

Source§

fn ordinals(&self) -> Option<i32>

Source§

fn pod_management_policy(&self) -> Option<&str>

Source§

fn revision_history_limit(&self) -> Option<i32>

Source§

fn service_name(&self) -> Option<&str>

Source§

fn spec_replicas(&self) -> Option<i32>

Source§

fn min_ready_seconds(&self) -> Option<i32>

Source§

fn template(&self) -> Option<&PodTemplateSpec>

The PodTemplateSpec used to create Pods in the StatefulSet.
Source§

fn available_replicas(&self) -> Option<i32>

Total number of available pods (ready for at least minReadySeconds) targeted by this statefulset.
Source§

fn collision_count(&self) -> Option<i32>

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.
Source§

fn conditions(&self) -> Option<&[StatefulSetCondition]>

Represents the latest available observations of a statefulset’s current state.
Source§

fn current_replicas(&self) -> Option<i32>

The number of Pods created by the StatefulSet controller from the StatefulSet version indicated by current_revision.
Source§

fn current_revision(&self) -> Option<&str>

If not empty, indicates the version of the StatefulSet used to generate Pods in the sequence [0,currentReplicas).
Source§

fn observed_generation(&self) -> Option<i64>

The most recent generation observed for this StatefulSet. It corresponds to the StatefulSet’s generation, which is updated on mutation by the API Server.
Source§

fn ready_replicas(&self) -> Option<i32>

The number of pods created for this StatefulSet with a Ready Condition.
Source§

fn status_replicas(&self) -> i32

The number of Pods created by the StatefulSet controller.
Source§

fn update_revision(&self) -> Option<&str>

If not empty, indicates the version of the StatefulSet used to generate Pods in the sequence [replicas-updatedReplicas,replicas)
Source§

fn updated_replicas(&self) -> Option<i32>

The number of Pods created by the StatefulSet controller from the StatefulSet version indicated by update_revision.
Source§

impl StructuralPartialEq for StatefulSet

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<K> OwnerReferenceExt for K
where K: Metadata<Ty = ObjectMeta>,

Source§

fn is_owned_by<T>(&self, owner: &T) -> bool
where T: Metadata<Ty = ObjectMeta>,

Check for self being owned by owner
Source§

fn is_controlled_by<T>(&self, owner: &T) -> bool
where T: Metadata<Ty = ObjectMeta>,

Check for self being owned and controlled by owner
Source§

impl<T> ResourceBuilder for T
where T: Metadata<Ty = ObjectMeta>,

Source§

fn namespace(self, namespace: impl ToString) -> T

Set namespace for this object
Source§

fn owner(self, owner: OwnerReference) -> T

Set the owner for this object
Source§

fn label(self, key: impl ToString, value: impl ToString) -> T

Set one label for this object. For settins multiple lables at once prefer labels()
Source§

fn labels( self, labels: impl IntoIterator<Item = (impl ToString, impl ToString)>, ) -> T

Set labels for this object
Source§

fn annotation(self, key: impl ToString, value: impl ToString) -> T

Set one annotation for this object. For settins multiple lables at once prefer labels()
Source§

fn annotations( self, annotations: impl IntoIterator<Item = (impl ToString, impl ToString)>, ) -> T

Set annotations for this object
Source§

fn with_resource_version(self, resource_version: String) -> T

Source§

fn metadata(name: impl ToString) -> ObjectMeta

Source§

fn app_name(self, name: impl ToString) -> Self

Set recommended label ‘app.kubernetes.io/name’
Source§

fn app_instance(self, instance: impl ToString) -> Self

Set recommended label ‘app.kubernetes.io/instance’
Source§

fn app_version(self, version: impl ToString) -> Self

Set recommended label ‘app.kubernetes.io/version’
Source§

fn app_component(self, component: impl ToString) -> Self

Set recommended label ‘app.kubernetes.io/component’
Source§

fn app_part_of(self, part_of: impl ToString) -> Self

Set recommended label ‘app.kubernetes.io/part-of’
Source§

fn app_managed_by(self, managed_by: impl ToString) -> Self

Set recommended label ‘app.kubernetes.io/managed-by’
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,