[install-guide: 2/4] Adding the Add FCoE SAN section to FilterSpoke
by pbokoc
commit 168fe01c7ec63b861a8e2f4fce7f7332c25c61b2
Author: Petr Bokoc <pbokoc(a)redhat.com>
Date: Sun Nov 16 19:48:18 2014 +0100
Adding the Add FCoE SAN section to FilterSpoke
en-US/FilterSpoke_AddFCoE.xml | 43 ++++++++++++++++++++++++++++++++++++++++-
1 files changed, 42 insertions(+), 1 deletions(-)
---
diff --git a/en-US/FilterSpoke_AddFCoE.xml b/en-US/FilterSpoke_AddFCoE.xml
index 92ad22d..f3c64e2 100644
--- a/en-US/FilterSpoke_AddFCoE.xml
+++ b/en-US/FilterSpoke_AddFCoE.xml
@@ -6,6 +6,47 @@
<section id="sect-installation-gui-installation-destination-add-fcoe">
<title>Add FCoE SAN</title>
<para>
- text
+ The following procedure explains how to add <firstterm>Fibre Channel over Ethernet</firstterm> (FCoE) storage devices and make them available during the installation:
</para>
+ <procedure id="proc-installation-gui-installation-destination-add-fcoe">
+ <title>Add FCoE Target</title>
+ <step>
+ <para>
+ Click the <guilabel>Add FCoE SAN</guilabel> button in the bottom right corner of <xref linkend="sect-installation-gui-installation-destination" />. A new dialog window will open.
+ </para>
+ </step>
+ <step>
+ <para>
+ Select the network interface (<guilabel>NIC</guilabel>) which is connected to your FCoE switch from the drop-down menu. Note that this network interface must be configured and connected - see <xref linkend="sect-installation-gui-network-configuration" />.
+ </para>
+ </step>
+ <step>
+ <para>
+ Below the <guilabel>NIC</guilabel> drop-down menu are two choices:
+ </para>
+ <variablelist>
+ <varlistentry>
+ <term>Use DCB</term>
+ <listitem>
+ <para>
+ <firstterm>Data Center Bridging</firstterm> (DCB) is a set of enhancements to the Ethernet protocols designed to increase the efficiency of Ethernet connections in storage networks and clusters. This option should only be enabled for network interfaces that require a host-based DCBX client. Configurations on interfaces that implement a hardware DCBX client should leave this check box empty.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Use auto vlan</term>
+ <listitem>
+ <para>
+ This option indicates whether VLAN discovery should be performed. If this box is checked, then the <firstterm>FCoE Initiation Protocol</firstterm> (FIP) VLAN discovery protocol will run on the Ethernet interface once the link configuration has been validated. If they are not already configured, network interfaces for any discovered FCoE VLANs will be automatically created and FCoE instances will be created on the VLAN interfaces. This option is enabled by default.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </step>
+ <step>
+ <para>
+ After you select which interface and options to use, click <guilabel>Add FCoE Disk(s)</guilabel>. Discovered FCoE storage devices will be displayed under the <guilabel>Other SAN Devices</guilabel> tab in <xref linkend="sect-installation-gui-installation-destination" />.
+ </para>
+ </step>
+ </procedure>
</section>
9 years, 6 months
[install-guide] (4 commits) ...checksum introduction
by pbokoc
Summary of changes:
7d8b8c2... terminology; images for the ISOs, media for the physical (o (*)
168fe01... Adding the Add FCoE SAN section to FilterSpoke
eb06ae0... Adding structure to CustomSpoke and adding Advice on Partit
234e4d8... checksum introduction
(*) This commit already existed in another branch; no separate mail sent
9 years, 6 months
[install-guide/f21-branch] checksum introduction
by Pete Travis
commit 07910a34876d39861a514c3b6ca017719c540ebb
Author: Pete Travis <immanetize(a)fedoraproject.org>
Date: Sun Nov 16 13:47:01 2014 -0700
checksum introduction
en-US/Preparing_for_Installation.xml | 10 +++++++++-
1 files changed, 9 insertions(+), 1 deletions(-)
---
diff --git a/en-US/Preparing_for_Installation.xml b/en-US/Preparing_for_Installation.xml
index dcd1c23..37ce705 100644
--- a/en-US/Preparing_for_Installation.xml
+++ b/en-US/Preparing_for_Installation.xml
@@ -60,7 +60,15 @@
</para>
</section>
<section id="sect-verifying-images">
- <title>
+ <title>Verifying the Downloaded Image</title>
+ <para>
+ Because transmission errors or other problems may corrupt the Fedora image you have downloaded, it is imporant to verify the file's integrity. After the images are created, an operation is performed on the file that produces a value called a <literal>checksum</literal> using a complex mathematical algorithm. The operation is sufficiently complex that <emphasis>any change</emphasis> to the original file will produce a different checksum.
+ </para>
+ <para>
+ By calculating the image's <literal>checksum</literal> on your own computer and comparing it to the original <literal>checksum</literal>, you can verify the image has not been tampered with or corrupted. The original checksum values are provided at <ulink url="https://fedoraproject.org/verify" />, and are <command>gpg</command> signed to show that even the checksum values have not been tampered with.
+ </para>
+ </section>
+
<section id="sect-preparing-installation-methods">
<title>Choosing an Installation Method</title>
<para>
9 years, 6 months
[install-guide/f21-branch] terminology; images for the ISOs, media for the physical (or network, etc) delivery mechanism
by Pete Travis
commit 7d8b8c25526aa685ce111ede444d13bb47b99925
Author: Pete Travis <immanetize(a)fedoraproject.org>
Date: Sun Nov 16 13:02:52 2014 -0700
terminology; images for the ISOs, media for the physical (or network, etc) delivery mechanism
en-US/Preparing_for_Installation.xml | 9 +++++----
1 files changed, 5 insertions(+), 4 deletions(-)
---
diff --git a/en-US/Preparing_for_Installation.xml b/en-US/Preparing_for_Installation.xml
index 783ff0a..dcd1c23 100644
--- a/en-US/Preparing_for_Installation.xml
+++ b/en-US/Preparing_for_Installation.xml
@@ -53,13 +53,14 @@
</para>
</section>
- <section id="sect-preparing-obtaining-media">
- <title>Downloading Boot and Installation Media</title>
+ <section id="sect-preparing-obtaining-images">
+ <title>Downloading Boot and Installation Images</title>
<para>
TODO
</para>
</section>
-
+ <section id="sect-verifying-images">
+ <title>
<section id="sect-preparing-installation-methods">
<title>Choosing an Installation Method</title>
<para>
@@ -72,7 +73,7 @@
<para>
TODO
</para>
- </section>
+ </section>
<section id="sect-preparing-installation-sources">
<title>Preparing Installation Sources</title>
9 years, 6 months
[install-guide] (3 commits) ...Adding FilterSpoke and Add iSCSI Target
by pbokoc
Summary of changes:
d2ed61d... Splitting NetworkSpoke into separate files so we can xref w (*)
0f00408... Splitting StorageSpoke into more files so we can xref withi (*)
4e3c648... Adding FilterSpoke and Add iSCSI Target (*)
(*) This commit already existed in another branch; no separate mail sent
9 years, 6 months
[install-guide/f21-branch] Adding FilterSpoke and Add iSCSI Target
by pbokoc
commit 4e3c64859fb99a177d99f6d13cda38cf764387f8
Author: Petr Bokoc <pbokoc(a)redhat.com>
Date: Sun Nov 16 17:56:33 2014 +0100
Adding FilterSpoke and Add iSCSI Target
en-US/FilterSpoke.xml | 75 ++++++++++++++++++++++++++++-
en-US/FilterSpoke_AddFCoE.xml | 11 ++++
en-US/FilterSpoke_AddiSCSI.xml | 101 ++++++++++++++++++++++++++++++++++++++
prepare_anaconda_help_content.py | 2 +
4 files changed, 188 insertions(+), 1 deletions(-)
---
diff --git a/en-US/FilterSpoke.xml b/en-US/FilterSpoke.xml
index 7b0d1c3..e5a4245 100644
--- a/en-US/FilterSpoke.xml
+++ b/en-US/FilterSpoke.xml
@@ -6,6 +6,79 @@
<section id="sect-installation-gui-installation-destination">
<title>Installation Destination - Specialized & Network Disks</title>
<para>
- text
+ This part of the <guilabel>Installation Destination</guilabel> screen allows you to configure non-local storage devices, namely iSCSI and FCoE storage. This section will mostly be useful to advanced users who have a need for networked disks. For instructions on setting up local hard drives, see <xref linkend="sect-installation-gui-storage-partitioning" />.
</para>
+ <important>
+ <para>
+ This section only explains how to make existing network disks available inside the installer. It does not explain how to set up your network or a storage server, only how to connect to them.
+ </para>
+ </important>
+ <para>
+ <remark>TODO: screen</remark>
+ </para>
+ <para>
+ The screen contains a list of all currently available (discovered) network storage devices. When the screen is opened for the first time, the list will be empty in most cases because no network storage has been discovered - the installer makes no attempt at discovering this unless you configure network disks using a Kickstart file.
+ </para>
+ <para>
+ To add one or more storage devices to the screen so you can search them and use them in the installation, click <guilabel>Add iSCSI Target</guilabel> or <guilabel>Add FCoE SAN</guilabel> in the bottom right corner of the screen, and follow the instructions in <xref linkend="sect-installation-gui-installation-destination-add-iscsi" /> or <xref linkend="sect-installation-gui-installation-destination-add-fcoe" />, depending on which type of network storage you want to add.
+ </para>
+ <para>
+ Network storage devices successfully discovered and configured by the installer will then be displayed in the main list, along with identifying information such as <guilabel>Name</guilabel>, <guilabel>WWID</guilabel>, <guilabel>Model</guilabel> and <guilabel>Target</guilabel>. To sort the list by a specific column (for example <guilabel>WWID</guilabel>), click the column's heading.
+ </para>
+ <note>
+ <para>
+ On lower display resolutions, the list may be too wide to fit on the screen, and some of the columns or buttons may be hidden initially. Use the horizontal scroll bar at the bottom of the list to move your view and see all available table columns and controls.
+ </para>
+ </note>
+ <para>
+ There are three tabs on the top of the list, which display different information:
+ </para>
+ <variablelist>
+ <varlistentry>
+ <term>Search</term>
+ <listitem>
+ <para>
+ Displays all available devices, regardless of their type, and allows you to filter them either by their <firstterm>World Wide Identifier</firstterm> (WWID) or by the port, target, or logical unit number (LUN) at which they are accessed.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Multipath Devices</term>
+ <listitem>
+ <para>
+ Storage devices accessible through more than one path, such as through multiple SCSI controllers or Fiber Channel ports on the same system.
+ </para>
+ <important>
+ <para>
+ The installation program only detects multipath storage devices with serial numbers that are 16 or 32 characters long.
+ </para>
+ </important>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Other SAN Devices</term>
+ <listitem>
+ <para>
+ Devices available on a Storage Area Network (SAN).
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ <para>
+ Depending on the tab you are currently in, you can filter the discovered devices by using the <guilabel>Filter By</guilabel> field. Some of the filtering options are automatically populated based on discovered devices (for example, if you select <guilabel>Filter By:</guilabel> <guilabel>Vendor</guilabel>, another drop-down menu will appear showing all vendors of all discovered devices). Other filters require your input (for example when filtering by WWID), and present you with a text input field instead of a drop-down menu.
+ </para>
+ <para>
+ In the list (regardless of how it is filtered), each device is presented on a separate row, with a check box to its left. Mark the check box to make the device available during the installation process; this will cause this device (node) to be shown in the <guilabel>Specialized & Network Disks</guilabel> section in <xref linkend="sect-installation-gui-storage-partitioning" />. There, you can select the disk as an installation target and proceed with either manual or automatic partitioning.
+ </para>
+ <note>
+ <para>
+ Devices that you select here are not automatically wiped by the installation process. Selecting a device on this screen does not, in itself, place data stored on the device at risk. Also note that any devices that you do not select here to form part of the installed system can be added to the system after installation by modifying the <filename>/etc/fstab</filename> file.
+ </para>
+ </note>
+ <para>
+ When you have selected the storage devices to make available during installation, click <guilabel>Done</guilabel> to return to <xref linkend="sect-installation-gui-storage-partitioning" />.
+ </para>
+
+ <xi:include href="FilterSpoke_AddiSCSI.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="FilterSpoke_AddFCoE.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</section>
diff --git a/en-US/FilterSpoke_AddFCoE.xml b/en-US/FilterSpoke_AddFCoE.xml
new file mode 100644
index 0000000..92ad22d
--- /dev/null
+++ b/en-US/FilterSpoke_AddFCoE.xml
@@ -0,0 +1,11 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+<!ENTITY % BOOK_ENTITIES SYSTEM "Installation_Guide.ent">
+%BOOK_ENTITIES;
+]>
+<section id="sect-installation-gui-installation-destination-add-fcoe">
+ <title>Add FCoE SAN</title>
+ <para>
+ text
+ </para>
+</section>
diff --git a/en-US/FilterSpoke_AddiSCSI.xml b/en-US/FilterSpoke_AddiSCSI.xml
new file mode 100644
index 0000000..f02e0693
--- /dev/null
+++ b/en-US/FilterSpoke_AddiSCSI.xml
@@ -0,0 +1,101 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+<!ENTITY % BOOK_ENTITIES SYSTEM "Installation_Guide.ent">
+%BOOK_ENTITIES;
+]>
+<section id="sect-installation-gui-installation-destination-add-iscsi">
+ <title>Add iSCSI Target</title>
+ <para>
+ To use iSCSI storage devices, the installer must be able to discover them as <firstterm>iSCSI targets</firstterm> and be able to create an iSCSI session to access them. Both of these steps may require a user name and password for <firstterm>Challenge Handshake Authentication Protocol</firstterm> (CHAP) authentication.
+ </para>
+ <para>
+ You can also configure an iSCSI target to authenticate the iSCSI initiator on the system to which the target is attached (<firstterm>reverse CHAP</firstterm>), both for discovery and for the session. Used together, CHAP and reverse CHAP are called <firstterm>mutual CHAP</firstterm> or <firstterm>two-way CHAP</firstterm>. Mutual CHAP provides the greatest level of security for iSCSI connections, particularly if the user name and password are different for CHAP authentication and reverse CHAP authentication.
+ </para>
+ <para>
+ Follow the procedure below to add an iSCSI storage target to your system.
+ </para>
+ <procedure id="proc-installation-gui-installation-destination-add-iscsi">
+ <title>Add iSCSI Target</title>
+ <step>
+ <para>
+ Click the <guilabel>Add iSCSI Target</guilabel> button in the bottom right corner of the <xref linkend="sect-installation-gui-installation-destination" /> screen. A new dialog window titled <guilabel>Add iSCSI Storage Target</guilabel> will open.
+ </para>
+ </step>
+ <step>
+ <para>
+ Enter the IP address of the iSCSI target in the <guilabel>Target IP Address</guilabel> field.
+ </para>
+ </step>
+ <step>
+ <para>
+ Provide a name in the <guilabel>iSCSI Initiator Name</guilabel> field for the iSCSI initiator in <firstterm>iSCSI Qualified Name</firstterm> (IQN) format. A valid IQN entry contains:
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ The string <literal>iqn.</literal> (including the period).
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ A date code specifying the year and month in which your organization's Internet domain or subdomain name was registered, represented as four digits for the year, a dash, and two digits for the month, followed by a period. For example, represent September 2010 as <literal>2010-09.</literal>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Your organization's Internet domain or subdomain name, presented in <emphasis>reverse</emphasis> order (with the top-level domain first). For example, represent the subdomain storage.example.com as <literal>com.example.storage</literal>.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ A colon (<literal>:</literal>) followed by a string which uniquely identifies this particular iSCSI initiator within your domain or subdomain. For example, <literal>:diskarrays-sn-a8675309</literal>
+ </para>
+ </listitem>
+ </itemizedlist>
+ <para>
+ A complete IQN will therefore look as follows:
+ </para>
+ <screen>
+<literal>iqn.2010-09.com.example.storage:diskarrays-sn-a8675309</literal>
+ </screen>
+ <para>
+ An example using the correct format is also displayed below the input field for reference.
+ </para>
+ <para>
+ For more information about IQNs, see <citetitle>3.2.6. iSCSI Names in RFC 3720 - Internet Small Computer Systems Interface (iSCSI)</citetitle>, available from <ulink url="http://tools.ietf.org/html/rfc3720#section-3.2.6" /> and <citetitle>1. iSCSI Names and Addresses in RFC 3721 - Internet Small Computer Systems Interface (iSCSI) Naming and Discovery</citetitle>, available from <ulink url="http://tools.ietf.org/html/rfc3721#section-1" />.
+ </para>
+ </step>
+ <step>
+ <para>
+ Specify the type of authentication to use for iSCSI discovery using the <guilabel>Discovery Authentication Type</guilabel> drop-down menu. Depending on which type of authentication you selected, additional input fields (such as <guilabel>CHAP Username</guilabel> and <guilabel>CHAP Password</guilabel> may then become visible. Fill in your authentication credentials; these should be provided by your organization.
+ </para>
+ </step>
+ <step>
+ <para>
+ Click the <guilabel>Start Discovery</guilabel> button. The installer will now attempt to discover an iSCSI target based on the information you provided, and if the target requires CHAP or reverse CHAP authentication, it will attempt to use the credentials you provided. This process may take some time (generally less than 30 seconds), depending on your network.
+ </para>
+ <para>
+ If the discovery was <emphasis>not</emphasis> successful, an error message will be displayed in the dialog window. This message will vary based on which part of the discovery failed. If the installer did not find the target you specified at all, you should check the IP address; if the problem is an authentication error, make sure you entered all CHAP and reverse CHAP credentials correctly and that you have access to the iSCSI target.
+ </para>
+ <note>
+ <para>
+ The <guilabel>No nodes discovered</guilabel> error message may also mean that all nodes on the address you specified are already configured. During discovery, <application>Anaconda</application> ignores nodes which have already been added.
+ </para>
+ </note>
+ <para>
+ If the discovery was successful, you will see a list of all discovered nodes.
+ </para>
+ </step>
+ <step>
+ <para>
+ Select one or more nodes you want to log in to by marking or unmarking the check box next to each node discovered on the target. Below the list, select again the type of authentication you want to use; you can also select the <guilabel>Use the credentials from discovery</guilabel> option if the CHAP/reverse CHAP user name and password you used to discover the target are also valid for logging in to it.
+ </para>
+ <para>
+ After selecting all nodes you want to use, click <guilabel>Log In</guilabel> to initiate an iSCSI session. <application>Anaconda</application> will attempt to log in to all selected nodes. If the login process is succesful, the <guilabel>Add iSCSI Storage Target</guilabel> dialog will close, and all nodes you have configured will now be shown in the list of network disks in <xref linkend="sect-installation-gui-installation-destination" />.
+ </para>
+ </step>
+ </procedure>
+ <para>
+ You can repeat this procedure to discover additional iSCSI targets, or to add more nodes from a previously configured target. However, note that once you click the <guilabel>Start Discovery</guilabel> button for the first time, you will not be able to change the <guilabel>iSCSI Initiator Name</guilabel>. If you made an error when configuring the initiator name, you must restart the installation.
+ </para>
+</section>
diff --git a/prepare_anaconda_help_content.py b/prepare_anaconda_help_content.py
index 94d7b29..19ff72a 100755
--- a/prepare_anaconda_help_content.py
+++ b/prepare_anaconda_help_content.py
@@ -18,6 +18,8 @@ ANACONDA_HELP_FILES = [
"KeyboardSpoke.xml",
"SourceSpoke.xml",
"FilterSpoke.xml",
+ "FilterSpoke_AddiSCSI.xml",
+ "FilterSpoke_AddFCoE.xml",
"PasswordSpoke.xml",
"StorageSpoke.xml",
"StorageSpoke_BootLoader.xml",
9 years, 6 months
[install-guide/f21-branch] Splitting StorageSpoke into more files so we can xref within the section
by pbokoc
commit 0f0040815732f36ea9b24d31f72f1f0d7fae549e
Author: Petr Bokoc <pbokoc(a)redhat.com>
Date: Sun Nov 16 14:51:29 2014 +0100
Splitting StorageSpoke into more files so we can xref within the section
en-US/StorageSpoke.xml | 91 +-----------------------------------
en-US/StorageSpoke_BootLoader.xml | 93 +++++++++++++++++++++++++++++++++++++
prepare_anaconda_help_content.py | 1 +
3 files changed, 96 insertions(+), 89 deletions(-)
---
diff --git a/en-US/StorageSpoke.xml b/en-US/StorageSpoke.xml
index f9eae9a..d6d8671 100644
--- a/en-US/StorageSpoke.xml
+++ b/en-US/StorageSpoke.xml
@@ -63,7 +63,7 @@
</para>
</warning>
<para>
- To control which one of your selected storage devices will contain the <firstterm>boot loader</firstterm>, click the <guilabel>Full disk summary and bootloader</guilabel> link in the bottom left corner of the screen, and follow the instructions below. Note that while in most cases it is sufficient to leave the boot loader in the default location, some configurations (for example, systems which require <firstterm>chain loading</firstterm> from another boot loader) will require the boot drive to be specified manually.
+ To control which one of your selected storage devices will contain the <firstterm>boot loader</firstterm>, click the <guilabel>Full disk summary and bootloader</guilabel> link in the bottom left corner of the screen, and follow the instructions in <xref linkend="sect-installation-gui-storage-partitioning-bootloader" />. Note that while in most cases it is sufficient to leave the boot loader in the default location, some configurations (for example, systems which require <firstterm>chain loading</firstterm> from another boot loader) will require the boot drive to be specified manually.
</para>
<para>
After you select storage devices, choose between automatic and manual partitioning, configure encryption and boot loader location, press <guilabel>Done</guilabel> in the top left corner of the screen. Then, depending on your settings, the following will happen:
@@ -102,93 +102,6 @@
</listitem>
</itemizedlist>
- <section id="sect-installation-gui-storage-partitioning-bootloader">
- <title>Boot Loader Installation</title>
- <para>
- &PRODUCT; uses <application>GRUB2</application> (GRand Unified Bootloader version 2) as its boot loader. The boot loader is the first program that runs when the computer starts and is responsible for loading and transferring control to an operating system. <application>GRUB2</application> can boot any compatible operating system (including Microsoft Windows) and can also use chain loading to transfer control to other boot loaders for unsupported operating systems.
- </para>
- <warning>
- <para>
- Installing <application>GRUB2</application> may overwrite your existing boot loader.
- </para>
- </warning>
- <para>
- If you have other operating systems already installed, the &PRODUCT; installer will attempt to automatically detect and configure the boot loader to start them. You can manually configure any additional operating systems after you finish the installation, if they are not detected properly. For instructions on editing <application>GRUB2</application> configuration, see the <citetitle>&PRODUCT; System Administrator's Guide</citetitle>, available at <ulink url="http://docs.fedoraproject.org/">&PRODUCT; Documentation</ulink>
- </para>
- <para>
- To specify which device the boot loader should be installed on, click the <guilabel>Full disk summary and bootloader</guilabel> link at the bottom of the <guilabel>Installation Destination</guilabel> screen. The <guilabel>Selected Disks</guilabel> dialog will appear. If you are configuring your partitioning layout manually, the same dialog can be accessed from <xref linkend="sect-installation-gui-manual-partitioning" /> using the <guilabel><replaceable>X</replaceable> storage devices selected</guilabel> link in the bottom left corner of the screen.
- </para>
- <para>
- <remark>TODO: screen</remark>
- </para>
- <para>
- In the <guilabel>Boot</guilabel> column, a "tick" icon marks one of the devices as the intended boot device. To change the boot device, select a device from the list and click the <guilabel>Set as Boot Device</guilabel> button to install the boot loader there instead. Only one device can be set as the boot device.
- </para>
- <para>
- To decline installation of a new boot loader, select the device currently marked for boot and click the <guilabel>Do not install bootloader</guilabel> button. This will remove the tick and ensure <application>GRUB2</application> is not installed on any device.
- </para>
- <warning>
- <para>
- If you choose not to install a boot loader for any reason, you will not be able to boot the system directly, and you must use another boot method, such as a stand-alone commercial boot loader application. Use this option only if you are sure you have another way to boot your system.
- </para>
- </warning>
-
- <section id="sect-installation-gui-storage-partitioning-mbr-gpt">
- <title>MBR and GPT Considerations</title>
- <para>
- <application>GRUB2</application> can be installed either in the <firstterm>Master Boot Record</firstterm> (MBR) or the <firstterm>GUID Partition Table</firstterm> (GPT) of the boot device. In order to determine which of these methods to use, the installation program considers the following variations:
- </para>
- <variablelist>
- <varlistentry>
- <term>Systems with BIOS firmware and UEFI systems in BIOS compatibility mode</term>
- <listitem>
- <para>
- If the disk is already formatted, the partitioning scheme is retained.
- </para>
- <para>
- If the disk is not formatted, or you have erased all existing partitions from the disk, the installer choose the following:
- </para>
- <itemizedlist>
- <listitem>
- <para>
- MBR if the size of the disk is less than 2 TB (terabytes)
- </para>
- </listitem>
- <listitem>
- <para>
- GPT if the size of the disk is more than 2 TB
- </para>
- </listitem>
- </itemizedlist>
- <note>
- <para>
- You can force the installer to use GPT on disks smaller than 2 TB by using the <option>inst.gpt</option> boot option as described in <xref linkend="chap-anaconda-boot-options" />. However, the opposite is not possible - you can not use MBR on disks larger than 2 TB.
- </para>
- </note>
- <para>
- You need to create a <firstterm>BIOS Boot</firstterm> partition with a size of 1 MB to install on a system with BIOS firmware if the disk containing the boot loader uses GPT. If the disk uses a MBR, no special partition is necessary on a BIOS system.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Systems with UEFI firmware</term>
- <listitem>
- <para>
- Only GPT is allowed on UEFI systems. In order to install on a formatted disk with a MBR, it must be reformated and relabeled. All data currently on the disk will be lost.
- </para>
- <para>
- UEFI-based systems require an <firstterm>EFI System Partition</firstterm> at least 50 MB in size (recommended size is 200 MB), regardless of the partitioning scheme.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- <important>
- <para>
- If your system requires either a BIOS Boot partition or an EFI System Partition based on the requirements detailed above, this partition must be created as a standard physical partition. It can not reside on a LVM volume or a Btrfs subvolume.
- </para>
- </important>
- </section>
-
- </section>
+ <xi:include href="StorageSpoke_BootLoader.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</section>
diff --git a/en-US/StorageSpoke_BootLoader.xml b/en-US/StorageSpoke_BootLoader.xml
new file mode 100644
index 0000000..d3ebaa6
--- /dev/null
+++ b/en-US/StorageSpoke_BootLoader.xml
@@ -0,0 +1,93 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+<!ENTITY % BOOK_ENTITIES SYSTEM "Installation_Guide.ent">
+%BOOK_ENTITIES;
+]>
+<section id="sect-installation-gui-storage-partitioning-bootloader">
+ <title>Boot Loader Installation</title>
+ <para>
+ &PRODUCT; uses <application>GRUB2</application> (GRand Unified Bootloader version 2) as its boot loader. The boot loader is the first program that runs when the computer starts and is responsible for loading and transferring control to an operating system. <application>GRUB2</application> can boot any compatible operating system (including Microsoft Windows) and can also use chain loading to transfer control to other boot loaders for unsupported operating systems.
+ </para>
+ <warning>
+ <para>
+ Installing <application>GRUB2</application> may overwrite your existing boot loader.
+ </para>
+ </warning>
+ <para>
+ If you have other operating systems already installed, the &PRODUCT; installer will attempt to automatically detect and configure the boot loader to start them. You can manually configure any additional operating systems after you finish the installation, if they are not detected properly. For instructions on editing <application>GRUB2</application> configuration, see the <citetitle>&PRODUCT; System Administrator's Guide</citetitle>, available at <ulink url="http://docs.fedoraproject.org/">&PRODUCT; Documentation</ulink>
+ </para>
+ <para>
+ To specify which device the boot loader should be installed on, click the <guilabel>Full disk summary and bootloader</guilabel> link at the bottom of the <guilabel>Installation Destination</guilabel> screen. The <guilabel>Selected Disks</guilabel> dialog will appear. If you are configuring your partitioning layout manually, the same dialog can be accessed from <xref linkend="sect-installation-gui-manual-partitioning" /> using the <guilabel><replaceable>X</replaceable> storage devices selected</guilabel> link in the bottom left corner of the screen.
+ </para>
+ <para>
+ <remark>TODO: screen</remark>
+ </para>
+ <para>
+ In the <guilabel>Boot</guilabel> column, a "tick" icon marks one of the devices as the intended boot device. To change the boot device, select a device from the list and click the <guilabel>Set as Boot Device</guilabel> button to install the boot loader there instead. Only one device can be set as the boot device.
+ </para>
+ <para>
+ To decline installation of a new boot loader, select the device currently marked for boot and click the <guilabel>Do not install bootloader</guilabel> button. This will remove the tick and ensure <application>GRUB2</application> is not installed on any device.
+ </para>
+ <warning>
+ <para>
+ If you choose not to install a boot loader for any reason, you will not be able to boot the system directly, and you must use another boot method, such as a stand-alone commercial boot loader application. Use this option only if you are sure you have another way to boot your system.
+ </para>
+ </warning>
+
+ <section id="sect-installation-gui-storage-partitioning-mbr-gpt">
+ <title>MBR and GPT Considerations</title>
+ <para>
+ <application>GRUB2</application> can be installed either in the <firstterm>Master Boot Record</firstterm> (MBR) or the <firstterm>GUID Partition Table</firstterm> (GPT) of the boot device. In order to determine which of these methods to use, the installation program considers the following variations:
+ </para>
+ <variablelist>
+ <varlistentry>
+ <term>Systems with BIOS firmware and UEFI systems in BIOS compatibility mode</term>
+ <listitem>
+ <para>
+ If the disk is already formatted, the partitioning scheme is retained.
+ </para>
+ <para>
+ If the disk is not formatted, or you have erased all existing partitions from the disk, the installer choose the following:
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ MBR if the size of the disk is less than 2 TB (terabytes)
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ GPT if the size of the disk is more than 2 TB
+ </para>
+ </listitem>
+ </itemizedlist>
+ <note>
+ <para>
+ You can force the installer to use GPT on disks smaller than 2 TB by using the <option>inst.gpt</option> boot option as described in <xref linkend="chap-anaconda-boot-options" />. However, the opposite is not possible - you can not use MBR on disks larger than 2 TB.
+ </para>
+ </note>
+ <para>
+ You need to create a <firstterm>BIOS Boot</firstterm> partition with a size of 1 MB to install on a system with BIOS firmware if the disk containing the boot loader uses GPT. If the disk uses a MBR, no special partition is necessary on a BIOS system.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Systems with UEFI firmware</term>
+ <listitem>
+ <para>
+ Only GPT is allowed on UEFI systems. In order to install on a formatted disk with a MBR, it must be reformated and relabeled. All data currently on the disk will be lost.
+ </para>
+ <para>
+ UEFI-based systems require an <firstterm>EFI System Partition</firstterm> at least 50 MB in size (recommended size is 200 MB), regardless of the partitioning scheme.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ <important>
+ <para>
+ If your system requires either a BIOS Boot partition or an EFI System Partition based on the requirements detailed above, this partition must be created as a standard physical partition. It can not reside on a LVM volume or a Btrfs subvolume.
+ </para>
+ </important>
+ </section>
+
+</section>
diff --git a/prepare_anaconda_help_content.py b/prepare_anaconda_help_content.py
index 3e63b20..94d7b29 100755
--- a/prepare_anaconda_help_content.py
+++ b/prepare_anaconda_help_content.py
@@ -20,6 +20,7 @@ ANACONDA_HELP_FILES = [
"FilterSpoke.xml",
"PasswordSpoke.xml",
"StorageSpoke.xml",
+ "StorageSpoke_BootLoader.xml",
"WelcomeSpoke.xml",
"SummaryHub.xml",
"Installation_Guide.xml",
9 years, 6 months
[install-guide/f21-branch] Splitting NetworkSpoke into separate files so we can xref within the section
by pbokoc
commit d2ed61defcc004782ec239d2e0c1c91c53585808
Author: Petr Bokoc <pbokoc(a)redhat.com>
Date: Sun Nov 16 14:45:20 2014 +0100
Splitting NetworkSpoke into separate files so we can xref within the section
en-US/NetworkSpoke.xml | 113 +----------------------------
en-US/NetworkSpoke_EditConnection.xml | 80 +++++++++++++++++++++
en-US/NetworkSpoke_VirtualInterfaces.xml | 36 ++++++++++
prepare_anaconda_help_content.py | 2 +
4 files changed, 122 insertions(+), 109 deletions(-)
---
diff --git a/en-US/NetworkSpoke.xml b/en-US/NetworkSpoke.xml
index 69c8cd4..31c0805 100644
--- a/en-US/NetworkSpoke.xml
+++ b/en-US/NetworkSpoke.xml
@@ -20,10 +20,10 @@
Locally accessible interfaces are automatically detected by the installation program and cannot be manually added or deleted. All detected interfaces are listed on the left side of the screen. Click an interface in the list to display its current configuration (such as IP and DNS address); the details are displayed on the right side of the screen.
</para>
<para>
- Below the list of interfaces are two buttons. Use the <guilabel>+</guilabel> button to add a virtual network interface (Team, Bond or VLAN), as described further in this section. To remove a previously created virtual interface, select it in the list and click the <guilabel>-</guilabel> button.
+ Below the list of interfaces are two buttons. Use the <guilabel>+</guilabel> button to add a virtual network interface (Team, Bond or VLAN) as described in <xref linkend="sect-installation-gui-network-configuration-virtual-interface" />. To remove a previously created virtual interface, select it in the list and click the <guilabel>-</guilabel> button.
</para>
<para>
- To change settings such as IP addresses, DNS servers, or routing configuration for an existing interface (both virtual and physical), select the interface in the left pane and click <guilabel>Configure</guilabel> in the bottom right corner of the screen. Available settings are described further in this chapter.
+ To change settings such as IP addresses, DNS servers, or routing configuration for an existing interface (both virtual and physical), select the interface in the left pane and click <guilabel>Configure</guilabel> in the bottom right corner of the screen. Available settings are described in <xref linkend="sect-installation-gui-network-configuration-advanced" />.
</para>
<para>
Use the <guilabel>ON</guilabel>/<guilabel>OFF</guilabel> switch in the top right corner to enable or disable the currently selected interface.
@@ -32,112 +32,7 @@
Below the list of connections, enter a host name for this computer in the <guilabel>Hostname</guilabel> input field. The host name can be either a <firstterm>fully-qualified domain name</firstterm> (FQDN) in the format <replaceable>hostname</replaceable>.<replaceable>domainname</replaceable>, or a short host name with no domain name. Many networks have a <firstterm>Dynamic Host Configuration Protocol</firstterm> (<systemitem class="protocol">DHCP</systemitem>) service that automatically supplies connected systems with a domain name; to allow the <systemitem class="protocol">DHCP</systemitem> service to assign the domain name to this machine, only specify the short host name.
</para>
- <section id="sect-installation-gui-network-configuration-virtual-interface">
- <title>Adding a Virtual Network Interface</title>
- <para>
- To add a virtual network interface, click the <guilabel>+</guilabel> button at the bottom of the interface list. A new window will open, prompting you to select one of the three available types of virtual interfaces:
- </para>
- <itemizedlist>
- <listitem>
- <para>
- <guilabel>Bond</guilabel> - NIC (<firstterm>Network Interface Controller</firstterm>) Bonding, a method to bind multiple physical network interfaces together into a single bonded channel.
- </para>
- </listitem>
- <listitem>
- <para>
- <guilabel>Team</guilabel> - NIC Teaming, a new implementation to aggregate links, designed to provide a small kernel driver to implement the fast handling of packet flows, and various applications to do everything else in user space.
- </para>
- </listitem>
- <listitem>
- <para>
- <guilabel>Vlan</guilabel> (<firstterm>Virtual LAN</firstterm>) - A method to create multiple distinct broadcast domains which are mutually isolated.
- </para>
- </listitem>
- </itemizedlist>
- <para>
- Select the interface type you want to add, and click <guilabel>Add</guilabel>. Another dialog window will open, allowing you to edit any available settings for your chosen interface type. For information about available settings, see the respective sections of the <citetitle>&PRODUCT; Networking Guide</citetitle>, available at <ulink url="http://docs.fedoraproject.org/">&PRODUCT; Documentation</ulink>.
- </para>
- <note>
- <para>
- To access the settings dialog again after you closed it, select the same interface in the list of configured interfaces and click <guilabel>Configure</guilabel> in the bottom right corner of the screen. To remove a virtual interface, select it in the list and click the <guilabel>-</guilabel> button below.
- </para>
- </note>
- </section>
-
- <section id="sect-installation-gui-network-configuration-advanced">
- <title>Editing Network Interface Configuration</title>
- <para>
- This section only details the most important settings for a typical wired connection used during installation. Many of the available options do not have to be changed in most installation scenarios and are not carried over to the installed system. Configuration of other types of networks is broadly similar, although the specific configuration parameters may be different. To learn more about network configuration after installation, see the <citetitle>&PRODUCT; Networking Guide</citetitle>, available at <ulink url="http://docs.fedoraproject.org/">&PRODUCT; Documentation</ulink>.
- </para>
- <para>
- To configure a network connection manually, select that connection in the list on the left side of the screen, and click the <guilabel>Configure</guilabel> button. A dialog will appear that allows you to configure the selected connection. The configuration options presented depends on the connection type - the available options will be slightly different depending on whether it is a physical interface (wired or wireless network interface controller) or a virtual interface (Bond, Team or Vlan) which you previously configured in <xref linkend="sect-installation-gui-network-configuration-virtual-interface" />.. A full description of all configuration settings for all connection types is beyond the scope of this document; see the <citetitle>Networking Guide</citetitle> for details.
- </para>
- <para>
- The most common and useful options in the configuration dialog are:
- </para>
- <variablelist>
- <varlistentry>
- <term>Enable or disable the connection by default</term>
- <listitem>
- <para>
- In the <guilabel>General</guilabel> tab of the configuration dialog, you can select or unselect the <guilabel>Automatically connect to this network when it is available</guilabel> check box to allow or disallow this connection to connect by default. When enabled on a wired connection, this means the system will typically connect during startup (unless you unplug the network cable); on a wireless connection, it means that the interface will attempt to connect to any known wireless networks in range.
- </para>
- <para>
- Additionally, you can allow or disallow all users on the system from connecting to this network using the <guilabel>All users may connect to this network</guilabel> tab. If you disable this option, only <systemitem class="username">root</systemitem> will be able to connect to this network.
- </para>
- <note>
- <para>
- It is not possible to only allow a specific user other than <systemitem class="username">root</systemitem> to use this interface, because no other users are created at this point during the installation. If you need a connection for a different user, you must configure it after the installation.
- </para>
- </note>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Set up static IPv4 or IPv6 settings</term>
- <listitem>
- <para>
- By default, both <systemitem class="protocol">IPv4</systemitem> and <systemitem class="protocol">IPv6</systemitem> are set to automatic configuration depending on current network settings. This means that addresses such as the local IP address, DNS address, and other settings will be detected automatically each time the interface connects to a network. In many cases, this is sufficient, but you can also provide static configuration in the <guilabel>IPv4 Settings</guilabel> and <guilabel>IPv6</guilabel> settings, respectively.
- </para>
- <para>
- To set static network configuration, navigate to one of the settings tabs and select a method other than <guilabel>Automatic</guilabel> (for example, <guilabel>Manual</guilabel>) from the <guilabel>Method</guilabel> drop-down menu. This will enable the <guilabel>Addresses</guilabel> field below.
- </para>
- <note>
- <para>
- In the <guilabel>IPv6 Settings</guilabel> tab, you can also set the method to <guilabel>Ignore</guilabel> to disable <systemitem class="protocol">IPv6</systemitem> on this interface.
- </para>
- </note>
- <para>
- Then, click <guilabel>Add</guilabel> on the right side and add a set of settings: <guilabel>Address</guilabel>, <guilabel>Netmask</guilabel> (for <systemitem class="protocol">IPv4</systemitem>), <guilabel>Prefix</guilabel> (for <systemitem class="protocol">IPv6</systemitem>), and <guilabel>Gateway</guilabel>.
- </para>
- <para>
- The <guilabel>DNS servers</guilabel> field accepts one or more IP addresses of DNS servers - for example, <literal>10.0.0.1,10.0.0.8</literal>.
- </para>
- <para>
- The final option in both tabs is <guilabel>Require IPv<replaceable>X</replaceable> addressing for this connection to complete</guilabel>. Select this option in the <systemitem class="protocol">IPv4</systemitem> tab to only allow this connection if <systemitem class="protocol">IPv4</systemitem> was successful; the same principle applies to this setting in the <systemitem class="protocol">IPv6</systemitem> tab. If this option remains disabled for both <systemitem class="protocol">IPv4</systemitem> and <systemitem class="protocol">IPv6</systemitem>, the interface will be able to connect if configuration succeeds on either IP protocol.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Configure routes</term>
- <listitem>
- <para>
- In the <guilabel>IPv4 Settings</guilabel> and <guilabel>IPv4 Settings</guilabel> tabs, click the <guilabel>Routes</guilabel> button in the bottom right corner to configure routing settings for a specific IP protocol on an interface. A new dialog will open, allowing you to <guilabel>Add</guilabel> a specific route.
- </para>
- <para>
- If you confire at least one static route, you can disallow all routes not specifically configured here by enabling the <guilabel>Ignore automatically obtained routes</guilabel>.
- </para>
- <para>
- Select <guilabel>Use this connection only for resources on its network</guilabel> to prevent this connection from becoming the default route. This option can be selected even if you did not configure any static routes. Enabling this option means that this route will only be used when necessary to access certain resources, such as intranet pages which require a local or VPN connection. Another (default) route will be used for publicly available resources if possible. Note that unlike the additional routes configured in this dialog, this setting will be transferred to the installed system. Also note that this option is only useful when more than one interface is configured.
- </para>
- <para>
- When you finish configuring the interface's routing settings, click <guilabel>OK</guilabel> to return to the configuration dialog.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- <para>
- Once you finish configuring the interface, click <guilabel>Save</guilabel> in the configuration window's bottom right corner to save your settings and return to the <guilabel>Network & Hostname</guilabel> screen.
- </para>
- </section>
+ <xi:include href="NetworkSpoke_VirtualInterfaces.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="NetworkSpoke_EditConnection.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</section>
diff --git a/en-US/NetworkSpoke_EditConnection.xml b/en-US/NetworkSpoke_EditConnection.xml
new file mode 100644
index 0000000..0c358f5
--- /dev/null
+++ b/en-US/NetworkSpoke_EditConnection.xml
@@ -0,0 +1,80 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+<!ENTITY % BOOK_ENTITIES SYSTEM "Installation_Guide.ent">
+%BOOK_ENTITIES;
+]>
+<section id="sect-installation-gui-network-configuration-advanced">
+ <title>Editing Network Interface Configuration</title>
+ <para>
+ This section only details the most important settings for a typical wired connection used during installation. Many of the available options do not have to be changed in most installation scenarios and are not carried over to the installed system. Configuration of other types of networks is broadly similar, although the specific configuration parameters may be different. To learn more about network configuration after installation, see the <citetitle>&PRODUCT; Networking Guide</citetitle>, available at <ulink url="http://docs.fedoraproject.org/">&PRODUCT; Documentation</ulink>.
+ </para>
+ <para>
+ To configure a network connection manually, select that connection in the list on the left side of the screen, and click the <guilabel>Configure</guilabel> button. A dialog will appear that allows you to configure the selected connection. The configuration options presented depends on the connection type - the available options will be slightly different depending on whether it is a physical interface (wired or wireless network interface controller) or a virtual interface (Bond, Team or Vlan) which you previously configured in <xref linkend="sect-installation-gui-network-configuration-virtual-interface" />.. A full description of all configuration settings for all connection types is beyond the scope of this document; see the <citetitle>Networking Guide</citetitle> for details.
+ </para>
+ <para>
+ The most common and useful options in the configuration dialog are:
+ </para>
+ <variablelist>
+ <varlistentry>
+ <term>Enable or disable the connection by default</term>
+ <listitem>
+ <para>
+ In the <guilabel>General</guilabel> tab of the configuration dialog, you can select or unselect the <guilabel>Automatically connect to this network when it is available</guilabel> check box to allow or disallow this connection to connect by default. When enabled on a wired connection, this means the system will typically connect during startup (unless you unplug the network cable); on a wireless connection, it means that the interface will attempt to connect to any known wireless networks in range.
+ </para>
+ <para>
+ Additionally, you can allow or disallow all users on the system from connecting to this network using the <guilabel>All users may connect to this network</guilabel> tab. If you disable this option, only <systemitem class="username">root</systemitem> will be able to connect to this network.
+ </para>
+ <note>
+ <para>
+ It is not possible to only allow a specific user other than <systemitem class="username">root</systemitem> to use this interface, because no other users are created at this point during the installation. If you need a connection for a different user, you must configure it after the installation.
+ </para>
+ </note>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Set up static IPv4 or IPv6 settings</term>
+ <listitem>
+ <para>
+ By default, both <systemitem class="protocol">IPv4</systemitem> and <systemitem class="protocol">IPv6</systemitem> are set to automatic configuration depending on current network settings. This means that addresses such as the local IP address, DNS address, and other settings will be detected automatically each time the interface connects to a network. In many cases, this is sufficient, but you can also provide static configuration in the <guilabel>IPv4 Settings</guilabel> and <guilabel>IPv6</guilabel> settings, respectively.
+ </para>
+ <para>
+ To set static network configuration, navigate to one of the settings tabs and select a method other than <guilabel>Automatic</guilabel> (for example, <guilabel>Manual</guilabel>) from the <guilabel>Method</guilabel> drop-down menu. This will enable the <guilabel>Addresses</guilabel> field below.
+ </para>
+ <note>
+ <para>
+ In the <guilabel>IPv6 Settings</guilabel> tab, you can also set the method to <guilabel>Ignore</guilabel> to disable <systemitem class="protocol">IPv6</systemitem> on this interface.
+ </para>
+ </note>
+ <para>
+ Then, click <guilabel>Add</guilabel> on the right side and add a set of settings: <guilabel>Address</guilabel>, <guilabel>Netmask</guilabel> (for <systemitem class="protocol">IPv4</systemitem>), <guilabel>Prefix</guilabel> (for <systemitem class="protocol">IPv6</systemitem>), and <guilabel>Gateway</guilabel>.
+ </para>
+ <para>
+ The <guilabel>DNS servers</guilabel> field accepts one or more IP addresses of DNS servers - for example, <literal>10.0.0.1,10.0.0.8</literal>.
+ </para>
+ <para>
+ The final option in both tabs is <guilabel>Require IPv<replaceable>X</replaceable> addressing for this connection to complete</guilabel>. Select this option in the <systemitem class="protocol">IPv4</systemitem> tab to only allow this connection if <systemitem class="protocol">IPv4</systemitem> was successful; the same principle applies to this setting in the <systemitem class="protocol">IPv6</systemitem> tab. If this option remains disabled for both <systemitem class="protocol">IPv4</systemitem> and <systemitem class="protocol">IPv6</systemitem>, the interface will be able to connect if configuration succeeds on either IP protocol.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Configure routes</term>
+ <listitem>
+ <para>
+ In the <guilabel>IPv4 Settings</guilabel> and <guilabel>IPv4 Settings</guilabel> tabs, click the <guilabel>Routes</guilabel> button in the bottom right corner to configure routing settings for a specific IP protocol on an interface. A new dialog will open, allowing you to <guilabel>Add</guilabel> a specific route.
+ </para>
+ <para>
+ If you confire at least one static route, you can disallow all routes not specifically configured here by enabling the <guilabel>Ignore automatically obtained routes</guilabel>.
+ </para>
+ <para>
+ Select <guilabel>Use this connection only for resources on its network</guilabel> to prevent this connection from becoming the default route. This option can be selected even if you did not configure any static routes. Enabling this option means that this route will only be used when necessary to access certain resources, such as intranet pages which require a local or VPN connection. Another (default) route will be used for publicly available resources if possible. Note that unlike the additional routes configured in this dialog, this setting will be transferred to the installed system. Also note that this option is only useful when more than one interface is configured.
+ </para>
+ <para>
+ When you finish configuring the interface's routing settings, click <guilabel>OK</guilabel> to return to the configuration dialog.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ <para>
+ Once you finish configuring the interface, click <guilabel>Save</guilabel> in the configuration window's bottom right corner to save your settings and return to <xref linkend="sect-installation-gui-network-configuration" />.
+ </para>
+</section>
diff --git a/en-US/NetworkSpoke_VirtualInterfaces.xml b/en-US/NetworkSpoke_VirtualInterfaces.xml
new file mode 100644
index 0000000..addb8c0
--- /dev/null
+++ b/en-US/NetworkSpoke_VirtualInterfaces.xml
@@ -0,0 +1,36 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+<!ENTITY % BOOK_ENTITIES SYSTEM "Installation_Guide.ent">
+%BOOK_ENTITIES;
+]>
+<section id="sect-installation-gui-network-configuration-virtual-interface">
+ <title>Adding a Virtual Network Interface</title>
+ <para>
+ To add a virtual network interface, click the <guilabel>+</guilabel> button at the bottom of the interface list. A new window will open, prompting you to select one of the three available types of virtual interfaces:
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ <guilabel>Bond</guilabel> - NIC (<firstterm>Network Interface Controller</firstterm>) Bonding, a method to bind multiple physical network interfaces together into a single bonded channel.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <guilabel>Team</guilabel> - NIC Teaming, a new implementation to aggregate links, designed to provide a small kernel driver to implement the fast handling of packet flows, and various applications to do everything else in user space.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <guilabel>Vlan</guilabel> (<firstterm>Virtual LAN</firstterm>) - A method to create multiple distinct broadcast domains which are mutually isolated.
+ </para>
+ </listitem>
+ </itemizedlist>
+ <para>
+ Select the interface type you want to add, and click <guilabel>Add</guilabel>. Another dialog window will open, allowing you to edit any available settings for your chosen interface type. For information about available settings, see the respective sections of the <citetitle>&PRODUCT; Networking Guide</citetitle>, available at <ulink url="http://docs.fedoraproject.org/">&PRODUCT; Documentation</ulink>. Basic documentation is also available in <xref linkend="sect-installation-gui-network-configuration-advanced" />.
+ </para>
+ <note>
+ <para>
+ To access the settings dialog again after you closed it, select the same interface in the list of configured interfaces and click <guilabel>Configure</guilabel> in the bottom right corner of the screen. To remove a virtual interface, select it in the list and click the <guilabel>-</guilabel> button below.
+ </para>
+ </note>
+</section>
diff --git a/prepare_anaconda_help_content.py b/prepare_anaconda_help_content.py
index ef3d988..3e63b20 100755
--- a/prepare_anaconda_help_content.py
+++ b/prepare_anaconda_help_content.py
@@ -27,6 +27,8 @@ ANACONDA_HELP_FILES = [
"LangSupportSpoke.xml",
"CustomSpoke.xml",
"NetworkSpoke.xml",
+ "NetworkSpoke_VirtualInterfaces.xml",
+ "NetworkSpoke_EditConnection.xml",
"SoftwareSpoke.xml",
"UserSpoke.xml",
"ProgressHub.xml",
9 years, 6 months
[install-guide] (7 commits) ...Adding text to StorageSpoke
by pbokoc
Summary of changes:
c2f586b... Clarifying inst.dd= in Boot Options (*)
084da88... Adding text to UserSpoke (*)
d5bd639... Clarifying part --asprimary in Kickstart (*)
910153b... Typo fixes and clarifications in UserSpoke (*)
f3948ca... Removing some internal xrefs from NetworkSpoke (*)
ca66a54... Adding text to InitialSetupHub (*)
199fe20... Adding text to StorageSpoke (*)
(*) This commit already existed in another branch; no separate mail sent
9 years, 6 months
[install-guide/f21-branch] Adding text to StorageSpoke
by pbokoc
commit 199fe2083b51334eefdd76e6417bbbdb90a53f8e
Author: Petr Bokoc <pbokoc(a)redhat.com>
Date: Fri Nov 14 19:19:33 2014 +0100
Adding text to StorageSpoke
en-US/StorageSpoke.xml | 185 +++++++++++++++++++++++++++++++++++++++++++++++-
1 files changed, 184 insertions(+), 1 deletions(-)
---
diff --git a/en-US/StorageSpoke.xml b/en-US/StorageSpoke.xml
index 4c9b241..f9eae9a 100644
--- a/en-US/StorageSpoke.xml
+++ b/en-US/StorageSpoke.xml
@@ -6,6 +6,189 @@
<section id="sect-installation-gui-storage-partitioning">
<title>Installation Destination</title>
<para>
- text
+ The <guilabel>Installation Destination</guilabel> screen allows you to configure storage options - namely, which disks will be used as the installation target for your &PRODUCT; installation. At least one disk must always be selected for the installation to proceed.
</para>
+ <para>
+ For information about the theory and concepts behind disk partitioning in Linux, see <remark>TODO: xref to the disk partitioning appendix</remark>.
+ </para>
+ <warning>
+ <para>
+ If you plan to use a disk which already contains some data - for example, if you want to shrink an existing Microsoft Windows partition and install &PRODUCT; as a second system or if you are upgrading a previous release of &PRODUCT;, make sure to back up any important data first. Manipulating partitions always carries a risk - if the process is interrupted or fails for any reason (installer error, hardware failure, power outage, etc.), any data already on the disk may become impossible to recover.
+ </para>
+ </warning>
+ <para>
+ <remark>TODO: screen</remark>
+ </para>
+ <para>
+ In the top part of the screen, all locally available storage devices (SATA, IDE and SCSI hard drives, USB flash drives, etc.) are displayed in the <guilabel>Local Standard Disks</guilabel> section. Local disks are detected when the installer starts - any storage devices connected after the installation has started will not be shown. If you need to additional local storage devices, you must restart the installation.
+ </para>
+ <para>
+ The <guilabel>Specialized & Network Disks</guilabel> section below shows advanced network storage (such as iSCSI and FCoE disks) currently configured. When you first open this screen, no such devices will be displayed because they can not be automatically detected; to search for network storage devices <guilabel>Add a disk</guilabel> button and proceed with <xref linkend="sect-installation-gui-installation-destination" />. Any network storage you configure will then show up in the <guilabel>Specialized & Network Disks</guilabel> the same way local disks are shown above.
+ </para>
+ <para>
+ All storage devices which will be used to install &PRODUCT; have a black circle icon with a white check mark on them. Disks not marked by this icon will not be used during the installation - they will be ignored if you choose automatic partitioning, and they will not be available in manual partitioning.
+ </para>
+ <important>
+ <para>
+ USB storage devices such as flash drives and external disks will be shown in the <guilabel>Local Standard Disks</guilabel> as well, and they will be available for selection the same way internal hard drives are. Make sure to <emphasis>not</emphasis> select any removable storage as installation targets unless you really want to do so. If you accidentally use a removable drive to install &PRODUCT; and then unplug it, your system will likely become unusable.
+ </para>
+ </important>
+ <para>
+ <remark>TODO: screen with a selected and an unselected disk</remark>
+ </para>
+ <para>
+ After you select all disks you want to install &PRODUCT;, select one of the two options in the <guilabel>Other Storage Options</guilabel> section:
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ <guilabel>Automatically configure partitioning</guilabel> - If this option is selected, then after you press <guilabel>Done</guilabel> in the top left corner of the screen, the installer will determine the total amount of space on all selected disks, and it will create a <firstterm>Logical Volume Management</firstterm> (LVM) layout suitable for your system. The specifics of this layout depend on whether your system uses BIOS or UEFI firmware, the total amount of free space on your disks, and the amount of RAM on your system (which determines the size of your swap space).
+ </para>
+ <para>
+ With automatic partitioning, you can also select the <guilabel>I would like to make additional space available</guilabel> option below. Use this option if you want to reclaim space from an existing partitioning layout - for example, if a disk you want to use already contains a different operating system, and you want to make this system's partitions smaller to allow more room for &PRODUCT;. The <guilabel>Reclaim space</guilabel> dialog which opens if this option is selected is described later in this section.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <guilabel>I will configure partitioning</guilabel> - Select this option and press <guilabel>Done</guilabel> in the top left corner of the screen to configure your system's partitioning layout manually. This requires some knowledge of the theory behind disk partitions and related concepts, but gives you full control over the way the system will be installed. For instructions for manual partitioning, see <xref linkend="sect-installation-gui-manual-partitioning" />.
+ </para>
+ </listitem>
+ </itemizedlist>
+ <para>
+ Additionally, you can select <guilabel>Encrypt my data</guilabel>; this will encrypt all partitions except the ones needed to boot the system (such as <filename class="directory">/boot</filename>) using <firstterm>Linux Unified Key Setup</firstterm> (LUKS). Encrypting your hard drive is recommended. For detailed information about LUKS encryption, see the <citetitle>&PRODUCT; Security Guide</citetitle>, available at <ulink url="http://docs.fedoraproject.org/">&PRODUCT; Documentation</ulink>.
+ </para>
+ <warning>
+ <para>
+ If you lose the LUKS passphrase, any encrypted partitions and the data on them will become completely inaccessible. There is no way to recover a lost passphrase. However, if you perform a Kickstart installation, you can save encryption passphrases and create backup encryption passphrases during the installation. See <xref linkend="chap-kickstart-installations" /> for information about Kickstart installations.
+ </para>
+ </warning>
+ <para>
+ To control which one of your selected storage devices will contain the <firstterm>boot loader</firstterm>, click the <guilabel>Full disk summary and bootloader</guilabel> link in the bottom left corner of the screen, and follow the instructions below. Note that while in most cases it is sufficient to leave the boot loader in the default location, some configurations (for example, systems which require <firstterm>chain loading</firstterm> from another boot loader) will require the boot drive to be specified manually.
+ </para>
+ <para>
+ After you select storage devices, choose between automatic and manual partitioning, configure encryption and boot loader location, press <guilabel>Done</guilabel> in the top left corner of the screen. Then, depending on your settings, the following will happen:
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ If you chose to encrypt your hard drive, the <guilabel>Disk Encryption Passphrase</guilabel> dialog will appear. Enter your chosen passphrase into the <guilabel>Passphrase</guilabel> and <guilabel>Confirm</guilabel> fields. When you do so, the passphrase will be automatically evaluated and its strength will be displayed, along with suggestions on how to make it stronger if the installer has determined it to be weak. For information about creating strong passwords, see <citetitle>&PRODUCT; Security Guide</citetitle>.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ If you selected automatic partitioning and the <guilabel>I would like to make additional space available</guilabel>, or if there is not enough free space on your selected hard drives to install &PRODUCT;, the <guilabel>Reclaim Space</guilabel> dialog will appear. This dialog lists all disk devices you have configured and all partitions on those devices. The bottom right corner of the dialog displays information about how much space the system needs for at least a minimal installation and how much space you have reclaimed.
+ </para>
+ <warning>
+ <para>
+ If you use the <guilabel>Reclaim Space</guilabel> dialog to <emphasis>delete</emphasis> a partition, all data on that partition will be lost. If you want to preserve your data, use the <guilabel>Shrink</guilabel> option, not the <guilabel>Delete</guilabel> option.
+ </para>
+ </warning>
+ <para>
+ First, review the displayed list of available storage devices. The <guilabel>Reclaimable Space</guilabel> column shows how much space can be reclaimed from each entry. To reclaim space, select a disk or partition, and press either the <guilabel>Delete</guilabel> button to delete that partition (or all partitions on a selected disk), or <guilabel>Shrink</guilabel> to use free space on a partition while preserving existing data. Alternatively, you can press <guilabel>Delete all</guilabel> in the bottom right corner; this will delete all existing partitions on all disks and make this space available to &PRODUCT;, but all existing data on all disks will be lost.
+ </para>
+ <para>
+ After you free enough space for your &PRODUCT; installation, press <guilabel>Reclaim space</guilabel> to finish.
+ </para>
+ <note>
+ <para>
+ No changes to any disks will be made until you press <guilabel>Begin Installation</guilabel> in <xref linkend="sect-installation-gui-installation-summary" />. The <guilabel>Reclaim Space</guilabel> dialog only <emphasis>marks</emphasis> partitions for resizing or deletion, but no such action is performed immediately.
+ </para>
+ </note>
+ </listitem>
+ <listitem>
+ <para>
+ If you selected the <guilabel>I will configure partitioning</guilabel> option, pressing <guilabel>Done</guilabel> will open the <guilabel>Manual Partitioning</guilabel> screen. See <xref linkend="sect-installation-gui-manual-partitioning" /> for further instructions.
+ </para>
+ </listitem>
+ </itemizedlist>
+
+ <section id="sect-installation-gui-storage-partitioning-bootloader">
+ <title>Boot Loader Installation</title>
+ <para>
+ &PRODUCT; uses <application>GRUB2</application> (GRand Unified Bootloader version 2) as its boot loader. The boot loader is the first program that runs when the computer starts and is responsible for loading and transferring control to an operating system. <application>GRUB2</application> can boot any compatible operating system (including Microsoft Windows) and can also use chain loading to transfer control to other boot loaders for unsupported operating systems.
+ </para>
+ <warning>
+ <para>
+ Installing <application>GRUB2</application> may overwrite your existing boot loader.
+ </para>
+ </warning>
+ <para>
+ If you have other operating systems already installed, the &PRODUCT; installer will attempt to automatically detect and configure the boot loader to start them. You can manually configure any additional operating systems after you finish the installation, if they are not detected properly. For instructions on editing <application>GRUB2</application> configuration, see the <citetitle>&PRODUCT; System Administrator's Guide</citetitle>, available at <ulink url="http://docs.fedoraproject.org/">&PRODUCT; Documentation</ulink>
+ </para>
+ <para>
+ To specify which device the boot loader should be installed on, click the <guilabel>Full disk summary and bootloader</guilabel> link at the bottom of the <guilabel>Installation Destination</guilabel> screen. The <guilabel>Selected Disks</guilabel> dialog will appear. If you are configuring your partitioning layout manually, the same dialog can be accessed from <xref linkend="sect-installation-gui-manual-partitioning" /> using the <guilabel><replaceable>X</replaceable> storage devices selected</guilabel> link in the bottom left corner of the screen.
+ </para>
+ <para>
+ <remark>TODO: screen</remark>
+ </para>
+ <para>
+ In the <guilabel>Boot</guilabel> column, a "tick" icon marks one of the devices as the intended boot device. To change the boot device, select a device from the list and click the <guilabel>Set as Boot Device</guilabel> button to install the boot loader there instead. Only one device can be set as the boot device.
+ </para>
+ <para>
+ To decline installation of a new boot loader, select the device currently marked for boot and click the <guilabel>Do not install bootloader</guilabel> button. This will remove the tick and ensure <application>GRUB2</application> is not installed on any device.
+ </para>
+ <warning>
+ <para>
+ If you choose not to install a boot loader for any reason, you will not be able to boot the system directly, and you must use another boot method, such as a stand-alone commercial boot loader application. Use this option only if you are sure you have another way to boot your system.
+ </para>
+ </warning>
+
+ <section id="sect-installation-gui-storage-partitioning-mbr-gpt">
+ <title>MBR and GPT Considerations</title>
+ <para>
+ <application>GRUB2</application> can be installed either in the <firstterm>Master Boot Record</firstterm> (MBR) or the <firstterm>GUID Partition Table</firstterm> (GPT) of the boot device. In order to determine which of these methods to use, the installation program considers the following variations:
+ </para>
+ <variablelist>
+ <varlistentry>
+ <term>Systems with BIOS firmware and UEFI systems in BIOS compatibility mode</term>
+ <listitem>
+ <para>
+ If the disk is already formatted, the partitioning scheme is retained.
+ </para>
+ <para>
+ If the disk is not formatted, or you have erased all existing partitions from the disk, the installer choose the following:
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ MBR if the size of the disk is less than 2 TB (terabytes)
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ GPT if the size of the disk is more than 2 TB
+ </para>
+ </listitem>
+ </itemizedlist>
+ <note>
+ <para>
+ You can force the installer to use GPT on disks smaller than 2 TB by using the <option>inst.gpt</option> boot option as described in <xref linkend="chap-anaconda-boot-options" />. However, the opposite is not possible - you can not use MBR on disks larger than 2 TB.
+ </para>
+ </note>
+ <para>
+ You need to create a <firstterm>BIOS Boot</firstterm> partition with a size of 1 MB to install on a system with BIOS firmware if the disk containing the boot loader uses GPT. If the disk uses a MBR, no special partition is necessary on a BIOS system.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Systems with UEFI firmware</term>
+ <listitem>
+ <para>
+ Only GPT is allowed on UEFI systems. In order to install on a formatted disk with a MBR, it must be reformated and relabeled. All data currently on the disk will be lost.
+ </para>
+ <para>
+ UEFI-based systems require an <firstterm>EFI System Partition</firstterm> at least 50 MB in size (recommended size is 200 MB), regardless of the partitioning scheme.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ <important>
+ <para>
+ If your system requires either a BIOS Boot partition or an EFI System Partition based on the requirements detailed above, this partition must be created as a standard physical partition. It can not reside on a LVM volume or a Btrfs subvolume.
+ </para>
+ </important>
+ </section>
+
+ </section>
+
</section>
9 years, 6 months