Introducing Autopilot, an AI coding assistant
gradient
StatefulSet vs. Deployment: differences and use cases

StatefulSet vs. Deployment: differences and use cases

Sep 13, 2022
8 min read

While the pod is the basic deployment unit for containers, Kubernetes provides various resource objects for orchestrating multiple pod replicas. Two commonly used ones are Deployments and StatefulSets. A Deployment manages multiple pods by automating the creation, updating, and deletion of ReplicaSets. By contrast, a StatefulSet helps orchestrate stateful pods by guaranteeing the ordering and uniqueness of pod replicas.

In this article, we’ll discuss these two pod orchestration resources, how they differ, and the use cases they are most suitable for.

What is a Deployment in Kubernetes?

A Deployment is a Kubernetes resource object that provides declarative updates for pods that encapsulate application containers. A Deployment represents a number of identical pods without unique IDs, while specifying the pods’ desired state and attributes. Deployments are typically used to autoscale the number of pod replicas, perform controlled rollouts for application code, and perform rollbacks when necessary.

Kubernetes administrators rely on Deployments to manage a containerized application’s lifecycle by defining the number of pods to be deployed, the image to be used for the application, and how to perform code updates. Kubernetes deployments help automate repeatable application updates, subsequently reducing the effort, time, and number of errors associated with manual updates.

Components of a Kubernetes Deployment

The primary components used to create and apply a Deployment to a cluster include:

  • Deployment template: This is a JSON or YAML configuration file that is used to define the Deployment’s configuration specification. The Kubernetes Deployment controller relies on the desired state described in the Deployment template to create, update, and scale pods. The JSON or YAML file is static, and it includes a pod template that defines what each pod should look like, as well as other common parameters, such as:
    - Number of pod replicas
    - Name of the image running in the pods
    - Deployment’s image tag
    - Secrets, ConfigMaps, and other settings injected into the pod
    - Service labels
  • Service: Defines a single endpoint that is used to enable network access and expose workloads running on the pods within the Deployment. A service is a REST object that points to the Deployment pods and includes a policy to access them.
  • Persistent Volume: Allows pods within the Deployment to access a portion of node storage to store data.

Deployment configuration manifest

Consider a static YAML file for a Kubernetes deployment named darwin-deployment.yaml with the following specifications:

yaml

The above static file represents a Deployment named darwin-deployment that deploys three replicas of a pod to encapsulate containers running the novice image workload. The pods are attached to the darwin-volume-claim PersistentVolumeClaim with a specification similar to:

yaml

To execute the Deployment within the cluster, it should be exposed using a service, such as the NodePort service, specified by the service.yaml file below:

yaml

To deploy the application, the Deployment, volume claim, and service are all applied to the cluster using the following commands:

$ kubectl apply -f service.yaml

$ kubectl apply -f darwin-volume-claim.yaml

$ kubectl apply -f darwin-deployment.yaml

Discovering Deployment details

Administrators can use the kubectl command to discover details of the Deployment and the pods they control. To check for the successful creation of the deployment, run the command:

$ kubectl get deployments

Which returns a response similar to:

NAMEREADYUP-TO-DATEAVAILABLEAGE
darwin-deployment3/33318s

To check for the pods automatically created by the deployment, run the command:

$ kubectl get pods

Which returns the following output:

NAMEREADYSTATUSRESTARTSAGE
darwin-deployment-75675f5897-8qc9o1/1Running025s
darwin-deployment-75675f5897-kzcij1/1Running025s
darwin-deployment-75675f5897-qsznm1/1Running025s

Scaling deployments

The ‘kubect’l command can also be used to scale the number of pods with changing patterns of an application load. To increase the number of pods for darwin-deployment to 5, run the command:

$ kubectl scale deployment/darwin-deployment --replicas=5

With an output similar to:

deployment.apps/darwin-deployment scaled

Kubernetes deployment strategies

Kubernetes supports multiple rollout strategies for pod deployments. These include:

  • Recreate: Simultaneously terminates and replaces all pods running the old version of the application with new pods.
  • Ramped: Rolls out new application versions while terminating the old pods.
  • Rolling update: Replaces old pods with new ones, one-by-one, with zero downtime.
  • Canary deployment: Replaces a subset of existing pods with new ones, keeping both versions running, and then rolls out the new version to more pods if the test deployment is a success.

What is a StatefulSet in Kubernetes?

A StatefulSet is a Kubernetes resource object that manages a set of pods with unique identities. By assigning a persistent ID that is maintained even if the pod is rescheduled, a StatefulSet helps maintain the uniqueness and ordering of pods. With unique pod identifiers, administrators can efficiently attach cluster volumes to new pods across failures.

Although the StatefulSet controller deploys pods using similar specifications, pods are not interchangeable. As a StatefulSet does not create a ReplicaSet, the pod replicas cannot be rolled back to previous versions. StatefulSets are typically used for applications that require persistent storage for stateful workloads, and ordered, automated rolling updates.

Components of a Kubernetes StatefulSet configuration manifest

A Kubernetes StatefulSet configuration comprises the following:

  • StatefulSet: The template that defines pod selectors and replicas of containers that will run on the pods.
  • Headless service: The network domain controller that allows clients to connect with the pods using a DNS entry.
  • Volume claim template: The template specification that allows administrators to provision stateful storage using persistent volumes.

