Deorbit IRIX-specific QuickStartGuide bits
[openafs.git] / doc / xml / QuickStartUnix / auqbg006.xml
index b13fb5a..bc3948c 100644 (file)
           </listitem>
 
           <listitem>
-            <para><link linkend="HDRWQ104">Getting Started on IRIX Systems</link></para>
-          </listitem>
-
-          <listitem>
             <para><link linkend="HDRWQ106">Getting Started on Linux Systems</link></para>
           </listitem>
 
           </orderedlist></para>
       </sect3>
 
-      <sect3 id="HDRWQ104">
-        <title>Getting Started on IRIX Systems</title>
-
-        <para>Begin by incorporating AFS modifications into the kernel. Either use the <emphasis role="bold">ml</emphasis> dynamic
-        loader program, or build a static kernel. Then configure partitions to house AFS volumes. AFS supports use of both EFS and
-        XFS partitions for housing AFS volumes. SGI encourages use of XFS partitions. <indexterm>
-            <primary>file server machine, additional</primary>
-
-            <secondary>fsck program</secondary>
-
-            <tertiary>on IRIX</tertiary>
-          </indexterm> <indexterm>
-            <primary>fsck program</primary>
-
-            <secondary>on server machine after first</secondary>
-
-            <tertiary>IRIX</tertiary>
-          </indexterm></para>
-
-        <para>You do not need to replace IRIX <emphasis role="bold">fsck</emphasis> program, because the version that SGI
-        distributes handles AFS volumes properly. <orderedlist>
-            <indexterm>
-              <primary>incorporating AFS kernel extensions</primary>
-
-              <secondary>server machine after first</secondary>
-
-              <tertiary>IRIX</tertiary>
-            </indexterm>
-
-            <indexterm>
-              <primary>AFS kernel extensions</primary>
-
-              <secondary>on server machine after first</secondary>
-
-              <tertiary>IRIX</tertiary>
-            </indexterm>
-
-            <indexterm>
-              <primary>file server machine, additional</primary>
-
-              <secondary>AFS kernel extensions</secondary>
-
-              <tertiary>on IRIX</tertiary>
-            </indexterm>
-
-            <listitem>
-              <para>Prepare for incorporating AFS into the kernel by performing the following procedures. <orderedlist>
-                  <listitem>
-                    <para>Unpack the OpenAFS IRIX distribution tarball. The 
-                    examples below assume that you have unpacked the files into 
-                    the <emphasis role="bold">/tmp/afsdist</emphasis> 
-                    directory. If you pick a different location, substitue this 
-                    in all of the following examples. Once you have unpacked 
-                    the distribution, change directory as indicated.
-<programlisting>
-   # <emphasis role="bold">cd /tmp/afsdist/sgi_65/dest/root.client</emphasis>
-</programlisting></para>
-                  </listitem>
-
-                  <listitem>
-                    <para>Copy the AFS initialization script to the local directory for initialization files (by convention,
-                    <emphasis role="bold">/etc/init.d</emphasis> on IRIX machines). Note the removal of the <emphasis
-                    role="bold">.rc</emphasis> extension as you copy the script. <programlisting>
-   # <emphasis role="bold">cp -p   usr/vice/etc/afs.rc  /etc/init.d/afs</emphasis>
-</programlisting></para>
-                  </listitem>
-
-                  <listitem>
-                    <para>Issue the <emphasis role="bold">uname -m</emphasis> command to determine the machine's CPU board type. The
-                    <emphasis role="bold">IP</emphasis><replaceable>xx</replaceable> value in the output must match one of the
-                    supported CPU board types listed in the <emphasis>OpenAFS Release Notes</emphasis> for the current version of
-                    AFS. <programlisting>
-   # <emphasis role="bold">uname -m</emphasis>
-</programlisting></para>
-                  </listitem>
-                </orderedlist></para>
-            </listitem>
-
-            <listitem>
-              <para>Incorporate AFS into the kernel, either using the <emphasis role="bold">ml</emphasis> program or by building AFS
-              modifications into a static kernel. <itemizedlist>
-                  <indexterm>
-                    <primary>IRIX</primary>
-
-                    <secondary>AFS kernel extensions</secondary>
-
-                    <tertiary>on server machine after first</tertiary>
-                  </indexterm>
-
-                  <listitem>
-                    <para>To use the <emphasis role="bold">ml</emphasis> program: <indexterm>
-                        <primary>afsml variable (IRIX)</primary>
-
-                        <secondary>server machine after first</secondary>
-                      </indexterm> <indexterm>
-                        <primary>variables</primary>
-
-                        <secondary>afsml (IRIX)</secondary>
-
-                        <tertiary>server machine after first</tertiary>
-                      </indexterm> <indexterm>
-                        <primary>IRIX</primary>
-
-                        <secondary>afsml variable</secondary>
-
-                        <tertiary>server machine after first</tertiary>
-                      </indexterm> <indexterm>
-                        <primary>afsxnfs variable (IRIX)</primary>
-
-                        <secondary>server machine after first</secondary>
-                      </indexterm> <indexterm>
-                        <primary>variables</primary>
-
-                        <secondary>afsxnfs (IRIX)</secondary>
-
-                        <tertiary>server machine after first</tertiary>
-                      </indexterm> <indexterm>
-                        <primary>IRIX</primary>
-
-                        <secondary>afsxnfs variable</secondary>
-
-                        <tertiary>server machine after first</tertiary>
-                      </indexterm> <orderedlist>
-                        <listitem>
-                          <para>Create the local <emphasis role="bold">/usr/vice/etc/sgiload</emphasis> directory to house the AFS
-                          kernel library file. <programlisting>
-   # <emphasis role="bold">mkdir /usr/vice/etc/sgiload</emphasis>
-</programlisting></para>
-                        </listitem>
-
-                        <listitem>
-                          <para>Copy the appropriate AFS kernel library file to the <emphasis
-                          role="bold">/usr/vice/etc/sgiload</emphasis> directory. The <emphasis
-                          role="bold">IP</emphasis><replaceable>xx</replaceable> portion of the library file name must match the
-                          value previously returned by the <emphasis role="bold">uname -m</emphasis> command. Also choose the file
-                          appropriate to whether the machine's kernel supports NFS server functionality (NFS must be supported for
-                          the machine to act as an NFS/AFS Translator). Single- and multiprocessor machines use the same library
-                          file.</para>
-
-                          <para>(You can choose to copy all of the kernel library files into the <emphasis
-                          role="bold">/usr/vice/etc/sgiload</emphasis> directory, but they require a significant amount of
-                          space.)</para>
-
-                          <para>If the machine's kernel supports NFS server functionality:</para>
-
-                          <programlisting>
-   # <emphasis role="bold">cp -p  usr/vice/etc/sgiload/libafs.IP</emphasis><replaceable>xx</replaceable><emphasis role="bold">.o  /usr/vice/etc/sgiload</emphasis>   
-</programlisting>
-
-                          <para>If the machine's kernel does not support NFS server functionality:</para>
-
-                          <programlisting>
-   # <emphasis role="bold">cp -p  usr/vice/etc/sgiload/libafs.IP</emphasis><replaceable>xx</replaceable><emphasis role="bold">.nonfs.o</emphasis>   \
-                   <emphasis role="bold">/usr/vice/etc/sgiload</emphasis>
-</programlisting>
-                        </listitem>
-
-                        <listitem>
-                          <para>Issue the <emphasis role="bold">chkconfig</emphasis> command to activate the <emphasis
-                          role="bold">afsml</emphasis> configuration variable. <programlisting>
-   # <emphasis role="bold">/etc/chkconfig -f afsml on</emphasis>   
-</programlisting></para>
-
-                          <para>If the machine is to function as an NFS/AFS Translator and the kernel supports NFS server
-                          functionality, activate the <emphasis role="bold">afsxnfs</emphasis> variable.</para>
-
-                          <programlisting>
-   # <emphasis role="bold">/etc/chkconfig -f afsxnfs on</emphasis>
-</programlisting>
-                        </listitem>
-
-                        <listitem>
-                          <para>Run the <emphasis role="bold">/etc/init.d/afs</emphasis> script to load AFS extensions into the
-                          kernel. The script invokes the <emphasis role="bold">ml</emphasis> command, automatically determining
-                          which kernel library file to use based on this machine's CPU type and the activation state of the
-                          <emphasis role="bold">afsxnfs</emphasis> variable.</para>
-
-                          <para>You can ignore any error messages about the inability to start the BOS Server or the Cache Manager
-                          or AFS client.</para>
-
-                          <programlisting>
-   # <emphasis role="bold">/etc/init.d/afs start</emphasis>
-</programlisting>
-                        </listitem>
-
-                        <listitem>
-                          <para>Proceed to Step <link linkend="LIWQ105">3</link>.</para>
-                        </listitem>
-                      </orderedlist></para>
-
-                    <indexterm>
-                      <primary>IRIX</primary>
-
-                      <secondary>AFS-modified kernel</secondary>
-
-                      <tertiary>on add'l server machine</tertiary>
-                    </indexterm>
-                  </listitem>
-
-                  <listitem>
-                    <para>If you prefer to build a kernel, and the machine's hardware and software configuration exactly matches
-                    another IRIX machine on which AFS is already built into the kernel, you can copy the kernel from that machine to
-                    this one. In general, however, it is better to build AFS modifications into the kernel on each machine according
-                    to the following instructions. <orderedlist>
-                        <listitem>
-                          <para>Copy the kernel initialization file <emphasis role="bold">afs.sm</emphasis> to the local <emphasis
-                          role="bold">/var/sysgen/system</emphasis> directory, and the kernel master file <emphasis
-                          role="bold">afs</emphasis> to the local <emphasis role="bold">/var/sysgen/master.d</emphasis> directory.
-                          <programlisting>
-   # <emphasis role="bold">cp -p  bin/afs.sm  /var/sysgen/system</emphasis>
-   # <emphasis role="bold">cp -p  bin/afs  /var/sysgen/master.d</emphasis>
-</programlisting></para>
-                        </listitem>
-
-                        <listitem>
-                          <para>Copy the appropriate AFS kernel library file to the local file <emphasis
-                          role="bold">/var/sysgen/boot/afs.a</emphasis>; the <emphasis
-                          role="bold">IP</emphasis><replaceable>xx</replaceable> portion of the library file name must match the
-                          value previously returned by the <emphasis role="bold">uname -m</emphasis> command. Also choose the file
-                          appropriate to whether the machine's kernel supports NFS server functionality (NFS must be supported for
-                          the machine to act as an NFS/AFS Translator). Single- and multiprocessor machines use the same library
-                          file.</para>
-
-                          <para>If the machine's kernel supports NFS server functionality:</para>
-
-                          <programlisting>
-   # <emphasis role="bold">cp -p   bin/libafs.IP</emphasis><replaceable>xx</replaceable><emphasis role="bold">.a   /var/sysgen/boot/afs.a</emphasis>   
-</programlisting>
-
-                          <para>If the machine's kernel does not support NFS server functionality:</para>
-
-                          <programlisting>
-   # <emphasis role="bold">cp -p  bin/libafs.IP</emphasis><replaceable>xx</replaceable><emphasis role="bold">.nonfs.a  /var/sysgen/boot/afs.a</emphasis>
-</programlisting>
-                        </listitem>
-
-                        <listitem>
-                          <para>Issue the <emphasis role="bold">chkconfig</emphasis> command to deactivate the <emphasis
-                          role="bold">afsml</emphasis> configuration variable. <programlisting>
-   # <emphasis role="bold">/etc/chkconfig -f afsml off</emphasis>   
-</programlisting></para>
-
-                          <para>If the machine is to function as an NFS/AFS Translator and the kernel supports NFS server
-                          functionality, activate the <emphasis role="bold">afsxnfs</emphasis> variable.</para>
-
-                          <programlisting>
-   # <emphasis role="bold">/etc/chkconfig -f afsxnfs on</emphasis>
-</programlisting>
-                        </listitem>
-
-                        <listitem>
-                          <para>Copy the existing kernel file, <emphasis role="bold">/unix</emphasis>, to a safe location. Compile
-                          the new kernel, which is created in the file <emphasis role="bold">/unix.install</emphasis>. It overwrites
-                          the existing <emphasis role="bold">/unix</emphasis> file when the machine reboots in the next step.
-                          <programlisting>
-   # <emphasis role="bold">cp /unix /unix_noafs</emphasis>
-   # <emphasis role="bold">autoconfig</emphasis>
-</programlisting></para>
-                        </listitem>
-
-                        <listitem>
-                          <para>Reboot the machine to start using the new kernel, and login again as the superuser <emphasis
-                          role="bold">root</emphasis>. <programlisting>
-   # <emphasis role="bold">cd /</emphasis>
-   # <emphasis role="bold">shutdown -i6 -g0 -y</emphasis>
-   login: <emphasis role="bold">root</emphasis>
-   Password: <replaceable>root_password</replaceable>
-</programlisting></para>
-                        </listitem>
-                      </orderedlist></para>
-                  </listitem>
-                </itemizedlist></para>
-
-              <indexterm>
-                <primary>configuring</primary>
-
-                <secondary>AFS server partition on server machine after first</secondary>
-
-                <tertiary>IRIX</tertiary>
-              </indexterm>
-
-              <indexterm>
-                <primary>AFS server partition</primary>
-
-                <secondary>configuring on server machine after first</secondary>
-
-                <tertiary>IRIX</tertiary>
-              </indexterm>
-
-              <indexterm>
-                <primary>file server machine, additional</primary>
-
-                <secondary>AFS server partition</secondary>
-
-                <tertiary>on IRIX</tertiary>
-              </indexterm>
-
-              <indexterm>
-                <primary>IRIX</primary>
-
-                <secondary>AFS server partition</secondary>
-
-                <tertiary>on add'l server machine</tertiary>
-              </indexterm>
-            </listitem>
-
-            <listitem id="LIWQ105">
-              <para>Create a directory called <emphasis
-              role="bold">/vicep</emphasis><replaceable>xx</replaceable> for each AFS server partition you are configuring (there
-              must be at least one). Repeat the command for each partition. <programlisting>
-   # <emphasis role="bold">mkdir /vicep</emphasis><replaceable>xx</replaceable>
-</programlisting></para>
-            </listitem>
-
-            <listitem>
-              <para>Add a line with the following format to the file systems registry file, <emphasis
-              role="bold">/etc/fstab</emphasis>, for each partition (or logical volume created with the XLV volume manager) to be
-              mounted on one of the directories created in the previous step.</para>
-
-              <para>For an XFS partition or logical volume:</para>
-
-              <programlisting>
-   /dev/dsk/<replaceable>disk</replaceable>  /vicep<replaceable>xx</replaceable>  xfs  rw,raw=/dev/rdsk/<replaceable>disk</replaceable>  0  0   
-</programlisting>
-
-              <para>For an EFS partition:</para>
-
-              <programlisting>
-   /dev/dsk/<replaceable>disk</replaceable>  /vicep<replaceable>xx</replaceable>  efs  rw,raw=/dev/rdsk/<replaceable>disk</replaceable>  0  0   
-</programlisting>
-
-              <para>The following are examples of an entry for each file system type:</para>
-
-              <programlisting>
-   /dev/dsk/dks0d2s6 /vicepa  xfs rw,raw=/dev/rdsk/dks0d2s6  0 0
-   /dev/dsk/dks0d3s1 /vicepb  efs rw,raw=/dev/rdsk/dks0d3s1  0 0
-</programlisting>
-            </listitem>
-
-            <listitem>
-              <para>Create a file system on each partition that is to be mounted on a <emphasis
-              role="bold">/vicep</emphasis><replaceable>xx</replaceable> directory. The following commands are probably appropriate,
-              but consult the IRIX documentation for more information. In both cases, <replaceable>raw_device</replaceable> is a raw
-              device name like <emphasis role="bold">/dev/rdsk/dks0d0s0</emphasis> for a single disk partition or <emphasis
-              role="bold">/dev/rxlv/xlv0</emphasis> for a logical volume.</para>
-
-              <para>For XFS file systems, include the indicated options to configure the partition or logical volume with inodes
-              large enough to accommodate AFS-specific information:</para>
-
-              <programlisting>
-   # <emphasis role="bold">mkfs -t xfs -i size=512 -l size=4000b</emphasis> <replaceable>raw_device</replaceable>   
-</programlisting>
-
-              <para>For EFS file systems:</para>
-
-              <programlisting>
-   # <emphasis role="bold">mkfs -t efs</emphasis> <replaceable>raw_device</replaceable>
-</programlisting>
-            </listitem>
-
-            <listitem>
-              <para>Mount each partition by issuing either the <emphasis role="bold">mount -a</emphasis> command to mount all
-              partitions at once or the <emphasis role="bold">mount</emphasis> command to mount each partition in turn.</para>
-            </listitem>
-
-            <listitem>
-              <para><emphasis role="bold">(Optional)</emphasis> If you have configured partitions or logical volumes to use XFS,
-              issue the following command to verify that the inodes are configured properly (are large enough to accommodate
-              AFS-specific information). If the configuration is correct, the command returns no output. Otherwise, it specifies the
-              command to run in order to configure each partition or logical volume properly. <programlisting>
-   # <emphasis role="bold">/usr/afs/bin/xfs_size_check</emphasis>
-</programlisting></para>
-            </listitem>
-
-            <listitem>
-              <para>If the machine is to remain an AFS client, incorporate AFS into its authentication system, following the
-              instructions in <link linkend="HDRWQ40">Enabling AFS Login on IRIX Systems</link>.</para>
-            </listitem>
-
-            <listitem>
-              <para>Proceed to <link linkend="HDRWQ108">Starting Server Programs</link>.</para>
-            </listitem>
-          </orderedlist></para>
-      </sect3>
-
       <sect3 id="HDRWQ106">
         <title>Getting Started on Linux Systems</title>
 
                 </listitem>
 
                 <listitem>
