From ebed7106479127b1ccaf5202a26018c7bbc8811e Mon Sep 17 00:00:00 2001 From: Tim Bannister Date: Fri, 31 May 2019 01:42:20 +0100 Subject: [PATCH] Add relevant glossary tooltips (#14632) Guide reader to learn more about StatefulSet. --- content/en/docs/tasks/run-application/delete-stateful-set.md | 2 +- .../tasks/run-application/force-delete-stateful-set-pod.md | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/content/en/docs/tasks/run-application/delete-stateful-set.md b/content/en/docs/tasks/run-application/delete-stateful-set.md index 8db021c6c6..d37e3ba7a0 100644 --- a/content/en/docs/tasks/run-application/delete-stateful-set.md +++ b/content/en/docs/tasks/run-application/delete-stateful-set.md @@ -12,7 +12,7 @@ weight: 60 {{% capture overview %}} -This task shows you how to delete a StatefulSet. +This task shows you how to delete a {{< glossary_tooltip term_id="StatefulSet" >}}. {{% /capture %}} diff --git a/content/en/docs/tasks/run-application/force-delete-stateful-set-pod.md b/content/en/docs/tasks/run-application/force-delete-stateful-set-pod.md index 725220434d..45a59b6b88 100644 --- a/content/en/docs/tasks/run-application/force-delete-stateful-set-pod.md +++ b/content/en/docs/tasks/run-application/force-delete-stateful-set-pod.md @@ -10,7 +10,7 @@ weight: 70 --- {{% capture overview %}} -This page shows how to delete Pods which are part of a stateful set, and explains the considerations to keep in mind when doing so. +This page shows how to delete Pods which are part of a {{< glossary_tooltip text="stateful set" term_id="StatefulSet" >}}, and explains the considerations to keep in mind when doing so. {{% /capture %}} {{% capture prerequisites %}} @@ -24,7 +24,7 @@ This page shows how to delete Pods which are part of a stateful set, and explain ## 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](/docs/concepts/workloads/controllers/statefulset/) 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. Manual force deletion should be undertaken with caution, as it has the potential to violate the at most one semantics inherent to StatefulSet. StatefulSets may be used to run distributed and clustered applications which have a need for a stable network identity and stable storage. These applications often have configuration which relies on an ensemble of a fixed number of members with fixed identities. Having multiple members with the same identity can be disastrous and may lead to data loss (e.g. split brain scenario in quorum-based systems).