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",