Merge pull request #6250 from hpcc-systems/revert-6235-11903UpdateDocsScripts

Revert "HPCC-11903 Update Docs for scripts that write to logs"

Reviewed-By: Richard Chapman <rchapman@hpccsystems.com>

docs/Installing_and_RunningTheHPCCPlatform/Inst-Mods/hpcc_ldap.xml

@@ -60,7 +60,7 @@
 
         <listitem>
           <para>Verify that they are stopped. You can use a single command,
-          such as : <programlisting>sudo /opt/HPCCSystems/sbin/hpcc-run.sh -a hpcc-init status</programlisting></para>
+          such as : <programlisting>sudo -u hpcc /opt/HPCCSystems/sbin/hpcc-run.sh -a hpcc-init status</programlisting></para>
         </listitem>
 
         <listitem>
@@ -218,7 +218,7 @@
 
         <listitem>
           <para>Verify that they are stopped. You can use a single command,
-          such as : <programlisting>sudo /opt/HPCCSystems/sbin/hpcc-run.sh -a hpcc-init status</programlisting></para>
+          such as : <programlisting>sudo -u hpcc /opt/HPCCSystems/sbin/hpcc-run.sh -a hpcc-init status</programlisting></para>
         </listitem>
 
         <listitem>
@@ -560,19 +560,19 @@
       “hpccinternal::&lt;user&gt;” file scope is also created granting new
       users full access to that scope and restricting access to other users.
       This file scope is used to store temporary HPCC files such as spill
-      files and temp files.</para>
+      files and temp files. </para>
 
       <para>If you are enabling LDAP file scope security and already have user
       accounts, you should run the addScopes utility program to create the
-      hpccinternal::&lt;user&gt; scope for those existing users.</para>
+      hpccinternal::&lt;user&gt; scope for those existing users. </para>
 
       <para>Users which already have this scope defined are ignored and so it
-      can be used on both new and legacy ESP user accounts safely.</para>
+      can be used on both new and legacy ESP user accounts safely. </para>
 
       <para>The tool is located in the <emphasis
       role="bold">/opt/HPCCSystems/bin/</emphasis> folder and to run it you
       must pass the location of <emphasis role="bold">daliconf.xml</emphasis>,
-      for example:</para>
+      for example: </para>
 
       <para><programlisting>/opt/HPCCSystems/bin/addScopes /var/lib/HPCCSystems/mydali/daliconf.xml</programlisting></para>
     </sect3>

docs/Installing_and_RunningTheHPCCPlatform/Installing_and_RunningTheHPCCPlatform.xml

@@ -1613,7 +1613,7 @@ sudo -u hpcc cp /etc/HPCCSystems/source/NewEnvironment.xml /etc/HPCCSystems/envi
             all nodes. A sample script is provided with HPCC. The following
             command copies the XML files out to all nodes as required:</para>
 
-            <para><programlisting>sudo /opt/HPCCSystems/sbin/hpcc-push.sh -s &lt;sourcefile&gt; -t &lt;destinationfile&gt;
+            <para><programlisting>sudo -u hpcc /opt/HPCCSystems/sbin/hpcc-push.sh &lt;sourcefile&gt; &lt;destinationfile&gt;
 </programlisting>See the appendix for more information on using this
             script.</para>
           </listitem>
@@ -1656,7 +1656,7 @@ sudo -u hpcc cp /etc/HPCCSystems/source/NewEnvironment.xml /etc/HPCCSystems/envi
                     <entry><para>You may want to create a script to push this
                     command out to every node. A sample script is provided
                     with HPCC. Use the following command to start HPCC on all
-                    nodes:</para><para><programlisting>sudo /opt/HPCCSystems/sbin/hpcc-run.sh -a hpcc-init start</programlisting></para></entry>
+                    nodes:</para><para><programlisting>sudo -u hpcc /opt/HPCCSystems/sbin/hpcc-run.sh -a hpcc-init start</programlisting></para></entry>
                   </row>
                 </tbody>
               </tgroup>
@@ -2625,7 +2625,9 @@ OUTPUT(ValidWords)
                 <entry><inlinegraphic fileref="images/caution.png" /></entry>
 
                 <entry>Make sure that you have the sufficient privileges to
-                sudo as an administrator to use the scripts. </entry>
+                sudo as an administrator to use the install-cluster.sh script.
+                To use the hpcc-push.sh or hpcc-run.sh scripts, you must sudo
+                as user <emphasis role="bold">hpcc</emphasis>.</entry>
               </row>
             </tbody>
           </tgroup>
@@ -2755,14 +2757,14 @@ OUTPUT(ValidWords)
                   <entry>-c</entry>
 
                   <entry>When specified, this option adds the target directory
