doc: remove references to AFS's NTP daemon
authorKen Dreyer <kdreyer@usgs.gov>
Wed, 14 Mar 2012 02:06:43 +0000 (20:06 -0600)
committerDerrick Brashear <shadow@dementix.org>
Wed, 21 Mar 2012 03:59:27 +0000 (20:59 -0700)
AFS's own ntpd and runntp are obsolete. Remove them from the
documentation, and recommend the OS vendor-supplied NTP instead.

Change-Id: If0cd837aa407eb49049881790e618ccd75ca6e5b
Reviewed-on: http://gerrit.openafs.org/6903
Tested-by: BuildBot <buildbot@rampaginggeek.com>
Reviewed-by: Alistair Ferguson <alistair.ferguson@mac.com>
Reviewed-by: Derrick Brashear <shadow@dementix.org>

doc/man-pages/pod8/bos_create.pod
doc/man-pages/pod8/bos_status.pod
doc/man-pages/pod8/bos_stop.pod
doc/xml/AdminGuide/auagd008.xml
doc/xml/AdminGuide/auagd009.xml
doc/xml/QuickStartUnix/auqbg005.xml
doc/xml/QuickStartUnix/auqbg006.xml
src/afsinstall/lib/InstallGuides/GENERIC/miscserver
src/afsinstall/lib/InstallGuides/info/miscserver.toc

index 589516e..567462a 100644 (file)
@@ -84,10 +84,6 @@ The Authentication Server process.
 
 The Protection Server process.
 
-=item runntp
-
-The controller process for the Network Time Protocol Daemon (obsolete).
-
 =item upclientbin
 
 The client portion of the Update Server process that retrieves binary
index 82b28b3..8216524 100644 (file)
@@ -235,7 +235,6 @@ machine B<fs3.example.com>:
    Instance fs, has core file, currently running normally.
        Auxiliary status is: file server running.
    Instance upserver, currently running normally.
-   Instance runntp, currently running normally.
 
 The following example command displays a detailed status report for the
 B<fs> and B<ptserver> processes on the machine
index 1db32f3..f1a1071 100644 (file)
@@ -77,10 +77,10 @@ ignored.
 
 =head1 EXAMPLES
 
-The following example command stops the B<upserver> and B<runntp>
+The following example command stops the B<upserver> and B<vlserver>
 processes on the machine C<fs7.example.com>.
 
-   % bos stop -server fs7.example.com -instance upserver runntp
+   % bos stop -server fs7.example.com -instance upserver vlserver
 
 =head1 PRIVILEGE REQUIRED
 
index 773e576..2738f1e 100644 (file)
               <para>The binary for the Authentication Server process.</para>
 
               <indexterm>
-                <primary>ntpd</primary>
-
-                <secondary>binary in /usr/afs/bin</secondary>
-              </indexterm>
-
-              <indexterm>
-                <primary>files</primary>
-
-                <secondary>ntpd</secondary>
-              </indexterm>
-
-              <indexterm>
-                <primary>programs</primary>
-
-                <secondary>ntpd</secondary>
-              </indexterm>
-
-              <indexterm>
-                <primary>processes</primary>
-
-                <secondary>NTPD, binary in /usr/afs/bin</secondary>
-              </indexterm>
-
-              <indexterm>
-                <primary>NTPD</primary>
-              </indexterm>
-
-              <indexterm>
-                <primary>Network Time Protocol Daemon</primary>
-
-                <secondary></secondary>
-
-                <see>NTPD</see>
-              </indexterm>
-            </listitem>
-          </varlistentry>
-
-          <varlistentry>
-            <term><emphasis role="bold">ntpd</emphasis></term>
-
-            <listitem>
-              <para>The binary for the Network Time Protocol Daemon (NTPD). AFS redistributes this binary and uses the <emphasis
-              role="bold">runntp</emphasis> program to configure and initialize the NTPD process.</para>
-
-              <indexterm>
-                <primary>ntpdc</primary>
-
-                <secondary>binary in /usr/afs/bin</secondary>
-              </indexterm>
-
-              <indexterm>
-                <primary>files</primary>
-
-                <secondary>ntpdc</secondary>
-              </indexterm>
-
-              <indexterm>
-                <primary>programs</primary>
-
-                <secondary>ntpdc</secondary>
-              </indexterm>
-            </listitem>
-          </varlistentry>
-
-          <varlistentry>
-            <term><emphasis role="bold">ntpdc</emphasis></term>
-
-            <listitem>
-              <para>A debugging utility furnished with the <emphasis role="bold">ntpd</emphasis> program.</para>
-
-              <indexterm>
                 <primary>files</primary>
 
                 <secondary>pts command binary</secondary>
               <para>The binary for the Protection Server process.</para>
 
               <indexterm>
