Class StatefulSet

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.

This resource waits until its status is ready before registering success for create/update, and populating output properties from the current state of the resource. The following conditions are used to determine whether the resource creation has succeeded or failed:

1. The value of 'spec.replicas' matches '.status.replicas', '.status.currentReplicas', and '.status.readyReplicas'.
2. The value of '.status.updateRevision' matches '.status.currentRevision'.

If the StatefulSet has not reached a Ready state after 10 minutes, it will time out and mark the resource update as Failed. You can override the default timeout value by setting the 'customTimeouts' option on the resource.

Inheritance

System.Object

Resource

CustomResource

KubernetesResource

StatefulSet

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Kubernetes.Apps.V1

Assembly: Pulumi.Kubernetes.dll

Syntax

public class StatefulSet : KubernetesResource

Constructors

StatefulSet(String, StatefulSetArgs, CustomResourceOptions)

Create a StatefulSet resource with the given unique name, arguments, and options.

Declaration

public StatefulSet(string name, StatefulSetArgs args = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
StatefulSetArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

ApiVersion

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: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

Declaration

public Output<string> ApiVersion { get; }

Property Value

Type	Description
Output<System.String>

Kind

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: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

Declaration

public Output<string> Kind { get; }

Property Value

Type	Description
Output<System.String>

Metadata

Declaration

public Output<ObjectMeta> Metadata { get; }

Property Value

Type	Description
Output<ObjectMeta>

Spec

Spec defines the desired identities of pods in this set.

Declaration

public Output<StatefulSetSpec> Spec { get; }

Property Value

Type	Description
Output<StatefulSetSpec>

Status

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

Declaration

public Output<StatefulSetStatus> Status { get; }

Property Value

Type	Description
Output<StatefulSetStatus>

Methods

Get(String, Input<String>, CustomResourceOptions)

Get an existing StatefulSet resource's state with the given name and ID.

Declaration

public static StatefulSet Get(string name, Input<string> id, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
StatefulSet