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