-
Notifications
You must be signed in to change notification settings - Fork 302
/
ConfiguringHPCC.xml
2712 lines (2019 loc) · 93.3 KB
/
ConfiguringHPCC.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
<book xml:base="../">
<bookinfo>
<title>Configuring the HPCC System</title>
<mediaobject>
<imageobject>
<imagedata fileref="images/redswooshWithLogo3.jpg" />
</imageobject>
</mediaobject>
<author>
<surname>Boca Raton Documentation Team</surname>
</author>
<legalnotice>
<para>We welcome your comments and feedback about this document via
email to <email>docfeedback@hpccsystems.com</email></para>
<para>Please include <emphasis role="bold">Documentation
Feedback</emphasis> in the subject line and reference the document name,
page numbers, and current Version Number in the text of the
message.</para>
<para>LexisNexis and the Knowledge Burst logo are registered trademarks
of Reed Elsevier Properties Inc., used under license.</para>
<para>HPCC Systems<superscript>®</superscript> is a registered trademark
of LexisNexis Risk Data Management Inc.</para>
<para>Other products, logos, and services may be trademarks or
registered trademarks of their respective companies.</para>
<para>All names and example data used in this manual are fictitious. Any
similarity to actual persons, living or dead, is purely
coincidental.</para>
<para />
</legalnotice>
<xi:include href="common/Version.xml"
xpointer="xpointer(//*[@id='FooterInfo'])"
xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="common/Version.xml"
xpointer="xpointer(//*[@id='DateVer'])"
xmlns:xi="http://www.w3.org/2001/XInclude" />
<corpname>HPCC Systems<superscript>®</superscript></corpname>
<xi:include href="common/Version.xml"
xpointer="xpointer(//*[@id='Copyright'])"
xmlns:xi="http://www.w3.org/2001/XInclude" />
<mediaobject role="logo">
<imageobject>
<imagedata fileref="images/LN_Rightjustified.jpg" />
</imageobject>
</mediaobject>
</bookinfo>
<chapter id="Buildin-HPCC-from-Source">
<title>Using Configuration Manager</title>
<para>Configuration Manager is the utility with which we configure the
HPCC platform. The HPCC platform's configuration is stored in an XML file
named <emphasis role="bold">environment.xml</emphasis>. When you install a
package, a default single-node environment.xml is generated. After that,
you can use the Configuration Manager to modify it and add nodes and
configure components.</para>
<para>The Configuration Manager Wizard creates a similar file, but after
it is generated, you must rename it and put it into place on each
node.</para>
<para>Configuration Manager also offers an <emphasis role="bold">Advanced
View</emphasis> which allows you to add instances of components or change
the default settings for components. Even if you plane to use Advanced
View, it is a good idea to start with a wizard generated configuration and
use Advanced View to finish it.</para>
<para>This document will guide you through configuring an HPCC environment
using the Configuration Manager.</para>
<sect1 id="configuring-a-multi-node-system">
<title>Running the Configuration Manager</title>
<para>This document will guide you through configuring an HPCC
environment using the Configuration Manager.</para>
<para>The HPCC package should already be installed on ALL nodes.</para>
<para>You can use any tool or shell script you choose.</para>
<orderedlist>
<listitem>
<para>SSH to a node in your environment and login as a user with
sudo privileges. We would suggest that it would be the first node,
and that it is a support node, however that is up to your
discretion.</para>
</listitem>
<listitem>
<para>Start the Configuration Manager service on the node (again we
would suggest that it should be on a support node, and further that
you use the same node to start the Configuration Manager every time,
but this is also entirely up to you).</para>
<programlisting>sudo /opt/HPCCSystems/sbin/configmgr</programlisting>
<para><graphic fileref="images/gs_img_configmgrStart.jpg" /></para>
</listitem>
<listitem>
<para>Using a Web browser, go to the Configuration Manager's
interface:</para>
<programlisting>http://<<emphasis>ip of installed system</emphasis>>:8015</programlisting>
<para>The Configuration Manager startup wizard displays.</para>
</listitem>
</orderedlist>
<para>There are different ways to configure your HPCC system. You can
use the <emphasis role="bold">Generate environment wizard</emphasis> and
use that environment or experienced users can then use the <emphasis
role="bold">Advanced View</emphasis> for more specific customization.
There is also the option of using <emphasis role="bold">Create blank
environment</emphasis> to generate an empty environment that you could
then go in and add only the components you would want.</para>
<sect2 id="Env_Wizard">
<title>Environment Wizard</title>
<orderedlist>
<listitem>
<?dbfo keep-together="always"?>
<para>To use the wizard select the <emphasis role="bold">Generate
new environment using wizard</emphasis> button.</para>
<para><graphic fileref="images/GS_ConfigMgrWizStart.jpg"
vendor="configmgrSS" /></para>
</listitem>
<listitem>
<para>Provide a name for the environment file.</para>
<para>This will then be the name of the configuration XML file.
For example, we will name our environment
<emphasis>NewEnvironment</emphasis> and this will produce a
configuration XML file named
<emphasis>NewEnvironment.xml</emphasis> that we will
use.<emphasis> </emphasis></para>
</listitem>
<listitem>
<para>Press the Next button.</para>
<para>Next you will need to define the IP addresses that your HPCC
system will be using.</para>
</listitem>
<listitem>
<?dbfo keep-together="always"?>
<para>Enter the IP addresses or hostname(s).</para>
<para>IP Addresses can be specified individually using semi-colon
delimiters. You can also specify a range of IPs using a hyphen
(for example, nnn.nnn.nnn.x-y). In the image below, we specified
the IP addresses 10.239.219.1 through 10.239.219.100 using the
range syntax, and also a single IP 10.239.219.111. Alternatively,
you can enter the hostnames.</para>
<para><graphic fileref="images/GS_ConfigMgrWiz002.jpg"
vendor="configmgrSS" /></para>
</listitem>
<listitem>
<para>Press the Next button.</para>
<para>Now you will define how many nodes to use for the Roxie and
Thor clusters.</para>
</listitem>
<listitem>
<?dbfo keep-together="always"?>
<para>Enter the appropriate values as indicated.</para>
<para><graphic fileref="images/GS_CMWiz003.jpg"
vendor="configmgrSS" /></para>
<variablelist>
<varlistentry>
<term>Number of support nodes:</term>
<listitem>
<para>Specify the number of nodes to use for support
components. The default is 1.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Number of nodes for Roxie cluster:</term>
<listitem>
<para>Specify the number of nodes to use for your Roxie
cluster. Enter zero (0) if you do not want a Roxie
cluster.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Number of slave nodes for Thor cluster</term>
<listitem>
<para>Specify the number of slave nodes to use in your Thor
cluster. A Thor master node will be added automatically.
Enter zero (0) if you do not want any Thor slaves.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Number of Thor slaves per node (default 1)</term>
<listitem>
<para>Specify the number of Thor slave processes to
instantiate on each slave node. Enter zero (0) if you do not
want a Thor cluster.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Enable Roxie on demand</term>
<listitem>
<para>Specify whether or not to allow queries to be run
immediately on Roxie. This must be enabled to run the
debugger. (Default is true)</para>
</listitem>
</varlistentry>
</variablelist>
</listitem>
<listitem>
<para>Press the <emphasis role="bold">Next</emphasis>
button</para>
<para>The wizard displays the configuration parameters.</para>
</listitem>
<listitem>
<?dbfo keep-together="always"?>
<para>Press the <emphasis role="bold">Finish</emphasis> button to
accept these values or press the <emphasis role="bold">Advanced
View</emphasis> button to edit in advanced mode.</para>
<graphic fileref="images/GS_ConfigMgrWiz004.jpg" />
</listitem>
</orderedlist>
<para>You will now be notified that you have completed the
wizard.</para>
<para><graphic fileref="images/GS_ConfigMgrWiz005.jpg" /></para>
<para>At this point, you have created a file named NewEnvironment.xml
in the <emphasis role="bold">/etc/HPCCSystems/source</emphasis>
directory</para>
<informaltable colsep="1" frame="all" rowsep="1">
<?dbfo keep-together="always"?>
<tgroup cols="2">
<colspec colwidth="49.50pt" />
<colspec />
<tbody>
<row>
<entry><inlinegraphic fileref="images/OSSgr3.png" /></entry>
<entry>Keep in mind, that your HPCC configuration may be
different depending on your needs. For example, you may not
need a Roxie or you may need several smaller Roxie clusters.
In addition, in a production [Thor] system, you would ensure
that Thor and Roxie nodes are dedicated and have no other
processes running on them. This document is intended to show
you how to use the configuration tools. Capacity planning and
system design is covered in a training module.</entry>
</row>
</tbody>
</tgroup>
</informaltable>
<sect3 id="Distrib_Conf" role="brk">
<title>Distribute the Configuration</title>
<orderedlist>
<listitem>
<?dbfo keep-together="always"?>
<para>Stop the HPCC system.</para>
<para>If it is running stop the HPCC system (on every node),
using a command such as this:</para>
<xi:include href="Installing_and_RunningTheHPCCPlatform/Inst-Mods/SysDStop.xml"
xpointer="element(/1)"
xmlns:xi="http://www.w3.org/2001/XInclude" />
<variablelist>
<varlistentry>
<term>Note:</term>
<listitem>
<para>You may have a multi-node system and a custom script
such as the one illustrated in Appendix of the <emphasis
role="bluebold">Installing and Running the HPCC
Platform</emphasis> document to start and stop your
system. If that is the case please use the appropriate
command for stopping your system on every node.</para>
</listitem>
</varlistentry>
</variablelist>
<para><informaltable colsep="1" frame="all" rowsep="1">
<tgroup cols="2">
<colspec colwidth="49.50pt" />
<colspec />
<tbody>
<row>
<entry><inlinegraphic
fileref="images/caution.png" /></entry>
<entry>Be sure HPCC is stopped before attempting to
copy the environment.xml file.</entry>
</row>
</tbody>
</tgroup>
</informaltable></para>
</listitem>
<listitem>
<para>Back up the original environment.xml file.</para>
<programlisting># For example
sudo -u hpcc cp /etc/HPCCSystems/environment.xml /etc/HPCCSystems/source/environment-date.xml </programlisting>
<variablelist>
<varlistentry>
<term>Note:</term>
<listitem>
<para>The live environment.xml file is located in your
<emphasis role="bold">/etc/HPCCSystems/</emphasis>
directory. ConfigManager works on files in <emphasis
role="bold">/etc/HPCCSystems/source</emphasis> directory.
You must copy from this location to make an
environment.xml file active.</para>
</listitem>
</varlistentry>
</variablelist>
<para>You can also choose to give the environment file a more
descriptive name, to help differentiate any differences.</para>
<para>Having environment files under source control is a good
way to archive your environment settings.</para>
</listitem>
<listitem>
<para>Copy the new .xml file from the source directory to the
/etc/HPCCSystems and rename the file to
<emphasis>environment.xml</emphasis></para>
<programlisting># for example
sudo -u hpcc cp /etc/HPCCSystems/source/NewEnvironment.xml /etc/HPCCSystems/environment.xml</programlisting>
<para></para>
</listitem>
<listitem>
<para>Copy the <emphasis
role="bold">/etc/HPCCSystems/environment.xml</emphasis> to the
<emphasis role="bold">/etc/HPCCSystems/</emphasis> on to
<emphasis>every</emphasis> node.</para>
<para>You may want to use a script to push out the XML file to
all nodes. See the <emphasis>Example Scripts</emphasis> section
in the Appendix of the <emphasis role="bluebold">Installing and
Running the HPCC Platform</emphasis> document. You can use the
scripts as a model to create your own script to copy the
environment.xml file out to all your nodes.</para>
</listitem>
<listitem>
<para>Restart the HPCC platform on all nodes.</para>
</listitem>
</orderedlist>
</sect3>
</sect2>
</sect1>
</chapter>
<chapter>
<title>Configuration Manager Advanced View</title>
<para>For the advanced user, the Advanced View offers access to adding
additional instances of components or making configuration settings for
individual components.</para>
<sect1 id="configuring-advanced-setup">
<title>Using ConfigMgr in Advanced Mode</title>
<para>This section shows some of the configuration options in Advanced
Mode. There are a few different ways to configure your system. If you
are not an experienced user you can use the Generate environment wizard
discussed in the previous section. The following steps will detail the
Advanced set up.</para>
<orderedlist>
<listitem>
<para>SSH to the first box in your environment and login as a user
with sudo privileges.</para>
</listitem>
<listitem>
<para>If it is running, stop the HPCC system using this command on
every node:</para>
<xi:include href="Installing_and_RunningTheHPCCPlatform/Inst-Mods/SysDStop.xml"
xpointer="element(/1)"
xmlns:xi="http://www.w3.org/2001/XInclude" />
<variablelist>
<varlistentry>
<term>Note:</term>
<listitem>
<para>If you have a large system with many nodes, you may want
to use a script to perform this step. See the
<emphasis>Example Scripts</emphasis> section in the Appendix
of the <emphasis role="bluebold">Installing and Running the
HPCC Platform</emphasis> document.</para>
</listitem>
</varlistentry>
</variablelist>
<para><informaltable colsep="1" frame="all" rowsep="1">
<?dbfo keep-together="always"?>
<tgroup cols="2">
<colspec colwidth="49.50pt" />
<colspec />
<tbody>
<row>
<entry><inlinegraphic
fileref="images/OSSgr3.png" /></entry>
<entry>You can use this command to confirm HPCC processes
are stopped: <para><programlisting>sudo systemctl status hpccsystems-platform.target</programlisting></para></entry>
</row>
</tbody>
</tgroup>
</informaltable></para>
</listitem>
<listitem>
<para>Start the Configuration Manager service on one node (usually
the first node is considered the head node and is used for this
task, but this is up to you).</para>
<programlisting>sudo /opt/HPCCSystems/sbin/configmgr</programlisting>
<para><graphic fileref="images/gs_img_configmgrStart.jpg" /></para>
</listitem>
<listitem>
<para>Using a Web browser, go to the Configuration Manager's
interface:</para>
<programlisting>http://<<emphasis>ip of installed system</emphasis>>:8015</programlisting>
<para>The Configuration Manager startup wizard displays.</para>
</listitem>
<listitem>
<para>Select <emphasis role="bold">Advanced View</emphasis>, then
press the <emphasis role="bold">Next </emphasis>button.</para>
<para>There are a few different ways to configure your system. If
you are not an experienced user you can use the Generate environment
wizard discussed in the previous section.</para>
</listitem>
<listitem>
<para>Select an XML file from the drop list.</para>
<para>This list is populated from versions of an environment XML
file in your server's /etc/HPCCSystems/source/ directory.</para>
<para>The system will check the current environment file and if a
match is found here it will highlight in blue the current
environment file being used.</para>
</listitem>
<listitem>
<?dbfo keep-together="always"?>
<para>Press the <emphasis role="bold">Next</emphasis> button.
<graphic fileref="images/CM-WizStart.jpg"
vendor="configmgrSS" /></para>
</listitem>
<listitem>
<para>The Configuration Manager interface displays.</para>
<para><informaltable colsep="1" frame="all" rowsep="1">
<?dbfo keep-together="always"?>
<tgroup cols="2">
<colspec colwidth="49.50pt" />
<colspec />
<tbody>
<row>
<entry><inlinegraphic
fileref="images/OSSgr3.png" /></entry>
<entry>Default access is read-only. Many options are only
available when write-access is enabled. <para>Gain write
access by checking the <emphasis role="bold">Write
Access</emphasis> checkbox. </para><para>Unchecking this
box returns the environment to read-only mode. All menu
items are disabled in read-only mode. </para><para>Closing
the web page automatically removes any write-access
locks.</para></entry>
</row>
</tbody>
</tgroup>
</informaltable></para>
</listitem>
<listitem>
<para>Check the <emphasis role="bold">Write Access</emphasis>
box.</para>
<para><graphic fileref="images/CM-img101.jpg"
vendor="configmgrSS" />The <emphasis role="bold">Save</emphasis>
button<inlinegraphic fileref="images/GS-img01c.png"
vendor="configmgrSS" /> validates and saves the environment.</para>
<para>The <emphasis role="bold">Save Environment As</emphasis>
button <inlinegraphic fileref="images/CM-img181.jpg"
vendor="configmgrSS" /> validates and lets you specify the
environment filename to save.</para>
<para>The <emphasis role="bold">Validate Environment</emphasis>
button<inlinegraphic fileref="images/GS-img01d.png"
vendor="configmgrSS" /> just validates the current environment
including any changes that have not yet been saved.</para>
<para>The <emphasis role="bold">Open Environment</emphasis> button
<inlinegraphic fileref="images/CM-img18.jpg" vendor="configmgrSS" />
allows you to open a new environment file to work on.</para>
<para>The <emphasis role="bold">Wizard</emphasis> button
<inlinegraphic fileref="images/CM-img19.jpg" vendor="configmgrSS" />
will bring up the Configuration Manager chooser form which will
allow you to create or view an environment file where you can also
launch the configuration wizard.</para>
<para>These buttons are only enabled in Write Access mode.</para>
</listitem>
</orderedlist>
<sect2 role="brk">
<title>XML View</title>
<para>In the advanced view of Configuration Manager, you can
optionally choose to work with the XML View.</para>
<para>To see the the configuration in XML View, click on the
Environment heading in the Navigator panel on the left side.</para>
<para><graphic fileref="images/CM-120.jpg" />You can access all
attributes through the XML view.</para>
<para>If you wish to add an attribute that does not exist, right-click
on one of the components then you can choose to add an
attribute.</para>
<para><graphic fileref="images/CM-121.jpg" /></para>
</sect2>
</sect1>
<sect1 role="brk">
<title>Hardware Section</title>
<para>This section allows you to define your list of servers. When
defining instances of components, you will choose from servers in this
list.</para>
<orderedlist>
<listitem>
<?dbfo keep-together="always"?>
<para>Select <emphasis role="bold">Hardware</emphasis> in the
Navigator panel on the left side.</para>
<para><graphic fileref="images/CM-img01.jpg"
vendor="configmgrSS" /></para>
</listitem>
<listitem>
<para>Select the <emphasis role="bold">Computers</emphasis>
tab.</para>
</listitem>
<listitem>
<?dbfo keep-together="always"?>
<para>right-click on one of computers listed, then select New
Range.</para>
<para><graphic fileref="images/CM-img02.jpg"
vendor="configmgrSS" /></para>
</listitem>
<listitem>
<para>Specify the following:</para>
<itemizedlist>
<listitem>
<para>Name Prefix - any name that will help you to identify the
node or range</para>
</listitem>
<listitem>
<para>Start IP Address</para>
</listitem>
<listitem>
<para>Stop IP Address</para>
<para>The IP Addresses can be specified in a range if all your
host IP addresses are consecutively numbered. If the IP
addresses are not sequential you should repeat the process for
each individual IP address and just add the IP address in both
the start and stop IP address field. You will then need to
repeat the process for each node.</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<?dbfo keep-together="always"?>
<para>Press the <emphasis role="bold">OK</emphasis> button.</para>
<para>The list of nodes now displays with the nodes that you just
added.</para>
<para><inlinegraphic fileref="images/CM-img03.jpg"
vendor="configmgrSS" /></para>
<para>Next, edit each System Server component instance and set it to
a newly defined node.</para>
<!--***The steps that follow are using one component per node. You can allocate more components per node, if needed.-->
</listitem>
<listitem>
<para>Click the <inlinegraphic fileref="images/GS-img01c.png" />
disk icon to save</para>
</listitem>
<listitem>
<para>Expand the <emphasis role="bold">Software</emphasis> section,
if necessary, in the Navigator panel on the left side, by clicking
on the <inlinegraphic fileref="images/expandButton.png" />
button.</para>
</listitem>
</orderedlist>
</sect1>
<sect1>
<title>Software Section</title>
<para>Use the software components section to configure software
components of the HPCC platform. Most software components are actual
running processes; however, some are just definitions used by the
system. These definitions are used by the configuration
generator.</para>
<para>Items that appear in <emphasis role="red">red</emphasis> indicate
optional values. They are only written to the environment if you add to
or change that value. If untouched, they will not appear in the
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/<thorname>/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>
<title>Instances</title>
<para><orderedlist>
<listitem>
<para>Select <emphasis role="bold">Dali Server</emphasis> in
the Navigator panel on the left side.</para>
</listitem>
<listitem>
<para>Select the Instances tab.</para>
</listitem>
<listitem>
<?dbfo keep-together="always"?>
<para>In the computer column, choose a node from the drop list
as shown below:<graphic fileref="images/CM-img04.jpg"
vendor="configmgrSS" /></para>
</listitem>
<listitem>
<para>Click the <inlinegraphic
fileref="images/GS-img01c.png" /> disk icon to save</para>
</listitem>
</orderedlist></para>
</sect3>
<sect3 role="brk">
<title>DaliServer attributes</title>
<para>This section describes the DaliServer attributes.</para>
<para><graphic fileref="images/CM-img04-1.jpg"
vendor="configmgrSS" /></para>
<para></para>
<!--configMgr-Dali-Server-Include-XXX1-->
<para><xi:include href="../XMLGeneration/xml/dali.xsd.mod.xml"
xpointer="xpointer(//*[@id='da.t1'])"
xmlns:xi="http://www.w3.org/2001/XInclude" /></para>
</sect3>
<?hard-pagebreak ?>
<sect3>
<title>DaliServer store</title>
<para>This section describes the attributes configuring how Dali
handles the system data store.</para>
<para><graphic fileref="images/CM-img04-2.jpg"
vendor="configmgrSS" /></para>
<para></para>
<!--configMgr-Dali-Server-Include-XXX2-->
<para><xi:include href="../XMLGeneration/xml/dali.xsd.mod.xml"
xpointer="xpointer(//*[@id='da.t2'])"
xmlns:xi="http://www.w3.org/2001/XInclude" /></para>
</sect3>
<?hard-pagebreak ?>
<sect3>
<title>DaliServer LDAP options</title>
<para>This section describes the DaliServer LDAP tab.</para>
<para><graphic fileref="images/CM-img04-4.jpg"
vendor="configmgrSS" /></para>
<!--configMgr-DaliServer-LDAP-Include-XXX3-->
<para><xi:include href="../XMLGeneration/xml/dali.xsd.mod.xml"
xpointer="xpointer(//*[@id='da.t4'])"
xmlns:xi="http://www.w3.org/2001/XInclude" /></para>
</sect3>
<sect3>
<title>DaliServer Notes</title>
<para>This tab allows you to add any notes pertinent to the
component's configuration. This can be useful to keep a record of
changes and to communicate this information to peers.</para>
</sect3>
</sect2>
<sect2 id="DaliServerPlugin" role="brk">
<title>DaliServerPlugin</title>
<para>DaliServerPlugin allows you to add plugin functionality to a
Dail server.</para>
<sect3>
<title>DaliServerPlugin attributes</title>
<para>This section describes the DaliServerPlugin attributes.</para>
<para><graphic fileref="images/Cass2.jpg"
vendor="configmgrSS" /></para>
<!--configMgr-daplugin-Include-->
<para><xi:include href="../XMLGeneration/xml/daliplugin.xsd.mod.xml"
xpointer="xpointer(//*[@id='daplug.t'])"
xmlns:xi="http://www.w3.org/2001/XInclude" /></para>
</sect3>
<sect3 role="brk">
<title>DaliServerPlugin Options</title>
<para>This section describes the DaliServerPlugin options</para>
<para>These options are available for the DaliServerplugin when
configuring a Casandra server. See the System Administrator's Guide
for more details about configuring a Cassandra server as a system
datastore.</para>
<para><informaltable colsep="1" frame="all"
id="daliplugoptionstable" rowsep="1">
<tgroup cols="2">
<colspec align="left" colwidth="125.55pt" />
<colspec />
<tbody>
<row>
<entry>randomWuidSuffix</entry>
<entry>An integer value indicating how many randomized
digits to append to workunits. Set this if you need to
create workunits at a high rate to reduce the risk of
collisions (which would slow down the process of creating
a new unique workunit id).</entry>
</row>
<row>
<entry>traceLevel</entry>
<entry>An integer value indicating how much tracing to
output from Cassandra workunit operations. Set to zero or
do not set in normal usage.</entry>
</row>
<row>
<entry>partitions</entry>
<entry>An integer value indicating how many ways to
partition the data on a Cassandra cluster. The default is
2. The value only takes effect when a new Cassandra
workunit repository is created. Larger values permit
scaling to a more distributed store but at the expense of
some overhead on smaller stores where the scaling is not
needed.</entry>
</row>
<row>
<entry>prefixsize</entry>
<entry><para>An integer value specifying the minimum
number of characters that must be provided when wildcard
searching in the repository. Larger values will be more
efficient but also more restrictive on users. The default
is 2. As with partitions, this value only takes effect
when a new Cassandra workunit repository is
created.</para></entry>
</row>
<row>
<entry>keyspace</entry>
<entry>The name of the Cassandra keyspace to use for the
HPCC data store. The default is
<emphasis>hpcc</emphasis>.</entry>
</row>
<row>
<entry>user</entry>
<entry>The username to use if the Cassandra server is
configured to require credentials.</entry>
</row>
<row>
<entry>password</entry>
<entry>The password to use if the Cassandra server is
configured to require credentials.</entry>
</row>
</tbody>
</tgroup>
</informaltable></para>
</sect3>
</sect2>
<sect2 id="Dafilesrv-Process" role="brk">
<title>Dafilesrv Process</title>
<sect3>
<title>Dafilesrv Instances</title>
<para>Dafilesrv is a helper process that every node needs.</para>
<orderedlist>
<listitem>
<para>Select Dafilesrv in the Navigator panel on the left
side.</para>
</listitem>
<listitem>
<para>Select the Instances tab.</para>
</listitem>
<listitem>
<para>Right-click on a computer in the computer column, and
select Add Instance .</para>
</listitem>