-                <primary>runntp</primary>
-
-                <secondary>binary in /usr/afs/bin</secondary>
-              </indexterm>
-
-              <indexterm>
-                <primary>runntp</primary>
-
-                <secondary></secondary>
-
-                <see>NTPD</see>
-              </indexterm>
-
-              <indexterm>
-                <primary>files</primary>
-
-                <secondary>runntp</secondary>
-              </indexterm>
-
-              <indexterm>
-                <primary>programs</primary>
-
-                <secondary>runntp</secondary>
-              </indexterm>
-            </listitem>
-          </varlistentry>
-
-          <varlistentry>
-            <term><emphasis role="bold">runntp</emphasis></term>
-
-            <listitem>
-              <para>The binary for the program used to configure NTPD most appropriately for use with AFS.</para>
-
-              <indexterm>
                 <primary>Salvager</primary>
 
                 <secondary>binary in /usr/afs/bin</secondary>
           </listitem>
 
           <listitem>
-            <para>The NTP coordinator (<emphasis role="bold">runntp</emphasis> process), which helps keep the machine's clock
-            synchronized with the clocks on the other server machines in the cell</para>
-          </listitem>
-
-          <listitem>
             <para>A client portion of the Update Server that picks up binary files from the binary distribution machine of its AFS
             system type (the <emphasis role="bold">upclientbin</emphasis> process)</para>
           </listitem>
             United States edition of AFS. The client portion of the Update Server (<emphasis role="bold">upclientetc</emphasis>
             process) runs on the other server machines and references the system control machine.</para>
           </listitem>
-
-          <listitem>
-            <para>The NTP coordinator (<emphasis role="bold">runntp</emphasis> process) which points to a time source outside the
-            cell, if the cell uses NTPD to synchronize its clocks. The <emphasis role="bold">runntp</emphasis> process on other
-            machines reference the system control machine as their main time source.</para>
-          </listitem>
         </itemizedlist></para>
 
       <para>The system control machine can also run the processes that define a simple file server machine, as listed in <link
             <listitem>
               <para>Keep the clocks synchronized on all machines in the cell, especially the database server machines.</para>
 
-              <para>In the conventional configuration specified in the <emphasis>OpenAFS Quick Beginnings</emphasis>, you run the
-              <emphasis role="bold">runntp</emphasis> process to supervise the local Network Time Protocol Daemon (NTPD) on every
-              AFS server machine. The NTPD on the system control machine synchronizes its clock with a reliable source outside the
-              cell and broadcasts the time to the NTPDs on the other server machines. You can choose to run a different time
-              synchronization protocol if you wish.</para>
-
               <para>Keeping clocks synchronized is important because the Ubik processes at a database's sites timestamp the messages
               which they exchange to maintain constant contact. Timestamping the messages is necessary because in a networked
               environment it is not safe to assume that a message reaches its destination instantly. Ubik compares the timestamp on
index 5fcc2de..f04472b 100644 (file)
         </itemizedlist></para>
     </sect2>
 
