Update persistent-storage-csi-vol-detach-non-graceful-shutdown-procedure.adoc

prithvipatil97 · Prithviraj Patil · commit 2efdcb2c0b19 · 2025-07-01T18:29:50.000+05:30
- Incorrect structure in the OpenShift documentation - Here is the documentation link: https://docs.redhat.com/en/documentation/openshift_container_platform/4.16/html/storage/ephemeral-storage-csi-vol-detach-non-graceful-shutdown#persistent-storage-csi-vol-detach-non-graceful-shutdown-procedure_ephemeral-storage-csi-vol-detach-non-graceful-shutdown -$ sign is missing from every command. - <node name> is mentioned without an underscore. Following changes are required: 1. Need to add $ sign at the start of each command. 2. Need to mention underscore between <node name> 3. Need to add <node_name> value for 1 Newcommit-Update persistent-storage-csi-vol-detach-non-graceful-shutdown-procedure.adoc Newcommit-Update persistent-storage-csi-vol-detach-non-graceful-shutdown-procedure.adoc
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
@@ -21,9 +21,9 @@ To allow volumes to detach automatically from a node after a non-graceful node s
 +
 [source,terminal]
 ----
-oc get node <node name> <1>
+$ oc get node <node_name> <1>
 ----
-<1> <node name> = name of the non-gracefully shutdown node
+<1> <node_name> = name of the node that shut down non-gracefully
 +
 [IMPORTANT]
 ====
@@ -40,9 +40,9 @@ statefulsets to be evicted, and replacement pods to be created on a different no
 +
 [source,terminal]
 ----
-oc adm taint node <node name> node.kubernetes.io/out-of-service=nodeshutdown:NoExecute <1>
+$ oc adm taint node <node_name> node.kubernetes.io/out-of-service=nodeshutdown:NoExecute <1>
 ----
-<1> <node name> = name of the non-gracefully shutdown node
+<1> <node_name> = name of the node that shut down non-gracefully
 +
 After the taint is applied, the volumes detach from the shutdown node allowing their disks to be attached to a different node.
 +
@@ -65,5 +65,6 @@ spec:
 +
 [source, terminal]
 ----
-oc adm taint node <node name> node.kubernetes.io/out-of-service=nodeshutdown:NoExecute- <1>
+$ oc adm taint node <node_name> node.kubernetes.io/out-of-service=nodeshutdown:NoExecute- <1>
 ----
+<1> <node_name> = name of the node that shut down non-gracefully

Original file line number	Diff line number	Diff line change
`@@ -21,9 +21,9 @@ To allow volumes to detach automatically from a node after a non-graceful node s`
`21`	`21`	`+`
`22`	`22`	`[source,terminal]`
`23`	`23`	`----`
`24`		`-oc get node <node name> <1>`
	`24`	`+$ oc get node <node_name> <1>`
`25`	`25`	`----`
`26`		`-<1> <node name> = name of the non-gracefully shutdown node`
	`26`	`+<1> <node_name> = name of the node that shut down non-gracefully`
`27`	`27`	`+`
`28`	`28`	`[IMPORTANT]`
`29`	`29`	`====`
`@@ -40,9 +40,9 @@ statefulsets to be evicted, and replacement pods to be created on a different no`
`40`	`40`	`+`
`41`	`41`	`[source,terminal]`
`42`	`42`	`----`
`43`		`-oc adm taint node <node name> node.kubernetes.io/out-of-service=nodeshutdown:NoExecute <1>`
	`43`	`+$ oc adm taint node <node_name> node.kubernetes.io/out-of-service=nodeshutdown:NoExecute <1>`
`44`	`44`	`----`
`45`		`-<1> <node name> = name of the non-gracefully shutdown node`
	`45`	`+<1> <node_name> = name of the node that shut down non-gracefully`
`46`	`46`	`+`
`47`	`47`	`After the taint is applied, the volumes detach from the shutdown node allowing their disks to be attached to a different node.`
`48`	`48`	`+`
`@@ -65,5 +65,6 @@ spec:`
`65`	`65`	`+`
`66`	`66`	`[source, terminal]`
`67`	`67`	`----`
`68`		`-oc adm taint node <node name> node.kubernetes.io/out-of-service=nodeshutdown:NoExecute- <1>`
	`68`	`+$ oc adm taint node <node_name> node.kubernetes.io/out-of-service=nodeshutdown:NoExecute- <1>`
`69`	`69`	`----`
	`70`	`+<1> <node_name> = name of the node that shut down non-gracefully`