nightmorph 10/03/03 01:37:42 Modified: gentoo-sparc-netboot-howto.xml Log: HUGE cleanup for the sparc netboot doc. a ridiculous number of changes big and small. ugh. bug 296744
Revision Changes Path 1.12 xml/htdocs/doc/en/gentoo-sparc-netboot-howto.xml file : http://sources.gentoo.org/viewcvs.py/gentoo/xml/htdocs/doc/en/gentoo-sparc-netboot-howto.xml?rev=1.12&view=markup plain: http://sources.gentoo.org/viewcvs.py/gentoo/xml/htdocs/doc/en/gentoo-sparc-netboot-howto.xml?rev=1.12&content-type=text/plain diff : http://sources.gentoo.org/viewcvs.py/gentoo/xml/htdocs/doc/en/gentoo-sparc-netboot-howto.xml?r1=1.11&r2=1.12 Index: gentoo-sparc-netboot-howto.xml =================================================================== RCS file: /var/cvsroot/gentoo/xml/htdocs/doc/en/gentoo-sparc-netboot-howto.xml,v retrieving revision 1.11 retrieving revision 1.12 diff -u -r1.11 -r1.12 --- gentoo-sparc-netboot-howto.xml 14 Dec 2009 21:35:05 -0000 1.11 +++ gentoo-sparc-netboot-howto.xml 3 Mar 2010 01:37:41 -0000 1.12 @@ -1,6 +1,6 @@ <?xml version='1.0' encoding="UTF-8"?> <!DOCTYPE guide SYSTEM "/dtd/guide.dtd"> -<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/gentoo-sparc-netboot-howto.xml,v 1.11 2009/12/14 21:35:05 nightmorph Exp $ --> +<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/gentoo-sparc-netboot-howto.xml,v 1.12 2010/03/03 01:37:41 nightmorph Exp $ --> <guide> <title>Gentoo Linux based Netboot HOWTO</title> @@ -8,6 +8,9 @@ <author title="SPARC Developer"> <mail link="weeve"/> </author> +<author title="Editor"> + <mail link="nightmorph"/> +</author> <abstract> Guide for setting up a netboot server for use with the Gentoo/SPARC netboot @@ -18,8 +21,8 @@ <!-- See http://creativecommons.org/licenses/by-sa/2.5 --> <license/> -<version>1.3</version> -<date>2009-12-14</date> +<version>1.4</version> +<date>2010-03-02</date> <chapter> <title>Introduction</title> @@ -55,14 +58,14 @@ <li>A server machine returns a response to the client with the IP address</li> <li> The client then attempts to download a boot image from the RARP server - using the tftp protocol + using the TFTP protocol </li> <li>Once the image is downloaded, the netboot client then boots the image</li> </ol> <p> Based on this overview, we will need to install software for a reverse ARP -daemon and a tftp daemon. +daemon and a TFTP daemon. </p> </body> @@ -77,12 +80,13 @@ <p> Currently, there are two choices for a reverse ARP daemon. They are -net-misc/iputils (installed as part of the system profile) and net-misc/rarpd. +<c>net-misc/iputils</c> (installed as part of the system profile) and +<c>net-misc/rarpd</c>. </p> <note> -Installing net-misc/rarpd will overwrite the rarpd and rarpd manpage from -net-misc/iputils +Installing <c>net-misc/rarpd</c> will overwrite the <c>rarpd</c> and +<c>rarpd</c> manpage from <c>net-misc/iputils</c>. </note> <p> @@ -90,9 +94,9 @@ </p> <p> -No matter which rarpd you choose to use, you will need to setup the -<path>/etc/ethers</path> file. This file indicates which hosts rarpd should -respond to when a request is seen, and what address to reply with. +No matter which <c>rarpd</c> you choose to use, you will need to setup the +<path>/etc/ethers</path> file. This file indicates which hosts <c>rarpd</c> +should respond to when a request is seen, and what address to reply with. </p> <p> @@ -113,8 +117,8 @@ <p> If you desire to add additional hosts to <path>/etc/ethers</path>, you do not -need to restart the rarpd services as the file is checked each time a request -is received. +need to restart the <c>rarpd</c> services as the file is checked each time a +request is received. </p> <p> @@ -164,11 +168,12 @@ </p> <p> -First, we will need to determine the options to use for rarpd. While there are -more options than we'll cover here, these options should get you started As -there is currently no init.d script for net-misc/iputils version of rarpd, an -entry will need to be added to <path>/etc/conf.d/local.start</path> if you want -to enable rarpd servies at boot time. A sample entry is as follows; +First, we will need to determine the options to use for <c>rarpd</c>. While +there are more options than we'll cover here, these options should get you +started As there is currently no <path>init.d</path> script for the +<c>net-misc/iputils</c> version of <c>rarpd</c>, an entry will need to be added +to <path>/etc/conf.d/local.start</path> if you want to enable <c>rarpd</c> +services at boot time. A sample entry is as follows: </p> <pre caption="/etc/conf.d/local.start"> @@ -176,20 +181,21 @@ </pre> <p> -An explanation of the above rarpd options (as taken from the man page): +An explanation of the above <c>rarpd</c> options (as taken from the man page): </p> <ul> - <li>-v Be verbose</li> + <li><c>-v</c> Be verbose</li> <li> - -e Do not check for the presence of a boot image, reply if MAC address - resolves to a valid IP address using /etc/ethers database and DNS + <c>-e</c> Do not check for the presence of a boot image, reply if MAC + address resolves to a valid IP address using <path>/etc/ethers</path> + database and DNS </li> - <li>eth0 represents the interface rarpd should bind to</li> + <li>eth0 represents the interface <c>rarpd</c> should bind to</li> </ul> <p> -For more options, consult the section 8 man page on rarpd. +For more options, consult <c>man 8 rarpd</c>. </p> <p> @@ -197,7 +203,7 @@ </p> <p> -Firstly, we'll need to install rarpd with the following command: +Firstly, we'll need to install <c>rarpd</c> with the following command: </p> <pre caption="Installing rarpd"> @@ -205,9 +211,10 @@ </pre> <p> -Next, options for rarpd will need to be set in <path>/etc/conf.d/rarpd</path>. -For an equivalent configuration as the one used above for net-misc/iputils -rarpd, adjust <path>/etc/conf.d/rarpd</path> to look like the following +Next, options for <c>rarpd</c> will need to be set in +<path>/etc/conf.d/rarpd</path>. For an equivalent configuration as the one used +above for the <c>net-misc/iputils</c> <c>rarpd</c>, adjust +<path>/etc/conf.d/rarpd</path> to look like the following </p> <pre caption="/etc/conf.d/rarpd"> @@ -223,13 +230,13 @@ <c>-v</c> Be verbose. Show requests which the daemon is responding to </li> <li> - <c>-i</c> Bind to the named interface. By default rarpd binds to the + <c>-i</c> Bind to the named interface. By default <c>rarpd</c> binds to the default interface for the local system type, if available </li> </ul> <p> -For more options, consult the section 8 man page on rarpd and rarpd --help. +For more options, consult <c>man 8 rarpd</c> and <c>rarpd --help</c>. </p> </body> @@ -239,9 +246,9 @@ <body> <p> -Here there are three options for a tftp daemon, net-misc/atftp, -net-misc/netkit-tftp and net-misc/tftp-hpa. You only need to install one of the -tftp daemons for proper operation. +Here there are three options for a TFTP daemon, <c>net-misc/atftp</c>, +<c>net-misc/netkit-tftp</c> and <c>net-misc/tftp-hpa</c>. You only need to +install one of the TFTP daemons for proper operation. </p> <p> @@ -249,16 +256,17 @@ </p> <p> -Each tftp daemon will need a directory from which to serve files to tftp -clients. The directory we will use for this howto will be /tftpboot. This will -appear as the root (<path>/</path>) directory to the clients when requests are -received. Additionally, we'll setup the system to run the tftp daemon with the -user and group nobody. +Each TFTP daemon will need a directory from which to serve files to tftp +clients. The directory we will use for this howto will be +<path>/tftpboot</path>. This will appear as the root (<path>/</path>) directory +to the clients when requests are received. Additionally, we'll setup the system +to run the TFTP daemon with the user and group <c>nobody</c>. </p> <p> If the directory you have chosen does not currently exist, it will need to be -created with the mkdir command. The command for the example /tftpboot is; +created with the <c>mkdir</c> command. The command for the example +<path>/tftpboot</path> is: </p> <pre caption="Creating /tftpboot"> @@ -267,7 +275,7 @@ <p> Then we will need to change the owner of <path>/tftpboot</path> so that it is -owned by user nobody and group nobody; +owned by user nobody and group <c>nobody</c>: </p> <pre caption="Changing ownership"> @@ -281,7 +289,7 @@ <body> <p> -First, install the net-misc/atftp package as follows; +First, install the <c>net-misc/atftp</c> package as follows; </p> <pre caption="Installing atftp"> @@ -289,15 +297,17 @@ </pre> <p> -After the net-misc/atftp package has been installed, it will need to be +After the <c>net-misc/atftp</c> package has been installed, it will need to be configured. If tftpd services are desired at boot time, an entry to -<path>/etc/conf.d/local.start</path> will need to be added as atftp has no -init.d, inetd or xinetd scripts of its own. If you want to use inetd or xinetd -for controlling the tftpd service, please see their respective man pages. +<path>/etc/conf.d/local.start</path> will need to be added as <c>atftp</c> has +no <path>init.d</path>, <c>inetd</c> or <c>xinetd</c> scripts of its own. If you +want to use <c>inetd</c> or <c>xinetd</c> for controlling the tftpd service, +please see their respective man pages. </p> <p> -Below is an example entry for atftpd in <path>/etc/conf.d/local.start</path>; +Below is an example entry for <c>atftpd</c> in +<path>/etc/conf.d/local.start</path>. </p> <pre caption="/etc/conf.d/local.start"> @@ -305,7 +315,7 @@ </pre> <p> -An explanation of the above rarpd options (as taken from the man page); +An explanation of the above <c>rarpd</c> options (as taken from the man page); </p> <ul> @@ -321,7 +331,7 @@ </ul> <p> -For more options, consult the section 8 man page on atftpd. +For more options, consult <c>man 8 atftpd</c>. </p> </body> @@ -331,7 +341,7 @@ <body> <p> -First, install the net-misc/netkit-tftp package as follows; +First, install the <c>net-misc/netkit-tftp</c> package: </p> <pre caption="Installing netkit-tftp"> @@ -339,11 +349,11 @@ </pre> <p> -Secondly, install sys-apps/xinetd if it is not currently present; After the -net-misc/netkit-tftp and sys-apps/xinetd packages have been installed, -netkit-tftp will need to be configured. netkit-tftp needs to be run from -xinetd, however it does not provide example scripts of its own. A sample xinetd -file is provided below; +Second, install <c>sys-apps/xinetd</c> if it is not currently present. After +the <c>net-misc/netkit-tftp</c> and <c>sys-apps/xinetd</c> packages have been +installed, <c>netkit-tftp</c> will need to be configured. <c>netkit-tftp</c> +needs to be run from <c>xinetd</c>, however it does not provide example scripts +of its own. A sample <c>xinetd</c> file is provided below: </p> <pre caption="Sample /etc/xinetd.d/tftp file"> @@ -363,28 +373,36 @@ </pre> <note> -This sample xinetd configuration file for tftp uses the line "disable = no", -which enables the service by default. This is opposite of the default way -packages in Gentoo provide their respective xinetd configuration files, which -have disable set to yes. +This sample <c>xinetd</c> configuration file for tftp uses the line <c>disable = +no</c>, which enables the service by default. This is opposite of the default +way packages in Gentoo provide their respective <c>xinetd</c> configuration +files, which have <c>disable</c> set to <c>yes</c>. </note> <p> -An explanation of the above options which can be changed; -user user in.tftpd requests are handled as -group group in.tftpd requests are handled as -server_args root directory for tftp daemon to serve files from -only_from tells xinetd what hosts to allow tftp connections from +An explanation of the above options which can be changed: </p> +<ul> + <li><b>user</b>: the user in.tftpd requests are handled as</li> + <li><b>group</b>: the group in.tftpd requests are handled as</li> + <li> + <b>server_args</b>: the root directory for the TFTP daemon to serve files + from + </li> + <li> + <b>only_from</b>: tells xinetd which hosts to allow TFTP connections from + </li> +</ul> + <p> -Additional information on xinetd configuration files can be found in the -section 5 manpage on xinetd.conf +Additional information on <c>xinetd</c> configuration files can be found in +<c>man 5 xinetd.conf</c>. </p> <p> -If xinetd is running, you can send it the HUP signal to have it re-read its -configuration files; +If <c>xinetd</c> is running, you can send it the HUP signal to have it re-read +its configuration files: </p> <pre caption="Sending HUP signal to xinetd"> @@ -392,7 +410,7 @@ </pre> <p> -If xinetd is not running, start it with the init.d command; +If <c>xinetd</c> is not running, start it with the init.d command: </p> <pre caption="Starting xinetd"> @@ -400,7 +418,7 @@ </pre> <p> -For more information, consult the section 8 man page on in.tftpd +For more information, consult <c>man 8 in.tftpd</c>. </p> </body> @@ -410,7 +428,7 @@ <body> <p> -First, install the tftp-hpa package using the following command; +First, install the <c>tftp-hpa</c> package: </p> <pre caption="Installing tftp-hpa"> @@ -418,9 +436,9 @@ </pre> <p> -tftp-hpa comes with an init.d and the accompanying conf.d configuration file. -Check to make sure that INIITFTPD_PATH and INITFTP_OPTS in -<path>/etc/conf.d/in.tftpd</path> match those below; +<c>tftp-hpa</c> comes with an <path>init.d</path> and the accompanying +<path>conf.d</path> configuration file. Check to make sure that INTFTPD_PATH +and INTFTP_OPTS in <path>/etc/conf.d/in.tftpd</path> match those below: </p> <pre caption="/etc/conf.d/in.tftpd"> @@ -429,7 +447,7 @@ </pre> <p> -The tftp daemon can then be started via the init.d script; +The TFTP daemon can then be started via the <path>init.d</path> script: </p> <pre caption="Starting in.tftpd"> @@ -437,7 +455,7 @@ </pre> <p> -For more options, consult the section 8 man page on tftpd. +For more options, consult <c>man 8 tftpd</c>. </p> </body> @@ -450,23 +468,24 @@ <body> <p> -Make sure you have an image you want to use for netbooting. For a sparc or -sparc64 netboot image, please check your local Gentoo distfiles mirror under -<path>experimental/sparc/tftpboot</path> for the appropriate image. We'll -assume you are planning to boot a sparc64 host using the -<path>gentoo-sparc64-1.4_rc4-20040102.tftpboot</path> image. +Make sure you have an image you want to use for netbooting. Please check your +<uri link="/main/en/mirrors.xml">local</uri> Gentoo <uri +link="http://distfiles.gentoo.org/experimental/sparc/tftpboot/sparc64/";>distfiles +mirror</uri> for the appropriate image. We'll assume you are planning to boot +using the <path>gentoo-sparc64-20100128.tftpboot</path> image. </p> <p> -Once you have an image, copy the image into <path>/tftpboot</path>; +Once you have an image, copy the image into <path>/tftpboot</path>: </p> <pre caption="Copying the image"> -# <i>cp gentoo-sparc64-1.4_rc4-20040102.tftpboot /tftpboot</i> +# <i>cp gentoo-sparc64-20100128.tftpboot /tftpboot</i> +# <i>chmod 644 /tftpboot/gentoo-sparc64-20100128.tftpboot</i> </pre> <p> -Now, when the netboot client makes a tftp request, it looks for a file that is +Now, when the netboot client makes a TFTP request, it looks for a file that is the hexadecimal number of its current IP address, and on some platforms an <path>.ARCH</path> suffix. The hexadecimal number should use <e>capital</e> characters. @@ -478,7 +497,7 @@ </p> <pre caption="Convert to hexadecimal"> -# <i>printf "%.2x%.2x%.2x%.2x\n" 10 0 1 15</i> +# <i>printf "%.2X%.2X%.2X%.2X\n" 10 0 1 15</i> </pre> <pre caption="Example IP address"> @@ -487,33 +506,29 @@ </pre> <p> -So for the example sparc64 netboot client, it would look for a file named -0A00010F when it tftpboots. +So for the example netboot client, it would look for a file named +<path>0A00010F</path> when it tftpboots. </p> <p> -On sparc however, the file would be 0A00010F.SUN4M, 0A00010F.SUN4C or -0A00010F.SUN4D depending on what type of sparc system. +Iif you are really, really lazy (like me), you can netboot the host to get the +filename the client is looking for from the netboot server logs. </p> <p> -Additionally, if you are really really lazy (like me), you can netboot the host -to get the filename the client is looking for from the netboot server logs. -</p> - -<p> -Make sure that both the rarpd and tftpd daemon you've chosen are currently -running, then boot the host as described below in "Netbooting the client". +Make sure that both the <c>rarpd</c> and TFTP daemon you've chosen are currently +running, then boot the host as described below in <uri +link="#netbootingclient">Netbooting the client</uri>. </p> <p> The client will appear to hang after the boot net command is issued. Then on -the netboot server, check the system logs for an entry for in.tftpd. +the netboot server, check the system logs for an entry for <c>in.tftpd</c>. </p> <p> -An example entry from a netboot server running sysklogd and tftp-hpa looks -like; +An example entry from a netboot server running <c>sysklogd</c> and +<c>tftp-hpa</c> looks like: </p> <pre caption="Log entry for netboot server"> @@ -522,19 +537,19 @@ <p> The filename is shown above after "filename" in the log entry, which in this -case is 0A00010F. +case is <path>0A00010F</path>. </p> <p> As a way to keep track of what netboot image you are using, and to allow multiple machines to use the same netboot image, you can use a soft link to create the file with the hexadecimal value. To create this using our sample -sparc64 host and the <path>gentoo-sparc64-1.4_rc4-20040102.tftpboot</path>, use -the following command; +sparc64 host and the <path>gentoo-sparc64-20100128.tftpboot</path>, use +the following command: </p> <pre caption="Linking the image files"> -# <i>/bin/ln -s /tftpboot/gentoo-sparc64-1.4_rc4-20040102.tftpboot \ +# <i>/bin/ln -s /tftpboot/gentoo-sparc64-20100128.tftpboot \ /tftpboot/0A00010F</i> </pre> @@ -546,9 +561,8 @@ </section> </chapter> -<chapter> +<chapter id="netbootingclient"> <title>Netbooting the client</title> - <section> <body> @@ -598,12 +612,12 @@ </p> <p> -If the netboot server is a Gentoo/LINUX system and experiences problems -installing the rarpd and tftpd packages, please search -<uri>http://forums.gentoo.org</uri> and <uri>http://bugs.gentoo.org</uri> to -see if this problem has been encountered by anyone else. If it has not, or the -solutions found do not work, then please open a new bug at -<uri>http://bugs.gentoo.org</uri> +If the netboot server is a Gentoo Linux system and experiences problems after +installing the rarpd and tftpd packages, please search the <uri +link="http://forums.gentoo.org";>Gentoo Forums</uri> and <uri +link="http://bugs.gentoo.org";>Gentoo Bugzilla</uri> to see if this problem has +been encountered by anyone else. If it has not, or the solutions found do not +work, then please open a new bug. </p> <p> @@ -613,7 +627,7 @@ <p> This is presumably because the file your system is trying to load from the tftpboot server is not available. On a SPARC system, you would probably see the -following; +following: </p> <pre caption="Booting appears to hang"> @@ -675,7 +689,7 @@ <p> To change the value of tpe-link-test? from an OBP prompt, issue the following -command; +command: </p> <pre caption="Changing tpe-link-test value">
