Skip to content

Commit 9c66f01

Browse files
authored
Merge pull request #43132 from sftim/20230920_revise_statefulset_tutorial
Fix case for headings in StatefulSet tutorial
2 parents 35eef11 + 67fc110 commit 9c66f01

File tree

1 file changed

+16
-15
lines changed

1 file changed

+16
-15
lines changed

content/en/docs/tutorials/stateful-application/basic-stateful-set.md

Lines changed: 16 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -140,7 +140,7 @@ To configure the integer ordinal assigned to each Pod in a StatefulSet, see
140140

141141
Pods in a StatefulSet have a unique ordinal index and a stable network identity.
142142

143-
### Examining the Pod's Ordinal Index
143+
### Examining the Pod's ordinal index
144144

145145
Get the StatefulSet's Pods:
146146

@@ -160,7 +160,7 @@ StatefulSet {{< glossary_tooltip term_id="controller" text="controller">}}.
160160
The Pods' names take the form `<statefulset name>-<ordinal index>`.
161161
Since the `web` StatefulSet has two replicas, it creates two Pods, `web-0` and `web-1`.
162162

163-
### Using Stable Network Identities
163+
### Using stable network identities
164164

165165
Each Pod has a stable hostname based on its ordinal index. Use
166166
[`kubectl exec`](/docs/reference/generated/kubectl/kubectl-commands/#exec) to execute the
@@ -286,6 +286,7 @@ but the IP addresses associated with the Pods may have changed. In the cluster
286286
used for this tutorial, they have. This is why it is important not to configure
287287
other applications to connect to Pods in a StatefulSet by IP address.
288288

289+
#### Discovery for specific Pods in a StatefulSet
289290

290291
If you need to find and connect to the active members of a StatefulSet, you
291292
should query the CNAME of the headless Service
@@ -300,7 +301,7 @@ liveness and readiness, you can use the SRV records of the Pods (
300301
application will be able to discover the Pods' addresses when they transition
301302
to Running and Ready.
302303

303-
### Writing to Stable Storage
304+
### Writing to stable storage
304305

305306
Get the PersistentVolumeClaims for `web-0` and `web-1`:
306307

@@ -406,7 +407,7 @@ This is accomplished by updating the `replicas` field. You can use either
406407
[`kubectl scale`](/docs/reference/generated/kubectl/kubectl-commands/#scale) or
407408
[`kubectl patch`](/docs/reference/generated/kubectl/kubectl-commands/#patch) to scale a StatefulSet.
408409

409-
### Scaling Up
410+
### Scaling up
410411

411412
In one terminal window, watch the Pods in the StatefulSet:
412413

@@ -493,7 +494,7 @@ web-3 1/1 Terminating 0 42s
493494
web-3 1/1 Terminating 0 42s
494495
```
495496

496-
### Ordered Pod Termination
497+
### Ordered Pod termination
497498

498499
The controller deleted one Pod at a time, in reverse order with respect to its
499500
ordinal index, and it waited for each to be completely shutdown before
@@ -528,7 +529,7 @@ StatefulSet. There are two valid update strategies, `RollingUpdate` and
528529

529530
`RollingUpdate` update strategy is the default for StatefulSets.
530531

531-
### Rolling Update
532+
### RollingUpdate {#rolling-update}
532533

533534
The `RollingUpdate` update strategy will update all Pods in a StatefulSet, in
534535
reverse ordinal order, while respecting the StatefulSet guarantees.
@@ -624,7 +625,7 @@ You can also use `kubectl rollout status sts/<name>` to view
624625
the status of a rolling update to a StatefulSet
625626
{{< /note >}}
626627

627-
#### Staging an Update
628+
#### Staging an update
628629

629630
You can stage an update to a StatefulSet by using the `partition` parameter of
630631
the `RollingUpdate` update strategy. A staged update will keep all of the Pods
@@ -685,7 +686,7 @@ restored the Pod with its original container. This is because the
685686
ordinal of the Pod is less than the `partition` specified by the
686687
`updateStrategy`.
687688

688-
#### Rolling Out a Canary
689+
#### Rolling out a canary
689690

690691
You can roll out a canary to test a modification by decrementing the `partition`
691692
you specified [above](#staging-an-update).
@@ -771,7 +772,7 @@ StatefulSet's `.spec.template` is updated. If a Pod that has an ordinal less
771772
than the partition is deleted or otherwise terminated, it will be restored to
772773
its original configuration.
773774

774-
#### Phased Roll Outs
775+
#### Phased roll outs
775776

776777
You can perform a phased roll out (e.g. a linear, geometric, or exponential
777778
roll out) using a partitioned rolling update in a similar manner to how you
@@ -826,7 +827,7 @@ registry.k8s.io/nginx-slim:0.7
826827
By moving the `partition` to `0`, you allowed the StatefulSet to
827828
continue the update process.
828829

829-
### On Delete
830+
### OnDelete {#on-delete}
830831

831832
The `OnDelete` update strategy implements the legacy (1.6 and prior) behavior,
832833
When you select this update strategy, the StatefulSet controller will not
@@ -841,7 +842,7 @@ StatefulSet supports both Non-Cascading and Cascading deletion. In a
841842
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
842843
deleted.
843844

844-
### Non-Cascading Delete
845+
### Non-cascading delete
845846

846847
In one terminal window, watch the Pods in the StatefulSet.
847848

@@ -962,7 +963,7 @@ because the StatefulSet never deletes the PersistentVolumes associated with a
962963
Pod. When you recreated the StatefulSet and it relaunched `web-0`, its original
963964
PersistentVolume was remounted.
964965

965-
### Cascading Delete
966+
### Cascading delete
966967

967968
In one terminal window, watch the Pods in the StatefulSet.
968969

@@ -1070,20 +1071,20 @@ kubectl delete statefulset web
10701071
statefulset "web" deleted
10711072
```
10721073

1073-
## Pod Management Policy
1074+
## Pod management policy
10741075

10751076
For some distributed systems, the StatefulSet ordering guarantees are
10761077
unnecessary and/or undesirable. These systems require only uniqueness and
10771078
identity. To address this, in Kubernetes 1.7, we introduced
10781079
`.spec.podManagementPolicy` to the StatefulSet API Object.
10791080

1080-
### OrderedReady Pod Management
1081+
### OrderedReady Pod management
10811082

10821083
`OrderedReady` pod management is the default for StatefulSets. It tells the
10831084
StatefulSet controller to respect the ordering guarantees demonstrated
10841085
above.
10851086

1086-
### Parallel Pod Management
1087+
### Parallel Pod management
10871088

10881089
`Parallel` pod management tells the StatefulSet controller to launch or
10891090
terminate all Pods in parallel, and not to wait for Pods to become Running

0 commit comments

Comments
 (0)