StatefulSetAppsV1 class

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.

{{% examples %}}

Example Usage

{{% example %}}

Create a StatefulSet with auto-naming

import * as pulumi from "@pulumi/pulumi";
import * as kubernetes from "@pulumi/kubernetes";

const service = new kubernetes.core.v1.Service("service", {
    metadata: {
        labels: {
            app: "nginx",
        },
    },
    spec: {
        clusterIP: "None",
        ports: [{
            name: "web",
            port: 80,
        }],
        selector: {
            app: "nginx",
        },
    },
});
const statefulset = new kubernetes.apps.v1.StatefulSet("statefulset", {spec: {
    replicas: 3,
    selector: {
        matchLabels: {
            app: "nginx",
        },
    },
    serviceName: service.metadata.apply(metadata => metadata?.name),
    template: {
        metadata: {
            labels: {
                app: "nginx",
            },
        },
        spec: {
            containers: [{
                image: "nginx:stable-alpine3.17-slim",
                name: "nginx",
                ports: [{
                    containerPort: 80,
                    name: "web",
                }],
                volumeMounts: [{
                    mountPath: "/usr/share/nginx/html",
                    name: "www",
                }],
            }],
            terminationGracePeriodSeconds: 10,
        },
    },
    volumeClaimTemplates: [{
        metadata: {
            name: "www",
        },
        spec: {
            accessModes: ["ReadWriteOnce"],
            resources: {
                requests: {
                    storage: "1Gi",
                },
            },
        },
    }],
}});
import pulumi
import pulumi_kubernetes as kubernetes

service = kubernetes.core.v1.Service("service",
    metadata=kubernetes.meta.v1.ObjectMetaArgs(
        labels={
            "app": "nginx",
        },
    ),
    spec=kubernetes.core.v1.ServiceSpecArgs(
        cluster_ip="None",
        ports=[kubernetes.core.v1.ServicePortArgs(
            name="web",
            port=80,
        )],
        selector={
            "app": "nginx",
        },
    ))
statefulset = kubernetes.apps.v1.StatefulSet("statefulset", spec=kubernetes.apps.v1.StatefulSetSpecArgs(
    replicas=3,
    selector=kubernetes.meta.v1.LabelSelectorArgs(
        match_labels={
            "app": "nginx",
        },
    ),
    service_name=service.metadata.name,
    template=kubernetes.core.v1.PodTemplateSpecArgs(
        metadata=kubernetes.meta.v1.ObjectMetaArgs(
            labels={
                "app": "nginx",
            },
        ),
        spec=kubernetes.core.v1.PodSpecArgs(
            containers=[kubernetes.core.v1.ContainerArgs(
                image="nginx:stable-alpine3.17-slim",
                name="nginx",
                ports=[kubernetes.core.v1.ContainerPortArgs(
                    container_port=80,
                    name="web",
                )],
                volume_mounts=[kubernetes.core.v1.VolumeMountArgs(
                    mount_path="/usr/share/nginx/html",
                    name="www",
                )],
            )],
            termination_grace_period_seconds=10,
        ),
    ),
    volume_claim_templates=[kubernetes.core.v1.PersistentVolumeClaimArgs(
        metadata=kubernetes.meta.v1.ObjectMetaArgs(
            name="www",
        ),
        spec=kubernetes.core.v1.PersistentVolumeClaimSpecArgs(
            access_modes=["ReadWriteOnce"],
            resources=kubernetes.core.v1.ResourceRequirementsArgs(
                requests={
                    "storage": "1Gi",
                },
            ),
        ),
    )],
))
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Kubernetes = Pulumi.Kubernetes;