-                  <para>On IRIX systems, <emphasis role="bold">/etc/init.d/afs</emphasis></para>
-                </listitem>
-
-                <listitem>
                   <para>On Fedora and RHEL systems, 
                   <emphasis role="bold">/etc/sysconfig/openafs</emphasis>. 
                   Note that this file has a different format from a standard 
               </orderedlist></para>
 
             <indexterm>
-              <primary>IRIX</primary>
-
-              <secondary>AFS initialization script</secondary>
-
-              <tertiary>on add'l server machine</tertiary>
-            </indexterm>
-
-            <indexterm>
-              <primary>afsclient variable (IRIX)</primary>
-
-              <secondary>server machine after first</secondary>
-            </indexterm>
-
-            <indexterm>
-              <primary>variables</primary>
-
-              <secondary>afsclient (IRIX)</secondary>
-
-              <tertiary>server machine after first</tertiary>
-            </indexterm>
-
-            <indexterm>
-              <primary>IRIX</primary>
-
-              <secondary>afsclient variable</secondary>
-
-              <tertiary>server machine after first</tertiary>
-            </indexterm>
-
-            <indexterm>
-              <primary>afsserver variable (IRIX)</primary>
-
-              <secondary>server machine after first</secondary>
-            </indexterm>
-
-            <indexterm>
-              <primary>variables</primary>
-
-              <secondary>afsserver (IRIX)</secondary>
-
-              <tertiary>server machine after first</tertiary>
-            </indexterm>
-
-            <indexterm>
-              <primary>IRIX</primary>
-
-              <secondary>afsserver variable</secondary>
-
-              <tertiary>server machine after first</tertiary>
-            </indexterm>
-
-            <para><emphasis role="bold">On IRIX systems:</emphasis> <orderedlist>
-                <listitem>
-                  <para>If you have configured the machine to use the <emphasis role="bold">ml</emphasis> dynamic loader program,
-                  reboot the machine and log in again as the local superuser <emphasis role="bold">root</emphasis>. <programlisting>
-   # <emphasis role="bold">cd /</emphasis>
-   # <emphasis role="bold">shutdown -i6 -g0 -y</emphasis>
-   login: <emphasis role="bold">root</emphasis>
-   Password: <replaceable>root_password</replaceable>
-</programlisting></para>
-                </listitem>
-
-                <listitem>
-                  <para>Issue the <emphasis role="bold">chkconfig</emphasis> command to activate the <emphasis
-                  role="bold">afsserver</emphasis> configuration variable. <programlisting>
-   # <emphasis role="bold">/etc/chkconfig -f afsserver on</emphasis>   
-</programlisting></para>
-
-                  <para>If you have configured this machine as an AFS client and want to it remain one, also issue the <emphasis
-                  role="bold">chkconfig</emphasis> command to activate the <emphasis role="bold">afsclient</emphasis> configuration
-                  variable.</para>
-
-                  <programlisting>
-   # <emphasis role="bold">/etc/chkconfig -f afsclient on</emphasis> 
-</programlisting>
-                </listitem>
-
-                <listitem>
-                  <para>Run the AFS initialization script. <programlisting>
-   # <emphasis role="bold">/etc/init.d/afs  start</emphasis>
-</programlisting></para>
-                </listitem>
-
-                <listitem>
-                  <para>Change to the <emphasis role="bold">/etc/init.d</emphasis> directory and issue the <emphasis role="bold">ln
-                  -s</emphasis> command to create symbolic links that incorporate the AFS initialization script into the IRIX
-                  startup and shutdown sequence. <programlisting>
-   # <emphasis role="bold">cd /etc/init.d</emphasis>
-   # <emphasis role="bold">ln -s ../init.d/afs /etc/rc2.d/S35afs</emphasis>
-   # <emphasis role="bold">ln -s ../init.d/afs /etc/rc0.d/K35afs</emphasis>
-</programlisting></para>
-                </listitem>
-
-                <listitem>
-                  <para><emphasis role="bold">(Optional)</emphasis> There are now copies of the AFS initialization file in both the
-                  <emphasis role="bold">/usr/vice/etc</emphasis> and <emphasis role="bold">/etc/init.d</emphasis> directories. If
-                  you want to avoid potential confusion by guaranteeing that they are always the same, create a link between them.
-                  You can always retrieve the original script from the AFS CD-ROM if necessary. <programlisting>
-   # <emphasis role="bold">cd /usr/vice/etc</emphasis>
-   # <emphasis role="bold">rm afs.rc</emphasis>
-   # <emphasis role="bold">ln -s  /etc/init.d/afs  afs.rc</emphasis>
-</programlisting></para>
-                </listitem>
-
-                <listitem>
-                  <para>Proceed to Step <link linkend="LIWQ113">4</link>.</para>
-                </listitem>
-              </orderedlist></para>
-
-            <indexterm>
               <primary>Linux</primary>
 
               <secondary>AFS initialization script</secondary>