[install-guide/F21-rewrite] More/better section introductions in Kickstart Syntax Reference

commit 20dcab9228f770c2951858561bae46e634c1c802 Author: Petr Bokoc <pbokoc(a)redhat.com&gt; Date: Tue Sep 16 23:17:13 2014 +0200 More/better section introductions in Kickstart Syntax Reference en-US/Kickstart_Syntax_Reference.xml | 96 +++++++++++++++++++++------------ 1 files changed, 61 insertions(+), 35 deletions(-) --- diff --git a/en-US/Kickstart_Syntax_Reference.xml b/en-US/Kickstart_Syntax_Reference.xml index c579422..64f0a11 100644 --- a/en-US/Kickstart_Syntax_Reference.xml +++ b/en-US/Kickstart_Syntax_Reference.xml @@ -6,26 +6,47 @@ <appendix id="appe-kickstart-syntax-reference"> <title>Kickstart Syntax Reference</title> <para> - This appendix describes commands and options available in Kickstart installations. For information about how to automate your installation using Kickstart, see <xref linkend="chap-kickstart-installations" />. + This appendix describes commands and options available in Kickstart installations. For general information about Kickstart, see <xref linkend="chap-kickstart-installations" />. </para> - + <important> + <para> + Device names are not guaranteed to be consistent across reboots, which can complicate usage in Kickstart scripts. When a Kickstart option calls for a device node name (such as <literal>sda</literal>), you can instead use any item from <filename>/dev/disk</filename>. For example, instead of: + </para> + <programlisting> +<command>part / --fstype=xfs --onpart=sda1</command> + </programlisting> + <para> + You could use an entry similar to one of the following: + </para> + <programlisting> +<command>part / --fstype=xfs --onpart=/dev/disk/by-path/pci-0000:00:05.0-scsi-0:0:0:0-part1</command> +<command>part / --fstype=xfs --onpart=/dev/disk/by-id/ata-ST3160815AS_6RA0C882-part1</command> + </programlisting> + <para> + This provides a consistent way to refer to disks that is more meaningful than just <literal>sda</literal>. This is especially useful in large storage environments. + </para> + </important> <para> - While the general principles of Kickstart installations tend to stay the same, the commands and options can change between major releases of &PRODUCT;. You can use the <command>ksverdiff</command> command to display the differences between two versions of the Kickstart syntax. This is useful when updating an existing Kickstart file to be used with a new release. To display a list of changes in syntax between &PRODUCT;&nbsp;&PREVVER; and &PRODVER;, use the following command: + While the general principles of Kickstart installations tend to stay the same, the commands and options can change between major releases. You can use the <command>ksverdiff</command> command to display the differences between two versions of the Kickstart syntax. This is useful when updating an existing Kickstart file to be used with a new release. To display a list of changes in syntax between Fedora&nbsp;&PREVVER; and &PRODVER;, use the following command: </para> <screen> <prompt>$</prompt> <command>ksverdiff -f F&PREVVER; -t F&PRODVER;</command> </screen> <para> - The <option>-f</option> option specifies the release to start the comparison with, and the <option>-t</option> option to specify the release to end with. For additional information, see the <systemitem>ksverdiff(1)</systemitem> man page. Also note that you can not use this to display changes in a release that is newer than your system - the version of <package>pykickstart</package> on &PRODUCT;&nbsp;&PREVVER; can not display changes in &PRODUCT;&nbsp;&PRODVER;. + The <option>-f</option> option specifies the release to start the comparison with, and the <option>-t</option> option to specify the release to end with. For additional information, see the <systemitem>ksverdiff(1)</systemitem> man page. Also note that you can not use this to display changes in a release that is newer than your system - the version of <package>pykickstart</package> on Fedora&nbsp;&PREVVER; can not display changes in Fedora&nbsp;&PRODVER;. </para> <para> - Additionally, you can review the <citetitle>&PRODUCT; Release Notes</citetitle>, available at <ulink url="http://docs.fedoraproject.org/">&PRODUCT; Documentation</ulink>, for a list of changes. + Additionally, you can review the <citetitle>Fedora&nbsp;&PRODVER; Release Notes</citetitle>, available at <ulink url="http://docs.fedoraproject.org/">Fedora Documentation</ulink>, for a list of changes. </para> - + <note> + <para> + In the following sections, if an option is followed by an equals mark (<literal>=</literal>), a value must be specified after it. In the example commands, options in square brackets (<literal>[ ]</literal>) are optional arguments for the command. + </para> + </note> <section id="sect-kickstart-commands-installation"> <title>Installation Methods and Sources</title> <para> - text + The following commands control the way Fedora will be installed. </para> <section id="sect-kickstart-commands-device"> @@ -75,7 +96,7 @@ <section id="sect-kickstart-commands-storage"> <title>Storage and Partitioning</title> <para> - text + Commands in this section are used to determine your system's storage options and partitioning. </para> <section id="sect-kickstart-commands-autopart"> @@ -181,7 +202,7 @@ <section id="sect-kickstart-commands-network-configuration"> <title>Network Configuration</title> <para> - text + Commands in this chapter are used for network configuration. </para> <section id="sect-kickstart-commands-firewall"> @@ -203,7 +224,7 @@ <section id="sect-kickstart-commands-environment"> <title>Console and Environment</title> <para> - text + The following commands control the environment of the system after the installation finishes - language, keyboard layouts, or the graphical interface. </para> <section id="sect-kickstart-commands-keyboard"> @@ -253,7 +274,7 @@ <section id="sect-kickstart-commands-users-groups"> <title>Users, Groups and Authentication</title> <para> - text + The commands below are used to control user accounts, groups, and related areas. </para> <section id="sect-kickstart-commands-auth"> @@ -303,7 +324,7 @@ <section id="sect-kickstart-commands-installation-environment"> <title>Installation Environment</title> <para> - text + The following commands control how the system will behave during the installation. </para> <section id="sect-kickstart-commands-autostep"> @@ -374,7 +395,7 @@ <section id="sect-kickstart-commands-after"> <title>After the Installation</title> <para> - text + This section contains commands which control the system's behavior immediately after the installation finishes. </para> <section id="sect-kickstart-commands-eula"> @@ -445,7 +466,7 @@ <important> <para> To install a 32-bit package on a 64-bit system, you will need to append the package name with the 32-bit architecture for which the package was built - for example, <package>glibc.i686</package>. The <option>--multilib</option> option also must be specified in the Kickstart file; see the available options below. - </para> + </para> </important> <important> <para> @@ -470,7 +491,7 @@ </programlisting> <para> This command will install all packages which are part of the <guilabel>Infrastracture Server</guilabel> environment. All available environments are described in the <filename>repodata/*-comps-<replaceable>variant</replaceable>.<replaceable>architecture</replaceable>.xml</filename> file. - </para> + </para> </listitem> </varlistentry> <varlistentry> @@ -544,7 +565,7 @@ docbook* </para> <programlisting> <command>%packages --multilib --ignoremissing</command> - </programlisting> + </programlisting> <varlistentry> <term> <option>--nobase</option> @@ -690,7 +711,7 @@ docbook* </para> <para> This section is useful for functions such as installing additional software or configuring an additional name server. The post-install script is run in a chroot environment, therefore, performing tasks such as copying scripts or RPM packages from the installation media do not work by default. You can change this behavior using the <option>--nochroot</option> option as described below. - </para> + </para> <important> <para> If you configured the network with static IP information, including a name server, you can access the network and resolve IP addresses in the <command>%post</command> section. If you configured the network for <systemitem>DHCP</systemitem>, the <filename>/etc/resolv.conf</filename> file has not been completed when the installation executes the <command>%post</command> section. You can access the network, but you cannot resolve IP addresses. Thus, if you are using <systemitem>DHCP</systemitem>, you must specify IP addresses in the <command>%post</command> section. @@ -820,6 +841,11 @@ cp /etc/resolv.conf /mnt/sysimage/etc/resolv.conf Finally, the last set of commands first creates a volume group named <literal>sysvg</literal> on the <literal>pv.01</literal> physical volume. Then, three logical volumes (<literal>/var</literal>, <literal>/var/freespace</literal> and <literal>/usr/local</literal>) are created and added to the <literal>sysvg</literal> volume group. The <literal>/var</literal> and <literal>/var/freespace</literal> volumes have a set size of 8 GB, and the <literal>/usr/local</literal> volume uses the <option>--grow</option> option to fill all remaining available space. </para> </example> + <important> + <para> + The above example uses identifiers <systemitem>hda</systemitem> and <systemitem>hdc</systemitem> to identify disk drives. You should use unique identifiers, such as a disk labels or an UUIDs, to identify disk drives. See the note in introduction to this appendix. + </para> + </important> </section> <section id="sect-kickstart-example-pre"> @@ -835,10 +861,10 @@ cp /etc/resolv.conf /mnt/sysimage/etc/resolv.conf hds="" mymedia="" for file in /proc/ide/h* do - mymedia=`cat $file/media` - if [ $mymedia == "disk" ] ; then - hds="$hds `basename $file`" - fi + mymedia=`cat $file/media` + if [ $mymedia == "disk" ] ; then + hds="$hds `basename $file`" + fi done set $hds numhd=`echo $#` @@ -847,21 +873,21 @@ drive2=`echo $hds | cut -d' ' -f2` #Write out partition scheme based on whether there are 1 or 2 hard drives if [ $numhd == "2" ] ; then - #2 drives - echo "#partitioning scheme generated in %pre for 2 drives" &gt; /tmp/part-include - echo "clearpart --all" &gt;&gt; /tmp/part-include - echo "part /boot --fstype xfs --size 75 --ondisk hda" &gt;&gt; /tmp/part-include - echo "part / --fstype xfs --size 1 --grow --ondisk hda" &gt;&gt; /tmp/part-include - echo "part swap --recommended --ondisk $drive1" &gt;&gt; /tmp/part-include - echo "part /home --fstype xfs --size 1 --grow --ondisk hdb" &gt;&gt; /tmp/part-include + #2 drives + echo "#partitioning scheme generated in %pre for 2 drives" &gt; /tmp/part-include + echo "clearpart --all" &gt;&gt; /tmp/part-include + echo "part /boot --fstype xfs --size 75 --ondisk hda" &gt;&gt; /tmp/part-include + echo "part / --fstype xfs --size 1 --grow --ondisk hda" &gt;&gt; /tmp/part-include + echo "part swap --recommended --ondisk $drive1" &gt;&gt; /tmp/part-include + echo "part /home --fstype xfs --size 1 --grow --ondisk hdb" &gt;&gt; /tmp/part-include else - #1 drive - echo "#partitioning scheme generated in %pre for 1 drive" &gt; /tmp/part-include - echo "clearpart --all" &gt;&gt; /tmp/part-include - echo "part /boot --fstype xfs --size 75" &gt;&gt; /tmp/part-include - echo "part swap --recommended" &gt;&gt; /tmp/part-include - echo "part / --fstype xfs --size 2048" &gt;&gt; /tmp/part-include - echo "part /home --fstype xfs --size 2048 --grow" &gt;&gt; /tmp/part-include + #1 drive + echo "#partitioning scheme generated in %pre for 1 drive" &gt; /tmp/part-include + echo "clearpart --all" &gt;&gt; /tmp/part-include + echo "part /boot --fstype xfs --size 75" &gt;&gt; /tmp/part-include + echo "part swap --recommended" &gt;&gt; /tmp/part-include + echo "part / --fstype xfs --size 2048" &gt;&gt; /tmp/part-include + echo "part /home --fstype xfs --size 2048 --grow" &gt;&gt; /tmp/part-include fi <command>%end</command> </programlisting>