From ae8f233eda38b218001ff4b4bcf4eb4228d7572e Mon Sep 17 00:00:00 2001 From: davidekete Date: Tue, 21 Jan 2025 23:17:25 +0100 Subject: [PATCH] docs: change markdown admonitions to MyST --- explanation/intro-to/multipath.md | 15 +++++++++------ .../common-multipath-tasks-and-procedures.md | 14 ++++++++------ explanation/multipath/configuring-multipath.md | 10 ++++++---- .../multipath/multipath-configuration-examples.md | 7 ++++--- 4 files changed, 27 insertions(+), 19 deletions(-) diff --git a/explanation/intro-to/multipath.md b/explanation/intro-to/multipath.md index 0260e778..8ddaf2d3 100644 --- a/explanation/intro-to/multipath.md +++ b/explanation/intro-to/multipath.md @@ -62,8 +62,9 @@ When the `user_friendly_names` configuration option is set to 'yes', the name of You can also set the name of a multipath device to a name of your choosing by using the `alias` option in the `multipaths` section of the multipath configuration file. -> **See also**: -> For information on the multipath configuration defaults, including the `user_friendly_names` and `alias` configuration options, see {ref}`DM-Multipath configuration `. +```{seealso} +For information on the multipath configuration defaults, including the `user_friendly_names` and `alias` configuration options, see {ref}`DM-Multipath configuration `. +``` ### Consistent multipath device names in a cluster @@ -110,8 +111,9 @@ pvcreate /dev/mapper/mpatha You can use the resulting LVM physical device when you create an LVM volume group just as you would use any other LVM physical device. -> **Note**: -> If you try to create an LVM physical volume on a whole device on which you have configured partitions, the `pvcreate` command will fail. +```{note} +If you try to create an LVM physical volume on a whole device on which you have configured partitions, the `pvcreate` command will fail. +``` When you create an LVM logical volume that uses active/passive multipath arrays as the underlying physical devices, you should include filters in the `lvm.conf` file to exclude the disks that underlie the multipath devices. This is because if the array automatically changes the active path to the passive path when it receives I/O, multipath will failover and fallback whenever LVM scans the passive path if these devices are not filtered. @@ -127,5 +129,6 @@ After updating `/etc/lvm.conf`, it's necessary to update the `initrd` so that th update-initramfs -u -k all ``` -> **Note**: -> Every time either `/etc/lvm.conf` or `/etc/multipath.conf` is updated, the `initrd` should be rebuilt to reflect these changes. This is imperative when **denylists** and filters are necessary to maintain a stable storage configuration. +```{note} +Every time either `/etc/lvm.conf` or `/etc/multipath.conf` is updated, the `initrd` should be rebuilt to reflect these changes. This is imperative when **denylists** and filters are necessary to maintain a stable storage configuration. +``` diff --git a/explanation/multipath/common-multipath-tasks-and-procedures.md b/explanation/multipath/common-multipath-tasks-and-procedures.md index a2b2b3e1..d5435f13 100644 --- a/explanation/multipath/common-multipath-tasks-and-procedures.md +++ b/explanation/multipath/common-multipath-tasks-and-procedures.md @@ -90,10 +90,11 @@ Make sure to run `resize2fs /dev/mapper/mpathb` to resize the filesystem. This is greatly simplified by the use of UUIDs to identify devices with an intrinsic label. To do this, install `multipath-tools-boot` and reboot your system. This will rebuild the initial RAM disk and afford multipath the opportunity to build its paths before the root filesystem is mounted by UUID. -> **Note**: -> Whenever `multipath.conf` is updated, initrd should be updated as well by running: -> `update-initramfs -u -k all` -> The reason for this is that `multipath.conf` is copied to the RAM disk, and is integral to determining the available devices to map via its `denylist` and `devices` sections. +```{note} +Whenever `multipath.conf` is updated, initrd should be updated as well by running: +`update-initramfs -u -k all` +The reason for this is that `multipath.conf` is copied to the RAM disk, and is integral to determining the available devices to map via its `denylist` and `devices` sections. +``` ## The multipathd daemon @@ -149,8 +150,9 @@ When displaying the multipath configuration, there are three verbosity levels yo - **`-v1`** : Outputs only the created or updated multipath names, which you can then feed to other tools such as `kpartx` - **`-v2`** : Prints all detected paths, multipaths, and device maps -> **Note**: -> The default verbosity level of multipath is 2 and can be globally modified by defining the verbosity attribute in the `defaults` section of `multipath.conf` +```{note} +The default verbosity level of multipath is 2 and can be globally modified by defining the verbosity attribute in the `defaults` section of `multipath.conf` +``` The following example shows the output of a `sudo multipath -l` command: diff --git a/explanation/multipath/configuring-multipath.md b/explanation/multipath/configuring-multipath.md index 146eabae..a984f2de 100644 --- a/explanation/multipath/configuring-multipath.md +++ b/explanation/multipath/configuring-multipath.md @@ -116,8 +116,9 @@ All the multipath attributes that can be set in the `defaults` section of the `m * `ghost_delay` * `enable_foreign` -> **Note**: -> Previously, the `multipath-tools` project provided a complete configuration file with all the most commonly used options for each of the most-used storage devices. Currently, you can see all those default options by running `sudo multipath -t`. This will dump a used configuration file including all the embedded default options. +```{note} +Previously, the `multipath-tools` project provided a complete configuration file with all the most commonly used options for each of the most-used storage devices. Currently, you can see all those default options by running `sudo multipath -t`. This will dump a used configuration file including all the embedded default options. +``` ## Configuration file blacklist and exceptions @@ -172,8 +173,9 @@ blacklist_exceptions { } ``` -> **Note**: -> A common use is to blacklist "everything" using a catch-all regular expression, and create specific `blacklist_exceptions` entries for those devices that should be handled by `multipath-tools`. +```{note} + A common use is to blacklist "everything" using a catch-all regular expression, and create specific `blacklist_exceptions` entries for those devices that should be handled by `multipath-tools`. + ``` ## Configuration file multipath section diff --git a/explanation/multipath/multipath-configuration-examples.md b/explanation/multipath/multipath-configuration-examples.md index 1256d128..75826ef7 100644 --- a/explanation/multipath/multipath-configuration-examples.md +++ b/explanation/multipath/multipath-configuration-examples.md @@ -363,9 +363,10 @@ defaults { ### Example of a multipaths section -> **Note**: -> You can obtain the WWIDs for your LUNs by running: `multipath -ll` -> after the service `multipath-tools.service` has been restarted. +```{note} +You can obtain the WWIDs for your LUNs by running: `multipath -ll` +after the service `multipath-tools.service` has been restarted. +``` ``` multipaths {