return await Deployment.RunAsync(() =>
{
    var service = new Kubernetes.Core.V1.Service("service", new()
    {
        Metadata = new Kubernetes.Types.Inputs.Meta.V1.ObjectMetaArgs
        {
            Labels =
            {
                { "app", "nginx" },
            },
        },
        Spec = new Kubernetes.Types.Inputs.Core.V1.ServiceSpecArgs
        {
            ClusterIP = "None",
            Ports = new[]
            {
                new Kubernetes.Types.Inputs.Core.V1.ServicePortArgs
                {
                    Name = "web",
                    Port = 80,
                },
            },
            Selector =
            {
                { "app", "nginx" },
            },
        },
    });

    var statefulset = new Kubernetes.Apps.V1.StatefulSet("statefulset", new()
    {
        Spec = new Kubernetes.Types.Inputs.Apps.V1.StatefulSetSpecArgs
        {
            Replicas = 3,
            Selector = new Kubernetes.Types.Inputs.Meta.V1.LabelSelectorArgs
            {
                MatchLabels =
                {
                    { "app", "nginx" },
                },
            },
            ServiceName = service.Metadata.Apply(metadata => metadata?.Name),
            Template = new Kubernetes.Types.Inputs.Core.V1.PodTemplateSpecArgs
            {
                Metadata = new Kubernetes.Types.Inputs.Meta.V1.ObjectMetaArgs
                {
                    Labels =
                    {
                        { "app", "nginx" },
                    },
                },
                Spec = new Kubernetes.Types.Inputs.Core.V1.PodSpecArgs
                {
                    Containers = new[]
                    {
                        new Kubernetes.Types.Inputs.Core.V1.ContainerArgs
                        {
                            Image = "nginx:stable-alpine3.17-slim",
                            Name = "nginx",
                            Ports = new[]
                            {
                                new Kubernetes.Types.Inputs.Core.V1.ContainerPortArgs
                                {
                                    ContainerPortValue = 80,
                                    Name = "web",
                                },
                            },
                            VolumeMounts = new[]
                            {
                                new Kubernetes.Types.Inputs.Core.V1.VolumeMountArgs
                                {
                                    MountPath = "/usr/share/nginx/html",
                                    Name = "www",
                                },
                            },
                        },
                    },
                    TerminationGracePeriodSeconds = 10,
                },
            },
            VolumeClaimTemplates = new[]
            {
                new Kubernetes.Types.Inputs.Core.V1.PersistentVolumeClaimArgs
                {
                    Metadata = new Kubernetes.Types.Inputs.Meta.V1.ObjectMetaArgs
                    {
                        Name = "www",
                    },
                    Spec = new Kubernetes.Types.Inputs.Core.V1.PersistentVolumeClaimSpecArgs
                    {
                        AccessModes = new[]
                        {
                            "ReadWriteOnce",
                        },
                        Resources = new Kubernetes.Types.Inputs.Core.V1.ResourceRequirementsArgs
                        {
                            Requests =
                            {
                                { "storage", "1Gi" },
                            },
                        },
                    },
                },
            },
        },
    });

});

package main