StatefulSet configuration manifest

Consider a StatefulSet configuration named statefulset.yaml with the following specification:

yaml

The above StatefulSet can be attached to a PersistentVolume named darwin-claim.yaml as follows:

yaml

To expose the StatefulSet via a headless service named darwin-service.yaml, the following configuration can be used:

yaml

All the above configurations can be applied to the cluster using the kubectl apply command, as follows:

$ kubectl apply -f statefulset.yaml

$ kubectl apply -f darwin-claim.yaml

$ kubectl apply -f darwin-service.yaml

The above commands create three pod replicas with ordered identities.

Discovering StatefulSet details

Pods within the StatefulSet can be verified with the get pods command:.

$ kubectl get pods

The above command returns the list of pods running, as shown below:

NAMEREADYSTATUSRESTARTSAGE
darwin-01/1Running047s
darwin-11/1Running038s
darwin-21/1Running021s

Quick Note: The above output shows that the StatefulSet created the pods in an ordered sequence, with the index starting at 0. As the StatefulSet controller guarantees ordering and uniqueness of pods, and since the StatefulSet was initially named as darwin, the pod replicas are auto-named as darwin-0, darwin-1, and darwin-2.

Kubernetes Deployment vs. StatefulSet: how to choose

The table below shows the primary differences between a StatefulSet and a Deployment:

AspectDeploymentStatefulSet
---------------------------
Data persistenceStatelessStateful
Pod name and identityPods are assigned an ID that consists of the deployment name and a random hash to generate a temporarily unique identityEach pod gets a persistent identity consisting of the StatefulSet name and a sequence number
InterchangeabilityPods are identical and can be interchangedPods in a StatefulSet are neither identical nor interchangeable
BehaviorA pod can be replaced by a new replica at any timePods retain their identity when rescheduled on another node
Volume claimAll replicas share a PVC and a volumeEach pod gets a unique volume and PVC
Allowed volume access mode(s)ReadWriteMany and ReadOnlyManyReadWriteOnce
Pod interactionRequires a service to interact with the podsThe headless service handles pod network identities
Order of pod creationPods are created and deleted randomlyPods are created in a strict sequence and cannot be deleted randomly

When to use

A StatefulSet is better suited to stateful workloads that require persistent storage on each cluster node, such as databases and other identity-sensitive workloads. A Deployment, on the other hand, is suitable for stateless workloads that use multiple replicas of one pod, such as web servers like Nginx and Apache.

This practical scenario demonstrates how a StatefulSet differs from a Deployment:

Consider a web app that uses a relational database to store data. When traffic to the application increases, administrators intend to scale up the number of pods to support the workload. A straightforward approach is simply to change the replica count within the Deployment’s configuration manifest; then the Deployment controller will take care of scaling. Since new pod replicas are assigned the same set of ConfigMaps and environment variables when starting, they communicate with the backend the same way as the original pod, retaining the user experience for incoming traffic.

Similar to the web servers, the relational database may also need to be scaled up to meet the increased workload. Since the master and replica pods need to implement a leader-follower pattern, the pods of the database cannot be created or deleted randomly. In addition, while each pod needs to sync its data with the previous pod, it retains its own copy of the data stored. In such an instance, a StatefulSet helps create the database pods in an ordered sequence where every new pod acquires its copy of data from the last pod generated. If a pod fails, the StatefulSet controller automatically deploys new pod replicas incrementally with the same identity and attaches them to the same PVC.

Use cases

StatefulSetDeployment
Stateful workloads that require persistent storage on each cluster nodeStateless workloads such as web servers
Ideal for key-value stores or database systemsFor balancing requests between replicas
Assigning ordered, unique identitiesTo automatically scale (creation/termination) pod replicas of a cluster
For gradual rolloutsFor controlled rollout and rollbacks
Deploy new pod replicas incrementallyFor deploying new pods with similar environment variables and ConfigMaps

Final thoughts

Deployments and StatefulSets are Kubernetes API resources with different approaches to launching and managing containerized workloads. StatefulSets assign pods the same storage and network identities across restarts, with every replica getting its own state and persistent volume claim. A Deployment is used to spin and scale stateless applications while saving the state of the ReplicaSet it manages in a persistent volume, so that all pod replicas share the same volume.

Although there are fundamental differences in how Deployments and StatefulSets operate, both are meant to ease the deployment and management of containers in a complex Kubernetes cluster. Before choosing one of them, it’s important for administrators to assess their technical use case and their objectives.

If you are looking for a way to monitor your Kubernetes clusters easily, try using Airplane. With Airplane, you can build custom internal tools within minutes. You can use Airplane's Views feature to build an internal dashboard that can monitor your Kubernetes clusters easily. Airplane offers a wide library of pre-built components and templates that make it simple to get started.

You can also use Airplane's engineering workflows solution for your other engineering-centric use cases, streamlining your engineering team's time and allowing them to work on customer-facing tasks.

To try it out and build your first internal UI within minutes, sign up for a free account or book a demo.

Share this article:
Sudip Sengupta
Sudip Sengupta is a TOGAF Certified Solutions Architect with more than 15 years of experience working for global majors such as CSC, Hewlett Packard Enterprise, and DXC Technology.

Subscribe to new blog posts from Airplane.