From 1d3ce349ad26bf2307a61eed460c83987ecf79db Mon Sep 17 00:00:00 2001 From: Lisa Pettyjohn Date: Wed, 19 Feb 2025 17:13:59 -0500 Subject: [PATCH] OSDOCS-13414#Fix docs for non-graceful node shutdown --- _topic_maps/_topic_map.yml | 5 +++-- ...rage-csi-vol-detach-non-graceful-shutdown-procedure.adoc | 6 ++++++ ...istent-storage-csi-vol-detach-non-graceful-shutdown.adoc | 4 ++-- 3 files changed, 11 insertions(+), 4 deletions(-) rename storage/{container_storage_interface => }/persistent-storage-csi-vol-detach-non-graceful-shutdown.adoc (69%) diff --git a/_topic_maps/_topic_map.yml b/_topic_maps/_topic_map.yml index a9743ed6ce..be3967b193 100644 --- a/_topic_maps/_topic_map.yml +++ b/_topic_maps/_topic_map.yml @@ -1775,8 +1775,6 @@ Topics: File: persistent-storage-csi-sc-manage - Name: CSI automatic migration File: persistent-storage-csi-migration - - Name: Detach CSI volumes after non-graceful node shutdown - File: persistent-storage-csi-vol-detach-non-graceful-shutdown - Name: AWS Elastic Block Store CSI Driver Operator File: persistent-storage-csi-ebs - Name: AWS Elastic File Service CSI Driver Operator @@ -1814,6 +1812,9 @@ Topics: - Name: Dynamic provisioning File: dynamic-provisioning Distros: openshift-enterprise,openshift-origin +- Name: Detach volumes after non-graceful node shutdown + File: persistent-storage-csi-vol-detach-non-graceful-shutdown + Distros: openshift-enterprise,openshift-origin,openshift-online --- Name: Registry Dir: registry diff --git a/modules/persistent-storage-csi-vol-detach-non-graceful-shutdown-procedure.adoc b/modules/persistent-storage-csi-vol-detach-non-graceful-shutdown-procedure.adoc index 03afaca85c..da0a8fdad1 100644 --- a/modules/persistent-storage-csi-vol-detach-non-graceful-shutdown-procedure.adoc +++ b/modules/persistent-storage-csi-vol-detach-non-graceful-shutdown-procedure.adoc @@ -32,6 +32,12 @@ If the node is not completely shut down, do not proceed with tainting the node. + . Taint the corresponding node object by running the following command: + +[IMPORTANT] +==== +Tainting a node this way deletes all pods on that node. This also causes any pods that are backed by +statefulsets to be evicted, and replacement pods to be created on a different node. +==== ++ [source,terminal] ---- oc adm taint node node.kubernetes.io/out-of-service=nodeshutdown:NoExecute <1> diff --git a/storage/container_storage_interface/persistent-storage-csi-vol-detach-non-graceful-shutdown.adoc b/storage/persistent-storage-csi-vol-detach-non-graceful-shutdown.adoc similarity index 69% rename from storage/container_storage_interface/persistent-storage-csi-vol-detach-non-graceful-shutdown.adoc rename to storage/persistent-storage-csi-vol-detach-non-graceful-shutdown.adoc index a01e2e35ef..602b9ed5ed 100644 --- a/storage/container_storage_interface/persistent-storage-csi-vol-detach-non-graceful-shutdown.adoc +++ b/storage/persistent-storage-csi-vol-detach-non-graceful-shutdown.adoc @@ -1,12 +1,12 @@ :_mod-docs-content-type: ASSEMBLY [id="ephemeral-storage-csi-vol-detach-non-graceful-shutdown"] -= Detach CSI volumes after non-graceful node shutdown += Detach volumes after non-graceful node shutdown include::_attributes/common-attributes.adoc[] :context: ephemeral-storage-csi-vol-detach-non-graceful-shutdown toc::[] -This feature allows Container Storage Interface (CSI) drivers to automatically detach volumes when a node goes down non-gracefully. +This feature allows drivers to automatically detach volumes when a node goes down non-gracefully. include::modules/persistent-storage-csi-vol-detach-non-graceful-shutdown-overview.adoc[leveloffset=+1]