commit 40b0c57483d7c779784190ba1f10cfe5571f4250
Author: Petr Bokoc <pbokoc(a)redhat.com>
Date: Mon Aug 25 23:11:16 2014 +0200
Adding the VNC chapter
en-US/VNC_Installations.xml | 327 ++++++++++++++++++++++++++-----
en-US/images/vnc/connection-details.png | Bin 0 -> 10857 bytes
2 files changed, 280 insertions(+), 47 deletions(-)
---
diff --git a/en-US/VNC_Installations.xml b/en-US/VNC_Installations.xml
index 81884f8..4951366 100644
--- a/en-US/VNC_Installations.xml
+++ b/en-US/VNC_Installations.xml
@@ -4,52 +4,285 @@
%BOOK_ENTITIES;
]>
<chapter id="chap-vnc-installations">
- <title>Installing Using VNC</title>
- <para>
- intro text
- </para>
-
- <section id="sect-vnc-installations-viewer">
- <title>Installing a VNC Viewer</title>
- <para>
- text
- </para>
- </section>
-
- <section id="sect-vnc-installations-anaconda-modes">
- <title>Performing a VNC Installation</title>
- <para>
- text
- </para>
-
- <section id="sect-vnc-installations-direct-mode">
- <title>Installing in VNC Direct Mode</title>
- <para>
- text
- </para>
- </section>
-
- <section id="sect-vnc-installations-connect-mode">
- <title>Installing in VNC Connect Mode</title>
- <para>
- text
- </para>
- </section>
-
- </section>
-
- <section id="sect-vnc-kickstart-considerations">
- <title>Kickstart Considerations</title>
- <para>
- text
- </para>
- </section>
-
- <section id="sect-vnc-headless-considerations">
- <title>Considerations for Headless Systems</title>
- <para>
- text
- </para>
- </section>
+ <title>Installing Using VNC</title>
+ <para>
+ The graphical installation interface is the recommended method of installing
&PRODUCT;. However, in some cases, accessing the graphical interface directly is
difficult or impossible. Some systems lack the capability to connect a display and a
keyboard, making VNC a necessity for manual (non-Kickstart) installations.
+ </para>
+ <para>
+ To allow manual installations on <firstterm>headless
systems</firstterm> (systems without a directly connected display, keyboard and
mouse), the <application>Anaconda</application> installation program includes
a <firstterm>Virtual Network Computing</firstterm> (VNC) mode which allows the
graphical mode of the installation program to run locally, but display on another system
connected to the network. The VNC installation provides you with the full range of
installation options.
+ </para>
+ <para>
+ This chapter provides instructions on activating VNC mode on the installation
system and connecting to it using a VNC viewer.
+ </para>
+
+ <section id="sect-vnc-installations-viewer">
+ <title>Installing a VNC Viewer</title>
+ <para>
+ Performing a VNC installation requires a VNC viewer running on your
workstation or another terminal computer. VNC viewers are available in the repositories of
most Linux distributions; free VNC viewers are also available for other operating systems
such as Windows. On Linux systems, use your package manager to search for a viewer for
your distribution.
+ </para>
+ <para>
+ The following VNC viewers are available in &PRODUCT;:
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ <application>TigerVNC</application> - A basic viewer
independent of your desktop environment. Installed as the
<package>tigervnc</package> package.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <application>Vinagre</application> - A viewer for the
<application>GNOME</application> desktop environment. Installed as the
<package>vinagre</package> package.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <application>KRDC</application> - A viewer integrated
with the <application>KDE</application> desktop environment. Installed as the
<package>kdenetwork-krdc</package> package.
+ </para>
+ </listitem>
+ </itemizedlist>
+ <para>
+ To install any of the viewers listed above, execute the following command as
<systemitem>root</systemitem>:
+ </para>
+ <screen>
+<prompt>#</prompt> <command>yum install
<replaceable>package</replaceable></command>
+ </screen>
+ <para>
+ Replace <replaceable>package</replaceable> with the package name
of the viewer you want to use (for example, <package>tigervnc</package>).
+ </para>
+ <note>
+ <para>
+ Procedures in this chapter assume you are using
<application>TigerVNC</application> as your VNC viewer. Specific instructions
for other viewers may differ, but the general principles still apply.
+ </para>
+ </note>
+ </section>
+
+ <section id="sect-vnc-installations-anaconda-modes">
+ <title>Performing a VNC Installation</title>
+ <para>
+ The <application>Anaconda</application> installation program
offers two modes for VNC installation: <firstterm>Direct mode</firstterm> and
<firstterm>Connect mode</firstterm>. The modes differ in the way the
connection between the server and viewer is established. After you successfully connect,
the installation will progress the same way regardless of the mode you used.
+ </para>
+ <variablelist>
+ <varlistentry>
+ <term>Direct Mode</term>
+ <listitem>
+ <para>
+ In this mode, <application>Anaconda</application> is
configured to start the installation and wait for an incoming connection from VNC viewer
before proceeding. While waiting for an incoming connection, the system's IP address
and the port on which the installer expects the connection is displayed on the display or
console if available; this implies that you need at least a serial console to connect
using this mode, but you can work around this limitation if you know the default VNC port
and the system's IP address.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Connect Mode</term>
+ <listitem>
+ <para>
+ In this mode, the VNC viewer is started on the remote system in
<firstterm>listening mode</firstterm>. The VNC viewer waits for an incoming
connection on a specified port. Then, <application>Anaconda</application> is
started and the host name/IP address and port number of the viewer are provided using a
boot option or a Kickstart command. When the installation begins, the installation program
establishes a connection with the listening VNC viewer using the specified host name/IP
address and port number. Connect mode is therefore easier to use on systems with no local
display or console, but it also may require additional preparation, because the viewer
system must be able to accept incoming connections on the specified port, which usually
requires changing firewall settings.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+
+ <section id="sect-vnc-installations-choosing-mode">
+ <title>Choosing a VNC Installation Mode</title>
+ <itemizedlist>
+ <listitem>
+ <para>Visual and Interactive access to the system</para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ If visual and interactive access to the system being
installed is not available, then you should use Connect Mode.
+ </para>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ <listitem>
+ <para>
+ Network Connection Rules and Firewalls
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ If the system being installed is not allowed inbound
connections by a firewall, then you must use Connect Mode or disable the firewall.
Disabling a firewall may have security implications.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ If the remote system running the VNC viewer is not
allowed incoming connections by a firewall, then you must use Direct Mode, or disable the
firewall. Disabling a firewall may have security implications.
+ </para>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ </itemizedlist>
+ </section>
+
+ <section id="sect-vnc-installations-direct-mode">
+ <title>Installing in VNC Direct Mode</title>
+
+ <para>
+ VNC Direct Mode is when the VNC viewer initiates a connection to the
system being installed. <application>Anaconda</application> will tell you when
to initiate this connection.
+ </para>
+
+ <procedure id="proc-vnc-installations-direct-mode">
+ <title>Starting VNC in Direct Mode</title>
+ <step>
+ <para>
+ Open the VNC viewer (for example,
<application>TigerVNC</application>) on the workstation you will be using to
connect to the system being installed. A window similar to <xref
linkend="figu-vnc-installations-connection-details" /> will be displayed with
an input field allowing you to specify an IP address.
+ </para>
+ <figure
id="figu-vnc-installations-connection-details">
+ <title>TigerVNC Connection Details</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/vnc/connection-details.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <para>
+ TigerVNC after startup, showing the Connection
Details dialog
+ </para>
+ </textobject>
+ </mediaobject>
+ </figure>
+ </step>
+ <step>
+ <para>
+ Boot the installation system and wait for the boot menu to
appear. In the menu, press the <keycap>Tab</keycap> key to edit boot options.
Append the <option>inst.vnc</option> option to end of the command line.
+ </para>
+ <para>
+ Optionally, if you want to restrict VNC access to the
installation system, add the
<option>inst.vncpassword=<replaceable>PASSWORD</replaceable></option>
boot option as well. Replace <replaceable>PASSWORD</replaceable> with the
password you want to use for the installation. The VNC password must be between 6 and 8
characters long.
+ </para>
+ <important>
+ <para>
+ Use a temporary password for the
<option>inst.vncpassword=</option> option. It should not be a real or root
password you use on any system.
+ </para>
+ </important>
+ <figure id="figu-vnc-installations-boot-options">
+ <title>Adding VNC Boot Options</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/vnc/boot-options.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <para>
+ Editing boot options to activate VNC <!-- TODO:
new image -->
+ </para>
+ </textobject>
+ </mediaobject>
+ </figure>
+ </step>
+ <step>
+ <para>
+ Press <keycap>Enter</keycap> to start the
installation. The system will initialize the installation program and start the necessary
services. When the system is ready, you will see a message on the screen similar to the
following:
+ </para>
+ <screen>
+<computeroutput>13:14:47 Please manually connect your VNC viewer to
192.168.100.131:5901 to begin the install.</computeroutput>
+ </screen>
+ <para>
+ Note the IP address and port number (in the above example,
<literal>192.168.100.131:5901</literal>).
+ </para>
+ </step>
+ <step>
+ <para>
+ On the system running the VNC Viewer, enter the IP address and
port number obtained in the previous step into the <guilabel>Connection
Details</guilabel> dialog in the same format as it was displayed on the screen by
the installer. Then, click <guilabel>Connect</guilabel>. The VNC viewer will
now connect to the installation system. If you set up a VNC password, enter it when
prompted and press <guilabel>OK</guilabel>.
+ </para>
+ </step>
+ </procedure>
+ <para>
+ After you finish the procedure, a new window will open with the VNC
connection established, displaying the installation menu. In this window, you will be able
to use the <application>Anaconda</application> graphical interface the same
way you would use it when installing directly on the system.
+ </para>
+ <para>
+ You can then proceed with <xref
linkend="chap-installing-using-anaconda" />.
+ </para>
+ </section>
+
+ <section id="sect-vnc-installations-connect-mode">
+ <title>Installing in VNC Connect Mode</title>
+ <para>
+ VNC connect mode is when the system being installed initiates a
connection to the VNC viewer running on a remote system. Before you start, make sure the
remote system is configured to accept incoming connection on the port you want to use for
VNC. The exact way to make sure the connection will not be blocked depends on your network
and on your workstation's configuration. Information about configuring the firewall in
&PRODUCT; 7 is available in <ulink
url="https://access.redhat.com/site/documentation/en-US/Red_Hat_Ente...
Enterprise Linux 7 Networking Guide</ulink>.
+ </para>
+ <procedure id="proc-vnc-installations-connect-mode">
+ <title>Starting VNC in Connect Mode</title>
+ <step>
+ <para>
+ Start the VNC viewer on the client system in listening mode. For
example, on &PRODUCT; using <application>TigerVNC</application>, execute
the following command:
+ </para>
+ <screen>
+<prompt>$</prompt> <command>vncviewer -listen
<replaceable>PORT</replaceable></command>
+ </screen>
+ <para>
+ Replace <replaceable>PORT</replaceable> with the port
number you want to use for the connection.
+ </para>
+ <para>
+ The terminal will display a message similar to the following
example:
+ </para>
+ <example id="exam-vnc-connect-mode-listening">
+ <title>TigerVNC Viewer Listening</title>
+ <screen>
+TigerVNC Viewer 64-bit v1.3.0 (20130924)
+Built on Sep 24 2013 at 16:32:56
+Copyright (C) 1999-2011 TigerVNC Team and many others (see README.txt)
+See
http://www.tigervnc.org for information on TigerVNC.
+
+Thu Feb 20 15:23:54 2014
+ main: Listening on port 5901
+ </screen>
+ </example>
+ <para>
+ When this message is displayed, the VNC viewer is ready and
waiting for an incoming connection from the installation system.
+ </para>
+ </step>
+ <step>
+ <para>
+ Boot the system being installed and wait for the boot menu to
appear. In the menu, press the <keycap>Tab</keycap> key to edit boot options.
Append the following options to the command line:
+ </para>
+ <screen>
+<option>inst.vnc
inst.vncconnect=<replaceable>HOST</replaceable>:<replaceable>PORT</replaceable></option>
+ </screen>
+ <para>
+ Replace <replaceable>HOST</replaceable> with the IP
address of the system running the listening VNC viewer, and
<replaceable>PORT</replaceable> with the port number that the VNC viewer is
listening on.
+ </para>
+ </step>
+ <step>
+ <para>
+ Press <keycap>Enter</keycap> to start the
installation. The system will initialize the installation program and start the necessary
services. Once the initialization is finished,
<application>Anaconda</application> will attempt to connect to the IP address
and port you provided in the previous step.
+ </para>
+ <para>
+ When the connection is successfully established, a new window
will open on the system running the VNC viewer, displaying the installation menu. In this
window, you will be able to use the <application>Anaconda</application>
graphical interface the same way you would use it when installing directly on the system.
+ </para>
+ </step>
+ </procedure>
+ <para>
+ You can then proceed with <xref
linkend="chap-installing-using-anaconda" />.
+ </para>
+ </section>
+
+ </section>
+
+ <section id="sect-vnc-kickstart-considerations">
+ <title>Kickstart Considerations</title>
+ <para>
+ Commands for using a VNC installation are also available in Kickstart
installations. Using just the <command>vnc</command> command will set up an
installation using Direct Mode. Options are available to set up an installation using
Connect Mode. For more information about the <command>vnc</command> command
and options used in Kickstart files, see <xref
linkend="sect-kickstart-commands" />.
+ </para>
+ </section>
+
+ <section id="sect-vnc-headless-considerations">
+ <title>Considerations for Headless Systems</title>
+ <para>
+ When installing headless systems, the only choices are an automated Kickstart
installation or an interactive VNC installation using connect mode. For more information
about automated Kickstart installation, see <xref
linkend="sect-kickstart-commands" />. The general process for an interactive
VNC installation is described below.
+ </para>
+ <orderedlist>
+ <listitem>
+ <para>
+ Set up a PXE server that will be used to start the installation.
Information about installing and performing basic configurating of a PXE server can be
found in <xref linkend="chap-pxe-server-setup" />.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Configure the PXE server to use the boot options for a connect mode
VNC installation. For information on these boot options, see <xref
linkend="sect-vnc-installations-connect-mode" />.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Follow the procedure for a VNC Installation using connect mode as
described in the <xref linkend="proc-vnc-installations-connect-mode" />.
However, when directed to boot the system, boot it from the PXE server as described in
<xref linkend="sect-booting-network" />.
+ </para>
+ </listitem>
+ </orderedlist>
+ </section>
</chapter>
diff --git a/en-US/images/vnc/connection-details.png
b/en-US/images/vnc/connection-details.png
new file mode 100644
index 0000000..ffb7219
Binary files /dev/null and b/en-US/images/vnc/connection-details.png differ