-    <sect2 id="HDRWQ151">
-      <title>The runntp Process</title>
-
-      <indexterm>
-        <primary>runntp process</primary>
-      </indexterm>
-
-      <indexterm>
-        <primary>ntpd</primary>
-
-        <secondary>invoked by runntp process</secondary>
-      </indexterm>
-
-      <indexterm>
-        <primary>server process</primary>
-
-        <secondary>runntp</secondary>
-      </indexterm>
-
-      <para>The <emphasis role="bold">runntp</emphasis> process, which runs on every server machine, is a controller program for the
-      Network Time Protocol Daemon (NTPD), which synchronizes the hardware clocks on server machines. You need to run the <emphasis
-      role="bold">runntp</emphasis> process if you are not already running NTP or another time synchronization protocol on your
-      server machines.</para>
-
-      <para>The clocks on database server machines need to be synchronized because AFS's distributed database technology (Ubik)
-      works properly only when the clocks agree within a narrow range of variation (see <link linkend="HDRWQ103">Configuring the
-      Cell for Proper Ubik Operation</link>). The clocks on file server machines need to be correct not only because the File Server
-      sets modification time stamps on files, but because in the conventional configuration they serve as the time source for AFS
-      client machines.</para>
-
-      <para>The process appears as <computeroutput>runntp</computeroutput> in the <emphasis role="bold">bos status</emphasis>
-      command's output, if the conventional name is assigned. It appears in the output from the <emphasis role="bold">ps</emphasis>
-      command as <computeroutput>/usr/afs/bin/runntp</computeroutput>. The <emphasis role="bold">ps</emphasis> command's output also
-      includes an entry called <computeroutput>ntpd</computeroutput>; its exact form depends on the arguments you provide to the
-      <emphasis role="bold">runntp</emphasis> command.</para>
-
-      <indexterm>
-        <primary>ntpd</primary>
-
-        <secondary>when to contact</secondary>
-      </indexterm>
-
-      <indexterm>
-        <primary>contacting processes</primary>
-
-        <secondary>NTPD</secondary>
-      </indexterm>
-
-      <para>As a system administrator, you do not contact the NTPD directly once you have installed it according to the instructions
-      in the <emphasis>OpenAFS Quick Beginnings</emphasis>.</para>
-    </sect2>
-
     <sect2 id="HDRWQ152">
       <title>The upserver and upclient Processes: the Update Server</title>
 
    Instance fs, currently running normally.
        Auxiliary status is: file server running.
    Instance upserver, currently running normally.
-   Instance runntp, currently running normally.
    Instance backupusers, currently running normally.
        Auxiliary status is: run next at Mon Jun 7 02:00:00 1999.
 </programlisting>
                       </listitem>
 
                       <listitem>
-                        <para><emphasis role="bold">runntp</emphasis> for the controller process for the Network Time Protocol
-                        Daemon</para>
-                      </listitem>
-
-                      <listitem>
                         <para><emphasis role="bold">upclientbin</emphasis> for the client portion of the Update Server that
                         references the binary distribution machine of this machine's system type</para>
                       </listitem>
index 4405bb9..d3709aa 100644 (file)
         </listitem>
 
         <listitem>
-          <para>You have a NTP, or similar, time service deployed to ensure 
-          rough clock syncronistation between your clients and servers. If you
-          wish to use AFS's built in timeservice (which is deprecated) please
-          see Appendix B for the necessary modifications to this installation
-          procedure.</para>
+          <para>You have NTP or a similar time service deployed to ensure
+          rough clock syncronistation between your clients and servers.</para>
         </listitem>
       </itemizedlist></para>
 
@@ -3984,18 +3981,16 @@ Entry for principal afs/&lt;<replaceable>cell name</replaceable>&gt; with kvno 3
   </sect1>
 
   <sect1 id="HDRWQ62">
-    <title>Starting the Controller for NTPD</title>
+    <title>Clock Sync Considerations</title>
 
     <para>Keeping the clocks on all server and client machines in your cell synchronized is crucial to several functions, and in
     particular to the correct operation of AFS's distributed database technology, Ubik. The chapter in the <emphasis>OpenAFS
     Administration Guide</emphasis> about administering server machines explains how time skew can disturb Ubik's performance and
     cause service outages in your cell.</para>
 
-    <para>Historically, AFS used to distribute its own version of the Network 
-Time Protocol Daemon. Whilst this is still provided for existing sites, we 
-recommend that you configure and install your time service independently of 
-AFS. A reliable timeservice will also be required by your Kerberos realm, 
-and so may already be available at your site.</para>
+    <para>You should install and configure your time service independently of
+    AFS. Your Kerberos realm will also require a reliable time source, so your site
+    may already have one available.</para>
 
     <indexterm>
       <primary>overview</primary>
index b471350..69d6429 100644 (file)
     <sect2 id="HDRWQ108">
       <title>Starting Server Programs</title>
 
