Author: emap
Date: Mon Nov 7 11:04:43 2011
New Revision: 66732
URL: http://svn.opensuse.org/viewcvs/yast?rev=66732&view=rev
Log:
edited by emap
Modified:
trunk/autoinstallation/doc/xml/Installation.xml
Modified: trunk/autoinstallation/doc/xml/Installation.xml
URL: http://svn.opensuse.org/viewcvs/yast/trunk/autoinstallation/doc/xml/Installation.xml?rev=66732&r1=66731&r2=66732&view=diff
==============================================================================
--- trunk/autoinstallation/doc/xml/Installation.xml (original)
+++ trunk/autoinstallation/doc/xml/Installation.xml Mon Nov 7 11:04:43 2011
@@ -9,33 +9,33 @@
Introduction
</title>
<para>
- After the system has booted and the control file has been retrieved,
- &yast2; performs configuration of the system according to the information
- provided in the control file. All the configuration is summarized in a window that is shown by
- default and should be deactivated if a full automatic installation is
- needed.
+ After the system has booted into an automatic installation and the
+ control file has been retrieved, &yast; configures the system according
+ to the information provided in the control file. All configuration
+ settings are summarized in a window that is shown by default and should
+ be deactivated if a fully automatic installation is needed.
</para>
<para>
- When &yast2; has reached the point where the summary of the configuration is shown,
- &yast2; has only probed hardware and prepared the system for
- auto-installation, thus, nothing has been changed in the system yet, so
- that in case of any error, the process still can be aborted.
+ By the time &yast; displays the summary of the configuration, &yast; has
+ only probed hardware and prepared the system for
+ auto-installation. Nothing has been changed in the system yet. In case
+ of any error, you can still abort the process.
</para>
<para>
A system should be automatically installable without the need to have
- any graphic adaptor or monitor. Having a monitor attached to the
- client machine is nevertheless recommended to follow the process and
- to get feedback in case of any errors. Choosing between the Qt and the
- Ncurses interfaces is possible. For headless
- clients, system messages can be monitored using the serial console.
+ any graphic adaptor or monitor. Having a monitor attached to the client
+ machine is nevertheless recommended so you can supervise the process and
+ to get feedback in case of errors. Choose between the Qt<remark>emap 2011-11-07: Should this read 'graphical' or 'X11'?</remark> and the text-based
+ Ncurses interfaces. For headless clients, system messages
+ can be monitored using the serial console.
</para>
<section id="Installation.Interface.X11">
<title>
- X11 Interface
+ X11 Interface (graphical)
</title>
<para>
- This is the default interface while auto-installing. No special
+ This is the default interface while auto-installing. No special
variables are required to activate it.
</para>
</section>
@@ -44,23 +44,23 @@
Serial console
</title>
<para>
- You can start installing a system using the serial console by adding
- the keyword console (i.e. console=ttyS0) to the command line of the
- kernel. This will start linuxrc in console mode and later in the
- process, &yast2; also is started in serial console mode.
+ Start installing a system using the serial console by adding the
+ keyword "console" (i.e. console=ttyS0) to the command line of the
+ kernel. This starts linuxrc in console mode and later &yast; in serial
+ console mode.
</para>
</section>
<section id="Installation.Interface.Ncurses">
<title>
- Text based YaST2-Installation
+ Text-based &yast; Installation
</title>
<para>
This option can also be activated on the command line. This will start
- YaST2 in <emphasis>Ncurses</emphasis> mode. To start &yast2; in text
+ YaST2 in <emphasis>Ncurses</emphasis> mode. To start &yast; in text
mode, add <emphasis>textmode=1</emphasis> on the command line.
</para>
<para>
- Starting &yast2; in text mode is recommended when installing a client
+ Starting &yast; in text mode is recommended when installing a client
with less than 64 MB or when X11 is not being configured at all,
especially on headless machines.
</para>
@@ -68,12 +68,12 @@
</section>
<section id="bootmedium">
- <title>Choosing the right Boot Medium</title>
+ <title>Choosing the Right Boot Medium</title>
<para>
- There are different methods for booting the client. The computer can boot from
- its network interface card (NIC) to receive the boot images via &dhcp; /TFTP
- or a suitable kernel as well as an initrd image are loaded from a
- floppy or a boot-able CD-ROM.
+ There are different methods for booting the client. The computer can
+ boot from its network interface card (NIC) to receive the boot images
+ via &dhcp; or TFTP. Alternatively a suitable kernel and initrd image can
+ be loaded from a floppy or a bootable CD-ROM.
</para>
<section>
<title>
@@ -81,21 +81,22 @@
</title>
<para>
For testing/rescue purposes or because the NIC does not have a PROM or PXE
- you can build a boot floppy to use with &autoyast2;. Using a floppy
+ you can build a boot floppy to use with &ay;. Using a floppy
to initiate an auto-install process is limited due to the size of the
data a floppy can hold. However, it is still possible to use
floppies when auto-installing a single, disconnected machine.
</para>
<para>
- Floppies can be used to store the control file, especially when using
- the original &company-suse; CD-ROMs for a single, disconnected machine. Using the
+ Floppies can also store the control file, especially when using
+ the original &company-suse; CD-ROMs for a single, disconnected machine. Via the
kernel command line, you can specify the location of the control
file on the floppy.
- </para>
+ </para><remark>emap 2011-11-07: Would people still use floppies these days? I'd expect USB sticks to be a lot more common.</remark>
<para>
- Even without specifying any command line options, it is still possible to initiate the
- auto-install process by placing a control file on a floppy with a
- special, pre-defined file name. (<filename>autoinst.xml</filename>) &yast2; will check for
+ Even without specifying any command line options, it is still possible
+ to initiate the auto-install process by placing a control file on a
+ floppy with the pre-defined file name
+ <filename>autoinst.xml</filename>. &yast; will check for
<filename>autoinst.xml</filename> upon startup and if it was found it
will switch from interactive to automated installation.
</para>
@@ -104,15 +105,15 @@
<section>
<title>Booting from CD-ROM</title>
<para>
- You can use the original &company-suse; CD-ROMs in combination with other
- media, i.e. with a floppy to hold the control file or in combination
- with network where the control file can be located.
+ You can use the original &company-suse; CD-ROMs in combination with
+ other media. For example, the control file can be provided via a
+ floppy or a specified location on the network.
</para>
<para>
- It is also possible to create customized CD-ROMs to hold only the
- package you need in addition to the control file which also can be
- saved on the CD-ROM. This method requires creation of CD-ROMs
- every time you wish to change the configuration though.
+ Alternatively, create a customized CD-ROM that holds only the package
+ you need <remark>emap 2011-11-07: Why not name the
+ package?</remark>and the control file. If you need to change the
+ configuration, you'll have to create a new CD-ROM.
</para>
</section>
@@ -123,8 +124,9 @@
will boot then without a physical media like a boot floppy or CDROM.
</para>
<para>
- Here is a small example of a "/srv/tftp/pxelinux.cfg/default" file:
- </para>
+ Here is an example of a
+ <filename>/srv/tftp/pxelinux.cfg/default</filename> file:
+ </para><remark>emap 2011-11-07: Update the example to SLES11?</remark>
<screen>
default SLES9
@@ -138,12 +140,12 @@
LOCALBOOT 0
</screen>
<para>
- It's recommended to add the vga=... parameter with a valid value for graphical
+ We recommended you add the vga=... parameter with a valid value for graphical
installations, to trigger an installation with the frame buffer device instead
of the vesa driver or ncurses mode.
</para>
<para>
- Here is as a small example my "/etc/dhcp.conf" file:
+ Here is as an example of a <filename>/etc/dhcp.conf</filename> file:
</para>
<screen>
option domain-name-servers 192.168.66.1;
@@ -173,21 +175,20 @@
}
</screen>
<para>
- A problem you might run into if you do installation via PXE is, that the
+ A problem you might run into if you do installation via PXE is that the
installation will run into an endless loop, because after the first reboot,
- the machine is doing PXE boot again and will restart the installation instead
- of booting from harddisc for the second stage of the installation.
+ the machine is doing PXE boot again and restarts the installation instead
+ of booting from hard disk for the second stage of the installation.
</para>
<para>
- This problem can be solved in different ways. One way is to use a http server
- to provide the autoyast profile and instead of a static profile, a CGI script
- on the webserver is run that provides the profile and then changes the TFTP server
- configuration then for this special host, so that the next PXE boot from that
- machine will be from harddisc by default.
+ This problem can be solved in different ways. One way is to use an http server
+ to provide the &ay; profile. And, instead of a static profile, run a CGI script
+ on the web server that provides the profile and changes the TFTP server
+ configuration for your target host. Then the next PXE boot of the
+ machine will be from hard disk by default.
</para>
<para>
- Another way is to use autoyast to upload a new PXE boot configuration for that host.
- That is done via autoyast profile like this:
+ Another way is to use &ay; to upload a new PXE boot configuration for the target host via the profile:
</para>
<screen>
<![CDATA[
@@ -207,54 +208,54 @@
]]>
</screen>
<para>
- This will upload a new configuration for the actual machine to the tftp server short
+ This entry will upload a new configuration for the target host to the tftp server shortly
before the first reboot happens. In most installations the TFTP daemon runs as user
- "nobody". You have to make sure that that user has write permissions to the "pxelinux.cfg"
- directory if you use that mechanism.
- So if your machine got the IP address "192.168.66.195" a file "C0A842C3" will
- be uploaded and if the machine reboots and will get the same IP address
- via DHCP again, the new configuration will be used that has the harddisc as
- a default boot media.
- </para>
- <para>
- Of course this requires that the machine will get the same IP address again after the
- reboot and if you want to do another autoinstallation for that machine, you have to
- remove the file from the TFTP server.
- </para>
- <para>
- Since openSUSE 11.2 (not SLES11) you can configure the filename too that will be uploaded.
- If you use the "magic" __MAC__ filename, the filename will be the mac address of your machine like this "01-08-00-27-79-49-ee".
- A missing filename creates the IP address filename like in the past.
+ "nobody". You have to make sure this user has write permissions to the <filename>pxelinux.cfg</filename>
+ directory.
+ So if your machine has the IP address "192.168.66.195", a file <filename>C0A842C3</filename> will
+ be uploaded. When the machine reboots and receives the same IP address
+ via DHCP, the new configuration will be used, telling the target host to book from hard disk.
+ </para>
+ <para>
+ If you want to do another auto-installation on the same machine, you
+ have to remove the file from the TFTP server.
+ </para>
+ <para>
+ Since openSUSE 11.2 (not SLES11), you can also configure the filename
+ that will be uploaded. If you use the "magic" __MAC__ filename, the
+ filename will be the mac address of your machine like this
+ "01-08-00-27-79-49-ee". If the filename setting is missing, the IP
+ address will be used for the filename.
</para>
</section>
</section>
<section id="invoking_autoinst">
<title id="invoking_autoinst.title">
- Invoking the Auto-Installation process
+ Invoking the Auto-Installation Process
</title>
<section>
- <title>Command line Options</title>
+ <title>Command Line Options</title>
<para>
- Adding the command line variable <emphasis>autoyast</emphasis> will make
- <emphasis>linuxrc</emphasis> start in automated mode.
- <command>Linuxrc</command> searches for a configuration file, which
+ Adding the command line variable <emphasis>autoyast</emphasis> causes
+ <emphasis>linuxrc</emphasis> to start in automated mode.
+ <command>linuxrc</command> searches for a configuration file<remark>emap 2011-11-07: Is this the profile? Better elaborate on this config file.</remark>, which
should be distinguished from the main control file in the following
places:
</para>
<itemizedlist>
<listitem>
- <para>In the root directory of the initial ram-disk used for booting
- the system up</para>
+ <para>in the root directory of the initial RAM disk used for booting
+ the system,</para>
</listitem>
<listitem>
- <para>In the root directory of the floppy</para>
+ <para>in the root directory of the floppy.</para>
</listitem>
</itemizedlist>
<para>
The configuration file used by <command>linuxrc</command> can have the
- following keywords (for a detailed description of how linuxrc works and
+ following keywords (for a detailed description of how <command>linuxrc</command> works and
other keywords, see <quote><xref linkend='appendix.linuxrc'
endterm="appendix.linuxrc.title"></xref></quote> ):
</para>
@@ -272,20 +273,18 @@
<tbody>
- <row><entry>netdevice</entry><entry>Which network device to use for
- network setup (Device used for &bootp; / &dhcp; requests)</entry></row>
- <row><entry>server</entry><entry>Which server to contact for source directory (NFS Server)</entry></row>
+ <row><entry>netdevice</entry><entry>Network device to use for
+ network setup (for &bootp; and &dhcp; requests)</entry></row>
+ <row><entry>server</entry><entry>Server (NFS) to contact for source directory</entry></row>
<row><entry>serverdir</entry><entry>Directory on NFS Server </entry></row>
<row><entry>hostip</entry><entry>When empty, client sends &bootp; request, otherwise client is configured with entered IP configuration.</entry></row>
<row><entry>netmask</entry><entry>Netmask</entry></row>
<row><entry>gateway</entry><entry>Gateway</entry></row>
<row><entry>nameserver</entry><entry>Nameserver</entry></row>
- <row><entry>insmod</entry><entry>Kernel modules to load.</entry></row>
+ <row><entry>insmod</entry><entry>Kernel modules to load</entry></row>
<row>
<entry>autoyast</entry>
- <entry>Location of the the control file to be used for the
- automatic installation, i.e
- <emphasis>autoyast=http://192.168.2.1/profiles/</emphasis></entry>
+ <entry>Location of the the control file for automatic installation, i.e. <emphasis>autoyast=http://192.168.2.1/profiles/</emphasis></entry>
</row>
<row>
@@ -294,13 +293,12 @@
</row>
<row>
<entry>instmode</entry>
- <entry>Installation mode, i.e. nfs, http etc. (Not needed if
+ <entry>Installation mode, i.e. nfs, http etc. (not needed if
<emphasis>install</emphasis> is set)</entry>
</row>
<row>
<entry>y2confirm</entry>
- <entry>even with <confirm>no</confirm> in the profile, the confirm proposal comes up.
- This is available since SUSE Linux 10.1 / SLES10
+ <entry>Even with <confirm>no</confirm> in the profile, the confirm proposal comes up (available since SUSE Linux 10.1/SLES10).
</entry>
</row>
</tbody>
@@ -311,36 +309,36 @@
<para>
These variables and keywords will bring the system up to the point
- where &yast2; can take over with the main control file. Currently, the
+ where &yast; can take over with the main control file. Currently, the
source medium is
automatically discovered, which in some cases makes it possible to
initiate the auto-install process without giving any instructions to
- linuxrc.
+ <command>linuxrc</command>.
</para>
<para>
The traditional <command>linuxrc</command> configuration file
(<filename>info</filename>) has the function of
giving the client enough information about the installation server and
- the location of the sources. In most cases this file is not needed; it is however
- needed in special network environments where &dhcp; / &bootp; are not
- used or when special kernel modules have to be loaded.
+ the location of the sources. In most cases, this file is not needed; it is however
+ needed in special network environments where &dhcp; and &bootp; are not
+ used or when special kernel modules have to be loaded.
</para>
<para>
All linuxrc keywords
can be passed to <command>linuxrc</command> using the kernel command
- line. The command line can for example also be set when creating network boot-able
+ line. The command line can also be set when creating network bootable
images or it can be passed to the kernel using a specially configured
- &dhcp; server in combination with Etherboot or &pxe;.
+ &dhcp; server in combination with Etherboot or &pxe;.<remark>emap 2011-11-07:Obscure paragraph. What is set in the command line? And what is the 'it' that can be passed to the kernel? Probably not the command line itself.</remark>
</para>
<para>
- The format of the special command line variable
- <emphasis>autoyast</emphasis> can be used as described in table <quote>