diff --git a/README.md b/README.md index c76b95a..e4c8893 100644 --- a/README.md +++ b/README.md @@ -222,7 +222,7 @@ More examples are available at `./examples/` ### [Use CSI driver on RancherOS/CoreOS + RKE or K3S](./docs/csi-config.md) ### [Restore a backup to an image file](./docs/restore-to-file.md) ### [Disaster Recovery Volume](./docs/dr-volume.md) -### [Restore volume after unexpected detachment](./docs/restore-volume.md) +### [Recover volume after unexpected detachment](./docs/recover-volume.md) # Troubleshooting You can click `Generate Support Bundle` link at the bottom of the UI to download a zip file contains Longhorn related configuration and logs. diff --git a/docs/restore-volume.md b/docs/recover-volume.md similarity index 93% rename from docs/restore-volume.md rename to docs/recover-volume.md index 29af8f4..ad86aaa 100644 --- a/docs/restore-volume.md +++ b/docs/recover-volume.md @@ -1,11 +1,11 @@ -# Restore volume after unexpected detachment +# Recover volume after unexpected detachment ## Overview 1. Now Longhorn can automatically reattach then remount volumes if unexpected detachment happens. e.g., [Kubernetes upgrade](https://github.com/longhorn/longhorn/issues/703), [Docker reboot](https://github.com/longhorn/longhorn/issues/686). 2. After reattachment and remount complete, users may need to **manually restart the related workload containers** for the volume restoration **if the following recommended setup is not applied**. ## Recommended setup when using Longhorn volumes -In order to restore unexpectedly detached volumes automatically, users can set `restartPolicy` to `Always` then add `livenessProbe` for the workloads using Longhorn volumes. +In order to recover unexpectedly detached volumes automatically, users can set `restartPolicy` to `Always` then add `livenessProbe` for the workloads using Longhorn volumes. Then those workloads will be restarted automatically after reattachment and remount. Here is one example for the setup: @@ -73,7 +73,7 @@ By checking the columns `COMMAND` and `NAMES` of the output, you can find the co 4. Restart the container ``` docker restart -``` +``` ### Reason -Typically the volume mount propagation is not `Bidirectional`. It means the Longhorn remount operation won't be propagated to the workload containers if the containers are not restarted. +Typically the volume mount propagation is not `Bidirectional`. It means the Longhorn remount operation won't be propagated to the workload containers if the containers are not restarted.