sbin/geom/class/raid/graid.8

   1 .\" Copyright (c) 2010 Alexander Motin <mav@FreeBSD.org>
   2 .\" All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\"
  13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND
  14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  16 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE
  17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  23 .\" SUCH DAMAGE.
  24 .\"
  25 .\" $FreeBSD$
  26 .\"
  27 .Dd March 22, 2011
  28 .Dt GRAID 8
  29 .Os
  30 .Sh NAME
  31 .Nm graid
  32 .Nd "control utility for software RAID devices"
  33 .Sh SYNOPSIS
  34 .Nm
  35 .Cm label
  36 .Op Fl f
  37 .Op Fl S Ar size
  38 .Op Fl s Ar strip
  39 .Ar format
  40 .Ar label
  41 .Ar level
  42 .Ar prov ...
  43 .Nm
  44 .Cm add
  45 .Op Fl f
  46 .Op Fl S Ar size
  47 .Op Fl s Ar strip
  48 .Ar name
  49 .Ar label
  50 .Ar level
  51 .Nm
  52 .Cm delete
  53 .Op Fl f
  54 .Ar name
  55 .Op Ar label | Ar num
  56 .Nm
  57 .Cm insert
  58 .Ar name
  59 .Ar prov ...
  60 .Nm
  61 .Cm remove
  62 .Ar name
  63 .Ar prov ...
  64 .Nm
  65 .Cm fail
  66 .Ar name
  67 .Ar prov ...
  68 .Nm
  69 .Cm stop
  70 .Op Fl fv
  71 .Ar name ...
  72 .Nm
  73 .Cm list
  74 .Nm
  75 .Cm status
  76 .Nm
  77 .Cm load
  78 .Nm
  79 .Cm unload
  80 .Sh DESCRIPTION
  81 The
  82 .Nm
  83 utility is used to manage software RAID configurations, supported by the
  84 GEOM RAID class.
  85 GEOM RAID class uses on-disk metadata to provide access to software-RAID
  86 volumes defined by different RAID BIOSes.
  87 Depending on RAID BIOS type and it's metadata format, different subsets of
  88 configurations and features are supported.
  89 To allow booting from RAID volume, the metadata format should match the
  90 RAID BIOS type and its capabilities.
  91 To guarantee that these match, it is recommended to create volumes via the
  92 RAID BIOS interface, while experienced users are free to do it using this
  93 utility.
  94 .Pp
  95 The first argument to
  96 .Nm
  97 indicates an action to be performed:
  98 .Bl -tag -width ".Cm destroy"
  99 .It Cm label
 100 Create an array with single volume.
 101 The
 102 .Ar format
 103 argument specifies the on-disk metadata format to use for this array,
 104 such as "Intel".
 105 The
 106 .Ar label
 107 argument specifies the label of the created volume.
 108 The
 109 .Ar level
 110 argument specifies the RAID level of the created volume, such as:
 111 "RAID0", "RAID1", etc.
 112 The subsequent list enumerates providers to use as array components.
 113 The special name "NONE" can be used to reserve space for absent disks.
 114 The order of components can be important, depending on specific RAID level
 115 and metadata format.
 116 .Pp
 117 Additional options include:
 118 .Bl -tag -width ".Fl s Ar strip"
 119 .It Fl f
 120 Enforce specified configuration creation if it is officially unsupported,
 121 but technically can be created.
 122 .It Fl S Ar size
 123 Use
 124 .Ar size
 125 bytes on each component for this volume.
 126 Should be used if several volumes per array are planned, or if smaller
 127 components going to be inserted later.
 128 Defaults to size of the smallest component.
 129 .It Fl s Ar strip
 130 Specifies strip size in bytes.
 131 Defaults to 131072.
 132 .El
 133 .It Cm add
 134 Create another volume on the existing array.
 135 The
 136 .Ar name
 137 argument is the name of the existing array, reported by label command.
 138 The rest of arguments are the same as for the label command.
 139 .It Cm delete
 140 Delete volume(s) from the existing array.
 141 When the last volume is deleted, the array is also deleted and its metadata
 142 erased.
 143 The
 144 .Ar name
 145 argument is the name of existing array.
 146 Optional
 147 .Ar label
 148 or
 149 .Ar num
 150 arguments allow specifying volume for deletion.
 151 .Pp
 152 Additional options include:
 153 .Bl -tag -width ".Fl f"
 154 .It Fl f
 155 Delete volume(s) even if it is still open.
 156 .El
 157 .It Cm insert
 158 Insert specified provider(s) into specified array instead of the first missing
 159 or failed components.
 160 If there are no such components, mark disk(s) as spare.
 161 .It Cm remove
 162 Remove the specified provider(s) from the specified array and erase metadata.
 163 If there are spare disks present, the removed disk(s) will be replaced by
 164 spares.
 165 .It Cm fail
 166 Mark the given disks(s) as failed, removing from active use unless absolutely
 167 necessary due to exhausted redundancy.
 168 If there are spare disks present - failed disk(s) will be replaced with one
 169 of them.
 170 .It Cm stop
 171 Stop the given array.
 172 The metadata will not be erased.
 173 .Pp
 174 Additional options include:
 175 .Bl -tag -width ".Fl f"
 176 .It Fl f
 177 Stop the given array even if some of its volumes are opened.
 178 .El
 179 .It Cm list
 180 See
 181 .Xr geom 8 .
 182 .It Cm status
 183 See
 184 .Xr geom 8 .
 185 .It Cm load
 186 See
 187 .Xr geom 8 .
 188 .It Cm unload
 189 See
 190 .Xr geom 8 .
 191 .El
 192 .Pp
 193 Additional options include:
 194 .Bl -tag -width ".Fl v"
 195 .It Fl v
 196 Be more verbose.
 197 .El
 198 .Sh SUPPORTED METADATA FORMATS
 199 The GEOM RAID class follows a modular design, allowing different metadata
 200 formats to be used.
 201 Support is currently implemented for the following formats:
 202 .Bl -tag -width "Intel"
 203 .It Intel
 204 The format used by Intel RAID BIOS.
 205 Supports up to two volumes per array.
 206 Supports configurations: RAID0 (2+ disks), RAID1 (2 disks),
 207 RAID5 (3+ disks), RAID10 (4 disks).
 208 Configurations not supported by Intel RAID BIOS, but enforceable on your own
 209 risk: RAID1 (3+ disks), RAID1E (3+ disks), RAID10 (6+ disks).
 210 .It JMicron
 211 The format used by JMicron RAID BIOS.
 212 Supports one volume per array.
 213 Supports configurations: RAID0 (2+ disks), RAID1 (2 disks),
 214 RAID10 (4 disks), CONCAT (2+ disks).
 215 Configurations not supported by JMicron RAID BIOS, but enforceable on your own
 216 risk: RAID1 (3+ disks), RAID1E (3+ disks), RAID10 (6+ disks), RAID5 (3+ disks).
 217 .It NVIDIA
 218 The format used by NVIDIA MediaShield RAID BIOS.
 219 Supports one volume per array.
 220 Supports configurations: RAID0 (2+ disks), RAID1 (2 disks),
 221 RAID5 (3+ disks), RAID10 (4+ disks), SINGLE (1 disk), CONCAT (2+ disks).
 222 Configurations not supported by NVIDIA MediaShield RAID BIOS, but enforceable
 223 on your own risk: RAID1 (3+ disks).
 224 .It Promise
 225 The format used by Promise and AMD/ATI RAID BIOSes and FreeBSD ataraid(4)
 226 driver.
 227 Supports multiple volumes per array.
 228 Each disk can be split to be used by up to two arbitrary volumes.
 229 Supports configurations: RAID0 (2+ disks), RAID1 (2 disks),
 230 RAID5 (3+ disks), RAID10 (4 disks), SINGLE (1 disk), CONCAT (2+ disks).
 231 Configurations not supported by RAID BIOSes, but enforceable on your
 232 own risk: RAID1 (3+ disks), RAID10 (6+ disks).
 233 .It SiI
 234 The format used by SiliconImage RAID BIOS.
 235 Supports one volume per array.
 236 Supports configurations: RAID0 (2+ disks), RAID1 (2 disks),
 237 RAID5 (3+ disks), RAID10 (4 disks), SINGLE (1 disk), CONCAT (2+ disks).
 238 Configurations not supported by SiliconImage RAID BIOS, but enforceable on your
 239 own risk: RAID1 (3+ disks), RAID10 (6+ disks).
 240 .El
 241 .Sh SUPPORTED RAID LEVELS
 242 The GEOM RAID class follows a modular design, allowing different RAID levels
 243 to be used.
 244 Support for the following RAID levels is currently implemented: RAID0, RAID1,
 245 RAID1E, RAID10, SINGLE, CONCAT.
 246 .Sh RAID LEVEL MIGRATION
 247 The GEOM RAID class has no support for RAID level migration, allowed by some
 248 metadata formats.
 249 If you started migration using BIOS or in some other way, make sure to
 250 complete it there.
 251 Do not run GEOM RAID class on migrating volumes under pain of possible data
 252 corruption!
 253 .Sh EXIT STATUS
 254 Exit status is 0 on success, and non-zero if the command fails.
 255 .Sh SEE ALSO
 256 .Xr geom 4 ,
 257 .Xr geom 8 ,
 258 .Xr vinum 8
 259 .Sh HISTORY
 260 The
 261 .Nm
 262 utility appeared in
 263 .Fx 9.0 .
 264 .Sh AUTHORS
 265 .An Alexander Motin Aq mav@FreeBSD.org
 266 .An M. Warner Losh Aq imp@FreeBSD.org