-      <para>In this section you initialize the BOS Server, the Update Server, the controller process for NTPD, and the <emphasis
+      <para>In this section you initialize the BOS Server, the Update Server, and the <emphasis
       role="bold">fs</emphasis> process. You begin by copying the necessary server files to the local disk. <orderedlist>
           <indexterm>
             <primary>copying</primary>
               </itemizedlist>
 
             <indexterm>
-              <primary>runntp process</primary>
-
-              <secondary>server machine after first</secondary>
-            </indexterm>
-
-            <indexterm>
-              <primary>starting</primary>
-
-              <secondary>runntp process</secondary>
-
-              <tertiary>server machine after first</tertiary>
-            </indexterm>
-
-            <indexterm>
-              <primary>file server machine, additional</primary>
-
-              <secondary>runntp process</secondary>
-            </indexterm>
-
-            <indexterm>
-              <primary>NTPD</primary>
-
-              <secondary>server machine after first</secondary>
-            </indexterm>
-          </listitem>
-
-          <listitem>
-          
-            <note>
-              <para>Historically, AFS provided its own version of the
-              Network Time Protocol Daemon. Whilst this is still provided for
-              existing sites, we recommend that you configure and run your
-              own timeservice independently of AFS. The instructions below are
-              provided for those sites still reliant upon OpenAFS's ntp system.
-              </para>
-            </note>
-            
-            <para>Start the <emphasis role="bold">runntp</emphasis> process, which configures the Network Time Protocol Daemon
-            (NTPD) to choose a database server machine chosen randomly from the local <emphasis
-            role="bold">/usr/afs/etc/CellServDB</emphasis> file as its time source. In the standard configuration, the first
-            database server machine installed in your cell refers to a time source outside the cell, and serves as the basis for
-            clock synchronization on all server machines. <programlisting>
-   # <emphasis role="bold">./bos create</emphasis>  &lt;<replaceable>machine name</replaceable>&gt; <emphasis role="bold">runntp simple</emphasis>  \ 
-         <emphasis role="bold">/usr/afs/bin/runntp -cell</emphasis> &lt;<replaceable>cell name</replaceable>&gt;  <emphasis
-                  role="bold">-noauth</emphasis>
-</programlisting></para>
-
-            <note>
-              <para>Do not run the <emphasis role="bold">runntp</emphasis> process if NTPD or another time synchronization protocol
-              is already running on the machine. Some versions of some operating systems run a time synchronization program by
-              default, as detailed in the <emphasis>OpenAFS Release Notes</emphasis>.</para>
-
-              <para>Attempting to run multiple instances of the NTPD causes an error. Running NTPD together with another time
-              synchronization protocol is unnecessary and can cause instability in the clock setting.</para>
-            </note>
-
-            <indexterm>
               <primary>File Server</primary>
 
               <secondary>server machine after first</secondary>
index 79c2915..52851d0 100644 (file)
@@ -17,11 +17,7 @@ sub miscserver {
 &Copy ("root.server/usr/afs/bin/buserver", "/usr/afs/bin");
 &Copy ("root.server/usr/afs/bin/upserver", "/usr/afs/bin");
 &Copy ("root.server/usr/afs/bin/upclient", "/usr/afs/bin");
-&Copy ("root.server/usr/afs/bin/runntp",   "/usr/afs/bin");
-&Copy ("root.server/usr/afs/bin/ntpd",     "/usr/afs/bin");
 &Chmod(0744, "/usr/afs/bin/buserver");
 &Chmod(0744, "/usr/afs/bin/upserver");
 &Chmod(0744, "/usr/afs/bin/upclient");
-&Chmod(0744, "/usr/afs/bin/runntp");
-&Chmod(0744, "/usr/afs/bin/ntpd");
 }
index b757a08..ec8fe07 100644 (file)
@@ -15,6 +15,4 @@ sub miscserver {
 &Print("  root.server/usr/afs/bin/buserver");
 &Print("  root.server/usr/afs/bin/upserver");
 &Print("  root.server/usr/afs/bin/upclient");
-&Print("  root.server/usr/afs/bin/runntp");
-&Print("  root.server/usr/afs/bin/ntpd");
 }