summaryrefslogtreecommitdiff
path: root/docs/operation
diff options
context:
space:
mode:
authorYuriy Andamasov <yuriy@vyos.io>2026-04-29 06:50:50 +0300
committerYuriy Andamasov <yuriy@vyos.io>2026-05-06 16:18:03 +0300
commit323f8b4b4bbbf2545991e1eb4dc5fa5f8def37e1 (patch)
treeaa60f13b4b3f0c62bb3dda49d6aa6ffe40c39eea /docs/operation
parent9277e2f189115d9c544834f77fb216eaf3711407 (diff)
downloadvyos-documentation-323f8b4b4bbbf2545991e1eb4dc5fa5f8def37e1.tar.gz
vyos-documentation-323f8b4b4bbbf2545991e1eb4dc5fa5f8def37e1.zip
fix: re-import 4 canary md-*.md files with xref label fixes
Re-imports the dash-form-corrected versions of: - contributing/md-development.md (added (coding-guidelines)= anchor) - operation/md-upgrade-recovery.md (3 ref renames: how_it_works / cancelling_recovery -> dash form) - vpp/configuration/dataplane/md-buffers.md (vpp_config_dataplane_physmem -> vpp-config-dataplane-physmem) - vpp/configuration/dataplane/md-unix.md (vpp_config_dataplane_interface_rx_mode -> vpp-config-dataplane-interface-rx-mode) Source: origin/myst/current commit 59fbe3ea. Verified locally: clean swap-build no longer reports any of the 5 target labels (1 of 6 — vpp-config-hugepages — remains because system.md isn't in the canary swap list; that anchor lives there). 🤖 Generated by [robots](https://vyos.io)
Diffstat (limited to 'docs/operation')
-rw-r--r--docs/operation/md-upgrade-recovery.md63
1 files changed, 0 insertions, 63 deletions
diff --git a/docs/operation/md-upgrade-recovery.md b/docs/operation/md-upgrade-recovery.md
deleted file mode 100644
index 89b2fd5e..00000000
--- a/docs/operation/md-upgrade-recovery.md
+++ /dev/null
@@ -1,63 +0,0 @@
----
-lastproofread: '2025-11-20'
----
-
-(upgrade-recovery)=
-
-# Recovery after Failed Upgrades
-
-Use **VyOS upgrade recovery** to restore the system to the last working
-version after a failed upgrade.
-
-- {ref}`Configuration: <configuration>` How to enable upgrade recovery
-- {ref}`How it works: <how_it_works>` Overview of the recovery process
-- {ref}`Cancelling recovery: <cancelling_recovery>` Overview of the recovery
- process
-
-(configuration)=
-
-## Configuration
-
-:::{warning}
-Upgrade recovery is disabled by default. To use it,
-**enable it first**.
-:::
-
-To enable upgrade recovery, run the following command:
-
-```{cfgcmd} set system option reboot-on-upgrade-failure [timeout \<min\>]
-```
-
-- `timeout <min>:` The time in minutes (5 - 30) to cancel upgrade
- recovery before VyOS reboots.
- See {ref}`Cancelling Recovery <cancelling_recovery>`.
-(how-it-works)=
-
-## How it works
-After a VyOS upgrade, the system monitors the boot process. Upon detecting a
-boot failure, VyOS initiates a revert to the last working version and displays
-the following warning:
-```none
-Booting failed, reverting to previous image
-Automatic reboot in xx minutes
-Use "reboot cancel" to cancel
-```
-If no action is taken, the reboot happens automatically after the configured
-timeout. Upon successful recovery and reboot, the following message appears:
-```none
-WARNING: Image update to "VyOS 1.5.xxxx" failed
-Please check the logs:
-/usr/lib/live/mount/persistence/boot/NAME/rw/var/log
-Message is cleared on next reboot!
-```
-(cancelling-recovery)=
-
-## Cancelling recovery
-Upon detecting a boot failure, you have the predefined timeout to cancel
-upgrade recovery. This is useful if you want to troubleshoot the faulty VyOS
-version on your own.
-
-To cancel upgrade recovery, run the following command:
-```none
-reboot cancel
-```