From c0acaafc6138ec5eb56617bd10866dc3170355bf Mon Sep 17 00:00:00 2001 From: "Joshua M. Boniface" Date: Fri, 30 Aug 2024 11:07:11 -0400 Subject: [PATCH] Update description of detect: strings --- README.md | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 6189814..ed21252 100644 --- a/README.md +++ b/README.md @@ -153,13 +153,15 @@ target_hostname="hv1.example.tld" # The target system disk path; must be a single disk (mdadm/software RAID is not supported) # This will usually use a `detect` string. A "detect" string is a string in the form "detect:::". # Detect strings allow for automatic determination of Linux block device paths from known basic information -# about disks by leveraging "lsscsi" on the target host. The "NAME" should be some descriptive identifier, -# for instance the manufacturer (e.g. "INTEL"), the "HUMAN-SIZE" should be the labeled human-readable size -# of the device (e.g. "480GB", "1.92TB"), and "ID" specifies the Nth 0-indexed device which matches the -# NAME" and "HUMAN-SIZE" values (e.g. "2" would match the third device with the corresponding "NAME" and -# "HUMAN-SIZE"). When matching against sizes, there is +/- 3% flexibility to account for base-1000 vs. -# base-1024 differences and rounding errors. The "NAME" may contain whitespace but if so the entire detect -# string should be quoted, and is case-insensitive. +# about disks by leveraging "lsscsi"/"nvme" on the target host. +# The "NAME" should be some descriptive identifier that would be part of the device's Model information, for instance +# the manufacturer (e.g. "INTEL") or a similar unique string (e.g. "BOSS" for Dell BOSS cards). +# The "HUMAN-SIZE" should be the labeled human-readable size of the device (e.g. "480GB", "1.92TB"). +# The "ID" specifies the Nth 0-indexed device which matches the NAME" and "HUMAN-SIZE" values (e.g. "2" would match the +# third device with the corresponding "NAME" and "HUMAN-SIZE"). +# When matching against sizes, there is +/- 3% flexibility to account for base-1000 vs. base-1024 differences and +# rounding errors. +# The "NAME" may contain whitespace but if so the entire detect string should be quoted, and is case-insensitive. target_disk="detect:LOGICAL:146GB:0" # SSH key fetch method (usually tftp)