Fix inline markup in headers, links (#10099)

* Clean up inline markup and links

- Clean up inline markup in html headers
- Fix links on page and related page
- Clean up some wording and add links to tutorial and concepts

* Update scale-stateful-set.md
This commit is contained in:
Karen Bradshaw
2018-09-19 23:32:20 -04:00
committed by k8s-ci-robot
parent 02c38e5180
commit 95da1ca48f
2 changed files with 19 additions and 26 deletions
@@ -22,7 +22,6 @@ This page shows how to delete Pods which are part of a stateful set, and explain
{{% capture steps %}} {{% capture steps %}}
## StatefulSet considerations ## StatefulSet considerations
In normal operation of a StatefulSet, there is **never** a need to force delete a StatefulSet Pod. The StatefulSet controller is responsible for creating, scaling and deleting members of the StatefulSet. It tries to ensure that the specified number of Pods from ordinal 0 through N-1 are alive and ready. StatefulSet ensures that, at any time, there is at most one Pod with a given identity running in a cluster. This is referred to as *at most one* semantics provided by a StatefulSet. In normal operation of a StatefulSet, there is **never** a need to force delete a StatefulSet Pod. The StatefulSet controller is responsible for creating, scaling and deleting members of the StatefulSet. It tries to ensure that the specified number of Pods from ordinal 0 through N-1 are alive and ready. StatefulSet ensures that, at any time, there is at most one Pod with a given identity running in a cluster. This is referred to as *at most one* semantics provided by a StatefulSet.
@@ -79,8 +78,6 @@ Always perform force deletion of StatefulSet Pods carefully and with complete kn
{{% capture whatsnext %}} {{% capture whatsnext %}}
Learn more about [debugging a StatefulSet](/docs/tasks/manage-stateful-set/debugging-a-statefulset/). Learn more about [debugging a StatefulSet](/docs/tasks/debug-application-cluster/debug-stateful-set/).
{{% /capture %}} {{% /capture %}}
@@ -13,29 +13,28 @@ weight: 50
--- ---
{{% capture overview %}} {{% capture overview %}}
This page shows how to scale a StatefulSet. This task shows how to scale a StatefulSet. Scaling a StatefulSet refers to increasing or decreasing the number of replicas.
{{% /capture %}} {{% /capture %}}
{{% capture prerequisites %}} {{% capture prerequisites %}}
* StatefulSets are only available in Kubernetes version 1.5 or later. * StatefulSets are only available in Kubernetes version 1.5 or later.
* **Not all stateful applications scale nicely.** You need to understand your StatefulSets well before continuing. If you're unsure, remember that it might not be safe to scale your StatefulSets. To check your version of Kubernetes, run `kubectl version`.
* You should perform scaling only when you're sure that your stateful application
* Not all stateful applications scale nicely. If you are unsure about whether to scale your StatefulSets, see [StatefulSet concepts](/docs/concepts/workloads/controllers/statefulset/) or [StatefulSet tutorial](/docs/tutorials/stateful-application/basic-stateful-set/) for futher information.
* You should perform scaling only when you are confident that your stateful application
cluster is completely healthy. cluster is completely healthy.
{{% /capture %}} {{% /capture %}}
{{% capture steps %}} {{% capture steps %}}
## Use `kubectl` to scale StatefulSets ## Scaling StatefulSets
Make sure you have `kubectl` upgraded to Kubernetes version 1.5 or later before ### Use kubectl to scale StatefulSets
continuing. If you're unsure, run `kubectl version` and check `Client Version`
for which kubectl you're using.
### `kubectl scale` First, find the StatefulSet you want to scale.
First, find the StatefulSet you want to scale. Remember, you need to first understand if you can scale it or not.
```shell ```shell
kubectl get statefulsets <stateful-set-name> kubectl get statefulsets <stateful-set-name>
@@ -47,7 +46,7 @@ Change the number of replicas of your StatefulSet:
kubectl scale statefulsets <stateful-set-name> --replicas=<new-replicas> kubectl scale statefulsets <stateful-set-name> --replicas=<new-replicas>
``` ```
### Alternative: `kubectl apply` / `kubectl edit` / `kubectl patch` ### Make in-place updates on your StatefulSets
Alternatively, you can do [in-place updates](/docs/concepts/cluster-administration/manage-deployment/#in-place-updates-of-resources) on your StatefulSets. Alternatively, you can do [in-place updates](/docs/concepts/cluster-administration/manage-deployment/#in-place-updates-of-resources) on your StatefulSets.
@@ -72,32 +71,29 @@ kubectl patch statefulsets <stateful-set-name> -p '{"spec":{"replicas":<new-repl
## Troubleshooting ## Troubleshooting
### Scaling down doesn't work right ### Scaling down does not work right
You cannot scale down a StatefulSet when any of the stateful Pods it manages is unhealthy. Scaling down only takes place You cannot scale down a StatefulSet when any of the stateful Pods it manages is unhealthy. Scaling down only takes place
after those stateful Pods become running and ready. after those stateful Pods become running and ready.
With a StatefulSet of size > 1, if there is an unhealthy Pod, there is no way If spec.replicas > 1, Kubernetes cannot determine the reason for an unhealthy Pod. It might be the result of a permanent fault or of a transient fault. A transient fault can be caused by a restart required by upgrading or maintenance.
for Kubernetes to know (yet) if it is due to a permanent fault or a transient
one (upgrade/maintenance/node reboot). If the Pod is unhealthy due to a permanent fault, scaling If the Pod is unhealthy due to a permanent fault, scaling
without correcting the fault may lead to a state where the StatefulSet membership without correcting the fault may lead to a state where the StatefulSet membership
drops below a certain minimum number of "replicas" that are needed to function drops below a certain minimum number of replicas that are needed to function
correctly. This may cause your StatefulSet to become unavailable. correctly. This may cause your StatefulSet to become unavailable.
If the Pod is unhealthy due to a transient fault and the Pod might become available again, If the Pod is unhealthy due to a transient fault and the Pod might become available again,
the transient error may interfere with your scale-up/scale-down operation. Some distributed the transient error may interfere with your scale-up or scale-down operation. Some distributed
databases have issues when nodes join and leave at the same time. It is better databases have issues when nodes join and leave at the same time. It is better
to reason about scaling operations at the application level in these cases, and to reason about scaling operations at the application level in these cases, and
perform scaling only when you're sure that your stateful application cluster is perform scaling only when you are sure that your stateful application cluster is
completely healthy. completely healthy.
{{% /capture %}} {{% /capture %}}
{{% capture whatsnext %}} {{% capture whatsnext %}}
Learn more about [deleting a StatefulSet](/docs/tasks/manage-stateful-set/deleting-a-statefulset/). * Learn more about [deleting a StatefulSet](/docs/tasks/run-application/delete-stateful-set/).
{{% /capture %}} {{% /capture %}}