import (
	appsv1 "github.com/pulumi/pulumi-kubernetes/sdk/v4/go/kubernetes/apps/v1"
	corev1 "github.com/pulumi/pulumi-kubernetes/sdk/v4/go/kubernetes/core/v1"
	metav1 "github.com/pulumi/pulumi-kubernetes/sdk/v4/go/kubernetes/meta/v1"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		service, err := corev1.NewService(ctx, "service", &corev1.ServiceArgs{
			Metadata: &metav1.ObjectMetaArgs{
				Labels: pulumi.StringMap{
					"app": pulumi.String("nginx"),
				},
			},
			Spec: &corev1.ServiceSpecArgs{
				ClusterIP: pulumi.String("None"),
				Ports: corev1.ServicePortArray{
					&corev1.ServicePortArgs{
						Name: pulumi.String("web"),
						Port: pulumi.Int(80),
					},
				},
				Selector: pulumi.StringMap{
					"app": pulumi.String("nginx"),
				},
			},
		})
		if err != nil {
			return err
		}
		_, err = appsv1.NewStatefulSet(ctx, "statefulset", &appsv1.StatefulSetArgs{
			Spec: &appsv1.StatefulSetSpecArgs{
				Replicas: pulumi.Int(3),
				Selector: &metav1.LabelSelectorArgs{
					MatchLabels: pulumi.StringMap{
						"app": pulumi.String("nginx"),
					},
				},
				ServiceName: service.Metadata.ApplyT(func(metadata metav1.ObjectMeta) (*string, error) {
					return &metadata.Name, nil
				}).(pulumi.StringPtrOutput),
				Template: &corev1.PodTemplateSpecArgs{
					Metadata: &metav1.ObjectMetaArgs{
						Labels: pulumi.StringMap{
							"app": pulumi.String("nginx"),
						},
					},
					Spec: &corev1.PodSpecArgs{
						Containers: corev1.ContainerArray{
							&corev1.ContainerArgs{
								Image: pulumi.String("nginx:stable-alpine3.17-slim"),
								Name:  pulumi.String("nginx"),
								Ports: corev1.ContainerPortArray{
									&corev1.ContainerPortArgs{
										ContainerPort: pulumi.Int(80),
										Name:          pulumi.String("web"),
									},
								},
								VolumeMounts: corev1.VolumeMountArray{
									&corev1.VolumeMountArgs{
										MountPath: pulumi.String("/usr/share/nginx/html"),
										Name:      pulumi.String("www"),
									},
								},
							},
						},
						TerminationGracePeriodSeconds: pulumi.Int(10),
					},
				},
				VolumeClaimTemplates: []corev1.PersistentVolumeClaimTypeArgs{
					{
						Metadata: {
							Name: pulumi.String("www"),
						},
						Spec: {
							AccessModes: pulumi.StringArray{
								pulumi.String("ReadWriteOnce"),
							},
							Resources: {
								Requests: {
									"storage": pulumi.String("1Gi"),
								},
							},
						},
					},
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.kubernetes.core_v1.Service;
import com.pulumi.kubernetes.core_v1.ServiceArgs;
import com.pulumi.kubernetes.meta_v1.inputs.ObjectMetaArgs;
import com.pulumi.kubernetes.core_v1.inputs.ServiceSpecArgs;
import com.pulumi.kubernetes.apps_v1.StatefulSet;
import com.pulumi.kubernetes.apps_v1.StatefulSetArgs;
import com.pulumi.kubernetes.apps_v1.inputs.StatefulSetSpecArgs;
import com.pulumi.kubernetes.meta_v1.inputs.LabelSelectorArgs;
import com.pulumi.kubernetes.core_v1.inputs.PodTemplateSpecArgs;
import com.pulumi.kubernetes.core_v1.inputs.PodSpecArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var service = new Service("service", ServiceArgs.builder()
            .metadata(ObjectMetaArgs.builder()
                .labels(Map.of("app", "nginx"))
                .build())
            .spec(ServiceSpecArgs.builder()
                .clusterIP("None")
                .ports(ServicePortArgs.builder()
                    .name("web")
                    .port(80)
                    .build())
                .selector(Map.of("app", "nginx"))
                .build())
            .build());

        var statefulset = new StatefulSet("statefulset", StatefulSetArgs.builder()
            .spec(StatefulSetSpecArgs.builder()
                .replicas(3)
                .selector(LabelSelectorArgs.builder()
                    .matchLabels(Map.of("app", "nginx"))
                    .build())
                .serviceName(service.metadata().applyValue(metadata -> metadata.name()))
                .template(PodTemplateSpecArgs.builder()
                    .metadata(ObjectMetaArgs.builder()
                        .labels(Map.of("app", "nginx"))
                        .build())
                    .spec(PodSpecArgs.builder()
                        .containers(ContainerArgs.builder()
                            .image("nginx:stable-alpine3.17-slim")
                            .name("nginx")
                            .ports(ContainerPortArgs.builder()
                                .containerPort(80)
                                .name("web")
                                .build())
                            .volumeMounts(VolumeMountArgs.builder()
                                .mountPath("/usr/share/nginx/html")
                                .name("www")
                                .build())
                            .build())
                        .terminationGracePeriodSeconds(10)
                        .build())
                    .build())
                .volumeClaimTemplates(PersistentVolumeClaimArgs.builder()
                    .metadata(ObjectMetaArgs.builder()
                        .name("www")
                        .build())
                    .spec(PersistentVolumeClaimSpecArgs.builder()
                        .accessModes("ReadWriteOnce")
                        .resources(ResourceRequirementsArgs.builder()
                            .requests(Map.of("storage", "1Gi"))
                            .build())
                        .build())
                    .build())
                .build())
            .build());

    }
}
description: Create a StatefulSet with auto-naming
name: yaml-example
resources:
    service:
        properties:
            metadata:
                labels:
                    app: nginx
            spec:
                clusterIP: None
                ports:
                    - name: web
                      port: 80
                selector:
                    app: nginx
        type: kubernetes:core/v1:Service
    statefulset:
        properties:
            spec:
                replicas: 3
                selector:
                    matchLabels:
                        app: nginx
                serviceName: ${service.metadata.name}
                template:
                    metadata:
                        labels:
                            app: nginx
                    spec:
                        containers:
                            - image: nginx:stable-alpine3.17-slim
                              name: nginx
                              ports:
                                - containerPort: 80
                                  name: web
                              volumeMounts:
                                - mountPath: /usr/share/nginx/html
                                  name: www
                        terminationGracePeriodSeconds: 10
                volumeClaimTemplates:
                    - metadata:
                        name: www
                      spec:
                        accessModes:
                            - ReadWriteOnce
                        resources:
                            requests:
                                storage: 1Gi
        type: kubernetes:apps/v1:StatefulSet
runtime: yaml
pulumi {
  required_providers {
    kubernetes = {
      source = "pulumi/kubernetes"
    }
  }
}

resource "kubernetes_core_v1_service" "service" {
  metadata = {
    labels = {
      app = "nginx"
    }
  }
  spec = {
    cluster_ip = "None"
    ports = [{
      name = "web"
      port = 80
    }]
    selector = {
      app = "nginx"
    }
  }
}

resource "kubernetes_apps_v1_stateful_set" "statefulset" {
  spec = {
    replicas = 3
    selector = {
      match_labels = {
        app = "nginx"
      }
    }
    service_name = kubernetes_core_v1_service.service.metadata.name
    template = {
      metadata = {
        labels = {
          app = "nginx"
        }
      }
      spec = {
        containers = [{
          image = "nginx:stable-alpine3.17-slim"
          name  = "nginx"
          ports = [{
            container_port = 80
            name           = "web"
          }]
          volume_mounts = [{
            mount_path = "/usr/share/nginx/html"
            name       = "www"
          }]
        }]
        termination_grace_period_seconds = 10
      }
    }
    volume_claim_templates = [{
      metadata = {
        name = "www"
      }
      spec = {
        access_modes = ["ReadWriteOnce"]
        resources = {
          requests = {
            storage = "1Gi"
          }
        }
      }
    }]
  }
}

{{% /example %}} {{% example %}}

Create a StatefulSet with a user-specified name

import * as pulumi from "@pulumi/pulumi";
import * as kubernetes from "@pulumi/kubernetes";

const service = new kubernetes.core.v1.Service("service", {
    metadata: {
        labels: {
            app: "nginx",
        },
        name: "nginx",
    },
    spec: {
        clusterIP: "None",
        ports: [{
            name: "web",
            port: 80,
        }],
        selector: {
            app: "nginx",
        },
    },
});
const statefulset = new kubernetes.apps.v1.StatefulSet("statefulset", {
    metadata: {
        name: "web",
    },
    spec: {
        replicas: 3,
        selector: {
            matchLabels: {
                app: "nginx",
            },
        },
        serviceName: service.metadata.apply(metadata => metadata?.name),
        template: {
            metadata: {
                labels: {
                    app: "nginx",
                },
            },
            spec: {
                containers: [{
                    image: "nginx:stable-alpine3.17-slim",
                    name: "nginx",
                    ports: [{
                        containerPort: 80,
                        name: "web",
                    }],
                    volumeMounts: [{
                        mountPath: "/usr/share/nginx/html",
                        name: "www",
                    }],
                }],
                terminationGracePeriodSeconds: 10,
            },
        },
        volumeClaimTemplates: [{
            metadata: {
                name: "www",
            },
            spec: {
                accessModes: ["ReadWriteOnce"],
                resources: {
                    requests: {
                        storage: "1Gi",
                    },
                },
            },
        }],
    },
});
import pulumi
import pulumi_kubernetes as kubernetes

service = kubernetes.core.v1.Service("service",
    metadata=kubernetes.meta.v1.ObjectMetaArgs(
        labels={
            "app": "nginx",
        },
        name="nginx",
    ),
    spec=kubernetes.core.v1.ServiceSpecArgs(
        cluster_ip="None",
        ports=[kubernetes.core.v1.ServicePortArgs(
            name="web",
            port=80,
        )],
        selector={
            "app": "nginx",
        },
    ))
statefulset = kubernetes.apps.v1.StatefulSet("statefulset",
    metadata=kubernetes.meta.v1.ObjectMetaArgs(
        name="web",
    ),
    spec=kubernetes.apps.v1.StatefulSetSpecArgs(
        replicas=3,
        selector=kubernetes.meta.v1.LabelSelectorArgs(
            match_labels={
                "app": "nginx",
            },
        ),
        service_name=service.metadata.name,
        template=kubernetes.core.v1.PodTemplateSpecArgs(
            metadata=kubernetes.meta.v1.ObjectMetaArgs(
                labels={
                    "app": "nginx",
                },
            ),
            spec=kubernetes.core.v1.PodSpecArgs(
                containers=[kubernetes.core.v1.ContainerArgs(
                    image="nginx:stable-alpine3.17-slim",
                    name="nginx",
                    ports=[kubernetes.core.v1.ContainerPortArgs(
                        container_port=80,
                        name="web",
                    )],
                    volume_mounts=[kubernetes.core.v1.VolumeMountArgs(
                        mount_path="/usr/share/nginx/html",
                        name="www",
                    )],
                )],
                termination_grace_period_seconds=10,
            ),
        ),
        volume_claim_templates=[kubernetes.core.v1.PersistentVolumeClaimArgs(
            metadata=kubernetes.meta.v1.ObjectMetaArgs(
                name="www",
            ),
            spec=kubernetes.core.v1.PersistentVolumeClaimSpecArgs(
                access_modes=["ReadWriteOnce"],
                resources=kubernetes.core.v1.ResourceRequirementsArgs(
                    requests={
                        "storage": "1Gi",
                    },
                ),
            ),
        )],
    ))
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Kubernetes = Pulumi.Kubernetes;

return await Deployment.RunAsync(() =>
{
    var service = new Kubernetes.Core.V1.Service("service", new()
    {
        Metadata = new Kubernetes.Types.Inputs.Meta.V1.ObjectMetaArgs
        {
            Labels =
            {
                { "app", "nginx" },
            },
            Name = "nginx",
        },
        Spec = new Kubernetes.Types.Inputs.Core.V1.ServiceSpecArgs
        {
            ClusterIP = "None",
            Ports = new[]
            {
                new Kubernetes.Types.Inputs.Core.V1.ServicePortArgs
                {
                    Name = "web",
                    Port = 80,
                },
            },
            Selector =
            {
                { "app", "nginx" },
            },
        },
    });

    var statefulset = new Kubernetes.Apps.V1.StatefulSet("statefulset", new()
    {
        Metadata = new Kubernetes.Types.Inputs.Meta.V1.ObjectMetaArgs
        {
            Name = "web",
        },
        Spec = new Kubernetes.Types.Inputs.Apps.V1.StatefulSetSpecArgs
        {
            Replicas = 3,
            Selector = new Kubernetes.Types.Inputs.Meta.V1.LabelSelectorArgs
            {
                MatchLabels =
                {
                    { "app", "nginx" },
                },
            },
            ServiceName = service.Metadata.Apply(metadata => metadata?.Name),
            Template = new Kubernetes.Types.Inputs.Core.V1.PodTemplateSpecArgs
            {
                Metadata = new Kubernetes.Types.Inputs.Meta.V1.ObjectMetaArgs
                {
                    Labels =
                    {
                        { "app", "nginx" },
                    },
                },
                Spec = new Kubernetes.Types.Inputs.Core.V1.PodSpecArgs
                {
                    Containers = new[]
                    {
                        new Kubernetes.Types.Inputs.Core.V1.ContainerArgs
                        {
                            Image = "nginx:stable-alpine3.17-slim",
                            Name = "nginx",
                            Ports = new[]
                            {
                                new Kubernetes.Types.Inputs.Core.V1.ContainerPortArgs
                                {
                                    ContainerPortValue = 80,
                                    Name = "web",
                                },
                            },
                            VolumeMounts = new[]
                            {
                                new Kubernetes.Types.Inputs.Core.V1.VolumeMountArgs
                                {
                                    MountPath = "/usr/share/nginx/html",
                                    Name = "www",
                                },
                            },
                        },
                    },
                    TerminationGracePeriodSeconds = 10,
                },
            },
            VolumeClaimTemplates = new[]
            {
                new Kubernetes.Types.Inputs.Core.V1.PersistentVolumeClaimArgs
                {
                    Metadata = new Kubernetes.Types.Inputs.Meta.V1.ObjectMetaArgs
                    {
                        Name = "www",
                    },
                    Spec = new Kubernetes.Types.Inputs.Core.V1.PersistentVolumeClaimSpecArgs
                    {
                        AccessModes = new[]
                        {
                            "ReadWriteOnce",
                        },
                        Resources = new Kubernetes.Types.Inputs.Core.V1.ResourceRequirementsArgs
                        {
                            Requests =
                            {
                                { "storage", "1Gi" },
                            },
                        },
                    },
                },
            },
        },
    });

});

package main

import (
	appsv1 "github.com/pulumi/pulumi-kubernetes/sdk/v4/go/kubernetes/apps/v1"
	corev1 "github.com/pulumi/pulumi-kubernetes/sdk/v4/go/kubernetes/core/v1"
	metav1 "github.com/pulumi/pulumi-kubernetes/sdk/v4/go/kubernetes/meta/v1"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		service, err := corev1.NewService(ctx, "service", &corev1.ServiceArgs{
			Metadata: &metav1.ObjectMetaArgs{
				Labels: pulumi.StringMap{
					"app": pulumi.String("nginx"),
				},
				Name: pulumi.String("nginx"),
			},
			Spec: &corev1.ServiceSpecArgs{
				ClusterIP: pulumi.String("None"),
				Ports: corev1.ServicePortArray{
					&corev1.ServicePortArgs{
						Name: pulumi.String("web"),
						Port: pulumi.Int(80),
					},
				},
				Selector: pulumi.StringMap{
					"app": pulumi.String("nginx"),
				},
			},
		})
		if err != nil {
			return err
		}
		_, err = appsv1.NewStatefulSet(ctx, "statefulset", &appsv1.StatefulSetArgs{
			Metadata: &metav1.ObjectMetaArgs{
				Name: pulumi.String("web"),
			},
			Spec: &appsv1.StatefulSetSpecArgs{
				Replicas: pulumi.Int(3),
				Selector: &metav1.LabelSelectorArgs{
					MatchLabels: pulumi.StringMap{
						"app": pulumi.String("nginx"),
					},
				},
				ServiceName: service.Metadata.ApplyT(func(metadata metav1.ObjectMeta) (*string, error) {
					return &metadata.Name, nil
				}).(pulumi.StringPtrOutput),
				Template: &corev1.PodTemplateSpecArgs{
					Metadata: &metav1.ObjectMetaArgs{
						Labels: pulumi.StringMap{
							"app": pulumi.String("nginx"),
						},
					},
					Spec: &corev1.PodSpecArgs{
						Containers: corev1.ContainerArray{
							&corev1.ContainerArgs{
								Image: pulumi.String("nginx:stable-alpine3.17-slim"),
								Name:  pulumi.String("nginx"),
								Ports: corev1.ContainerPortArray{
									&corev1.ContainerPortArgs{
										ContainerPort: pulumi.Int(80),
										Name:          pulumi.String("web"),
									},
								},
								VolumeMounts: corev1.VolumeMountArray{
									&corev1.VolumeMountArgs{
										MountPath: pulumi.String("/usr/share/nginx/html"),
										Name:      pulumi.String("www"),
									},
								},
							},
						},
						TerminationGracePeriodSeconds: pulumi.Int(10),
					},
				},
				VolumeClaimTemplates: []corev1.PersistentVolumeClaimTypeArgs{
					{
						Metadata: {
							Name: pulumi.String("www"),
						},
						Spec: {
							AccessModes: pulumi.StringArray{
								pulumi.String("ReadWriteOnce"),
							},
							Resources: {
								Requests: {
									"storage": pulumi.String("1Gi"),
								},
							},
						},
					},
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.kubernetes.core_v1.Service;
import com.pulumi.kubernetes.core_v1.ServiceArgs;
import com.pulumi.kubernetes.meta_v1.inputs.ObjectMetaArgs;
import com.pulumi.kubernetes.core_v1.inputs.ServiceSpecArgs;
import com.pulumi.kubernetes.apps_v1.StatefulSet;
import com.pulumi.kubernetes.apps_v1.StatefulSetArgs;
import com.pulumi.kubernetes.apps_v1.inputs.StatefulSetSpecArgs;
import com.pulumi.kubernetes.meta_v1.inputs.LabelSelectorArgs;
import com.pulumi.kubernetes.core_v1.inputs.PodTemplateSpecArgs;
import com.pulumi.kubernetes.core_v1.inputs.PodSpecArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var service = new Service("service", ServiceArgs.builder()
            .metadata(ObjectMetaArgs.builder()
                .labels(Map.of("app", "nginx"))
                .name("nginx")
                .build())
            .spec(ServiceSpecArgs.builder()
                .clusterIP("None")
                .ports(ServicePortArgs.builder()
                    .name("web")
                    .port(80)
                    .build())
                .selector(Map.of("app", "nginx"))
                .build())
            .build());

        var statefulset = new StatefulSet("statefulset", StatefulSetArgs.builder()
            .metadata(ObjectMetaArgs.builder()
                .name("web")
                .build())
            .spec(StatefulSetSpecArgs.builder()
                .replicas(3)
                .selector(LabelSelectorArgs.builder()
                    .matchLabels(Map.of("app", "nginx"))
                    .build())
                .serviceName(service.metadata().applyValue(metadata -> metadata.name()))
                .template(PodTemplateSpecArgs.builder()
                    .metadata(ObjectMetaArgs.builder()
                        .labels(Map.of("app", "nginx"))
                        .build())
                    .spec(PodSpecArgs.builder()
                        .containers(ContainerArgs.builder()
                            .image("nginx:stable-alpine3.17-slim")
                            .name("nginx")
                            .ports(ContainerPortArgs.builder()
                                .containerPort(80)
                                .name("web")
                                .build())
                            .volumeMounts(VolumeMountArgs.builder()
                                .mountPath("/usr/share/nginx/html")
                                .name("www")
                                .build())
                            .build())
                        .terminationGracePeriodSeconds(10)
                        .build())
                    .build())
                .volumeClaimTemplates(PersistentVolumeClaimArgs.builder()
                    .metadata(ObjectMetaArgs.builder()
                        .name("www")
                        .build())
                    .spec(PersistentVolumeClaimSpecArgs.builder()
                        .accessModes("ReadWriteOnce")
                        .resources(ResourceRequirementsArgs.builder()
                            .requests(Map.of("storage", "1Gi"))
                            .build())
                        .build())
                    .build())
                .build())
            .build());

    }
}
description: Create a StatefulSet with a user-specified name
name: yaml-example
resources:
    service:
        properties:
            metadata:
                labels:
                    app: nginx
                name: nginx
            spec:
                clusterIP: None
                ports:
                    - name: web
                      port: 80
                selector:
                    app: nginx
        type: kubernetes:core/v1:Service
    statefulset:
        properties:
            metadata:
                name: web
            spec:
                replicas: 3
                selector:
                    matchLabels:
                        app: nginx
                serviceName: ${service.metadata.name}
                template:
                    metadata:
                        labels:
                            app: nginx
                    spec:
                        containers:
                            - image: nginx:stable-alpine3.17-slim
                              name: nginx
                              ports:
                                - containerPort: 80
                                  name: web
                              volumeMounts:
                                - mountPath: /usr/share/nginx/html
                                  name: www
                        terminationGracePeriodSeconds: 10
                volumeClaimTemplates:
                    - metadata:
                        name: www
                      spec:
                        accessModes:
                            - ReadWriteOnce
                        resources:
                            requests:
                                storage: 1Gi
        type: kubernetes:apps/v1:StatefulSet
runtime: yaml
pulumi {
  required_providers {
    kubernetes = {
      source = "pulumi/kubernetes"
    }
  }
}

resource "kubernetes_core_v1_service" "service" {
  metadata = {
    labels = {
      app = "nginx"
    }
    name = "nginx"
  }
  spec = {
    cluster_ip = "None"
    ports = [{
      name = "web"
      port = 80
    }]
    selector = {
      app = "nginx"
    }
  }
}

resource "kubernetes_apps_v1_stateful_set" "statefulset" {
  metadata = {
    name = "web"
  }
  spec = {
    replicas = 3
    selector = {
      match_labels = {
        app = "nginx"
      }
    }
    service_name = kubernetes_core_v1_service.service.metadata.name
    template = {
      metadata = {
        labels = {
          app = "nginx"
        }
      }
      spec = {
        containers = [{
          image = "nginx:stable-alpine3.17-slim"
          name  = "nginx"
          ports = [{
            container_port = 80
            name           = "web"
          }]
          volume_mounts = [{
            mount_path = "/usr/share/nginx/html"
            name       = "www"
          }]
        }]
        termination_grace_period_seconds = 10
      }
    }
    volume_claim_templates = [{
      metadata = {
        name = "www"
      }
      spec = {
        access_modes = ["ReadWriteOnce"]
        resources = {
          requests = {
            storage = "1Gi"
          }
        }
      }
    }]
  }
}

{{% /example %}} {{% /examples %}}

Constructors

StatefulSetAppsV1(String name, {StatefulSetArgs? args, CustomResourceOptions? options})
Creates a new StatefulSetAppsV1. name The Pulumi resource name. args Arguments used to configure this StatefulSetAppsV1. The set of arguments for StatefulSet. options Resource options controlling this resource's behavior.

Properties

apiVersion ↔ Output<String>
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
latefinal
childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
hashCode → int
The hash code for this object.
no setterinherited
id ↔ Output<String>
getter/setter pairinherited
isCustom → bool
Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool
Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool
Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool
Whether this instance represents a resource value returned over RPC.
finalinherited
kind ↔ Output<String>
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
latefinal
metadata ↔ Output<ObjectMeta>
Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
latefinal
resourceTransforms → List<ResourceTransform>
Inherited/explicit async transforms.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
spec ↔ Output<StatefulSetSpec>
Spec defines the desired identities of pods in this set.
latefinal
status ↔ Output<StatefulSetStatus?>
Status is the current status of Pods in this StatefulSet. This data may be out of date by some window of time.
latefinal
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
urn ↔ Output<String>
latefinalinherited

Methods

failId(Object error) → void
Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void
Completes all output properties with error.
inherited
failUrn(Object error) → void
Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?
Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String
Returns this resource's logical name.
inherited
getResourceType() → String
Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>
Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void
Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void
Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void
Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>
Serializes resource properties for RPC transmission.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited