2016-11-28 22:22:55 +00:00
---
2018-02-18 20:13:37 +00:00
reviewers:
2016-11-28 22:22:55 +00:00
- enisoc
- erictune
- foxish
- janetkuo
- kow3ns
- smarterclayton
2016-12-15 20:16:54 +00:00
title: StatefulSet Basics
2018-05-05 16:00:51 +00:00
content_template: templates/tutorial
2018-05-15 22:29:27 +00:00
weight: 10
2016-11-28 22:22:55 +00:00
---
2018-05-05 16:00:51 +00:00
{{% capture overview %}}
2017-09-21 09:22:42 +00:00
This tutorial provides an introduction to managing applications with
2017-10-04 04:07:11 +00:00
[StatefulSets ](/docs/concepts/workloads/controllers/statefulset/ ). It
2017-06-27 16:46:39 +00:00
demonstrates how to create, delete, scale, and update the Pods of StatefulSets.
2018-05-05 16:00:51 +00:00
{{% /capture %}}
2016-11-28 22:22:55 +00:00
2018-05-05 16:00:51 +00:00
{{% capture prerequisites %}}
2016-11-28 22:22:55 +00:00
Before you begin this tutorial, you should familiarize yourself with the
following Kubernetes concepts.
* [Pods ](/docs/user-guide/pods/single-container/ )
2017-04-19 17:56:47 +00:00
* [Cluster DNS ](/docs/concepts/services-networking/dns-pod-service/ )
2017-04-20 12:08:43 +00:00
* [Headless Services ](/docs/concepts/services-networking/service/#headless-services )
2017-09-21 03:46:28 +00:00
* [PersistentVolumes ](/docs/concepts/storage/persistent-volumes/ )
2018-05-05 16:00:51 +00:00
* [PersistentVolume Provisioning ](https://github.com/kubernetes/examples/tree/{{< param "githubbranch" >}}/staging/persistent-volume-provisioning/ )
2017-10-04 04:07:11 +00:00
* [StatefulSets ](/docs/concepts/workloads/controllers/statefulset/ )
2017-10-10 04:08:58 +00:00
* [kubectl CLI ](/docs/user-guide/kubectl/ )
2016-11-28 22:22:55 +00:00
This tutorial assumes that your cluster is configured to dynamically provision
2016-11-29 19:33:21 +00:00
PersistentVolumes. If your cluster is not configured to do so, you
2017-09-21 03:46:28 +00:00
will have to manually provision two 1 GiB volumes prior to starting this
2016-11-28 22:22:55 +00:00
tutorial.
2018-05-05 16:00:51 +00:00
{{% /capture %}}
2016-11-28 22:22:55 +00:00
2018-05-05 16:00:51 +00:00
{{% capture objectives %}}
2016-11-29 18:01:38 +00:00
StatefulSets are intended to be used with stateful applications and distributed
2016-11-28 22:22:55 +00:00
systems. However, the administration of stateful applications and
distributed systems on Kubernetes is a broad, complex topic. In order to
2017-09-21 03:46:28 +00:00
demonstrate the basic features of a StatefulSet, and not to conflate the former
2017-06-27 16:46:39 +00:00
topic with the latter, you will deploy a simple web application using a StatefulSet.
2016-11-28 22:22:55 +00:00
After this tutorial, you will be familiar with the following.
2016-11-29 18:01:38 +00:00
* How to create a StatefulSet
* How a StatefulSet manages its Pods
* How to delete a StatefulSet
* How to scale a StatefulSet
2017-06-27 16:46:39 +00:00
* How to update a StatefulSet's Pods
2018-05-05 16:00:51 +00:00
{{% /capture %}}
2016-11-28 22:22:55 +00:00
2018-05-05 16:00:51 +00:00
{{% capture lessoncontent %}}
2017-01-18 18:18:37 +00:00
## Creating a StatefulSet
2016-11-28 22:22:55 +00:00
2016-11-29 18:01:38 +00:00
Begin by creating a StatefulSet using the example below. It is similar to the
2016-11-28 22:22:55 +00:00
example presented in the
2017-10-04 04:07:11 +00:00
[StatefulSets ](/docs/concepts/workloads/controllers/statefulset/ ) concept.
2017-09-24 18:06:23 +00:00
It creates a [Headless Service ](/docs/concepts/services-networking/service/#headless-services ),
2017-06-27 16:46:39 +00:00
`nginx` , to publish the IP addresses of Pods in the StatefulSet, `web` .
2016-11-28 22:22:55 +00:00
2018-07-02 20:37:19 +00:00
{{< codenew file = "application/web/web.yaml" > }}
2016-11-28 22:22:55 +00:00
2016-11-29 19:33:21 +00:00
Download the example above, and save it to a file named `web.yaml`
2016-11-28 22:22:55 +00:00
You will need to use two terminal windows. In the first terminal, use
2018-04-27 22:02:19 +00:00
[`kubectl get` ](/docs/reference/generated/kubectl/kubectl-commands/#get ) to watch the creation
2016-11-29 18:01:38 +00:00
of the StatefulSet's Pods.
2016-11-28 22:22:55 +00:00
```shell
2016-11-29 19:33:21 +00:00
kubectl get pods -w -l app=nginx
2016-11-28 22:22:55 +00:00
```
In the second terminal, use
2018-04-27 22:02:19 +00:00
[`kubectl create` ](/docs/reference/generated/kubectl/kubectl-commands/#create ) to create the
2016-11-29 18:01:38 +00:00
Headless Service and StatefulSet defined in `web.yaml` .
2016-11-28 22:22:55 +00:00
```shell
2016-12-27 21:34:54 +00:00
kubectl create -f web.yaml
2016-11-28 22:22:55 +00:00
service "nginx" created
statefulset "web" created
```
2016-11-29 19:33:21 +00:00
The command above creates two Pods, each running an
2016-11-28 22:22:55 +00:00
[NGINX ](https://www.nginx.com ) webserver. Get the `nginx` Service and the
2016-11-29 18:01:38 +00:00
`web` StatefulSet to verify that they were created successfully.
2016-11-28 22:22:55 +00:00
```shell
2016-11-29 19:33:21 +00:00
kubectl get service nginx
2016-11-28 22:22:55 +00:00
NAME CLUSTER-IP EXTERNAL-IP PORT(S) AGE
nginx None < none > 80/TCP 12s
2016-11-29 19:33:21 +00:00
kubectl get statefulset web
2016-11-28 22:22:55 +00:00
NAME DESIRED CURRENT AGE
web 2 1 20s
```
2017-01-18 18:18:37 +00:00
### Ordered Pod Creation
2016-11-28 22:22:55 +00:00
2016-11-29 18:01:38 +00:00
For a StatefulSet with N replicas, when Pods are being deployed, they are
2016-11-28 22:22:55 +00:00
created sequentially, in order from {0..N-1}. Examine the output of the
`kubectl get` command in the first terminal. Eventually, the output will
look like the example below.
```shell
2016-11-29 19:33:21 +00:00
kubectl get pods -w -l app=nginx
2016-11-28 22:22:55 +00:00
NAME READY STATUS RESTARTS AGE
web-0 0/1 Pending 0 0s
web-0 0/1 Pending 0 0s
web-0 0/1 ContainerCreating 0 0s
web-0 1/1 Running 0 19s
web-1 0/1 Pending 0 0s
web-1 0/1 Pending 0 0s
web-1 0/1 ContainerCreating 0 0s
web-1 1/1 Running 0 18s
```
2017-06-27 16:46:39 +00:00
Notice that the `web-1` Pod is not launched until the `web-0` Pod is
2016-11-28 22:22:55 +00:00
[Running and Ready ](/docs/user-guide/pod-states ).
2017-01-18 18:18:37 +00:00
## Pods in a StatefulSet
2017-06-27 16:46:39 +00:00
Pods in a StatefulSet have a unique ordinal index and a stable network identity.
2016-11-28 22:22:55 +00:00
2017-01-18 18:18:37 +00:00
### Examining the Pod's Ordinal Index
2016-11-28 22:22:55 +00:00
2016-11-29 18:01:38 +00:00
Get the StatefulSet's Pods.
2016-11-28 22:22:55 +00:00
```shell
2016-11-29 19:33:21 +00:00
kubectl get pods -l app=nginx
2016-11-28 22:22:55 +00:00
NAME READY STATUS RESTARTS AGE
web-0 1/1 Running 0 1m
web-1 1/1 Running 0 1m
```
2017-10-04 04:07:11 +00:00
As mentioned in the [StatefulSets ](/docs/concepts/workloads/controllers/statefulset/ )
2016-11-29 18:01:38 +00:00
concept, the Pods in a StatefulSet have a sticky, unique identity. This identity
2017-06-27 16:46:39 +00:00
is based on a unique ordinal index that is assigned to each Pod by the
StatefulSet controller. The Pods' names take the form
2016-11-29 19:33:21 +00:00
`<statefulset name>-<ordinal index>` . Since the `web` StatefulSet has two
2016-11-28 22:22:55 +00:00
replicas, it creates two Pods, `web-0` and `web-1` .
2017-01-18 18:18:37 +00:00
### Using Stable Network Identities
2017-06-27 16:46:39 +00:00
2016-11-28 22:22:55 +00:00
Each Pod has a stable hostname based on its ordinal index. Use
2018-04-27 22:02:19 +00:00
[`kubectl exec` ](/docs/reference/generated/kubectl/kubectl-commands/#exec ) to execute the
2016-11-28 22:22:55 +00:00
`hostname` command in each Pod.
```shell
2016-11-29 19:33:21 +00:00
for i in 0 1; do kubectl exec web-$i -- sh -c 'hostname'; done
2016-11-28 22:22:55 +00:00
web-0
web-1
```
2018-04-27 22:02:19 +00:00
Use [`kubectl run` ](/docs/reference/generated/kubectl/kubectl-commands/#run ) to execute
2016-11-28 22:22:55 +00:00
a container that provides the `nslookup` command from the `dnsutils` package.
Using `nslookup` on the Pods' hostnames, you can examine their in-cluster DNS
addresses.
```shell
2016-11-29 19:33:21 +00:00
kubectl run -i --tty --image busybox dns-test --restart=Never --rm /bin/sh
nslookup web-0.nginx
2016-11-28 22:22:55 +00:00
Server: 10.0.0.10
Address 1: 10.0.0.10 kube-dns.kube-system.svc.cluster.local
Name: web-0.nginx
Address 1: 10.244.1.6
2016-11-29 19:33:21 +00:00
nslookup web-1.nginx
2016-11-28 22:22:55 +00:00
Server: 10.0.0.10
Address 1: 10.0.0.10 kube-dns.kube-system.svc.cluster.local
Name: web-1.nginx
Address 1: 10.244.2.6
```
2016-12-23 08:45:56 +00:00
The CNAME of the headless service points to SRV records (one for each Pod that
2016-11-28 22:22:55 +00:00
is Running and Ready). The SRV records point to A record entries that
contain the Pods' IP addresses.
2016-11-29 18:01:38 +00:00
In one terminal, watch the StatefulSet's Pods.
2016-11-28 22:22:55 +00:00
```shell
2016-11-29 19:33:21 +00:00
kubectl get pod -w -l app=nginx
2016-11-28 22:22:55 +00:00
```
In a second terminal, use
2018-04-27 22:02:19 +00:00
[`kubectl delete` ](/docs/reference/generated/kubectl/kubectl-commands/#delete ) to delete all
2016-11-29 18:01:38 +00:00
the Pods in the StatefulSet.
2016-11-28 22:22:55 +00:00
```shell
2016-11-29 19:33:21 +00:00
kubectl delete pod -l app=nginx
2016-11-28 22:22:55 +00:00
pod "web-0" deleted
pod "web-1" deleted
```
2016-11-29 19:33:21 +00:00
Wait for the StatefulSet to restart them, and for both Pods to transition to
Running and Ready.
2016-11-28 22:22:55 +00:00
```shell
2016-11-29 19:33:21 +00:00
kubectl get pod -w -l app=nginx
2016-11-28 22:22:55 +00:00
NAME READY STATUS RESTARTS AGE
web-0 0/1 ContainerCreating 0 0s
NAME READY STATUS RESTARTS AGE
web-0 1/1 Running 0 2s
web-1 0/1 Pending 0 0s
web-1 0/1 Pending 0 0s
web-1 0/1 ContainerCreating 0 0s
web-1 1/1 Running 0 34s
```
Use `kubectl exec` and `kubectl run` to view the Pods hostnames and in-cluster
DNS entries.
```shell
2016-11-29 19:33:21 +00:00
for i in 0 1; do kubectl exec web-$i -- sh -c 'hostname'; done
2016-11-28 22:22:55 +00:00
web-0
web-1
2016-11-29 19:33:21 +00:00
kubectl run -i --tty --image busybox dns-test --restart=Never --rm /bin/sh
nslookup web-0.nginx
2016-11-28 22:22:55 +00:00
Server: 10.0.0.10
Address 1: 10.0.0.10 kube-dns.kube-system.svc.cluster.local
Name: web-0.nginx
Address 1: 10.244.1.7
2016-11-29 19:33:21 +00:00
nslookup web-1.nginx
2016-11-28 22:22:55 +00:00
Server: 10.0.0.10
Address 1: 10.0.0.10 kube-dns.kube-system.svc.cluster.local
Name: web-1.nginx
Address 1: 10.244.2.8
```
The Pods' ordinals, hostnames, SRV records, and A record names have not changed,
but the IP addresses associated with the Pods may have changed. In the cluster
used for this tutorial, they have. This is why it is important not to configure
2016-11-29 18:01:38 +00:00
other applications to connect to Pods in a StatefulSet by IP address.
2016-11-28 22:22:55 +00:00
2016-12-02 17:53:04 +00:00
2016-11-29 18:01:38 +00:00
If you need to find and connect to the active members of a StatefulSet, you
2016-11-28 22:22:55 +00:00
should query the CNAME of the Headless Service
2016-12-02 17:53:04 +00:00
(`nginx.default.svc.cluster.local`). The SRV records associated with the
2016-11-29 18:01:38 +00:00
CNAME will contain only the Pods in the StatefulSet that are Running and
2016-11-28 22:22:55 +00:00
Ready.
2016-12-02 17:53:04 +00:00
If your application already implements connection logic that tests for
liveness and readiness, you can use the SRV records of the Pods (
`web-0.nginx.default.svc.cluster.local` ,
`web-1.nginx.default.svc.cluster.local` ), as they are stable, and your
application will be able to discover the Pods' addresses when they transition
to Running and Ready.
2016-11-28 22:22:55 +00:00
2017-01-18 18:18:37 +00:00
### Writing to Stable Storage
2016-11-28 22:22:55 +00:00
2016-11-29 18:01:38 +00:00
Get the PersistentVolumeClaims for `web-0` and `web-1` .
2016-11-28 22:22:55 +00:00
```shell
2016-11-29 19:33:21 +00:00
kubectl get pvc -l app=nginx
2016-11-28 22:22:55 +00:00
NAME STATUS VOLUME CAPACITY ACCESSMODES AGE
www-web-0 Bound pvc-15c268c7-b507-11e6-932f-42010a800002 1Gi RWO 48s
www-web-1 Bound pvc-15c79307-b507-11e6-932f-42010a800002 1Gi RWO 48s
```
2016-11-29 18:01:38 +00:00
The StatefulSet controller created two PersistentVolumeClaims that are
2017-09-21 07:57:21 +00:00
bound to two [PersistentVolumes ](/docs/concepts/storage/persistent-volumes/ ). As the cluster used in this tutorial is configured to dynamically provision
2017-06-27 16:46:39 +00:00
PersistentVolumes, the PersistentVolumes were created and bound automatically.
2016-11-28 22:22:55 +00:00
2016-11-29 19:33:21 +00:00
The NGINX webservers, by default, will serve an index file at
2016-11-28 22:22:55 +00:00
`/usr/share/nginx/html/index.html` . The `volumeMounts` field in the
2016-11-29 18:01:38 +00:00
StatefulSets `spec` ensures that the `/usr/share/nginx/html` directory is
backed by a PersistentVolume.
2016-11-28 22:22:55 +00:00
Write the Pods' hostnames to their `index.html` files and verify that the NGINX
webservers serve the hostnames.
```shell
2016-11-29 19:33:21 +00:00
for i in 0 1; do kubectl exec web-$i -- sh -c 'echo $(hostname) > /usr/share/nginx/html/index.html'; done
2016-11-28 22:22:55 +00:00
2016-11-29 19:33:21 +00:00
for i in 0 1; do kubectl exec -it web-$i -- curl localhost; done
2016-11-28 22:22:55 +00:00
web-0
web-1
```
2018-06-25 18:31:22 +00:00
{{< note > }}
2018-06-30 00:57:20 +00:00
**Note:** If you instead see 403 Forbidden responses for the above curl command,
2017-01-17 07:05:32 +00:00
you will need to fix the permissions of the directory mounted by the `volumeMounts`
(due to a [bug when using hostPath volumes ](https://github.com/kubernetes/kubernetes/issues/2630 )) with:
```shell
for i in 0 1; do kubectl exec web-$i -- chmod 755 /usr/share/nginx/html; done
```
before retrying the curl command above.
2018-06-25 18:31:22 +00:00
{{< / note > }}
2017-01-17 07:05:32 +00:00
2016-11-29 18:01:38 +00:00
In one terminal, watch the StatefulSet's Pods.
2016-11-28 22:22:55 +00:00
```shell
kubectl get pod -w -l app=nginx
```
2016-11-29 18:01:38 +00:00
In a second terminal, delete all of the StatefulSet's Pods.
2016-11-28 22:22:55 +00:00
```shell
2016-11-29 19:33:21 +00:00
kubectl delete pod -l app=nginx
2016-11-28 22:22:55 +00:00
pod "web-0" deleted
pod "web-1" deleted
```
Examine the output of the `kubectl get` command in the first terminal, and wait
for all of the Pods to transition to Running and Ready.
```shell
2016-11-29 19:33:21 +00:00
kubectl get pod -w -l app=nginx
2016-11-28 22:22:55 +00:00
NAME READY STATUS RESTARTS AGE
web-0 0/1 ContainerCreating 0 0s
NAME READY STATUS RESTARTS AGE
web-0 1/1 Running 0 2s
web-1 0/1 Pending 0 0s
web-1 0/1 Pending 0 0s
web-1 0/1 ContainerCreating 0 0s
web-1 1/1 Running 0 34s
```
2016-11-29 19:33:21 +00:00
Verify the web servers continue to serve their hostnames.
2016-11-28 22:22:55 +00:00
```
2016-11-29 19:33:21 +00:00
for i in 0 1; do kubectl exec -it web-$i -- curl localhost; done
2016-11-28 22:22:55 +00:00
web-0
web-1
```
2017-04-12 16:12:49 +00:00
Even though `web-0` and `web-1` were rescheduled, they continue to serve their
2017-06-27 16:46:39 +00:00
hostnames because the PersistentVolumes associated with their
2017-09-21 07:57:21 +00:00
PersistentVolumeClaims are remounted to their `volumeMounts` . No matter what
2017-06-27 16:46:39 +00:00
node `web-0` and `web-1` are scheduled on, their PersistentVolumes will be
mounted to the appropriate mount points.
2016-11-28 22:22:55 +00:00
2017-01-18 18:18:37 +00:00
## Scaling a StatefulSet
2016-12-02 22:26:22 +00:00
Scaling a StatefulSet refers to increasing or decreasing the number of replicas.
This is accomplished by updating the `replicas` field. You can use either
2018-04-27 22:02:19 +00:00
[`kubectl scale` ](/docs/reference/generated/kubectl/kubectl-commands/#scale ) or
[`kubectl patch` ](/docs/reference/generated/kubectl/kubectl-commands/#patch ) to scale a StatefulSet.
2016-11-28 22:22:55 +00:00
2017-01-18 18:18:37 +00:00
### Scaling Up
2016-11-28 22:22:55 +00:00
2016-11-29 18:01:38 +00:00
In one terminal window, watch the Pods in the StatefulSet.
2016-11-28 22:22:55 +00:00
```shell
2016-11-29 19:33:21 +00:00
kubectl get pods -w -l app=nginx
2016-11-28 22:22:55 +00:00
```
In another terminal window, use `kubectl scale` to scale the number of replicas
to 5.
```shell
2017-06-27 16:46:39 +00:00
kubectl scale sts web --replicas=5
2016-11-28 22:22:55 +00:00
statefulset "web" scaled
```
Examine the output of the `kubectl get` command in the first terminal, and wait
for the three additional Pods to transition to Running and Ready.
```shell
2016-11-29 19:33:21 +00:00
kubectl get pods -w -l app=nginx
2016-11-28 22:22:55 +00:00
NAME READY STATUS RESTARTS AGE
web-0 1/1 Running 0 2h
web-1 1/1 Running 0 2h
NAME READY STATUS RESTARTS AGE
web-2 0/1 Pending 0 0s
web-2 0/1 Pending 0 0s
web-2 0/1 ContainerCreating 0 0s
web-2 1/1 Running 0 19s
web-3 0/1 Pending 0 0s
web-3 0/1 Pending 0 0s
web-3 0/1 ContainerCreating 0 0s
web-3 1/1 Running 0 18s
web-4 0/1 Pending 0 0s
web-4 0/1 Pending 0 0s
web-4 0/1 ContainerCreating 0 0s
web-4 1/1 Running 0 19s
```
2016-11-29 18:01:38 +00:00
The StatefulSet controller scaled the number of replicas. As with
[StatefulSet creation ](#ordered-pod-creation ), the StatefulSet controller
2016-11-28 22:22:55 +00:00
created each Pod sequentially with respect to its ordinal index, and it
waited for each Pod's predecessor to be Running and Ready before launching the
subsequent Pod.
2017-01-18 18:18:37 +00:00
### Scaling Down
2016-11-28 22:22:55 +00:00
2016-11-29 18:01:38 +00:00
In one terminal, watch the StatefulSet's Pods.
2016-11-28 22:22:55 +00:00
```shell
2016-11-29 19:33:21 +00:00
kubectl get pods -w -l app=nginx
2016-11-28 22:22:55 +00:00
```
2016-11-29 18:01:38 +00:00
In another terminal, use `kubectl patch` to scale the StatefulSet back down to
2017-06-27 16:46:39 +00:00
three replicas.
2016-11-28 22:22:55 +00:00
```shell
2017-06-27 16:46:39 +00:00
kubectl patch sts web -p '{"spec":{"replicas":3}}'
2017-09-13 09:29:58 +00:00
statefulset "web" patched
2016-11-28 22:22:55 +00:00
```
Wait for `web-4` and `web-3` to transition to Terminating.
```
2016-11-29 19:33:21 +00:00
kubectl get pods -w -l app=nginx
2016-11-28 22:22:55 +00:00
NAME READY STATUS RESTARTS AGE
web-0 1/1 Running 0 3h
web-1 1/1 Running 0 3h
web-2 1/1 Running 0 55s
web-3 1/1 Running 0 36s
web-4 0/1 ContainerCreating 0 18s
NAME READY STATUS RESTARTS AGE
web-4 1/1 Running 0 19s
web-4 1/1 Terminating 0 24s
web-4 1/1 Terminating 0 24s
web-3 1/1 Terminating 0 42s
web-3 1/1 Terminating 0 42s
```
2017-01-18 18:18:37 +00:00
### Ordered Pod Termination
2016-11-28 22:22:55 +00:00
2017-06-27 16:46:39 +00:00
The controller deleted one Pod at a time, in reverse order with respect to its
ordinal index, and it waited for each to be completely shutdown before
2016-11-29 19:33:21 +00:00
deleting the next.
2016-11-28 22:22:55 +00:00
2016-11-29 19:33:21 +00:00
Get the StatefulSet's PersistentVolumeClaims.
2016-11-28 22:22:55 +00:00
```shell
2016-11-29 19:33:21 +00:00
kubectl get pvc -l app=nginx
2016-11-28 22:22:55 +00:00
NAME STATUS VOLUME CAPACITY ACCESSMODES AGE
www-web-0 Bound pvc-15c268c7-b507-11e6-932f-42010a800002 1Gi RWO 13h
www-web-1 Bound pvc-15c79307-b507-11e6-932f-42010a800002 1Gi RWO 13h
www-web-2 Bound pvc-e1125b27-b508-11e6-932f-42010a800002 1Gi RWO 13h
www-web-3 Bound pvc-e1176df6-b508-11e6-932f-42010a800002 1Gi RWO 13h
www-web-4 Bound pvc-e11bb5f8-b508-11e6-932f-42010a800002 1Gi RWO 13h
```
2016-11-29 18:01:38 +00:00
There are still five PersistentVolumeClaims and five PersistentVolumes.
2017-10-06 23:03:41 +00:00
When exploring a Pod's [stable storage ](#writing-to-stable-storage ), we saw that the PersistentVolumes mounted to the Pods of a StatefulSet are not deleted when the StatefulSet's Pods are deleted. This is still true when Pod deletion is caused by scaling the StatefulSet down.
2016-11-28 22:22:55 +00:00
2017-06-27 16:46:39 +00:00
## Updating StatefulSets
2016-11-28 22:22:55 +00:00
Release 1.8 (#5659)
* GC now supports non-core resources
* Add two examples about how to analysis audits of kube-apiserver (#4264)
* Deprecate system:nodes binding
* [1.8] StatefulSet `initialized` annotation is now ignored.
* inits the kubeadm upgrade docs
addresses kubernetes/kubernetes.github.io/issues/4689
* adds kubeadm upgrade cmd to ToC
addresses kubernetes/kubernetes.github.io/issues/4689
* add workload placement docs
* ScaleIO - document udpate for 1.8
* Add documentation on storageClass.mountOptions and PV.mountOptions (#5254)
* Add documentation on storageClass.mountOptions and PV.mountOptions
* convert notes into callouts
* Add docs for CustomResource validation
add info about supported fields
* advanced audit beta features (#5300)
* Update job workload doc with backoff failure policy (#5319)
Add to the Jobs documentation how to use the new backoffLimit field that
limit the number of Pod failure before considering the Job as failed.
* Documented additional AWS Service annotations (#4864)
* Add device plugin doc under concepts/cluster-administration. (#5261)
* Add device plugin doc under concepts/cluster-administration.
* Update device-plugins.md
* Update device-plugins.md
Add meta description. Fix typo. Change bare metal deployment to manual deployment.
* Update device-plugins.md
Fix typo again.
* Update page.version. (#5341)
* Add documentation on storageClass.reclaimPolicy (#5171)
* [Advanced audit] use new herf for audit-api (#5349)
This tag contains all the changes in v1beta1 version. Update it now.
* Added documentation around creating the InitializerConfiguration for the persistent volume label controller in the cloud-controller-manager (#5255)
* Documentation for kubectl plugins (#5294)
* Documentation for kubectl plugins
* Update kubectl-plugins.md
* Update kubectl-plugins.md
* Updated CPU manager docs to match implementation. (#5332)
* Noted limitation of alpha static cpumanager.
* Updated CPU manager docs to match implementation.
- Removed references to CPU pressure node condition and evictions.
- Added note about new --cpu-manager-reconcile-period flag.
- Added note about node allocatable requirements for static policy.
- Noted limitation of alpha static cpumanager.
* Move cpu-manager task link to rsc mgmt section.
* init containers annotation removed in 1.8 (#5390)
* Add documentation for TaintNodesByCondition (#5352)
* Add documentation for TaintNodesByCondition
* Update nodes.md
* Update taint-and-toleration.md
* Update daemonset.md
* Update nodes.md
* Update taint-and-toleration.md
* Update daemonset.md
* Fix deployments (#5421)
* Document extended resources and OIR deprecation. (#5399)
* Document extended resources and OIR deprecation.
* Updated extended resources doc per reviews.
* reverts extra spacing in _data/tasks.yml
* addresses `kubeadm upgrade` review comments
Feedback from @chenopis, @luxas, and @steveperry-53 addressed with this commit
* HugePages documentation (#5419)
* Update cpu-management-policies.md (#5407)
Fixed the bad link.
Modified "cpu" to "CPU".
Added more 'yaml' as supplement.
* Update RBAC docs for v1 (#5445)
* Add user docs for pod priority and preemption (#5328)
* Add user docs for pod priority and preemption
* Update pod-priority-preemption.md
* More updates
* Update docs/admin/kubeadm.md for 1.8 (#5440)
- Made a couple of minor wording changes (not strictly 1.8 related).
- Did some reformatting (not strictly 1.8 related).
- Updated references to the default token TTL (was infinite, now 24 hours).
- Documented the new `--discovery-token-ca-cert-hash` and `--discovery-token-unsafe-skip-ca-verification` flags for `kubeadm join`.
- Added references to the new `--discovery-token-ca-cert-hash` flag in all the default examples.
- Added a new _Security model_ section that describes the security tradeoffs of the various discovery modes.
- Documented the new `--groups` flag for `kubeadm token create`.
- Added a note of caution under _Automating kubeadm_ that references the _Security model_ section.
- Updated the component version table to drop 1.6 and add 1.8.
- Update `_data/reference.yml` to try to get the sidebar fixed up and more consistent with `kubefed`.
* Update StatefulSet Basics for 1.8 release (#5398)
* addresses `kubeadm upgrade` review comments
2nd iteration review comments by @luxas
* adds kubelet upgrade section to kubeadm upgrade
* Fix a bulleted list on docs/admin/kubeadm.md. (#5458)
I updated this doc yesterday and I was absolutely sure I fixed this, but I just saw that this commit got lost somehow.
This was introduced recently in https://github.com/kubernetes/kubernetes.github.io/pull/5440.
* Clarify the API to check for device plugins
* Moving Flexvolume to separate out-of-tree section
* addresses `kubeadm upgrade` review comments
CC: @luxas
* fixes kubeadm upgrade index
* Update Stackdriver Logging documentation (#5495)
* Re-update WordPress and MySQL PV doc to use apps/v1beta2 APIs (#5526)
* Update statefulset concepts doc to use apps/v1beta2 APIs (#5420)
* add document on kubectl's behavior regarding initializers (#5505)
* Update docs/admin/kubeadm.md to cover self-hosting in 1.8. (#5497)
This is a new beta feature in 1.8.
* Update kubectl patch doc to use apps/v1beta2 APIs (#5422)
* [1.8] Update "Run Applications" tasks to apps/v1beta2. (#5525)
* Update replicated stateful application task for 1.8.
* Update single instance stateful app task for 1.8.
* Update stateless app task for 1.8.
* Update kubectl patch task for 1.8.
* fix the link of persistent storage (#5515)
* update the admission-controllers.md index.md what-is-kubernetes.md link
* fix the link of persistent storage
* Add quota support for local ephemeral storage (#5493)
* Add quota support for local ephemeral storage
update the doc to this alpha feature
* Update resource-quotas.md
* Updated Deployments concepts doc (#5491)
* Updated Deployments concepts doc
* Addressed comments
* Addressed more comments
* Modify allocatable storage to ephemeral-storage (#5490)
Update the doc to use ephemeral-storage instead of storage
* Revamped concepts doc for ReplicaSet (#5463)
* Revamped concepts doc for ReplicaSet
* Minor changes to call out specific versions for selector defaulting and
immutability
* Addressed doc review comments
* Remove petset documentations (#5395)
* Update docs to use batch/v1beta1 cronjobs (#5475)
* add federation job doc (#5485)
* add federation job doc
* Update job.md
Edits for clarity and consistency
* Update job.md
Fixed a typo
* update DaemonSet concept for 1.8 release (#5397)
* update DaemonSet concept for 1.8 release
* Update daemonset.md
Fix typo. than -> then
* Update bootstrap tokens doc for 1.8. (#5479)
* Update bootstrap tokens doc for 1.8.
This has some changes I missed when I was updating the main kubeadm documention:
- Bootstrap tokens are now beta, not alpha (https://github.com/kubernetes/features/issues/130)
- The apiserver flag to enable the authenticator changedin 1.8 (https://github.com/kubernetes/kubernetes/pull/51198)
- Added `auth-extra-groups` documentaion (https://github.com/kubernetes/kubernetes/pull/50933)
- Updated the _Token Management with `kubeadm`_ section to link to the main kubeadm docs, since it was just duplicated information.
* Update bootstrap-tokens.md
* Updated the Cassandra tutorial to use apps/v1beta2 (#5548)
* add docs for AllowPrivilegeEscalation (#5448)
Signed-off-by: Jess Frazelle <acidburn@microsoft.com>
* Add local ephemeral storage alpha feature in managing compute resource (#5522)
* Add local ephemeral storage alpha feature in managing compute resource
Since 1.8, we add the local ephemeral storage alpha feature as one
resource type to manage. Add this feature into the doc.
* Update manage-compute-resources-container.md
* Update manage-compute-resources-container.md
* Update manage-compute-resources-container.md
* Update manage-compute-resources-container.md
* Update manage-compute-resources-container.md
* Update manage-compute-resources-container.md
* Added documentation for Metrics Server (#5560)
* authorization: improve authorization debugging docs (#5549)
* Document mount propagation (#5544)
* Update /docs/setup/independent/create-cluster-kubeadm.md for 1.8. (#5524)
This introduction needed a couple of small tweaks to cover the `--discovery-token-ca-cert-hash` flag added in https://github.com/kubernetes/kubernetes/pull/49520 and some version bumps.
* Add task doc for alpha dynamic kubelet configuration (#5523)
* Fix input/output of selfsubjectaccess review (#5593)
* Add docs for implementing resize (#5528)
* Add docs for implementing resize
* Update admission-controllers.md
* Added link to PVC section
* minor typo fixes
* Update NetworkPolicy concept guide with egress and CIDR changes (#5529)
* update zookeeper tutorial for 1.8 release
* add doc for hostpath type (#5503)
* Federated Hpa feature doc (#5487)
* Federated Hpa feature doc
* Federated Hpa feature doc review fixes
* Update hpa.md
* Update hpa.md
* update cloud controller manager docs for v1.8
* Update cronjob with defaults information (#5556)
* Kubernetes 1.8 reference docs (#5632)
* Kubernetes 1.8 reference docs
* Kubectl reference docs for 1.8
* Update side bar with 1.8 kubectl and api ref docs links
* remove petset.md
* update on state of HostAlias in 1.8 with hostNetwork Pod support (#5644)
* Fix cron job deletion section (#5655)
* update imported docs (#5656)
* Add documentation for certificate rotation. (#5639)
* Link to using kubeadm page
* fix the command output
fix the command output
* fix typo in api/resources reference: "Worloads"
* Add documentation for certificate rotation.
* Create TOC entry for cloud controller manager. (#5662)
* Updates for new versions of API types
* Followup 5655: fix link to garbage collection (#5666)
* Temporarily redirect resources-reference to api-reference. (#5668)
* Update config for 1.8 release. (#5661)
* Update config for 1.8 release.
* Address reviewer comments.
* Switch references in HPA docs from alpha to beta (#5671)
The HPA docs still referenced the alpha version. This switches them to
talk about v2beta1, which is the appropriate version for Kubernetes 1.8
* Deprecate openstack heat (#5670)
* Fix typo in pod preset conflict example
Move container port definition to the correct line.
* Highlight openstack-heat provider deprecation
The openstack-heat provider for kube-up is being deprecated and will be
removed in a future release.
* Temporarily fix broken links by redirecting. (#5672)
* Fix broken links. (#5675)
* Fix render of code block (#5674)
* Fix broken links. (#5677)
* Add a small note about auto-bootstrapped CSR ClusterRoles (#5660)
* Update kubeadm install doc for v1.8 (#5676)
* add draft workloads api content for 1.8 (#5650)
* add draft workloads api content for 1.8
* edits per review, add tables, for 1.8 workloads api doc
* fix typo
* Minor fixes to kubeadm 1.8 upgrade guide. (#5678)
- The kubelet upgrade instructions should be done on every host, not
just worker nodes.
- We should just upgrade all packages, instead of calling out kubelet
specifically. This will also upgrade kubectl, kubeadm, and
kubernetes-cni, if installed.
- Draining nodes should also ignore daemonsets, and master errors can be
ignored.
- Make sure that the new kubeadm download is chmoded correctly.
- Add a step to run `kubeadm version` to verify after downloading.
- Manually approve new kubelet CSRs if rotation is enabled (known issue).
* Release 1.8 (#5680)
* Fix versions for 1.8 API ref docs
* Updates for 1.8 kubectl reference docs
* Kubeadm /docs/admin/kubeadm.md cleanup, editing. (#5681)
* Update docs/admin/kubeadm.md (mostly 1.8 related).
This is Fabrizio's work, which I'm committing along with my edits (in a commit on top of this).
* A few of my own edits to clarify and clean up some Markdown.
2017-09-29 04:46:51 +00:00
In Kubernetes 1.7 and later, the StatefulSet controller supports automated updates. The
2017-06-27 16:46:39 +00:00
strategy used is determined by the `spec.updateStrategy` field of the
StatefulSet API Object. This feature can be used to upgrade the container
images, resource requests and/or limits, labels, and annotations of the Pods in a
Release 1.8 (#5659)
* GC now supports non-core resources
* Add two examples about how to analysis audits of kube-apiserver (#4264)
* Deprecate system:nodes binding
* [1.8] StatefulSet `initialized` annotation is now ignored.
* inits the kubeadm upgrade docs
addresses kubernetes/kubernetes.github.io/issues/4689
* adds kubeadm upgrade cmd to ToC
addresses kubernetes/kubernetes.github.io/issues/4689
* add workload placement docs
* ScaleIO - document udpate for 1.8
* Add documentation on storageClass.mountOptions and PV.mountOptions (#5254)
* Add documentation on storageClass.mountOptions and PV.mountOptions
* convert notes into callouts
* Add docs for CustomResource validation
add info about supported fields
* advanced audit beta features (#5300)
* Update job workload doc with backoff failure policy (#5319)
Add to the Jobs documentation how to use the new backoffLimit field that
limit the number of Pod failure before considering the Job as failed.
* Documented additional AWS Service annotations (#4864)
* Add device plugin doc under concepts/cluster-administration. (#5261)
* Add device plugin doc under concepts/cluster-administration.
* Update device-plugins.md
* Update device-plugins.md
Add meta description. Fix typo. Change bare metal deployment to manual deployment.
* Update device-plugins.md
Fix typo again.
* Update page.version. (#5341)
* Add documentation on storageClass.reclaimPolicy (#5171)
* [Advanced audit] use new herf for audit-api (#5349)
This tag contains all the changes in v1beta1 version. Update it now.
* Added documentation around creating the InitializerConfiguration for the persistent volume label controller in the cloud-controller-manager (#5255)
* Documentation for kubectl plugins (#5294)
* Documentation for kubectl plugins
* Update kubectl-plugins.md
* Update kubectl-plugins.md
* Updated CPU manager docs to match implementation. (#5332)
* Noted limitation of alpha static cpumanager.
* Updated CPU manager docs to match implementation.
- Removed references to CPU pressure node condition and evictions.
- Added note about new --cpu-manager-reconcile-period flag.
- Added note about node allocatable requirements for static policy.
- Noted limitation of alpha static cpumanager.
* Move cpu-manager task link to rsc mgmt section.
* init containers annotation removed in 1.8 (#5390)
* Add documentation for TaintNodesByCondition (#5352)
* Add documentation for TaintNodesByCondition
* Update nodes.md
* Update taint-and-toleration.md
* Update daemonset.md
* Update nodes.md
* Update taint-and-toleration.md
* Update daemonset.md
* Fix deployments (#5421)
* Document extended resources and OIR deprecation. (#5399)
* Document extended resources and OIR deprecation.
* Updated extended resources doc per reviews.
* reverts extra spacing in _data/tasks.yml
* addresses `kubeadm upgrade` review comments
Feedback from @chenopis, @luxas, and @steveperry-53 addressed with this commit
* HugePages documentation (#5419)
* Update cpu-management-policies.md (#5407)
Fixed the bad link.
Modified "cpu" to "CPU".
Added more 'yaml' as supplement.
* Update RBAC docs for v1 (#5445)
* Add user docs for pod priority and preemption (#5328)
* Add user docs for pod priority and preemption
* Update pod-priority-preemption.md
* More updates
* Update docs/admin/kubeadm.md for 1.8 (#5440)
- Made a couple of minor wording changes (not strictly 1.8 related).
- Did some reformatting (not strictly 1.8 related).
- Updated references to the default token TTL (was infinite, now 24 hours).
- Documented the new `--discovery-token-ca-cert-hash` and `--discovery-token-unsafe-skip-ca-verification` flags for `kubeadm join`.
- Added references to the new `--discovery-token-ca-cert-hash` flag in all the default examples.
- Added a new _Security model_ section that describes the security tradeoffs of the various discovery modes.
- Documented the new `--groups` flag for `kubeadm token create`.
- Added a note of caution under _Automating kubeadm_ that references the _Security model_ section.
- Updated the component version table to drop 1.6 and add 1.8.
- Update `_data/reference.yml` to try to get the sidebar fixed up and more consistent with `kubefed`.
* Update StatefulSet Basics for 1.8 release (#5398)
* addresses `kubeadm upgrade` review comments
2nd iteration review comments by @luxas
* adds kubelet upgrade section to kubeadm upgrade
* Fix a bulleted list on docs/admin/kubeadm.md. (#5458)
I updated this doc yesterday and I was absolutely sure I fixed this, but I just saw that this commit got lost somehow.
This was introduced recently in https://github.com/kubernetes/kubernetes.github.io/pull/5440.
* Clarify the API to check for device plugins
* Moving Flexvolume to separate out-of-tree section
* addresses `kubeadm upgrade` review comments
CC: @luxas
* fixes kubeadm upgrade index
* Update Stackdriver Logging documentation (#5495)
* Re-update WordPress and MySQL PV doc to use apps/v1beta2 APIs (#5526)
* Update statefulset concepts doc to use apps/v1beta2 APIs (#5420)
* add document on kubectl's behavior regarding initializers (#5505)
* Update docs/admin/kubeadm.md to cover self-hosting in 1.8. (#5497)
This is a new beta feature in 1.8.
* Update kubectl patch doc to use apps/v1beta2 APIs (#5422)
* [1.8] Update "Run Applications" tasks to apps/v1beta2. (#5525)
* Update replicated stateful application task for 1.8.
* Update single instance stateful app task for 1.8.
* Update stateless app task for 1.8.
* Update kubectl patch task for 1.8.
* fix the link of persistent storage (#5515)
* update the admission-controllers.md index.md what-is-kubernetes.md link
* fix the link of persistent storage
* Add quota support for local ephemeral storage (#5493)
* Add quota support for local ephemeral storage
update the doc to this alpha feature
* Update resource-quotas.md
* Updated Deployments concepts doc (#5491)
* Updated Deployments concepts doc
* Addressed comments
* Addressed more comments
* Modify allocatable storage to ephemeral-storage (#5490)
Update the doc to use ephemeral-storage instead of storage
* Revamped concepts doc for ReplicaSet (#5463)
* Revamped concepts doc for ReplicaSet
* Minor changes to call out specific versions for selector defaulting and
immutability
* Addressed doc review comments
* Remove petset documentations (#5395)
* Update docs to use batch/v1beta1 cronjobs (#5475)
* add federation job doc (#5485)
* add federation job doc
* Update job.md
Edits for clarity and consistency
* Update job.md
Fixed a typo
* update DaemonSet concept for 1.8 release (#5397)
* update DaemonSet concept for 1.8 release
* Update daemonset.md
Fix typo. than -> then
* Update bootstrap tokens doc for 1.8. (#5479)
* Update bootstrap tokens doc for 1.8.
This has some changes I missed when I was updating the main kubeadm documention:
- Bootstrap tokens are now beta, not alpha (https://github.com/kubernetes/features/issues/130)
- The apiserver flag to enable the authenticator changedin 1.8 (https://github.com/kubernetes/kubernetes/pull/51198)
- Added `auth-extra-groups` documentaion (https://github.com/kubernetes/kubernetes/pull/50933)
- Updated the _Token Management with `kubeadm`_ section to link to the main kubeadm docs, since it was just duplicated information.
* Update bootstrap-tokens.md
* Updated the Cassandra tutorial to use apps/v1beta2 (#5548)
* add docs for AllowPrivilegeEscalation (#5448)
Signed-off-by: Jess Frazelle <acidburn@microsoft.com>
* Add local ephemeral storage alpha feature in managing compute resource (#5522)
* Add local ephemeral storage alpha feature in managing compute resource
Since 1.8, we add the local ephemeral storage alpha feature as one
resource type to manage. Add this feature into the doc.
* Update manage-compute-resources-container.md
* Update manage-compute-resources-container.md
* Update manage-compute-resources-container.md
* Update manage-compute-resources-container.md
* Update manage-compute-resources-container.md
* Update manage-compute-resources-container.md
* Added documentation for Metrics Server (#5560)
* authorization: improve authorization debugging docs (#5549)
* Document mount propagation (#5544)
* Update /docs/setup/independent/create-cluster-kubeadm.md for 1.8. (#5524)
This introduction needed a couple of small tweaks to cover the `--discovery-token-ca-cert-hash` flag added in https://github.com/kubernetes/kubernetes/pull/49520 and some version bumps.
* Add task doc for alpha dynamic kubelet configuration (#5523)
* Fix input/output of selfsubjectaccess review (#5593)
* Add docs for implementing resize (#5528)
* Add docs for implementing resize
* Update admission-controllers.md
* Added link to PVC section
* minor typo fixes
* Update NetworkPolicy concept guide with egress and CIDR changes (#5529)
* update zookeeper tutorial for 1.8 release
* add doc for hostpath type (#5503)
* Federated Hpa feature doc (#5487)
* Federated Hpa feature doc
* Federated Hpa feature doc review fixes
* Update hpa.md
* Update hpa.md
* update cloud controller manager docs for v1.8
* Update cronjob with defaults information (#5556)
* Kubernetes 1.8 reference docs (#5632)
* Kubernetes 1.8 reference docs
* Kubectl reference docs for 1.8
* Update side bar with 1.8 kubectl and api ref docs links
* remove petset.md
* update on state of HostAlias in 1.8 with hostNetwork Pod support (#5644)
* Fix cron job deletion section (#5655)
* update imported docs (#5656)
* Add documentation for certificate rotation. (#5639)
* Link to using kubeadm page
* fix the command output
fix the command output
* fix typo in api/resources reference: "Worloads"
* Add documentation for certificate rotation.
* Create TOC entry for cloud controller manager. (#5662)
* Updates for new versions of API types
* Followup 5655: fix link to garbage collection (#5666)
* Temporarily redirect resources-reference to api-reference. (#5668)
* Update config for 1.8 release. (#5661)
* Update config for 1.8 release.
* Address reviewer comments.
* Switch references in HPA docs from alpha to beta (#5671)
The HPA docs still referenced the alpha version. This switches them to
talk about v2beta1, which is the appropriate version for Kubernetes 1.8
* Deprecate openstack heat (#5670)
* Fix typo in pod preset conflict example
Move container port definition to the correct line.
* Highlight openstack-heat provider deprecation
The openstack-heat provider for kube-up is being deprecated and will be
removed in a future release.
* Temporarily fix broken links by redirecting. (#5672)
* Fix broken links. (#5675)
* Fix render of code block (#5674)
* Fix broken links. (#5677)
* Add a small note about auto-bootstrapped CSR ClusterRoles (#5660)
* Update kubeadm install doc for v1.8 (#5676)
* add draft workloads api content for 1.8 (#5650)
* add draft workloads api content for 1.8
* edits per review, add tables, for 1.8 workloads api doc
* fix typo
* Minor fixes to kubeadm 1.8 upgrade guide. (#5678)
- The kubelet upgrade instructions should be done on every host, not
just worker nodes.
- We should just upgrade all packages, instead of calling out kubelet
specifically. This will also upgrade kubectl, kubeadm, and
kubernetes-cni, if installed.
- Draining nodes should also ignore daemonsets, and master errors can be
ignored.
- Make sure that the new kubeadm download is chmoded correctly.
- Add a step to run `kubeadm version` to verify after downloading.
- Manually approve new kubelet CSRs if rotation is enabled (known issue).
* Release 1.8 (#5680)
* Fix versions for 1.8 API ref docs
* Updates for 1.8 kubectl reference docs
* Kubeadm /docs/admin/kubeadm.md cleanup, editing. (#5681)
* Update docs/admin/kubeadm.md (mostly 1.8 related).
This is Fabrizio's work, which I'm committing along with my edits (in a commit on top of this).
* A few of my own edits to clarify and clean up some Markdown.
2017-09-29 04:46:51 +00:00
StatefulSet. There are two valid update strategies, `RollingUpdate` and
2018-07-08 10:34:18 +00:00
`OnDelete` .
`RollingUpdate` update strategy is the default for StatefulSets.
2016-11-28 22:22:55 +00:00
2017-06-27 16:46:39 +00:00
### Rolling Update
The `RollingUpdate` update strategy will update all Pods in a StatefulSet, in
reverse ordinal order, while respecting the StatefulSet guarantees.
Patch the `web` StatefulSet to apply the `RollingUpdate` update strategy.
```shell
2017-09-23 08:22:06 +00:00
kubectl patch statefulset web -p '{"spec":{"updateStrategy":{"type":"RollingUpdate"}}}'
2017-06-27 16:46:39 +00:00
statefulset "web" patched
```
In one terminal window, patch the `web` StatefulSet to change the container
image again.
```shell
2018-02-08 01:59:43 +00:00
kubectl patch statefulset web --type='json' -p='[{"op": "replace", "path": "/spec/template/spec/containers/0/image", "value":"gcr.io/google_containers/nginx-slim:0.8"}]'
2017-06-27 16:46:39 +00:00
statefulset "web" patched
```
In another terminal, watch the Pods in the StatefulSet.
```shell
kubectl get po -l app=nginx -w
NAME READY STATUS RESTARTS AGE
web-0 1/1 Running 0 7m
web-1 1/1 Running 0 7m
web-2 1/1 Running 0 8m
web-2 1/1 Terminating 0 8m
web-2 1/1 Terminating 0 8m
web-2 0/1 Terminating 0 8m
web-2 0/1 Terminating 0 8m
web-2 0/1 Terminating 0 8m
web-2 0/1 Terminating 0 8m
web-2 0/1 Pending 0 0s
web-2 0/1 Pending 0 0s
web-2 0/1 ContainerCreating 0 0s
web-2 1/1 Running 0 19s
web-1 1/1 Terminating 0 8m
web-1 0/1 Terminating 0 8m
web-1 0/1 Terminating 0 8m
web-1 0/1 Terminating 0 8m
web-1 0/1 Pending 0 0s
web-1 0/1 Pending 0 0s
web-1 0/1 ContainerCreating 0 0s
web-1 1/1 Running 0 6s
web-0 1/1 Terminating 0 7m
web-0 1/1 Terminating 0 7m
web-0 0/1 Terminating 0 7m
web-0 0/1 Terminating 0 7m
web-0 0/1 Terminating 0 7m
web-0 0/1 Terminating 0 7m
web-0 0/1 Pending 0 0s
web-0 0/1 Pending 0 0s
web-0 0/1 ContainerCreating 0 0s
web-0 1/1 Running 0 10s
```
The Pods in the StatefulSet are updated in reverse ordinal order. The
StatefulSet controller terminates each Pod, and waits for it to transition to Running and
Ready prior to updating the next Pod. Note that, even though the StatefulSet
controller will not proceed to update the next Pod until its ordinal successor
is Running and Ready, it will restore any Pod that fails during the update to
its current version. Pods that have already received the update will be
restored to the updated version, and Pods that have not yet received the
update will be restored to the previous version. In this way, the controller
attempts to continue to keep the application healthy and the update consistent
in the presence of intermittent failures.
Get the Pods to view their container images.
2018-05-05 16:00:51 +00:00
```shell
2017-06-27 16:46:39 +00:00
for p in 0 1 2; do kubectl get po web-$p --template '{{range $i, $c := .spec.containers}}{{$c.image}}{{end}}'; echo; done
2017-12-22 17:55:16 +00:00
k8s.gcr.io/nginx-slim:0.8
k8s.gcr.io/nginx-slim:0.8
k8s.gcr.io/nginx-slim:0.8
2018-05-05 16:00:51 +00:00
2017-06-27 16:46:39 +00:00
```
All the Pods in the StatefulSet are now running the previous container image.
**Tip** You can also use `kubectl rollout status sts/<name>` to view
the status of a rolling update.
#### Staging an Update
You can stage an update to a StatefulSet by using the `partition` parameter of
the `RollingUpdate` update strategy. A staged update will keep all of the Pods
in the StatefulSet at the current version while allowing mutations to the
StatefulSet's `.spec.template` .
Patch the `web` StatefulSet to add a partition to the `updateStrategy` field.
```shell
kubectl patch statefulset web -p '{"spec":{"updateStrategy":{"type":"RollingUpdate","rollingUpdate":{"partition":3}}}}'
statefulset "web" patched
```
Patch the StatefulSet again to change the container's image.
```shell
2017-12-22 17:55:16 +00:00
kubectl patch statefulset web --type='json' -p='[{"op": "replace", "path": "/spec/template/spec/containers/0/image", "value":"k8s.gcr.io/nginx-slim:0.7"}]'
2017-06-27 16:46:39 +00:00
statefulset "web" patched
```
Delete a Pod in the StatefulSet.
```shell
kubectl delete po web-2
pod "web-2" deleted
```
Wait for the Pod to be Running and Ready.
```shell
2017-09-25 23:09:16 +00:00
kubectl get po -l app=nginx -w
2017-06-27 16:46:39 +00:00
NAME READY STATUS RESTARTS AGE
web-0 1/1 Running 0 4m
web-1 1/1 Running 0 4m
web-2 0/1 ContainerCreating 0 11s
web-2 1/1 Running 0 18s
```
Get the Pod's container.
2018-05-05 16:00:51 +00:00
```shell
2017-08-22 13:14:16 +00:00
kubectl get po web-2 --template '{{range $i, $c := .spec.containers}}{{$c.image}}{{end}}'
2017-12-22 17:55:16 +00:00
k8s.gcr.io/nginx-slim:0.8
2018-05-05 16:00:51 +00:00
2017-06-27 16:46:39 +00:00
```
Notice that, even though the update strategy is `RollingUpdate` the StatefulSet
controller restored the Pod with its original container. This is because the
ordinal of the Pod is less than the `partition` specified by the
`updateStrategy` .
#### Rolling Out a Canary
You can roll out a canary to test a modification by decrementing the `partition`
you specified [above ](#staging-an-update ).
Patch the StatefulSet to decrement the partition.
```shell
kubectl patch statefulset web -p '{"spec":{"updateStrategy":{"type":"RollingUpdate","rollingUpdate":{"partition":2}}}}'
statefulset "web" patched
```
Wait for `web-2` to be Running and Ready.
```shell
2017-09-25 23:09:16 +00:00
kubectl get po -l app=nginx -w
2017-06-27 16:46:39 +00:00
NAME READY STATUS RESTARTS AGE
web-0 1/1 Running 0 4m
web-1 1/1 Running 0 4m
web-2 0/1 ContainerCreating 0 11s
web-2 1/1 Running 0 18s
```
Get the Pod's container.
2018-05-05 16:00:51 +00:00
```shell
2017-06-27 16:46:39 +00:00
kubectl get po web-2 --template '{{range $i, $c := .spec.containers}}{{$c.image}}{{end}}'
2017-12-22 17:55:16 +00:00
k8s.gcr.io/nginx-slim:0.7
2018-05-05 16:00:51 +00:00
2017-06-27 16:46:39 +00:00
```
When you changed the `partition` , the StatefulSet controller automatically
2018-01-29 17:47:31 +00:00
updated the `web-2` Pod because the Pod's ordinal was greater than or equal to
2017-06-27 16:46:39 +00:00
the `partition` .
Delete the `web-1` Pod.
```shell
kubectl delete po web-1
pod "web-1" deleted
```
Wait for the `web-1` Pod to be Running and Ready.
```shell
2017-09-25 23:09:16 +00:00
kubectl get po -l app=nginx -w
2017-06-27 16:46:39 +00:00
NAME READY STATUS RESTARTS AGE
web-0 1/1 Running 0 6m
web-1 0/1 Terminating 0 6m
web-2 1/1 Running 0 2m
web-1 0/1 Terminating 0 6m
web-1 0/1 Terminating 0 6m
web-1 0/1 Terminating 0 6m
web-1 0/1 Pending 0 0s
web-1 0/1 Pending 0 0s
web-1 0/1 ContainerCreating 0 0s
web-1 1/1 Running 0 18s
```
Get the `web-1` Pods container.
2018-05-05 16:00:51 +00:00
```shell
2017-08-22 13:21:31 +00:00
kubectl get po web-1 --template '{{range $i, $c := .spec.containers}}{{$c.image}}{{end}}'
2017-12-22 17:55:16 +00:00
k8s.gcr.io/nginx-slim:0.8
2018-05-05 16:00:51 +00:00
2017-06-27 16:46:39 +00:00
```
`web-1` was restored to its original configuration because the Pod's ordinal
was less than the partition. When a partition is specified, all Pods with an
ordinal that is greater than or equal to the partition will be updated when the
StatefulSet's `.spec.template` is updated. If a Pod that has an ordinal less
than the partition is deleted or otherwise terminated, it will be restored to
its original configuration.
#### Phased Roll Outs
You can perform a phased roll out (e.g. a linear, geometric, or exponential
roll out) using a partitioned rolling update in a similar manner to how you
rolled out a [canary ](#rolling-out-a-canary ). To perform a phased roll out, set
the `partition` to the ordinal at which you want the controller to pause the
update.
The partition is currently set to `2` . Set the partition to `0` .
```shell
kubectl patch statefulset web -p '{"spec":{"updateStrategy":{"type":"RollingUpdate","rollingUpdate":{"partition":0}}}}'
statefulset "web" patched
```
Wait for all of the Pods in the StatefulSet to become Running and Ready.
```shell
2017-09-25 23:09:16 +00:00
kubectl get po -l app=nginx -w
2017-06-27 16:46:39 +00:00
NAME READY STATUS RESTARTS AGE
web-0 1/1 Running 0 3m
web-1 0/1 ContainerCreating 0 11s
web-2 1/1 Running 0 2m
web-1 1/1 Running 0 18s
web-0 1/1 Terminating 0 3m
web-0 1/1 Terminating 0 3m
web-0 0/1 Terminating 0 3m
web-0 0/1 Terminating 0 3m
web-0 0/1 Terminating 0 3m
web-0 0/1 Terminating 0 3m
web-0 0/1 Pending 0 0s
web-0 0/1 Pending 0 0s
web-0 0/1 ContainerCreating 0 0s
web-0 1/1 Running 0 3s
```
Get the Pod's containers.
2018-05-05 16:00:51 +00:00
```shell
2017-06-27 16:46:39 +00:00
for p in 0 1 2; do kubectl get po web-$p --template '{{range $i, $c := .spec.containers}}{{$c.image}}{{end}}'; echo; done
2017-12-22 17:55:16 +00:00
k8s.gcr.io/nginx-slim:0.7
k8s.gcr.io/nginx-slim:0.7
k8s.gcr.io/nginx-slim:0.7
2018-05-05 16:00:51 +00:00
2017-06-27 16:46:39 +00:00
```
By moving the `partition` to `0` , you allowed the StatefulSet controller to
continue the update process.
Release 1.8 (#5659)
* GC now supports non-core resources
* Add two examples about how to analysis audits of kube-apiserver (#4264)
* Deprecate system:nodes binding
* [1.8] StatefulSet `initialized` annotation is now ignored.
* inits the kubeadm upgrade docs
addresses kubernetes/kubernetes.github.io/issues/4689
* adds kubeadm upgrade cmd to ToC
addresses kubernetes/kubernetes.github.io/issues/4689
* add workload placement docs
* ScaleIO - document udpate for 1.8
* Add documentation on storageClass.mountOptions and PV.mountOptions (#5254)
* Add documentation on storageClass.mountOptions and PV.mountOptions
* convert notes into callouts
* Add docs for CustomResource validation
add info about supported fields
* advanced audit beta features (#5300)
* Update job workload doc with backoff failure policy (#5319)
Add to the Jobs documentation how to use the new backoffLimit field that
limit the number of Pod failure before considering the Job as failed.
* Documented additional AWS Service annotations (#4864)
* Add device plugin doc under concepts/cluster-administration. (#5261)
* Add device plugin doc under concepts/cluster-administration.
* Update device-plugins.md
* Update device-plugins.md
Add meta description. Fix typo. Change bare metal deployment to manual deployment.
* Update device-plugins.md
Fix typo again.
* Update page.version. (#5341)
* Add documentation on storageClass.reclaimPolicy (#5171)
* [Advanced audit] use new herf for audit-api (#5349)
This tag contains all the changes in v1beta1 version. Update it now.
* Added documentation around creating the InitializerConfiguration for the persistent volume label controller in the cloud-controller-manager (#5255)
* Documentation for kubectl plugins (#5294)
* Documentation for kubectl plugins
* Update kubectl-plugins.md
* Update kubectl-plugins.md
* Updated CPU manager docs to match implementation. (#5332)
* Noted limitation of alpha static cpumanager.
* Updated CPU manager docs to match implementation.
- Removed references to CPU pressure node condition and evictions.
- Added note about new --cpu-manager-reconcile-period flag.
- Added note about node allocatable requirements for static policy.
- Noted limitation of alpha static cpumanager.
* Move cpu-manager task link to rsc mgmt section.
* init containers annotation removed in 1.8 (#5390)
* Add documentation for TaintNodesByCondition (#5352)
* Add documentation for TaintNodesByCondition
* Update nodes.md
* Update taint-and-toleration.md
* Update daemonset.md
* Update nodes.md
* Update taint-and-toleration.md
* Update daemonset.md
* Fix deployments (#5421)
* Document extended resources and OIR deprecation. (#5399)
* Document extended resources and OIR deprecation.
* Updated extended resources doc per reviews.
* reverts extra spacing in _data/tasks.yml
* addresses `kubeadm upgrade` review comments
Feedback from @chenopis, @luxas, and @steveperry-53 addressed with this commit
* HugePages documentation (#5419)
* Update cpu-management-policies.md (#5407)
Fixed the bad link.
Modified "cpu" to "CPU".
Added more 'yaml' as supplement.
* Update RBAC docs for v1 (#5445)
* Add user docs for pod priority and preemption (#5328)
* Add user docs for pod priority and preemption
* Update pod-priority-preemption.md
* More updates
* Update docs/admin/kubeadm.md for 1.8 (#5440)
- Made a couple of minor wording changes (not strictly 1.8 related).
- Did some reformatting (not strictly 1.8 related).
- Updated references to the default token TTL (was infinite, now 24 hours).
- Documented the new `--discovery-token-ca-cert-hash` and `--discovery-token-unsafe-skip-ca-verification` flags for `kubeadm join`.
- Added references to the new `--discovery-token-ca-cert-hash` flag in all the default examples.
- Added a new _Security model_ section that describes the security tradeoffs of the various discovery modes.
- Documented the new `--groups` flag for `kubeadm token create`.
- Added a note of caution under _Automating kubeadm_ that references the _Security model_ section.
- Updated the component version table to drop 1.6 and add 1.8.
- Update `_data/reference.yml` to try to get the sidebar fixed up and more consistent with `kubefed`.
* Update StatefulSet Basics for 1.8 release (#5398)
* addresses `kubeadm upgrade` review comments
2nd iteration review comments by @luxas
* adds kubelet upgrade section to kubeadm upgrade
* Fix a bulleted list on docs/admin/kubeadm.md. (#5458)
I updated this doc yesterday and I was absolutely sure I fixed this, but I just saw that this commit got lost somehow.
This was introduced recently in https://github.com/kubernetes/kubernetes.github.io/pull/5440.
* Clarify the API to check for device plugins
* Moving Flexvolume to separate out-of-tree section
* addresses `kubeadm upgrade` review comments
CC: @luxas
* fixes kubeadm upgrade index
* Update Stackdriver Logging documentation (#5495)
* Re-update WordPress and MySQL PV doc to use apps/v1beta2 APIs (#5526)
* Update statefulset concepts doc to use apps/v1beta2 APIs (#5420)
* add document on kubectl's behavior regarding initializers (#5505)
* Update docs/admin/kubeadm.md to cover self-hosting in 1.8. (#5497)
This is a new beta feature in 1.8.
* Update kubectl patch doc to use apps/v1beta2 APIs (#5422)
* [1.8] Update "Run Applications" tasks to apps/v1beta2. (#5525)
* Update replicated stateful application task for 1.8.
* Update single instance stateful app task for 1.8.
* Update stateless app task for 1.8.
* Update kubectl patch task for 1.8.
* fix the link of persistent storage (#5515)
* update the admission-controllers.md index.md what-is-kubernetes.md link
* fix the link of persistent storage
* Add quota support for local ephemeral storage (#5493)
* Add quota support for local ephemeral storage
update the doc to this alpha feature
* Update resource-quotas.md
* Updated Deployments concepts doc (#5491)
* Updated Deployments concepts doc
* Addressed comments
* Addressed more comments
* Modify allocatable storage to ephemeral-storage (#5490)
Update the doc to use ephemeral-storage instead of storage
* Revamped concepts doc for ReplicaSet (#5463)
* Revamped concepts doc for ReplicaSet
* Minor changes to call out specific versions for selector defaulting and
immutability
* Addressed doc review comments
* Remove petset documentations (#5395)
* Update docs to use batch/v1beta1 cronjobs (#5475)
* add federation job doc (#5485)
* add federation job doc
* Update job.md
Edits for clarity and consistency
* Update job.md
Fixed a typo
* update DaemonSet concept for 1.8 release (#5397)
* update DaemonSet concept for 1.8 release
* Update daemonset.md
Fix typo. than -> then
* Update bootstrap tokens doc for 1.8. (#5479)
* Update bootstrap tokens doc for 1.8.
This has some changes I missed when I was updating the main kubeadm documention:
- Bootstrap tokens are now beta, not alpha (https://github.com/kubernetes/features/issues/130)
- The apiserver flag to enable the authenticator changedin 1.8 (https://github.com/kubernetes/kubernetes/pull/51198)
- Added `auth-extra-groups` documentaion (https://github.com/kubernetes/kubernetes/pull/50933)
- Updated the _Token Management with `kubeadm`_ section to link to the main kubeadm docs, since it was just duplicated information.
* Update bootstrap-tokens.md
* Updated the Cassandra tutorial to use apps/v1beta2 (#5548)
* add docs for AllowPrivilegeEscalation (#5448)
Signed-off-by: Jess Frazelle <acidburn@microsoft.com>
* Add local ephemeral storage alpha feature in managing compute resource (#5522)
* Add local ephemeral storage alpha feature in managing compute resource
Since 1.8, we add the local ephemeral storage alpha feature as one
resource type to manage. Add this feature into the doc.
* Update manage-compute-resources-container.md
* Update manage-compute-resources-container.md
* Update manage-compute-resources-container.md
* Update manage-compute-resources-container.md
* Update manage-compute-resources-container.md
* Update manage-compute-resources-container.md
* Added documentation for Metrics Server (#5560)
* authorization: improve authorization debugging docs (#5549)
* Document mount propagation (#5544)
* Update /docs/setup/independent/create-cluster-kubeadm.md for 1.8. (#5524)
This introduction needed a couple of small tweaks to cover the `--discovery-token-ca-cert-hash` flag added in https://github.com/kubernetes/kubernetes/pull/49520 and some version bumps.
* Add task doc for alpha dynamic kubelet configuration (#5523)
* Fix input/output of selfsubjectaccess review (#5593)
* Add docs for implementing resize (#5528)
* Add docs for implementing resize
* Update admission-controllers.md
* Added link to PVC section
* minor typo fixes
* Update NetworkPolicy concept guide with egress and CIDR changes (#5529)
* update zookeeper tutorial for 1.8 release
* add doc for hostpath type (#5503)
* Federated Hpa feature doc (#5487)
* Federated Hpa feature doc
* Federated Hpa feature doc review fixes
* Update hpa.md
* Update hpa.md
* update cloud controller manager docs for v1.8
* Update cronjob with defaults information (#5556)
* Kubernetes 1.8 reference docs (#5632)
* Kubernetes 1.8 reference docs
* Kubectl reference docs for 1.8
* Update side bar with 1.8 kubectl and api ref docs links
* remove petset.md
* update on state of HostAlias in 1.8 with hostNetwork Pod support (#5644)
* Fix cron job deletion section (#5655)
* update imported docs (#5656)
* Add documentation for certificate rotation. (#5639)
* Link to using kubeadm page
* fix the command output
fix the command output
* fix typo in api/resources reference: "Worloads"
* Add documentation for certificate rotation.
* Create TOC entry for cloud controller manager. (#5662)
* Updates for new versions of API types
* Followup 5655: fix link to garbage collection (#5666)
* Temporarily redirect resources-reference to api-reference. (#5668)
* Update config for 1.8 release. (#5661)
* Update config for 1.8 release.
* Address reviewer comments.
* Switch references in HPA docs from alpha to beta (#5671)
The HPA docs still referenced the alpha version. This switches them to
talk about v2beta1, which is the appropriate version for Kubernetes 1.8
* Deprecate openstack heat (#5670)
* Fix typo in pod preset conflict example
Move container port definition to the correct line.
* Highlight openstack-heat provider deprecation
The openstack-heat provider for kube-up is being deprecated and will be
removed in a future release.
* Temporarily fix broken links by redirecting. (#5672)
* Fix broken links. (#5675)
* Fix render of code block (#5674)
* Fix broken links. (#5677)
* Add a small note about auto-bootstrapped CSR ClusterRoles (#5660)
* Update kubeadm install doc for v1.8 (#5676)
* add draft workloads api content for 1.8 (#5650)
* add draft workloads api content for 1.8
* edits per review, add tables, for 1.8 workloads api doc
* fix typo
* Minor fixes to kubeadm 1.8 upgrade guide. (#5678)
- The kubelet upgrade instructions should be done on every host, not
just worker nodes.
- We should just upgrade all packages, instead of calling out kubelet
specifically. This will also upgrade kubectl, kubeadm, and
kubernetes-cni, if installed.
- Draining nodes should also ignore daemonsets, and master errors can be
ignored.
- Make sure that the new kubeadm download is chmoded correctly.
- Add a step to run `kubeadm version` to verify after downloading.
- Manually approve new kubelet CSRs if rotation is enabled (known issue).
* Release 1.8 (#5680)
* Fix versions for 1.8 API ref docs
* Updates for 1.8 kubectl reference docs
* Kubeadm /docs/admin/kubeadm.md cleanup, editing. (#5681)
* Update docs/admin/kubeadm.md (mostly 1.8 related).
This is Fabrizio's work, which I'm committing along with my edits (in a commit on top of this).
* A few of my own edits to clarify and clean up some Markdown.
2017-09-29 04:46:51 +00:00
### On Delete
The `OnDelete` update strategy implements the legacy (1.6 and prior) behavior,
When you select this update strategy, the StatefulSet controller will not
automatically update Pods when a modification is made to the StatefulSet's
`.spec.template` field. This strategy can be selected by setting the
`.spec.template.updateStrategy.type` to `OnDelete` .
2017-01-18 18:18:37 +00:00
## Deleting StatefulSets
2016-11-28 22:22:55 +00:00
2016-11-29 18:01:38 +00:00
StatefulSet supports both Non-Cascading and Cascading deletion. In a
2017-09-21 09:27:41 +00:00
Non-Cascading Delete, the StatefulSet's Pods are not deleted when the StatefulSet is deleted. In a Cascading Delete, both the StatefulSet and its Pods are
2016-11-28 22:22:55 +00:00
deleted.
2017-01-18 18:18:37 +00:00
### Non-Cascading Delete
2016-11-28 22:22:55 +00:00
2016-11-29 18:01:38 +00:00
In one terminal window, watch the Pods in the StatefulSet.
2016-11-28 22:22:55 +00:00
```
2016-11-29 19:33:21 +00:00
kubectl get pods -w -l app=nginx
2016-11-28 22:22:55 +00:00
```
2018-04-27 22:02:19 +00:00
Use [`kubectl delete` ](/docs/reference/generated/kubectl/kubectl-commands/#delete ) to delete the
2016-11-29 18:01:38 +00:00
StatefulSet. Make sure to supply the `--cascade=false` parameter to the
command. This parameter tells Kubernetes to only delete the StatefulSet, and to
2016-11-28 22:22:55 +00:00
not delete any of its Pods.
```shell
2016-11-29 19:33:21 +00:00
kubectl delete statefulset web --cascade=false
2016-11-28 22:22:55 +00:00
statefulset "web" deleted
```
Get the Pods to examine their status.
```shell
2016-11-29 19:33:21 +00:00
kubectl get pods -l app=nginx
2016-11-28 22:22:55 +00:00
NAME READY STATUS RESTARTS AGE
web-0 1/1 Running 0 6m
web-1 1/1 Running 0 7m
web-2 1/1 Running 0 5m
```
Even though `web` has been deleted, all of the Pods are still Running and Ready.
Delete `web-0` .
```shell
2016-11-29 19:33:21 +00:00
kubectl delete pod web-0
2016-11-28 22:22:55 +00:00
pod "web-0" deleted
```
2016-11-29 18:01:38 +00:00
Get the StatefulSet's Pods.
2016-11-28 22:22:55 +00:00
```shell
2016-11-29 19:33:21 +00:00
kubectl get pods -l app=nginx
2016-11-28 22:22:55 +00:00
NAME READY STATUS RESTARTS AGE
web-1 1/1 Running 0 10m
web-2 1/1 Running 0 7m
```
2016-11-29 18:01:38 +00:00
As the `web` StatefulSet has been deleted, `web-0` has not been relaunched.
2016-11-28 22:22:55 +00:00
2016-11-29 18:01:38 +00:00
In one terminal, watch the StatefulSet's Pods.
2016-11-28 22:22:55 +00:00
2017-06-27 16:46:39 +00:00
```shell
2016-11-29 19:33:21 +00:00
kubectl get pods -w -l app=nginx
2016-11-28 22:22:55 +00:00
```
2016-11-29 18:01:38 +00:00
In a second terminal, recreate the StatefulSet. Note that, unless
2016-11-28 22:22:55 +00:00
you deleted the `nginx` Service ( which you should not have ), you will see
an error indicating that the Service already exists.
```shell
kubectl create -f web.yaml
statefulset "web" created
Error from server (AlreadyExists): error when creating "web.yaml": services "nginx" already exists
```
Ignore the error. It only indicates that an attempt was made to create the nginx
Headless Service even though that Service already exists.
Examine the output of the `kubectl get` command running in the first terminal.
```shell
kubectl get pods -w -l app=nginx
NAME READY STATUS RESTARTS AGE
web-1 1/1 Running 0 16m
web-2 1/1 Running 0 2m
NAME READY STATUS RESTARTS AGE
web-0 0/1 Pending 0 0s
web-0 0/1 Pending 0 0s
web-0 0/1 ContainerCreating 0 0s
web-0 1/1 Running 0 18s
web-2 1/1 Terminating 0 3m
web-2 0/1 Terminating 0 3m
web-2 0/1 Terminating 0 3m
web-2 0/1 Terminating 0 3m
```
2016-11-29 18:01:38 +00:00
When the `web` StatefulSet was recreated, it first relaunched `web-0` .
2016-11-28 22:22:55 +00:00
Since `web-1` was already Running and Ready, when `web-0` transitioned to
2016-12-02 22:26:22 +00:00
Running and Ready, it simply adopted this Pod. Since you recreated the StatefulSet
with `replicas` equal to 2, once `web-0` had been recreated, and once
2016-11-28 22:22:55 +00:00
`web-1` had been determined to already be Running and Ready, `web-2` was
terminated.
Let's take another look at the contents of the `index.html` file served by the
Pods' webservers.
```shell
2016-11-29 19:33:21 +00:00
for i in 0 1; do kubectl exec -it web-$i -- curl localhost; done
2016-11-28 22:22:55 +00:00
web-0
web-1
```
2016-12-02 22:26:22 +00:00
Even though you deleted both the StatefulSet and the `web-0` Pod, it still
2016-11-28 22:22:55 +00:00
serves the hostname originally entered into its `index.html` file. This is
2016-11-29 18:01:38 +00:00
because the StatefulSet never deletes the PersistentVolumes associated with a
Pod. When you recreated the StatefulSet and it relaunched `web-0` , its original
PersistentVolume was remounted.
2016-11-28 22:22:55 +00:00
2017-01-18 18:18:37 +00:00
### Cascading Delete
2016-11-28 22:22:55 +00:00
2016-11-29 18:01:38 +00:00
In one terminal window, watch the Pods in the StatefulSet.
2016-11-28 22:22:55 +00:00
```shell
2016-11-29 19:33:21 +00:00
kubectl get pods -w -l app=nginx
2016-11-28 22:22:55 +00:00
```
2016-11-29 18:01:38 +00:00
In another terminal, delete the StatefulSet again. This time, omit the
2016-11-28 22:22:55 +00:00
`--cascade=false` parameter.
```shell
2016-11-29 19:33:21 +00:00
kubectl delete statefulset web
2016-11-28 22:22:55 +00:00
statefulset "web" deleted
```
Examine the output of the `kubectl get` command running in the first terminal,
and wait for all of the Pods to transition to Terminating.
```shell
2016-11-29 19:33:21 +00:00
kubectl get pods -w -l app=nginx
2016-11-28 22:22:55 +00:00
NAME READY STATUS RESTARTS AGE
web-0 1/1 Running 0 11m
web-1 1/1 Running 0 27m
NAME READY STATUS RESTARTS AGE
web-0 1/1 Terminating 0 12m
web-1 1/1 Terminating 0 29m
web-0 0/1 Terminating 0 12m
web-0 0/1 Terminating 0 12m
web-0 0/1 Terminating 0 12m
web-1 0/1 Terminating 0 29m
web-1 0/1 Terminating 0 29m
web-1 0/1 Terminating 0 29m
```
2017-09-21 09:27:41 +00:00
As you saw in the [Scaling Down ](#scaling-down ) section, the Pods
2016-11-28 22:22:55 +00:00
are terminated one at a time, with respect to the reverse order of their ordinal
2016-11-29 19:33:21 +00:00
indices. Before terminating a Pod, the StatefulSet controller waits for
2016-11-28 22:22:55 +00:00
the Pod's successor to be completely terminated.
2016-11-29 18:01:38 +00:00
Note that, while a cascading delete will delete the StatefulSet and its Pods,
it will not delete the Headless Service associated with the StatefulSet. You
2016-11-28 22:22:55 +00:00
must delete the `nginx` Service manually.
```shell
2016-11-29 19:33:21 +00:00
kubectl delete service nginx
2016-11-28 22:22:55 +00:00
service "nginx" deleted
```
2016-11-29 18:01:38 +00:00
Recreate the StatefulSet and Headless Service one more time.
2016-11-28 22:22:55 +00:00
```shell
kubectl create -f web.yaml
service "nginx" created
statefulset "web" created
```
2016-11-29 18:01:38 +00:00
When all of the StatefulSet's Pods transition to Running and Ready, retrieve
2016-11-29 19:33:21 +00:00
the contents of their `index.html` files.
2016-11-28 22:22:55 +00:00
```shell
2016-11-29 19:33:21 +00:00
for i in 0 1; do kubectl exec -it web-$i -- curl localhost; done
2016-11-28 22:22:55 +00:00
web-0
web-1
```
2016-11-29 18:01:38 +00:00
Even though you completely deleted the StatefulSet, and all of its Pods, the
Pods are recreated with their PersistentVolumes mounted, and `web-0` and
2016-11-28 22:22:55 +00:00
`web-1` will still serve their hostnames.
2016-11-29 18:01:38 +00:00
Finally delete the `web` StatefulSet and the `nginx` service.
2016-11-28 22:22:55 +00:00
```shell
2016-11-29 19:33:21 +00:00
kubectl delete service nginx
2016-11-28 22:22:55 +00:00
service "nginx" deleted
2016-11-29 19:33:21 +00:00
kubectl delete statefulset web
2016-11-28 22:22:55 +00:00
statefulset "web" deleted
```
2017-06-27 16:46:39 +00:00
## Pod Management Policy
For some distributed systems, the StatefulSet ordering guarantees are
unnecessary and/or undesirable. These systems require only uniqueness and
identity. To address this, in Kubernetes 1.7, we introduced
`.spec.podManagementPolicy` to the StatefulSet API Object.
### OrderedReady Pod Management
`OrderedReady` pod management is the default for StatefulSets. It tells the
StatefulSet controller to respect the ordering guarantees demonstrated
above.
### Parallel Pod Management
`Parallel` pod management tells the StatefulSet controller to launch or
2017-08-03 08:12:31 +00:00
terminate all Pods in parallel, and not to wait for Pods to become Running
2017-06-27 16:46:39 +00:00
and Ready or completely terminated prior to launching or terminating another
Pod.
2018-07-02 20:37:19 +00:00
{{< codenew file = "application/web/web-parallel.yaml" > }}
2017-06-27 16:46:39 +00:00
2018-07-02 20:37:19 +00:00
Download the example above, and save it to a file named `web-parallel.yaml`
2017-06-27 16:46:39 +00:00
2017-07-08 08:12:08 +00:00
This manifest is identical to the one you downloaded above except that the `.spec.podManagementPolicy`
2017-06-27 16:46:39 +00:00
of the `web` StatefulSet is set to `Parallel` .
In one terminal, watch the Pods in the StatefulSet.
```shell
2017-09-25 23:09:16 +00:00
kubectl get po -l app=nginx -w
2017-06-27 16:46:39 +00:00
```
In another terminal, create the StatefulSet and Service in the manifest.
```shell
2018-07-02 20:37:19 +00:00
kubectl create -f web-parallel.yaml
2017-06-27 16:46:39 +00:00
service "nginx" created
statefulset "web" created
```
Examine the output of the `kubectl get` command that you executed in the first terminal.
```shell
2017-09-25 23:09:16 +00:00
kubectl get po -l app=nginx -w
2017-06-27 16:46:39 +00:00
NAME READY STATUS RESTARTS AGE
web-0 0/1 Pending 0 0s
web-0 0/1 Pending 0 0s
web-1 0/1 Pending 0 0s
web-1 0/1 Pending 0 0s
web-0 0/1 ContainerCreating 0 0s
web-1 0/1 ContainerCreating 0 0s
web-0 1/1 Running 0 10s
web-1 1/1 Running 0 10s
```
The StatefulSet controller launched both `web-0` and `web-1` at the same time.
Keep the second terminal open, and, in another terminal window scale the
StatefulSet.
```shell
kubectl scale statefulset/web --replicas=4
statefulset "web" scaled
```
Examine the output of the terminal where the `kubectl get` command is running.
```shell
web-3 0/1 Pending 0 0s
web-3 0/1 Pending 0 0s
web-3 0/1 Pending 0 7s
web-3 0/1 ContainerCreating 0 7s
web-2 1/1 Running 0 10s
web-3 1/1 Running 0 26s
```
The StatefulSet controller launched two new Pods, and it did not wait for
the first to become Running and Ready prior to launching the second.
Keep this terminal open, and in another terminal delete the `web` StatefulSet.
```shell
kubectl delete sts web
```
Again, examine the output of the `kubectl get` command running in the other terminal.
```shell
web-3 1/1 Terminating 0 9m
web-2 1/1 Terminating 0 9m
web-3 1/1 Terminating 0 9m
web-2 1/1 Terminating 0 9m
web-1 1/1 Terminating 0 44m
web-0 1/1 Terminating 0 44m
web-0 0/1 Terminating 0 44m
web-3 0/1 Terminating 0 9m
web-2 0/1 Terminating 0 9m
web-1 0/1 Terminating 0 44m
web-0 0/1 Terminating 0 44m
web-2 0/1 Terminating 0 9m
web-2 0/1 Terminating 0 9m
web-2 0/1 Terminating 0 9m
web-1 0/1 Terminating 0 44m
web-1 0/1 Terminating 0 44m
web-1 0/1 Terminating 0 44m
web-0 0/1 Terminating 0 44m
web-0 0/1 Terminating 0 44m
web-0 0/1 Terminating 0 44m
web-3 0/1 Terminating 0 9m
web-3 0/1 Terminating 0 9m
web-3 0/1 Terminating 0 9m
```
The StatefulSet controller deletes all Pods concurrently, it does not wait for
a Pod's ordinal successor to terminate prior to deleting that Pod.
Close the terminal where the `kubectl get` command is running and delete the `nginx`
Service.
```shell
kubectl delete svc nginx
```
2018-05-05 16:00:51 +00:00
{{% /capture %}}
2016-11-28 22:22:55 +00:00
2018-05-05 16:00:51 +00:00
{{% capture cleanup %}}
2016-12-02 17:53:04 +00:00
You will need to delete the persistent storage media for the PersistentVolumes
used in this tutorial. Follow the necessary steps, based on your environment,
storage configuration, and provisioning method, to ensure that all storage is
reclaimed.
2018-05-05 16:00:51 +00:00
{{% /capture %}}
2016-11-28 22:22:55 +00:00