-                  or jar file path to classpath in environment.conf.</entry>
+                  or jar file path to classpath in environment.conf. </entry>
                 </row>
 
                 <row>
                   <entry>-e</entry>
 
                   <entry>When specified, this denotes the target is to be
-                  removed from the classpath.</entry>
+                  removed from the classpath. </entry>
                 </row>
 
                 <row>
@@ -2815,7 +2817,7 @@ OUTPUT(ValidWords)
                   password to run ssh/scp. Without specifying this option you
                   will be prompted to supply a username and password. We
                   strongly recommend not using &lt;hpcc user&gt; to avoid
-                  security issues.</entry>
+                  security issues. </entry>
                 </row>
 
                 <row>
@@ -2877,11 +2879,11 @@ OUTPUT(ValidWords)
         <para>The IP addresses were defined when editing the environment in
         ConfigMgr.</para>
 
-        <para><programlisting>sudo /opt/HPCCSystems/sbin/hpcc-push.sh -s &lt;sourcefile&gt; -t &lt;destinationfile&gt;
+        <para><programlisting>sudo -u hpcc /opt/HPCCSystems/sbin/hpcc-push.sh &lt;sourcefile&gt; &lt;destinationfile&gt;
 </programlisting>For example:</para>
 
-        <para><programlisting>sudo  /opt/HPCCSystems/sbin/hpcc-push.sh \
-            -s /etc/HPCCSystems/environment.xml -t /etc/HPCCSystems/environment.xml
+        <para><programlisting>sudo -u hpcc /opt/HPCCSystems/sbin/hpcc-push.sh \
+             /etc/HPCCSystems/environment.xml /etc/HPCCSystems/environment.xml
 </programlisting></para>
       </sect2>
 
@@ -2925,7 +2927,7 @@ OUTPUT(ValidWords)
                   <entry>-S</entry>
 
                   <entry>When specified, the command runs sequentially, one
-                  host at a time.</entry>
+                  host at a time. </entry>
                 </row>
 
                 <row>
@@ -2939,7 +2941,7 @@ OUTPUT(ValidWords)
           </informaltable></para>
 
         <para>To use this script, the ssh keys need to be properly configured
-        on all nodes, and you must sudo. </para>
+        on all nodes, and you must sudo as user hpcc.</para>
 
         <para><emphasis role="bold">This script runs a command on all IP
         addresses in the active environment.xml. </emphasis></para>
@@ -2952,32 +2954,24 @@ OUTPUT(ValidWords)
 
         <para>This example starts all components on the nodes</para>
 
-        <para><programlisting>sudo /opt/HPCCSystems/sbin/hpcc-run.sh -a hpcc-init start
+        <para><programlisting>sudo -u hpcc /opt/HPCCSystems/sbin/hpcc-run.sh -a hpcc-init start
 </programlisting></para>
 
         <para>This example starts all components on all the nodes, using 8
         concurrent executions</para>
 
-        <para><programlisting>sudo /opt/HPCCSystems/sbin/hpcc-run.sh -n 8 -a hpcc-init start 
-</programlisting></para>
-
-        <para>This example starts all components on all the nodes
-        sequentially</para>
-
-        <para><programlisting>sudo /opt/HPCCSystems/sbin/hpcc-run.sh -S -a hpcc-init start 
-</programlisting></para>
-
-        <para>This example starts all components of the esp type on the
+        <para><programlisting>sudo -u hpcc /opt/HPCCSystems/sbin/hpcc-run.sh -a hpcc-init start -n 8
+</programlisting>This example starts all components of the esp type on the
         nodes</para>
 
-        <para><programlisting>sudo /opt/HPCCSystems/sbin/hpcc-run.sh -c esp -a hpcc-init start 
+        <para><programlisting>sudo -u hpcc /opt/HPCCSystems/sbin/hpcc-run.sh -c esp -a hpcc-init start 
 </programlisting>This example starts all components with a component name
         myesp on the nodes</para>
 
-        <para><programlisting>sudo /opt/HPCCSystems/sbin/hpcc-run.sh -c myesp -a hpcc-init start 
+        <para><programlisting>sudo -u hpcc /opt/HPCCSystems/sbin/hpcc-run.sh -c myesp -a hpcc-init start 
 </programlisting>This example starts the dafilesrv helper application</para>
 
-        <para><programlisting>sudo /opt/HPCCSystems/sbin/hpcc-run.sh -a dafilesrv start
+        <para><programlisting>sudo -u hpcc /opt/HPCCSystems/sbin/hpcc-run.sh -a dafilesrv start
 </programlisting></para>
       </sect2>
     </sect1>