Browse Source

HPCC-17422 DOCS:Documentation for BackupNode

Fix HPCC-17422 DOCS:Documentation for BackupNode
Add to documentation to Config Manager book for backupnode.
Includes updating several images.

Signed-off-by: G-Pan <greg.panagiotatos@lexisnexis.com>
G-Pan 8 years ago
parent
commit
ff88fb1954

+ 8 - 4
docs/HPCCSystemAdmin/HPCCSystemAdministratorsGuide.xml

@@ -775,8 +775,8 @@
 
           <para>Thor, the data refinery, as one of the critical components of
           HPCC Systems<superscript>®</superscript> needs to be backed up.
-          Backup Thor by configuring replication and setting up a nightly
-          backup cron task. Backup Thor on demand before and/or after any node
+          Backup Thor by configuring replication and setting up a nightly back
+          up cron task. Backup Thor on demand before and/or after any node
           swap or drive swap if you do not have a RAID configured.</para>
 
           <para>A very important part of administering Thor is to check the
@@ -786,8 +786,9 @@
 
           <para>Backupnode is a tool that is packaged with HPCC. Backupnode
           allows you to backup Thor nodes on demand or in a script. You can
-          also use backupnode regularly in a crontab. You would always want to
-          run it on the Thor master of that cluster.</para>
+          also use backupnode regularly in a crontab or by adding a backupnode
+          component with Configuration Manager to your environment. You would
+          always want to run it on the Thor master of that cluster.</para>
 
           <para>The following example is one suggested way for invoking
           backupnode manually.</para>
@@ -803,6 +804,9 @@
 
           <programlisting>  /bin/su - hpcc -c "/opt/HPCCSystems/bin/start_backupnode thor400_7s" &amp; </programlisting>
 
+          <para><emphasis role="bold">Backupnode run regularly</emphasis>
+          </para>
+
           <para>To run backupnode regularly you could use cron. For example,
           you may want a crontab entry (to backup thor400_7s) set to run at
           1am daily:</para>

+ 66 - 2
docs/UsingConfigManager/UsingConfigManager.xml

@@ -706,6 +706,70 @@ sudo -u hpcc cp /etc/HPCCSystems/source/NewEnvironment.xml /etc/HPCCSystems/envi
       environment XML file.</para>
 
       <sect2 role="brk">
+        <title>Backupnode</title>
+
+        <para>Backupnode allows you to back up Thor clusters at regular
+        intervals. The Backupnode component is a way to allow administrators
+        to manage the backupnode process without using a cron job.</para>
+
+        <para>To configure scheduled Thor node backups, add the backupnode
+        component, choose the hardware instance to run it on and then add Thor
+        groups to it. <graphic fileref="images/CM-img21.jpg"
+        vendor="configmgrSS" /></para>
+
+        <para><orderedlist>
+            <listitem>
+              <para>Right click on the <emphasis
+              role="bold">Software</emphasis> component in the <emphasis
+              role="bold">Navigator</emphasis> panel (on the right side),
+              choose <emphasis role="bold">New Components</emphasis> then
+              <emphasis role="bold">backupnode</emphasis> from the drop
+              list.</para>
+            </listitem>
+
+            <listitem>
+              <para>From the tabs on the right side, select the <emphasis
+              role="bold">Instances</emphasis> tab.</para>
+            </listitem>
+
+            <listitem>
+              <para>Right click on the <emphasis
+              role="bold">computer</emphasis> column and choose <emphasis
+              role="bold">Add Instances</emphasis>...<graphic
+              fileref="images/CM-img22.jpg" vendor="configmgrSS" /></para>
+            </listitem>
+
+            <listitem>
+              <para>Select the computer for the backupnode component, or press
+              <emphasis role="bold">Add Hardware</emphasis> to add a new
+              computer instance. You would always want to run backupnode on
+              the Thor master of the cluster.</para>
+            </listitem>
+
+            <listitem>
+              <para>Select the <emphasis role="bold">Thor Node
+              Groups</emphasis> tab.</para>
+            </listitem>
+
+            <listitem>
+              <para>Right click on the the <emphasis
+              role="bold">Interval</emphasis> column and choose the interval
+              and/or Thor group to back up.</para>
+            </listitem>
+
+            <listitem>
+              <para>Click the <inlinegraphic fileref="images/GS-img01c.png" />
+              disk icon to save</para>
+            </listitem>
+          </orderedlist>The default backup locations are:</para>
+
+        <programlisting> /var/lib/HPCCSystems/hpcc-data/backupnode/&lt;thorname&gt;/last_backup </programlisting>
+
+        <para>The interval attribute of the backupnode component determines
+        how many hours between backups.</para>
+      </sect2>
+
+      <sect2 role="brk">
         <title>Dali</title>
 
         <sect3>
@@ -1184,7 +1248,7 @@ sudo -u hpcc cp /etc/HPCCSystems/source/NewEnvironment.xml /etc/HPCCSystems/envi
             </listitem>
 
             <listitem>
-              <para>Select <emphasis role="bold">Drop Zone</emphasis> </para>
+              <para>Select <emphasis role="bold">Drop Zone</emphasis></para>
             </listitem>
           </orderedlist>
         </para>
@@ -1207,7 +1271,7 @@ sudo -u hpcc cp /etc/HPCCSystems/source/NewEnvironment.xml /etc/HPCCSystems/envi
 
               <listitem>
                 <para>Double-click on the value on the right side of the
-                attribute table for the value you wish to modify. </para>
+                attribute table for the value you wish to modify.</para>
 
                 <para>For example, select the <emphasis
                 role="bold">name</emphasis> attribute, double click on the

BIN
docs/images/CM-111.jpg


BIN
docs/images/CM-112.jpg


BIN
docs/images/CM-120.jpg


BIN
docs/images/CM-121.jpg


BIN
docs/images/CM-160.jpg


BIN
docs/images/CM-161.jpg


BIN
docs/images/CM-161a.jpg


BIN
docs/images/CM-190.jpg


BIN
docs/images/CM-ECLCC-01.jpg


BIN
docs/images/CM-ECLCC-02.jpg


BIN
docs/images/CM-Sasha17A.jpg


BIN
docs/images/CM-img01.jpg


BIN
docs/images/CM-img04-1.jpg


BIN
docs/images/CM-img04-2.jpg


BIN
docs/images/CM-img04.jpg


BIN
docs/images/CM-img05-1.jpg


BIN
docs/images/CM-img05-2.jpg


BIN
docs/images/CM-img05.jpg


BIN
docs/images/CM-img07-1.jpg


BIN
docs/images/CM-img07-2.jpg


BIN
docs/images/CM-img07.jpg


BIN
docs/images/CM-img08-1.jpg


BIN
docs/images/CM-img08-2.jpg


BIN
docs/images/CM-img08-3.jpg


BIN
docs/images/CM-img08.jpg


BIN
docs/images/CM-img09-1.jpg


BIN
docs/images/CM-img09-2.jpg


BIN
docs/images/CM-img09-2b.jpg


BIN
docs/images/CM-img09.jpg


BIN
docs/images/CM-img10.jpg


BIN
docs/images/CM-img12-1.jpg


BIN
docs/images/CM-img15.jpg


BIN
docs/images/CM-img17-1.jpg


BIN
docs/images/CM-img17-2.jpg


BIN
docs/images/CM-img17.jpg


BIN
docs/images/CM-img18-1.jpg


BIN
docs/images/CM-img18-4.jpg


BIN
docs/images/CM-img21.jpg


BIN
docs/images/CM-img22.jpg