svn commit: r53989 - in head: en_US.ISO8859-1/books/handbook en_US.ISO8859-1/books/handbook/bsdinstall share/images/books/handbook/bsdinstall
Sergio Carlavilla Delgado
carlavilla at FreeBSD.org
Mon Mar 16 18:24:08 UTC 2020
Author: carlavilla
Date: Mon Mar 16 18:24:07 2020
New Revision: 53989
URL: https://svnweb.freebsd.org/changeset/doc/53989
Log:
Upgrade Guided Partitioning Using Root-on-ZFS section
Patch by: carlavilla@
Approved by: bcr@(mentor)
Differential Revision: https://reviews.freebsd.org/D24078
Added:
head/share/images/books/handbook/bsdinstall/bsdinstall-zfs-init-encription.png (contents, props changed)
head/share/images/books/handbook/bsdinstall/bsdinstall-zfs-pool-name.png (contents, props changed)
head/share/images/books/handbook/bsdinstall/bsdinstall-zfs-rescan-devices.png (contents, props changed)
head/share/images/books/handbook/bsdinstall/bsdinstall-zfs-swap-amount.png (contents, props changed)
Modified:
head/en_US.ISO8859-1/books/handbook/Makefile
head/en_US.ISO8859-1/books/handbook/bsdinstall/chapter.xml
head/share/images/books/handbook/bsdinstall/bsdinstall-post-root-passwd.png
head/share/images/books/handbook/bsdinstall/bsdinstall-zfs-vdev_type.png
Modified: head/en_US.ISO8859-1/books/handbook/Makefile
==============================================================================
--- head/en_US.ISO8859-1/books/handbook/Makefile Mon Mar 16 14:38:17 2020 (r53988)
+++ head/en_US.ISO8859-1/books/handbook/Makefile Mon Mar 16 18:24:07 2020 (r53989)
@@ -96,6 +96,10 @@ IMAGES_EN+= bsdinstall/bsdinstall-zfs-partmenu.png
IMAGES_EN+= bsdinstall/bsdinstall-zfs-vdev_invalid.png
IMAGES_EN+= bsdinstall/bsdinstall-zfs-vdev_type.png
IMAGES_EN+= bsdinstall/bsdinstall-zfs-warning.png
+IMAGES_EN+= bsdinstall/bsdinstall-zfs-rescan-devices.png
+IMAGES_EN+= bsdinstall/bsdinstall-zfs-pool-name.png
+IMAGES_EN+= bsdinstall/bsdinstall-zfs-swap-amount.png
+IMAGES_EN+= bsdinstall/bsdinstall-zfs-init-encription.png
IMAGES_EN+= geom/striping.pic
IMAGES_EN+= mail/mutt1.scr
IMAGES_EN+= mail/mutt2.scr
Modified: head/en_US.ISO8859-1/books/handbook/bsdinstall/chapter.xml
==============================================================================
--- head/en_US.ISO8859-1/books/handbook/bsdinstall/chapter.xml Mon Mar 16 14:38:17 2020 (r53988)
+++ head/en_US.ISO8859-1/books/handbook/bsdinstall/chapter.xml Mon Mar 16 18:24:07 2020 (r53989)
@@ -1659,30 +1659,11 @@ Ethernet address 0:3:ba:b:92:d4, Host ID: 830b92d4.</s
<sect2 xml:id="bsdinstall-part-zfs">
<title>Guided Partitioning Using Root-on-ZFS</title>
- <para>Support for automatic creation of root-on-ZFS
- installations was added in &os; 10.0-RELEASE. This
- partitioning mode only works with whole disks and will erase
- the contents of the entire disk. The installer will
- automatically create partitions aligned to 4k boundaries and
- force <acronym>ZFS</acronym> to use 4k sectors. This is safe
- even with 512 byte sector disks, and has the added benefit of
- ensuring that pools created on 512 byte disks will be able to
- have 4k sector disks added in the future, either as additional
- storage space or as replacements for failed disks. The
- installer can also optionally employ <acronym>GELI</acronym>
- disk encryption as described in <xref
- linkend="disks-encrypting-geli"/>.
- If encryption is enabled, a 2 GB unencrypted boot pool
- containing the <filename>/boot</filename> directory is
- created. It holds the kernel and other files necessary to
- boot the system. A swap partition of a user selectable size
- is also created, and all remaining space is used for the
- <acronym>ZFS</acronym> pool.</para>
+ <para>This partitioning mode only works with whole disks and
+ will erase the contents of the entire disk. The main
+ <acronym>ZFS</acronym> configuration menu offers a number of
+ options to control the creation of the pool.</para>
- <para>The main <acronym>ZFS</acronym> configuration menu offers
- a number of options to control the creation of the
- pool.</para>
-
<figure xml:id="bsdinstall-zfs-menu">
<title><acronym>ZFS</acronym> Partitioning Menu</title>
@@ -1693,22 +1674,97 @@ Ethernet address 0:3:ba:b:92:d4, Host ID: 830b92d4.</s
</mediaobject>
</figure>
+ <para>Here is a summary of the options which can be used in
+ this menu:</para>
+
+ <itemizedlist>
+ <listitem>
+ <para><literal>Install</literal> - Proceed with the
+ installation with the selected options.</para>
+ </listitem>
+
+ <listitem>
+ <para><literal>Pool Type/Disks</literal> - Allow to configure
+ the <literal>Pool Type</literal> and the disk(s) that will
+ constitute the pool. The automatic <acronym>ZFS</acronym>
+ installer currently only supports the creation of a single top
+ level vdev, except in stripe mode. To create more complex
+ pools, use the instructions in <xref linkend="bsdinstall-part-shell"/>
+ to create the pool.</para>
+ </listitem>
+
+ <listitem>
+ <para><literal>Rescan Devices</literal> - Repopulate the list
+ of available disks.</para>
+ </listitem>
+
+ <listitem>
+ <para><literal>Disk Info</literal> - Disk Info menu can be
+ used to inspect each disk, including its partition table and
+ various other information such as the device model number
+ and serial number, if available.</para>
+ </listitem>
+
+ <listitem>
+ <para><literal>Pool Name</literal> - Establish the name of the
+ pool. The default name is
+ <emphasis>zroot</emphasis>.</para>
+ </listitem>
+
+ <listitem>
+ <para><literal>Force 4K Sectors?</literal> - Force the use of
+ 4K sectors. By default, the installer will automatically
+ create partitions aligned to 4K boundaries and force ZFS to
+ use 4K sectors. This is safe even with 512 byte sector
+ disks, and has the added benefit of ensuring that pools
+ created on 512 byte disks will be able to have 4K sector
+ disks added in the future, either as additional storage
+ space or as replacements for failed disks. Press the
+ <keycap>Enter</keycap> key to chose to activate it or
+ not.</para>
+ </listitem>
+
+ <listitem>
+ <para><literal>Encrypt Disks?</literal> - Encrypting the disks
+ allows the user to encrypt the disks using
+ <acronym>GELI</acronym>. More information about disk
+ encryption is available in <xref linkend="disks-encrypting-geli"/>.
+ Press the <keycap>Enter</keycap> key to chose activate it or
+ not.</para>
+ </listitem>
+
+ <listitem>
+ <para><literal>Partition Scheme</literal> - Allow to choose
+ the partition scheme. GPT is the recommended option in
+ most cases. Press the <keycap>Enter</keycap> key to chose
+ between the different options.</para>
+ </listitem>
+
+ <listitem>
+ <para><literal>Swap Size</literal> - Establish the amount of
+ swap space.</para>
+ </listitem>
+
+ <listitem>
+ <para><literal>Mirror Swap?</literal> - Allows the user to
+ mirror the swap between the disks. Be aware, enabling
+ mirror swap will break crash dumps. Press the
+ <keycap>Enter</keycap> key to activate it or not.</para>
+ </listitem>
+
+ <listitem>
+ <para><literal>Encrypt Swap?</literal> - Allow the user the
+ possibility to encrypt the swap. Encrypts the swap with a
+ temporary key each time that the system boots and discards
+ it on reboot. Press the <keycap>Enter</keycap> key to chose
+ activate it or not. More information about swap encryption
+ in <xref linkend="swap-encrypting"/>.</para>
+ </listitem>
+ </itemizedlist>
+
<para>Select <keycap>T</keycap> to configure the <literal>Pool
- Type</literal> and the disk(s) that will constitute the
- pool. The automatic <acronym>ZFS</acronym> installer
- currently only supports the creation of a single top level
- vdev, except in stripe mode. To create more complex pools,
- use the instructions in <xref
- linkend="bsdinstall-part-shell"/> to create the pool. The
- installer supports the creation of various pool types,
- including stripe (not recommended, no redundancy), mirror
- (best performance, least usable space), and RAID-Z 1, 2, and 3
- (with the capability to withstand the concurrent failure of 1,
- 2, and 3 disks, respectively). While selecting the pool type,
- a tooltip is displayed across the bottom of the screen with
- advice about the number of required disks, and in the case of
- RAID-Z, the optimal number of disks for each
- configuration.</para>
+ Type</literal> and the disk(s) that will constitute the
+ pool.</para>
<figure xml:id="bsdinstall-zfs-vdev_type">
<title><acronym>ZFS</acronym> Pool Type</title>
@@ -1720,14 +1776,55 @@ Ethernet address 0:3:ba:b:92:d4, Host ID: 830b92d4.</s
</mediaobject>
</figure>
+ <para>Here is a summary of the <literal>Pool Type</literal>
+ which can be selected in this menu:</para>
+
+ <itemizedlist>
+ <listitem>
+ <para><literal>stripe</literal> - Striping provides maximum
+ storage of all connected devices, but no redundancy. If
+ just one disk fails the data on the pool is lost
+ irrevocably.</para>
+ </listitem>
+ <listitem>
+ <para><literal>mirror</literal> - Mirroring stores a complete
+ copy of all data on every disk. Mirroring provides a good
+ read perfomance because data is read from all disks in
+ parallel. Write performance is slower as the data must be
+ written to all disks in the pool. Allows all but one disk
+ to fail. This options requires at least two disks.</para>
+ </listitem>
+ <listitem>
+ <para><literal>raid10</literal> - Striped mirrors. Provides
+ the best performance, but the least storage. This option
+ needs at least an even number of disks and a minimum of four
+ disks.</para>
+ </listitem>
+ <listitem>
+ <para><literal>raidz1</literal> - Single Redundant RAID.
+ Allow one disk to fail concurrently. This option needs at
+ least three disks.</para>
+ </listitem>
+ <listitem>
+ <para><literal>raidz2</literal> - Double Redundant RAID.
+ Allows two disks to fail concurrently. This option needs
+ at least four disks.</para>
+ </listitem>
+ <listitem>
+ <para><literal>raidz3</literal> - Triple Redundant RAID.
+ Allows three disks to fail concurrently. This option needs
+ at least five disks.</para>
+ </listitem>
+ </itemizedlist>
+
<para>Once a <literal>Pool Type</literal> has been selected, a
list of available disks is displayed, and the user is prompted
to select one or more disks to make up the pool. The
configuration is then validated, to ensure enough disks are
selected. If not, select <guibutton><Change
- Selection></guibutton> to return to the list of disks, or
- <guibutton><Cancel></guibutton> to change the pool
- type.</para>
+ Selection></guibutton> to return to the list of disks, or
+ <guibutton><Back></guibutton> to change the
+ <literal>Pool Type</literal>.</para>
<figure xml:id="bsdinstall-zfs-disk_select">
<title>Disk Selection</title>
@@ -1754,8 +1851,19 @@ Ethernet address 0:3:ba:b:92:d4, Host ID: 830b92d4.</s
<para>If one or more disks are missing from the list, or if
disks were attached after the installer was started, select
<guibutton>- Rescan Devices</guibutton> to repopulate the list
- of available disks.
- To avoid accidentally erasing the wrong disk, the
+ of available disks.</para>
+
+ <figure xml:id="bsdinstall-zfs-rescan-devices">
+ <title>Rescan Devices</title>
+
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="bsdinstall/bsdinstall-zfs-rescan-devices"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>To avoid accidentally erasing the wrong disk, the
<guibutton>- Disk Info</guibutton> menu can be used to inspect
each disk, including its partition table and various other
information such as the device model number and serial number,
@@ -1771,19 +1879,59 @@ Ethernet address 0:3:ba:b:92:d4, Host ID: 830b92d4.</s
</mediaobject>
</figure>
- <para>The main <acronym>ZFS</acronym> configuration menu also
- allows the user to enter a pool name, disable forcing 4k
- sectors, enable or disable encryption, switch between
- <acronym>GPT</acronym> (recommended) and
- <acronym>MBR</acronym> partition table types, and select the
- amount of swap space. Once all options have been set to the
- desired values, select the
- <guibutton>>>> Install</guibutton> option at the
- top of the menu.</para>
+ <para>Select <keycap>N</keycap> to configure the
+ <literal>Pool Name</literal>. Enter the desired name then
+ select <guibutton><OK></guibutton> to establish it or
+ <guibutton><Cancel></guibutton> to return to the
+ main menu and leave the default name.</para>
+ <figure xml:id="bsdinstall-zfs-pool-name">
+ <title>Pool Name</title>
+
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="bsdinstall/bsdinstall-zfs-pool-name"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>Select <keycap>S</keycap> to set the amount of
+ swap. Enter the desired amount of swap and then select
+ <guibutton><OK></guibutton> to establish it or
+ <guibutton><Cancel></guibutton> to return to the
+ main menu and let the default amount.</para>
+
+ <figure xml:id="bsdinstall-zfs-swap-amount">
+ <title>Swap Amount</title>
+
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="bsdinstall/bsdinstall-zfs-swap-amount"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>Once all options have been set to the desired values,
+ select the <guibutton>>>> Install</guibutton>
+ option at the top of the menu. The installer then offers a
+ last chance to cancel before the contents of the selected
+ drives are destroyed to create the <acronym>ZFS</acronym>
+ pool.</para>
+
+ <figure xml:id="bsdinstall-zfs-warning">
+ <title>Last Chance</title>
+
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="bsdinstall/bsdinstall-zfs-warning"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
<para>If <acronym>GELI</acronym> disk encryption was enabled,
the installer will prompt twice for the passphrase to be used
- to encrypt the disks.</para>
+ to encrypt the disks. And after that the initializing of the
+ encryption begins.</para>
<figure xml:id="bsdinstall-zfs-geli_password">
<title>Disk Encryption Password</title>
@@ -1795,22 +1943,21 @@ Ethernet address 0:3:ba:b:92:d4, Host ID: 830b92d4.</s
</imageobject>
</mediaobject>
</figure>
+
+ <figure xml:id="bsdinstall-zfs-init-encription">
+ <title>Initializing Encryption</title>
- <para>The installer then offers a last chance to cancel before
- the contents of the selected drives are destroyed to create
- the <acronym>ZFS</acronym> pool.</para>
-
- <figure xml:id="bsdinstall-zfs-warning">
- <title>Last Chance</title>
-
<mediaobject>
<imageobject>
- <imagedata fileref="bsdinstall/bsdinstall-zfs-warning"/>
+ <imagedata
+ fileref="bsdinstall/bsdinstall-zfs-init-encription"/>
</imageobject>
</mediaobject>
</figure>
- <para>The installation then proceeds normally.</para>
+ <para>The installation then proceeds normally. To continue
+ with the installation go to
+ <xref linkend="bsdinstall-fetching-distribution"/>.</para>
</sect2>
Modified: head/share/images/books/handbook/bsdinstall/bsdinstall-post-root-passwd.png
==============================================================================
Binary file (source and/or target). No diff available.
Added: head/share/images/books/handbook/bsdinstall/bsdinstall-zfs-init-encription.png
==============================================================================
Binary file. No diff available.
Added: head/share/images/books/handbook/bsdinstall/bsdinstall-zfs-pool-name.png
==============================================================================
Binary file. No diff available.
Added: head/share/images/books/handbook/bsdinstall/bsdinstall-zfs-rescan-devices.png
==============================================================================
Binary file. No diff available.
Added: head/share/images/books/handbook/bsdinstall/bsdinstall-zfs-swap-amount.png
==============================================================================
Binary file. No diff available.
Modified: head/share/images/books/handbook/bsdinstall/bsdinstall-zfs-vdev_type.png
==============================================================================
Binary file (source and/or target). No diff available.
More information about the svn-doc-all
mailing list