]> CyberLeo.Net >> Repos - FreeBSD/FreeBSD.git/blob - usr.sbin/bsdinstall/bsdinstall.8
Tweak language involving ZFS installation; no content changes.
[FreeBSD/FreeBSD.git] / usr.sbin / bsdinstall / bsdinstall.8
1 .\"-
2 .\" Copyright (c) 2011-2013 Nathan Whitehorn <nwhitehorn@FreeBSD.org> All rights reserved.
3 .\" Copyright (c) 2018 Roberto Fernandez Cueto <roberfern@gmail.com>
4 .\"
5 .\" Redistribution and use in source and binary forms, with or without
6 .\" modification, are permitted provided that the following conditions
7 .\" are met:
8 .\" 1. Redistributions of source code must retain the above copyright
9 .\"    notice, this list of conditions and the following disclaimer.
10 .\" 2. Redistributions in binary form must reproduce the above copyright
11 .\"    notice, this list of conditions and the following disclaimer in the
12 .\"    documentation and/or other materials provided with the distribution.
13 .\"
14 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
15 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
16 .\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
17 .\" DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
18 .\" INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
19 .\" (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
20 .\" SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
22 .\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
23 .\" ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
24 .\" POSSIBILITY OF SUCH DAMAGE.
25 .\"
26 .\" $FreeBSD$
27 .\"
28 .Dd March 22, 2021
29 .Dt BSDINSTALL 8
30 .Os
31 .Sh NAME
32 .Nm bsdinstall
33 .Nd system installer
34 .Sh SYNOPSIS
35 .Nm
36 .Op Ar options
37 .Op Ar target
38 .Op Ar ...
39 .Sh DESCRIPTION
40 .Nm
41 is used for installation of new systems, both for system setup from
42 installation media, e.g., CD-ROMs, and for use on live systems to prepare
43 VM images and jails.
44 .Pp
45 Much like
46 .Xr make 1 , Nm
47 takes a target and possible parameters of the target as arguments.
48 If invoked with no arguments, it will invoke the
49 .Cm auto
50 target, which provides a standard interactive installation, invoking the
51 others in sequence.
52 To perform a scripted installation,
53 these subtargets can be invoked separately by an installation script.
54 .Sh OPTIONS
55 .Nm
56 supports the following options, global to all targets:
57 .Bl -tag -width indent+
58 .It Fl D Ar file
59 Provide a path for the installation log file
60 .Pq overrides Ev BSDINSTALL_LOG .
61 See
62 .Sx ENVIRONMENT VARIABLES
63 for more information on
64 .Ev BSDINSTALL_LOG .
65 .El
66 .Sh TARGETS
67 Most of the following targets are only useful for scripting the installer.
68 For interactive use, most users will be interested only in the
69 .Cm auto ,
70 .Cm jail ,
71 and
72 .Cm script
73 targets.
74 .Bl -tag -width ".Cm jail Ar destination"
75 .It Cm auto
76 Run the standard interactive installation, including disk partitioning.
77 .It Cm jail Ar destination
78 Sets up a new chroot system at
79 .Pa destination ,
80 suitable for use with
81 .Xr jail 8 .
82 Behavior is generally similar to
83 .Cm auto ,
84 except that disk partitioning and network setup are skipped and a kernel is
85 not installed into the new system.
86 .It Cm script Ar script
87 Runs the installation script at
88 .Pa script .
89 See
90 .Sx SCRIPTING
91 for more information on this target.
92 .It Cm keymap
93 If the current controlling TTY is a
94 .Xr syscons 4
95 or
96 .Xr vt 4
97 console, asks the user to set the current keymap, and saves the result to the
98 new system's
99 .Pa rc.conf .
100 .It Cm hostname
101 Prompts the user for a host name for the new system and saves the result to the
102 new system's
103 .Pa rc.conf .
104 If
105 .Ev BSDINSTALL_CONFIGCURRENT
106 is set, also sets the host name of the current system.
107 .It Cm netconfig
108 Interactively configures network interfaces (first invoking
109 .Cm wlanconfig
110 on wireless interfaces), saving the result to the new system's
111 .Pa rc.conf
112 and
113 .Pa resolv.conf .
114 If
115 .Ev BSDINSTALL_CONFIGCURRENT
116 is set, also configures the network interfaces of the current system to match.
117 .It Cm autopart
118 Provides the installer's interactive guided disk partitioner for single-disk
119 installations.
120 Defaults to UFS.
121 .It Cm bootconfig
122 Detects an appropriate partition and installs UEFI boot loader files.
123 .It Cm zfsboot
124 Provides a ZFS-only automatic interactive disk partitioner.
125 Creates a single
126 .Ic zpool
127 with separate datasets for
128 .Pa /tmp ,
129 .Pa /usr ,
130 .Pa /usr/home ,
131 .Pa /usr/ports ,
132 .Pa /usr/src ,
133 and
134 .Pa /var .
135 Optionally can set up
136 .Xr geli 8
137 to encrypt the disk.
138 .It Cm partedit
139 Provides the installer's interactive manual disk partitioner with an interface
140 identical to
141 .Xr sade 8 .
142 Supports multiple disks as well as UFS, ZFS, and FAT file systems.
143 ZFS is set up with one pool and dataset per partition.
144 .It Cm scriptedpart Ar parameters
145 Sets up disks like
146 .Cm autopart
147 and
148 .Cm partedit ,
149 but non-interactively according to the disk setup specified in
150 .Ar parameters .
151 Each disk setup is specified by a three-part argument:
152 .Pp
153 .Ar disk
154 .Op Ar scheme
155 .Op Ar {partitions}
156 .Pp
157 Multiple disk setups are separated by semicolons.
158 The
159 .Ar disk
160 argument specifies the disk on which to operate (which will be erased),
161 while the
162 .Ar scheme
163 argument specifies the
164 .Xr gpart 8
165 partition scheme to apply to the disk.
166 If
167 .Ar scheme
168 is unspecified,
169 .Cm scriptedpart
170 will apply the default bootable scheme on your platform.
171 The
172 .Ar partitions
173 argument is also optional and specifies how to partition
174 .Ar disk .
175 It consists of a comma-separated list of partitions to create enclosed in
176 curly braces.
177 Each partition declaration takes the form
178 .Pp
179 .Ar size
180 .Ar type
181 .Op Ar mount point
182 .Pp
183 .Ar size
184 specifies the partition size to create in bytes (K, M, and G suffixes
185 can be appended to specify kilobytes, megabytes, and gigabytes respectively),
186 while the
187 .Em auto
188 keyword causes the partition to take all the remaining space on the disk.
189 The
190 .Ar type
191 option chooses the
192 .Xr gpart 8
193 filesystem type, e.g., freebsd-ufs, freebsd-zfs, or freebsd-swap.
194 The optional
195 .Ar mount point
196 argument sets where the created partition is to be mounted in the installed
197 system.
198 As an example, a typical invocation looks like:
199 .Pp
200 bsdinstall scriptedpart ada0 { 20G freebsd-ufs /, 4G freebsd-swap, 20G freebsd-ufs /var, auto freebsd-ufs /usr }
201 .Pp
202 Note that the list of partitions should
203 .Em not
204 include boot partitions (e.g. EFI system partitions), which will be created automatically on whatever disk includes /.
205 .Pp
206 A shorter invocation to use the default partitioning (as
207 .Cm autopart
208 would have used) on the same disk:
209 .Pp
210 bsdinstall scriptedpart ada0
211 .It Cm mount
212 Mounts the file systems previously configured by
213 .Cm autopart ,
214 .Cm partedit ,
215 or
216 .Cm scriptedpart
217 under
218 .Ev BSDINSTALL_CHROOT .
219 .It Cm distfetch
220 Fetches the distributions in
221 .Ev DISTRIBUTIONS
222 to
223 .Ev BSDINSTALL_DISTDIR
224 from
225 .Ev BSDINSTALL_DISTSITE .
226 .It Cm checksum
227 Verifies the checksums of the distributions listed in
228 .Ev DISTRIBUTIONS
229 against the distribution manifest.
230 .It Cm distextract
231 Extracts the distributions listed in
232 .Ev DISTRIBUTIONS
233 into
234 .Ev BSDINSTALL_CHROOT .
235 .It Cm rootpass
236 Interactively invokes
237 .Xr passwd 1
238 in the new system to set the root user's password.
239 .It Cm adduser
240 Interactively invokes
241 .Xr adduser 8
242 in the new system.
243 .It Cm time
244 Interactively sets the time, date, and time zone of the new system.
245 .It Cm services
246 Queries the user for the system daemons to begin at system startup,
247 writing the result into the new system's
248 .Pa rc.conf .
249 .It Cm entropy
250 Reads a small amount of data from
251 .Pa /dev/random
252 and stores it in a file in the new system's root directory.
253 .It Cm config
254 Installs the configuration files destined for the new system, e.g.,
255 .Xr rc.conf 5
256 fragments generated by
257 .Cm netconfig ,
258 etc.) onto the new system.
259 .El
260 .Sh ENVIRONMENT VARIABLES
261 The following environment variables control various aspects of the installation
262 process.
263 Many are used internally during installation and have reasonable default values
264 for most installation scenarios.
265 Others are set by various interactive user prompts, and can be usefully
266 overridden when making scripted or customized installers.
267 .Bl -tag -width ".Ev BSDINSTALL_DISTSITE"
268 .It Ev TMPDIR
269 The directory to use for temporary files.
270 Default:
271 .Dq Pa /tmp
272 .It Ev DISTRIBUTIONS
273 The set of distributions to install, e.g., "base.txz kernel.txz ports.txz".
274 Default: unset
275 .It Ev PARTITIONS
276 The partitioning of the disk onto which the system is being installed.
277 See
278 .Cm scriptedpart
279 of
280 the
281 .Sx TARGETS
282 section for format details.
283 Default: unset
284 .It Ev BSDINSTALL_DISTDIR
285 The directory in which the distribution files can be found (or to which they
286 should be downloaded).
287 Default:
288 .Dq Pa /usr/freebsd-dist
289 .It Ev BSDINSTALL_DISTSITE
290 URL from which the distribution files should be downloaded if they are not
291 already present in the directory defined by
292 .Ev BSDINSTALL_DISTDIR .
293 This should be a full path to the files, including architecture and release
294 names.
295 Most targets, e.g.,
296 .Cm auto
297 and
298 .Cm jail ,
299 that prompt for a
300 .Fx
301 mirror will skip that step if this variable is already defined in the
302 environment.
303 Example:
304 .Pa ftp://ftp.freebsd.org/pub/FreeBSD/releases/powerpc/powerpc64/9.1-RELEASE
305 .It Ev BSDINSTALL_CHROOT
306 The directory into which the distribution files should be unpacked and the
307 directory at which the root file system of the new system should be mounted.
308 Default:
309 .Dq Pa /mnt
310 .It Ev BSDINSTALL_LOG
311 Path to a log file for the installation.
312 Default:
313 .Dq Pa $TMPDIR/bsdinstall_log
314 .It Ev BSDINSTALL_TMPETC
315 Directory where files destined for the new system's
316 .Pa /etc
317 will be stored until the
318 .Cm config
319 target is executed.
320 If this directory does not already exist, it will be created.
321 Default:
322 .Dq Pa $TMPDIR/bsdinstall_etc
323 .It Ev BSDINSTALL_TMPBOOT
324 Directory where files destined for the new system's
325 .Pa /boot
326 will be stored until the
327 .Cm config
328 target is executed.
329 If this directory does not already exist, it will be created.
330 Default:
331 .Dq Pa $TMPDIR/bsdinstall_boot
332 .It Ev ZFSBOOT_POOL_NAME
333 Name for the pool containing the base system.
334 Default:
335 .Dq zroot
336 .It Ev ZFSBOOT_POOL_CREATE_OPTIONS
337 Options to be used when creating the base system's pool.
338 Each option must be followed by the -O flag to be taken into consideration
339 or the pool will not be created due to errors using the command
340 .Cm zpool .
341 Default:
342 .Dq Li "-O compress=lz4 -O atime=off"
343 .It Ev ZFSBOOT_BEROOT_NAME
344 Name for the boot environment parent dataset.
345 This is a non-mountable dataset meant to be a parent dataset where different
346 boot environment are going to be created.
347 Default:
348 .Dq ROOT
349 .It Ev ZFSBOOT_BOOTFS_NAME
350 Name for the primary boot environment, which will be the default boot
351 environment for the system.
352 Default:
353 .Dq default
354 .It Ev ZFSBOOT_VDEV_TYPE
355 The type of pool to be created for the base system.
356 This variable can take one of this values: stripe (No redundancy),
357 mirror (n-Way mirroring), raid10 (RAID 1+0 - n x 2-Way Mirrors),
358 raidz1 (RAID-Z1 - Single Redundancy RAID), raidz2 (RAID-Z2 - Double Redundancy RAID)
359 or raidz3 (RAID-Z3 Triple Redundancy RAID).
360 Default:
361 .Dq stripe
362 .It Ev ZFSBOOT_FORCE_4K_SECTORS
363 Indicates either the pool will use 4K or 512 sectors.
364 If this variable is not empty, 4K sectors will be used.
365 Default:
366 .Dq 1
367 .It Ev ZFSBOOT_GELI_ENCRYPTION
368 If this variable is not empty, it will use
369 .Xr geli 8
370 to encrypt the root pool, enabling automatically the
371 .Ev ZFSBOOT_BOOT_POOL
372 variable.
373 Default:
374 .Dq ""
375 .It Ev ZFSBOOT_GELI_KEY_FILE
376 Path to the
377 .Xr geli 8
378 keyfile used to encrypt the pool where the base system is stored.
379 Default:
380 .Dq Pa /boot/encryption.key
381 .It Ev ZFSBOOT_BOOT_POOL
382 If set a separated boot pool will be created for the kernel of the
383 system and
384 .Xr loader 8 .
385 Default: unset
386 .It Ev ZFSBOOT_BOOT_POOL_CREATE_OPTIONS
387 Options to use when creating the boot pool, when enabled (See
388 .Ev ZFSBOOT_BOOT_POOL ).
389 Default: unset
390 .It Ev ZFSBOOT_BOOT_POOL_NAME
391 Name for the optional boot pool when it is enabled, (See
392 .Ev ZFSBOOT_BOOT_POOL ).
393 Default:
394 .Dq bootpool
395 .It Ev ZFSBOOT_BOOT_POOL_SIZE
396 Size of the boot pool when it is enabled (See
397 .Ev ZFSBOOT_BOOT_POOL ).
398 Default:
399 .Dq 2g
400 .It Ev ZFSBOOT_DISKS
401 Disks to be used for the base system, including the boot pool.
402 This variable must only be used on a scripted installation.
403 See
404 .Sx SCRIPTING
405 for more information.
406 Default: unset
407 .It Ev ZFSBOOT_SWAP_SIZE
408 Size of the swap partition on each block device.
409 This variable will be passed to
410 .Xr gpart 8 ;
411 which supports SI unit suffixes.
412 Default:
413 .Dq 2g
414 .It Ev ZFSBOOT_SWAP_ENCRYPTION
415 If set, enables the encryption of the swap partition using
416 .Xr geli 8 .
417 Default: ""
418 .It Ev ZFSBOOT_SWAP_MIRROR
419 If set, enables a swap mirroring using
420 .Xr gmirror 8 .
421 Default:
422 unset
423 .It Ev ZFSBOOT_DATASETS
424 ZFS datasets to be created on the root zpool, it requires the
425 following datasets:
426 .Pa /tmp ,
427 .Pa /var/tmp ,
428 .Pa /$ZFSBOOT_BEROOT_NAME/$ZFSBOOT_BOOTFS_NAME .
429 See
430 .Sx ZFS DATASETS
431 for more information about who to write this variable and to
432 take a look into the default value of it.
433 .It Ev ZFSBOOT_CONFIRM_LAYOUT
434 If set and the installation is interactive, allow the user to confirm
435 the layout before continuing with the installation.
436 Default:
437 .Dq 1
438 .El
439 .Sh SCRIPTING
440 .Nm
441 supports unattended, or minimally-attended, installations using scripting.
442 This can be used with either modified physical installation media or with
443 .Xr diskless 8
444 installations over the network; information on preparing such media can be
445 found in
446 .Sx BUILDING AUTOMATIC INSTALL MEDIA
447 .Pp
448 Scripted installations follow an essentially identical path to interactive
449 installations, though with some minor feature differences (for example,
450 scripted installations do not support fetching of remote distribution files
451 since scripted installations normally install the same files and the distributions
452 can be added directly to the installation media).
453 .Nm
454 scripts consist of two parts: a
455 .Em preamble
456 and a
457 .Em setup script .
458 The preamble sets up the options for the installation (how to partition the
459 disk[s], which distributions to install, etc.) and the optional second part is
460 a shell script run under
461 .Xr chroot 8
462 in the newly installed system before
463 .Nm
464 exits.
465 The two parts are separated by the usual script header (#!), which also sets
466 the interpreter for the setup script.
467 .Pp
468 A typical bsdinstall script, using the default filesystem layout and the UFS
469 filesystem, looks like this:
470 .Bd -literal -offset indent
471 PARTITIONS=ada0
472 DISTRIBUTIONS="kernel.txz base.txz"
473
474 #!/bin/sh
475 sysrc ifconfig_DEFAULT=DHCP
476 sysrc sshd_enable=YES
477 pkg install puppet
478 .Ed
479 .Pp
480 For a scripted installation involving a ZFS pool spanning multiple disks,
481 the script instead looks like this:
482 .Bd -literal -offset indent
483 DISTRIBUTIONS="kernel.txz base.txz"
484 export ZFSBOOT_VDEV_TYPE=stripe
485 export ZFSBOOT_DISKS="ada0 ada1"
486 export nonInteractive="YES"
487
488 #!/bin/sh
489 echo "ifconfig_DEFAULT=DHCP" >> /etc/rc.conf
490 echo "sshd_enable=YES" >> /etc/rc.conf
491 pkg install puppet
492 .Ed
493 .Pp
494 On
495 .Fx
496 release media, such a script placed at
497 .Pa /etc/installerconfig
498 will be run at boot time and the system will be rebooted automatically after
499 the installation has completed.
500 This can be used for unattended network installation of new systems; see
501 .Xr diskless 8
502 for details.
503 .Ss PREAMBLE
504 The preamble consists of installer settings.
505 These control global installation parameters (see
506 .Sx ENVIRONMENT VARIABLES )
507 as well as disk partitioning.
508 The preamble is interpreted as a
509 .Xr sh 1
510 script run at the very beginning of the install.
511 If more complicated behavior than setting these variables is desired,
512 arbitrary commands can be run here to extend the installer.
513 In addition to the variables in
514 .Sx ENVIRONMENT VARIABLES ,
515 in particular
516 .Ev DISTRIBUTIONS ,
517 the preamble can contain a variable
518 .Ev PARTITIONS
519 which is passed to the
520 .Cm scriptedpart
521 target to control disk setup.
522 .Pp
523 Alternatively,
524 to use
525 .Cm zfsboot
526 instead of
527 .Cm partedit ,
528 the preamble can contain the variable
529 .Ev ZFSBOOT_DATASETS
530 instead of
531 .Ev PARTITIONS
532 (see below).
533 If using .Cm zfsboot, the variables
534 .Ev ZFSBOOT_DISKS
535 and
536 .Ev ZFSBOOT_VDEV_TYPE
537 must be set to create the pool of disks for the base system.
538 Usually, for a mirrored booting disk, this two variables looks like this:
539 .Bd -literal -offset indent
540 ZFSBOOT_DISKS="ada0 ada1"
541 ZFSBOOT_VDEV_TYPE=mirror
542 .Ed
543 .Pp
544 Remember to export all the variables for the
545 .Cm zfsboot
546 command, otherwise installation will fail.
547 .Ss SETUP SCRIPT
548 Following the preamble is an optional shell script, beginning with a #!
549 declaration.
550 This script will be run at the end of the installation process inside a
551 .Xr chroot 8
552 environment in the newly installed system and can be used to set up
553 configuration files, install packages, etc.
554 Note that newly configured system services, e.g., networking have not
555 been started in the installed system at this time and only installation
556 host services are available.
557 .Ss ZFS DATASETS
558 If using
559 .Cm zfsboot
560 in an installation script, the
561 .Cm zfsboot
562 partitioning tool takes the
563 .Ev ZFSBOOT_DATASETS
564 variable to create the ZFS datasets on the base system.
565 This variable definition can become large if the pool contains many datasets.
566 The default value of the
567 .Ev ZFSBOOT_DATASETS
568 is:
569 .Bd -literal -offset indent
570 # DATASET       OPTIONS (comma or space separated; or both)
571
572 # Boot Environment [BE] root and default boot dataset
573 /$ZFSBOOT_BEROOT_NAME                           mountpoint=none
574 /$ZFSBOOT_BEROOT_NAME/$ZFSBOOT_BOOTFS_NAME      mountpoint=/
575
576 # Compress /tmp, allow exec but not setuid
577 /tmp            mountpoint=/tmp,exec=on,setuid=off
578
579 # Do not mount /usr so that 'base' files go to the BEROOT
580 /usr            mountpoint=/usr,canmount=off
581
582 # Home directories separated so they are common to all BEs
583 /usr/home       # NB: /home is a symlink to /usr/home
584
585 # Ports tree
586 /usr/ports      setuid=off
587
588 # Source tree (compressed)
589 /usr/src
590
591 # Create /var and friends
592 /var            mountpoint=/var,canmount=off
593 /var/audit      exec=off,setuid=off
594 /var/crash      exec=off,setuid=off
595 /var/log        exec=off,setuid=off
596 /var/mail       atime=on
597 /var/tmp        setuid=off
598 .Ed
599 .Pp
600 The first column is the name of the dataset to be created as part of the
601 .Ev ZFSBOOT_POOL_NAME
602 pool and the remainder of each line contains the options to be set on each dataset.
603 If multiple options are given, they can be separated by either commas or whitespace;
604 everything following a pound/hash character is ignored as a comment.
605 .Ss BUILDING AUTOMATIC INSTALL MEDIA
606 If building automatic install media, use tar to extract a release ISO:
607 .Dl mkdir release-media
608 .Dl tar xvf -C release-media FreeBSD-13.0-RELEASE-amd64-disc1.iso
609 .Pp
610 Then place a script as above in
611 .Pa etc/installerconfig
612 .Pp
613 This directory can then be used directly as an NFS root for
614 .Xr diskless 8
615 installations or it can be rebuilt into an ISO image using the release scripts in
616 .Pa /usr/src/release .
617 For example, on amd64:
618 .Dl sh /usr/src/release/amd64/mkisoimages.sh -b '13_0_RELEASE_AMD64_CD' output.iso release-media
619 .Sh HISTORY
620 This version of
621 .Nm
622 first appeared in
623 .Fx 9.0 .
624 .Sh AUTHORS
625 .An Nathan Whitehorn Aq Mt nwhitehorn@FreeBSD.org
626 .An Devin Teske Aq Mt dteske@FreeBSD.org
627 .An Allan Jude Aq Mt allanjude@FreeBSD.org