From bc7512c2c7ac247943c736adfb3e0f58a67acc1d Mon Sep 17 00:00:00 2001 From: Quill <69414602+teslazonda@users.noreply.github.com> Date: Tue, 9 Dec 2025 23:10:26 +0900 Subject: Proofread docs in the /operation directory (#1710) * Proofread boot-options.rst * Fix line length Markdown lint errors * Proofread information.rst * Update lastproofread date in information.rst * Updated password-recovery.rst * Proofread upgrade-recovery.rst * Fix line length linting errors * Proofread up to Empty 2+ Disk * Complete proofread of raid.rst * Update upgrade-recovery timeout explanation * Fix header formatting * Update docs/operation/boot-options.rst Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Add missing period in raid.rst * Implement Copilot feedback --------- Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Co-authored-by: Daniil Baturin --- docs/operation/raid.rst | 161 ++++++++++++++++++++++++------------------------ 1 file changed, 80 insertions(+), 81 deletions(-) (limited to 'docs/operation/raid.rst') diff --git a/docs/operation/raid.rst b/docs/operation/raid.rst index 642a7332..b8dac2b5 100644 --- a/docs/operation/raid.rst +++ b/docs/operation/raid.rst @@ -1,134 +1,132 @@ +:lastproofread: 2025-11-20 + .. _raid: ###### -RAID-1 +RAID 1 ###### A Redundant Array of Independent Disks (RAID) uses two or more hard disk drives to improve disk speed, store more data, and/or provide fault tolerance. There are several storage schemes possible in a RAID array, each offering a -different combination of storage, reliability, and/or performance. -The VyOS system supports a “RAID 1” deployment. RAID 1 allows two or more -disks to mirror one another to provide system fault tolerance. In a RAID 1 -solution, every sector of one disk is duplicated onto every sector of all +different combination of storage, reliability, and performance. +VyOS supports **RAID 1** deployments. RAID 1 uses two or more +disks that mirror one another to provide system fault tolerance. In a RAID 1 +configuration, every sector on one disk is duplicated on every sector of all disks in the array. Provided even one disk in the RAID 1 set is operational, the system continues to run, even through disk replacement (provided that the hardware supports in-service replacement of drives). RAID 1 can be implemented using special hardware or it can be implemented in -software. The VyOS system supports software RAID 1 on two disks. -The VyOS implementation of RAID 1 allows the following: +software. VyOS supports software RAID 1 on two disks. +The VyOS implementation of RAID 1 features the following: -* Detection and reporting of disk failure -* The ability to maintain system operation with one failed disk -* The ability to boot the system with one failed disk -* The ability to replace a failed disk and initiate re-mirroring -* The ability to monitor the status of remirroring +* Detection and reporting of disk failure. +* Maintain system operation with one failed disk. +* Boot the system with one failed disk. +* Replace a failed disk and initiate re-mirroring. +* Monitor the status of re-mirroring. .. _raid_installation: -Installation Implications +Installation implications ========================= -The VyOS systems installation utility provides several options for installing +The VyOS installation utility provides several options for installing to a RAID 1 set. You can: -* Use the install system to create the RAID 1 set -* Use the underlying Linux commands to create a RAID 1 set before running the +* Use the install system to create the RAID 1 set. +* Use the built-in Linux commands to create a RAID 1 set before running the install system command. * Use a previously-created RAID 1 set. -.. note:: Before a permanent installation, VyOS runs a live installation +.. note:: Before a permanent installation, VyOS runs a live installation. Configuration ============= -Single disk, install as normal ------------------------------- +Standard installation on a single disk +-------------------------------------- -When the VyOS system is installed, it automatically detects the presence of two -disks not currently part of a RAID array. In these cases, the VyOS -installation utility automatically offers you the option of configuring RAID 1 -mirroring for the drives, with the following prompt. +VyOS automatically detects the presence of two or more +disks that are not currently part of a RAID array when installed. The VyOS +installation utility automatically offers you the option to configure RAID 1 +mirroring for eligible drives with the following prompt: .. code-block:: none Would you like to configure RAID 1 mirroring on them? -* If you do not want to configure RAID 1 mirroring, enter “No” at the prompt - and continue with installation in the normal way. +* If you do not want to configure RAID 1 mirroring, enter **No** at the prompt. -Empty 2+ Disk +Empty 2+ disk ------------- -If VyOS system detect two identical disks that are not currently part of a -RAID-1 set, the VyOS installation utility automatically offers you the option -of configuring RAID 1 mirroring for the drives, with the following prompt. +If VyOS detects two identical disks that are not currently part of a +RAID 1 set, the VyOS installation utility automatically offers the option +to configure RAID 1 mirroring for the drives with the following prompt: .. code-block:: none Would you like to configure RAID 1 mirroring on them? -1 - To create a new RAID 1 array, enter “Yes” at the prompt. If the system -detects a filesystem on the partitions being used for RAID 1 it will prompt you +1. To create a new RAID 1 array, enter **Yes** at the prompt. If VyOS +detects a filesystem on the partitions being used for RAID 1, it will prompt you to indicate whether you want to continue creating the RAID 1 array. .. code-block:: none Continue creating array? -2 - To overwrite the old filesystem, enter “Yes”. +2. To overwrite the old filesystem, enter **Yes**. -3 - The system informs you that all data on both drives will be erased. You are -prompted to confirm that you want to continue +3. The system informs you that all data on both drives will be erased. +Confirm you want to continue. .. code-block:: none Are you sure you want to do this? -4 - Enter “Yes” at the prompt to retain the current VyOS configuration once -installation is complete. Enter “No” to delete the current VyOS -configuration. +4. Enter **Yes** at the prompt to retain the current VyOS configuration. +Enter **No** to delete the current VyOS configuration. .. code-block:: none Would you like me to save the data on it before I delete it? -5 - Enter “Yes” at the prompt to retain the current VyOS configuration once -installation is complete. Enter “No” to delete the current VyOS configuration. +5. Enter **Yes** at the prompt to retain the current VyOS configuration. +Enter **No** to delete the current VyOS configuration. -6 - Continue with installation in the normal way. +6. Continue installing VyOS. -Present RAID-1 --------------- +Preexisting RAID 1 configuration +-------------------------------- -When the VyOS software on a system with a RAID 1 set already configured, -the installation utility will detect the array and will display the following -prompt: +When VyOS detects a previously configured RAID 1 set, +the installation utility displays the following prompt: .. code-block:: none Would you like to use this one? -1 - To break apart the current RAID 1 set, enter “No” at the prompt. The - +1. To break up the current RAID 1 set, enter **No** at the prompt. The installation utility detects that there are two identical disks and offers you -the option of configuring RAID 1 mirroring on them, displaying the following +the option of configuring RAID 1 mirroring with the following prompt: .. code-block:: none Would you like to configure RAID 1 mirroring on them? -2 - To decline to set up a new RAID 1 configuration on the disks, enter “No” -at the prompt. The system prompts you to indicate which partition you would +2. To decline to set up a new RAID 1 configuration on the disks, enter **No** +at the prompt. VyOS prompts you to indicate which partition you would like the system installed on. .. code-block:: none Which partition should I install the root on? [sda1]: -3 - Enter the partition where you would like the system installed. The system +3. Enter the partition where you would like the system installed. The system then prompts you to indicate whether you want to save the old configuration data. This represents the current VyOS configuration. @@ -136,54 +134,55 @@ data. This represents the current VyOS configuration. Would you like me to save the data on it before I delete it? -4 - Enter “Yes” at the prompt to retain the current VyOS configuration once -installation is complete. Enter “No” to delete the current VyOS configuration. +4. Enter **Yes** at the prompt to retain the current VyOS configuration once +installation is complete. Enter **No** to delete the current VyOS configuration. -5 - Continue with installation in the normal way. +5. Continue installing VyOS. -Detecting and Replacing a Failed RAID 1 Disk +Detecting and replacing a failed RAID 1 disk -------------------------------------------- -The VyOS system automatically detects a disk failure within a RAID 1 set and -reports it to the system console. You can verify the failure by issuing the -show raid command. +VyOS system detects disk failures within a RAID 1 set and +reports them to the system console. You can verify the failure by running the +``show raid`` command. -To replace a bad disk within a RAID 1 set, perform the following steps: +To replace a bad disk within a RAID 1 set: -1 - Remove the failed disk from the RAID 1 set by issuing the following -command: +1. Remove the failed disk from the RAID 1 set: -.. opcmd:: delete raid member + .. opcmd:: delete raid member - where RAID-1-device is the name of the RAID 1 device (for example, md0) and - disk-partition is the name of the failed disk partition (for example, sdb2). + where ``RAID-1-device`` is the name of the RAID 1 device. For example, + ``md0`` and + ``disk-partition`` is the name of the failed disk partition. For example, + ``sdb2``. -2- Physically remove the failed disk from the system. If the drives are not -hot-swappable, then you must shut down the system before removing the disk. +2. Physically remove the failed disk from the system. If the drives are not + hot-swappable, then you must shut down the system before removing the disk. -3 - Replace the failed drive with a drive of the same size or larger. +3. Replace the failed drive with a drive of the same size or larger. -4 - Format the new disk for RAID 1 by issuing the following command: +4. Format the new disk for RAID 1 by running the following command: -.. opcmd:: format disk like + .. opcmd:: format disk like - where disk-device1 is the replacement disk (for example, sdb) and - disk-device2 is the existing healthy disk (for example, sda). + where ``disk-device1`` is the replacement disk. For example, ``sdb`` and + ``disk-device2`` is the existing healthy disk. For example, ``sda``. -5-Add the replacement disk to the RAID 1 set by issuing the following command: +5. Add the replacement disk to the RAID 1 set by running the following command: -.. opcmd:: add raid member + .. opcmd:: add raid member - where RAID-1-device is the name of the RAID 1 device (for example, md0) and - disk-partition is the name of the replacement disk partition - (for example, sdb2). + where ``RAID-1-device`` is the name of the RAID 1 device. For example, + ``md0`` and ``disk-partition`` is the name of the replacement disk partition. + For example, ``sdb2``. Operation ========= -This part introduces how to add a disk partition to a RAID-1 set initiates -mirror synchronization, check and display information. +Learn how to add a disk partition to a RAID 1 set, initiate +mirror synchronization, and check and display information. .. opcmd:: add raid member @@ -194,11 +193,11 @@ mirror synchronization, check and display information. .. opcmd:: format disk like This command is typically used to prepare a disk to be added to a preexisting - RAID 1 set (of which disk-device2 is already a member). + RAID 1 set (of which ``disk-device2`` is already a member). .. opcmd:: show raid - shows output for show raid md0 as sdb1 is being added to the RAID 1 + shows output for ``show raid md0`` as ``sdb1`` is being added to the RAID 1 set and is in the process of being resynchronized. .. code-block:: none @@ -227,7 +226,7 @@ mirror synchronization, check and display information.      0       8        1        0      active sync   /dev/sda1      2       8       17        1      spare rebuilding   /dev/sdb1 -.. opcmd:: show raid +.. opcmd:: show disk sda format Use this command to display the formatting of a hard disk. -- cgit v1.2.3