UsingConfigManager.xml 108 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
  3. "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
  4. <book xml:base="../">
  5. <bookinfo>
  6. <title>HPCC Configuration Manager</title>
  7. <mediaobject>
  8. <imageobject>
  9. <imagedata fileref="images/redswooshWithLogo3.jpg" />
  10. </imageobject>
  11. </mediaobject>
  12. <author>
  13. <surname>Boca Raton Documentation Team</surname>
  14. </author>
  15. <legalnotice>
  16. <para>We welcome your comments and feedback about this document via
  17. email to <email>docfeedback@hpccsystems.com</email> Please include
  18. <emphasis role="bold">Documentation Feedback</emphasis> in the subject
  19. line and reference the document name, page numbers, and current Version
  20. Number in the text of the message.</para>
  21. <para>LexisNexis and the Knowledge Burst logo are registered trademarks
  22. of Reed Elsevier Properties Inc., used under license. HPCC Systems is a
  23. registered trademark of LexisNexis Risk Data Management Inc.</para>
  24. <para>Other products, logos, and services may be trademarks or
  25. registered trademarks of their respective companies. All names and
  26. example data used in this manual are fictitious. Any similarity to
  27. actual persons, living or dead, is purely coincidental.</para>
  28. <para></para>
  29. </legalnotice>
  30. <xi:include href="common/Version.xml" xpointer="FooterInfo"
  31. xmlns:xi="http://www.w3.org/2001/XInclude" />
  32. <xi:include href="common/Version.xml" xpointer="DateVer"
  33. xmlns:xi="http://www.w3.org/2001/XInclude" />
  34. <corpname>HPCC Systems</corpname>
  35. <xi:include href="common/Version.xml" xpointer="Copyright"
  36. xmlns:xi="http://www.w3.org/2001/XInclude" />
  37. <mediaobject role="logo">
  38. <imageobject>
  39. <imagedata fileref="images/LN_Rightjustified.jpg" />
  40. </imageobject>
  41. </mediaobject>
  42. </bookinfo>
  43. <chapter id="Buildin-HPCC-from-Source">
  44. <title>Using Configuration Manager</title>
  45. <para>Configuration Manager is the utility with which we configure the
  46. HPCC platform. The HPCC platform's configuration is stored in an XML file
  47. named <emphasis role="bold">environment.xml</emphasis>. When you install a
  48. package, a default single-node environment.xml is generated. After that,
  49. you can use the Configuration Manager to modify it and add nodes and
  50. configure components.</para>
  51. <para>The Configuration Manager Wizard creates a similar file, but after
  52. it is generated, you must rename it and put it into place on each
  53. node.</para>
  54. <para>Configuration Manager also offers an <emphasis role="bold">Advanced
  55. View</emphasis> which allows you to add instances of components or change
  56. the default settings for components. Even if you plane to use Advanced
  57. View, it is a good idea to start with a wizard generated configuration and
  58. use Advanced View to finish it.</para>
  59. <para>This document will guide you through configuring an HPCC environment
  60. using the Configuration Manager.</para>
  61. <sect1 id="configuring-a-multi-node-system">
  62. <title>Running the Configuration Manager</title>
  63. <para>This document will guide you through configuring an HPCC
  64. environment using the Configuration Manager.</para>
  65. <itemizedlist mark="square">
  66. <listitem>
  67. <para>The HPCC packages should already be installed on ALL
  68. nodes.</para>
  69. <para>You can use any tool or shell script you choose.</para>
  70. </listitem>
  71. <listitem>
  72. <para>SSH to the first box in your environment and login as a user
  73. with sudo privileges.</para>
  74. </listitem>
  75. </itemizedlist>
  76. <itemizedlist mark="square">
  77. <listitem>
  78. <para>Start the Configuration Manager service on one node (usually
  79. the first node is considered the head node and is used for this
  80. task, but this is up to you).</para>
  81. <programlisting>sudo /opt/HPCCSystems/sbin/configmgr</programlisting>
  82. <para><graphic fileref="images/gs_img_configmgrStart.jpg" /></para>
  83. </listitem>
  84. </itemizedlist>
  85. <itemizedlist>
  86. <listitem>
  87. <para>Using a Web browser, go to the Configuration Manager's
  88. interface:</para>
  89. <programlisting>http://&lt;<emphasis>ip of installed system</emphasis>&gt;:8015</programlisting>
  90. </listitem>
  91. </itemizedlist>
  92. <itemizedlist mark="square">
  93. <listitem>
  94. <para>The Configuration Manager startup wizard displays.</para>
  95. <para>There are a few different ways to configure your HPCC. You can
  96. use the Generate environment wizard or experienced users can use the
  97. Advanced View.</para>
  98. <itemizedlist>
  99. <listitem>
  100. <?dbfo keep-together="always"?>
  101. <para>To use the wizard select the <emphasis
  102. role="bold">Generate new environment using wizard</emphasis>
  103. button.</para>
  104. <para><graphic fileref="images/GS_ConfigMgrWizStart.jpg"
  105. vendor="configmgrSS" /></para>
  106. </listitem>
  107. <listitem>
  108. <para>Provide a name for the environment file.</para>
  109. <para>This will then be the name of the configuration xml. For
  110. example we will name our environment
  111. <emphasis>NewEnvironment</emphasis>. This will produce an XML
  112. file named<emphasis> NewEnvironment.xml</emphasis>.</para>
  113. </listitem>
  114. <listitem>
  115. <para>Press the Next button.</para>
  116. <para>Next you will need to define the IP addresses that your
  117. HPCC will be using.</para>
  118. </listitem>
  119. </itemizedlist>
  120. <itemizedlist>
  121. <listitem>
  122. <?dbfo keep-together="always"?>
  123. <para>Enter the IP addresses.</para>
  124. <para>IP Addresses can be specified individually using
  125. semi-colon delimiters. You can also specify a range of IPs using
  126. a hyphen (for example, nnn.nnn.nnn.x-y). In the image below, we
  127. specified the IP addresses 10.239.219.1 through 10.239.219.100
  128. using the range syntax, and also a single IP
  129. 10.239.219.111.</para>
  130. <para><graphic fileref="images/GS_ConfigMgrWiz002.jpg"
  131. vendor="configmgrSS" /></para>
  132. </listitem>
  133. <listitem>
  134. <para>Press the Next button.</para>
  135. <para>Alternatively, you could find the IP addresses using Auto
  136. Discovery by selecting the Auto Discovery button.</para>
  137. <para>Now you will define how many nodes to use for the Roxie
  138. and Thor clusters.</para>
  139. </listitem>
  140. </itemizedlist>
  141. <itemizedlist>
  142. <listitem>
  143. <?dbfo keep-together="always"?>
  144. <para>Enter the appropriate values as indicated.</para>
  145. <para><graphic fileref="images/GS_CMWiz003.jpg"
  146. vendor="configmgrSS" /></para>
  147. <variablelist>
  148. <varlistentry>
  149. <term>Number of support nodes:</term>
  150. <listitem>
  151. <para>Specify the number of nodes to use for support
  152. components. The default is 1.</para>
  153. </listitem>
  154. </varlistentry>
  155. <varlistentry>
  156. <term>Number of nodes for Roxie cluster:</term>
  157. <listitem>
  158. <para>Specify the number of nodes to use for your Roxie
  159. cluster. Enter zero (0) if you do not want a Roxie
  160. cluster.</para>
  161. </listitem>
  162. </varlistentry>
  163. <varlistentry>
  164. <term>Number of slave nodes for Thor cluster</term>
  165. <listitem>
  166. <para>Specify the number of slave nodes to use in your
  167. Thor cluster. A Thor master node will be added
  168. automatically.</para>
  169. </listitem>
  170. </varlistentry>
  171. <varlistentry>
  172. <term>Number of Thor slaves per node (default 1)</term>
  173. <listitem>
  174. <para>Specify the number of Thor slave processes to
  175. instantiate on each slave node. Enter zero (0) if you do
  176. not want a Thor cluster.</para>
  177. </listitem>
  178. </varlistentry>
  179. <varlistentry>
  180. <term>Enable Roxie on demand</term>
  181. <listitem>
  182. <para>Specify whether or not to allow queries to be run
  183. immediately on Roxie. This must be enabled to run the
  184. debugger. (Default is true)</para>
  185. </listitem>
  186. </varlistentry>
  187. </variablelist>
  188. </listitem>
  189. </itemizedlist>
  190. <itemizedlist>
  191. <listitem>
  192. <para>Press the <emphasis role="bold">Next</emphasis>
  193. button</para>
  194. <para>The wizard displays the configuration parameters.</para>
  195. </listitem>
  196. <listitem>
  197. <?dbfo keep-together="always"?>
  198. <para>Press the <emphasis role="bold">Finish</emphasis> button
  199. to accept these values or press the <emphasis
  200. role="bold">Advanced View</emphasis> button to edit in advanced
  201. mode.</para>
  202. <graphic fileref="images/GS_ConfigMgrWiz004.jpg" />
  203. </listitem>
  204. </itemizedlist>
  205. <para>You will now be notified that you have completed the
  206. wizard.</para>
  207. <para><graphic fileref="images/GS_ConfigMgrWiz005.jpg" /></para>
  208. <para>At this point, you have created a file named
  209. NewEnvironment.xml in the <emphasis
  210. role="bold">/etc/HPCCSystems/source</emphasis> directory</para>
  211. <informaltable colsep="1" frame="all" rowsep="1">
  212. <?dbfo keep-together="always"?>
  213. <tgroup cols="2">
  214. <colspec colwidth="49.50pt" />
  215. <colspec />
  216. <tbody>
  217. <row>
  218. <entry><inlinegraphic fileref="images/OSSgr3.png" /></entry>
  219. <entry>Keep in mind, that your HPPC configuration may be
  220. different depending on your needs. For example, you may not
  221. need a Roxie or you may need several smaller Roxie clusters.
  222. In addition, in a production [Thor] system, you would ensure
  223. that Thor and Roxie nodes are dedicated and have no other
  224. processes running on them. This document is intended to show
  225. you how to use the configuration tools. Capacity planning
  226. and system design is covered in a training module.</entry>
  227. </row>
  228. </tbody>
  229. </tgroup>
  230. </informaltable>
  231. </listitem>
  232. <listitem>
  233. <?dbfo keep-together="always"?>
  234. <para>Stop the HPCC</para>
  235. <para><informaltable colsep="1" frame="all" rowsep="1">
  236. <tgroup cols="2">
  237. <colspec colwidth="49.50pt" />
  238. <colspec />
  239. <tbody>
  240. <row>
  241. <entry><inlinegraphic
  242. fileref="images/caution.png" /></entry>
  243. <entry>Be sure HPCC is stopped before attempting to move
  244. the environment.xml file.</entry>
  245. </row>
  246. </tbody>
  247. </tgroup>
  248. </informaltable></para>
  249. </listitem>
  250. <listitem>
  251. <para>Back up the original environment.xml file</para>
  252. <programlisting># for example
  253. sudo -u hpcc cp /etc/HPCCSystems/environment.xml /etc/HPCCSystems/environment.bak </programlisting>
  254. <para>Note: the "live environment.xml file is located in your
  255. <emphasis role="bold">/etc/HPCCSystems/</emphasis> directory.
  256. ConfigManager works on files in <emphasis
  257. role="bold">/etc/HPCCSystems/source</emphasis> directory. You must
  258. copy from this location to make an environment.xml file
  259. active.</para>
  260. </listitem>
  261. <listitem>
  262. <para>Copy the new .xml file from the source directory to the
  263. /etc/HPCCSystems and rename the file to
  264. <emphasis>environment.xml</emphasis></para>
  265. <programlisting># for example
  266. sudo -u hpcc cp /etc/HPCCSystems/source/NewEnvironment.xml /etc/HPCCSystems/environment.xml</programlisting>
  267. <para></para>
  268. </listitem>
  269. <listitem>
  270. <para>Copy the <emphasis
  271. role="bold">/etc/HPCCSystems/environment.xml</emphasis> to the
  272. <emphasis role="bold">/etc/HPCCSystems/</emphasis> on
  273. <emphasis>every</emphasis> node.</para>
  274. <para>You may want to use a script to push out XML file to all
  275. nodes. See the Example Scripts section in the Appendix of the
  276. Installing_and_RunningtheHPCCPlatform document. You can use the
  277. scripts as a model to create your own script to copy the
  278. environment.xml file out to all your nodes.</para>
  279. </listitem>
  280. <listitem>
  281. <para>Restart the HPCC platform.</para>
  282. </listitem>
  283. </itemizedlist>
  284. </sect1>
  285. </chapter>
  286. <chapter>
  287. <title>Configuration Manager Advanced View</title>
  288. <para>For the advanced user, the Advanced View offers access to adding
  289. additional instances of components or making configuration settings for
  290. individual components.</para>
  291. <sect1 id="configuring-advanced-setup">
  292. <title>Using ConfigMgr in Advanced Mode</title>
  293. <para>This section shows some of the configuration options in Advanced
  294. Mode.</para>
  295. <para><itemizedlist mark="square">
  296. <listitem>
  297. <para>SSH to the first box in your environment and login as a user
  298. with sudo privileges.</para>
  299. </listitem>
  300. <listitem>
  301. <para>If it is running, stop the HPCC system, using this
  302. command:</para>
  303. <para><programlisting>sudo /sbin/service hpcc-init stop</programlisting><informaltable
  304. colsep="1" frame="all" rowsep="1">
  305. <?dbfo keep-together="always"?>
  306. <tgroup cols="2">
  307. <colspec colwidth="49.50pt" />
  308. <colspec />
  309. <tbody>
  310. <row>
  311. <entry><inlinegraphic
  312. fileref="images/OSSgr3.png" /></entry>
  313. <entry>You can use this command to confirm HPCC
  314. processes are stopped: <para><programlisting>sudo /sbin/service hpcc-init status</programlisting></para></entry>
  315. </row>
  316. </tbody>
  317. </tgroup>
  318. </informaltable></para>
  319. </listitem>
  320. </itemizedlist><itemizedlist mark="square">
  321. <listitem>
  322. <para>Start the Configuration Manager service on one node (usually
  323. the first node is considered the head node and is used for this
  324. task, but this is up to you).</para>
  325. <programlisting>sudo configmgr</programlisting>
  326. <para><graphic
  327. fileref="images/gs_img_configmgrStart.jpg" /></para>
  328. </listitem>
  329. </itemizedlist><itemizedlist>
  330. <listitem>
  331. <para>Using a Web browser, go to the Configuration Manager's
  332. interface:</para>
  333. <programlisting>http://&lt;<emphasis>ip of installed system</emphasis>&gt;:8015</programlisting>
  334. </listitem>
  335. </itemizedlist><itemizedlist mark="square">
  336. <listitem>
  337. <para>The Configuration Manager startup wizard displays.</para>
  338. <para>There are a few different ways to configure your system. You
  339. can use the Generate environment wizard or experienced users can
  340. use the Advanced set up.</para>
  341. <itemizedlist>
  342. <listitem>
  343. <para>Select <emphasis role="bold">Advanced View</emphasis>,
  344. then press the <emphasis role="bold">Next
  345. </emphasis>button.</para>
  346. </listitem>
  347. <listitem>
  348. <para>Select an XML file from the drop list.</para>
  349. <para>This list is populated from versions of an environment
  350. XML file in your server's ./etc/HPCCSystems/source/
  351. directory.</para>
  352. </listitem>
  353. <listitem>
  354. <?dbfo keep-together="always"?>
  355. <para>Press the <emphasis role="bold">Next</emphasis> button.
  356. <graphic fileref="images/CM-WizStart.jpg"
  357. vendor="configmgrSS" /></para>
  358. </listitem>
  359. </itemizedlist>
  360. </listitem>
  361. </itemizedlist></para>
  362. <itemizedlist mark="circle">
  363. <listitem>
  364. <para>The Configuration Manager interface displays.</para>
  365. <para><informaltable colsep="1" frame="all" rowsep="1">
  366. <?dbfo keep-together="always"?>
  367. <tgroup cols="2">
  368. <colspec colwidth="49.50pt" />
  369. <colspec />
  370. <tbody>
  371. <row>
  372. <entry><inlinegraphic
  373. fileref="images/OSSgr3.png" /></entry>
  374. <entry>Default access is read-only. Many options are only
  375. available when write-access is enabled. <para>Gain write
  376. access by checking the <emphasis role="bold">Write
  377. Access</emphasis> checkbox. </para><para>Unchecking this
  378. box returns the environment to read-only mode. All menu
  379. items are disabled in read-only mode. </para><para>Closing
  380. the web page automatically removes any write-access
  381. locks.</para></entry>
  382. </row>
  383. </tbody>
  384. </tgroup>
  385. </informaltable></para>
  386. </listitem>
  387. <listitem>
  388. <para>Check the <emphasis role="bold">Write Access</emphasis>
  389. box.</para>
  390. <para><graphic fileref="images/CM-img101.jpg"
  391. vendor="configmgrSS" />The <emphasis role="bold">Save</emphasis>
  392. button<inlinegraphic fileref="images/GS-img01c.png"
  393. vendor="configmgrSS" /> validates and saves the environment.</para>
  394. <para>The <emphasis role="bold">Save Environment As</emphasis>
  395. button <inlinegraphic fileref="images/CM-img181.jpg"
  396. vendor="configmgrSS" /> validates and lets you specify the
  397. environment filename to save.</para>
  398. <para>The <emphasis role="bold">Validate Environment</emphasis>
  399. button<inlinegraphic fileref="images/GS-img01d.png"
  400. vendor="configmgrSS" /> just validates the current environment
  401. including any changes that have not yet been saved.</para>
  402. <para>The <emphasis role="bold">Open Environment</emphasis> button
  403. <inlinegraphic fileref="images/CM-img18.jpg" vendor="configmgrSS" />
  404. allows you to open a new environment file to work on.</para>
  405. <para>The <emphasis role="bold">Wizard</emphasis> button
  406. <inlinegraphic fileref="images/CM-img19.jpg" vendor="configmgrSS" />
  407. will bring up the Configuration Manager chooser form which will
  408. allow you to create or view an environment file where you can also
  409. launch the configuration wizard.</para>
  410. <para>These buttons are only enabled in Write Access mode.</para>
  411. </listitem>
  412. </itemizedlist>
  413. <sect2 role="brk">
  414. <title>XML View</title>
  415. <para>In the advanced view of Configuration Manager, you can
  416. optionally choose to work with the XML View.</para>
  417. <para>To see the the configuration in XML View, click on the
  418. Environment heading in the Navigator panel on the left side.</para>
  419. <para><graphic fileref="images/CM-120.jpg" />You can access all
  420. attributes through the XML view.</para>
  421. <para>If you wish to add an attribute that does not exist, RT-CLICK on
  422. one of the components then you can choose to add an attribute.</para>
  423. <para><graphic fileref="images/CM-121.jpg" /></para>
  424. </sect2>
  425. <sect2 role="brk">
  426. <title>Hardware Section</title>
  427. <para>This section allows you to define your list of servers. When
  428. defining instances of components, you will choose from servers in this
  429. list.</para>
  430. <itemizedlist mark="circle">
  431. <listitem>
  432. <?dbfo keep-together="always"?>
  433. <para>Select <emphasis role="bold">Hardware</emphasis> in the
  434. Navigator panel on the left side.</para>
  435. <para><graphic fileref="images/CM-img01.jpg"
  436. vendor="configmgrSS" /></para>
  437. </listitem>
  438. </itemizedlist>
  439. <itemizedlist mark="square">
  440. <listitem>
  441. <para>Select the <emphasis role="bold">Computers</emphasis>
  442. tab.</para>
  443. </listitem>
  444. <listitem>
  445. <?dbfo keep-together="always"?>
  446. <para>RT-CLICK on one of computers listed, then select New
  447. Range.</para>
  448. <para><graphic fileref="images/CM-img02.jpg"
  449. vendor="configmgrSS" /></para>
  450. </listitem>
  451. </itemizedlist>
  452. <itemizedlist mark="square">
  453. <listitem>
  454. <para>Specify the following:</para>
  455. <itemizedlist>
  456. <listitem>
  457. <para>Name Prefix - any name that will help you to identify
  458. the node or range</para>
  459. </listitem>
  460. <listitem>
  461. <para>Start IP Address</para>
  462. </listitem>
  463. <listitem>
  464. <para>Stop IP Address</para>
  465. <para>The IP Addresses can be specified in a range if all your
  466. host IP addresses are consecutively numbered. If the IP
  467. addresses are not sequential you should repeat the process for
  468. each individual IP address and just add the IP address in both
  469. the start and stop IP address field. You will then need to
  470. repeat the process for each node.</para>
  471. </listitem>
  472. </itemizedlist>
  473. </listitem>
  474. </itemizedlist>
  475. <itemizedlist mark="square">
  476. <listitem>
  477. <?dbfo keep-together="always"?>
  478. <para>Press the <emphasis role="bold">OK</emphasis> button.</para>
  479. <para>The list of nodes now displays with the nodes that you just
  480. added.</para>
  481. <para><inlinegraphic fileref="images/CM-img03.jpg"
  482. vendor="configmgrSS" /></para>
  483. <para>Next, edit each System Server component instance and set it
  484. to a newly defined node.</para>
  485. <!--***The steps that follow are using one component per node. You can allocate more components per node, if needed.-->
  486. </listitem>
  487. <listitem>
  488. <para>Click the <inlinegraphic fileref="images/GS-img01c.png" />
  489. disk icon to save</para>
  490. </listitem>
  491. </itemizedlist>
  492. <itemizedlist mark="square">
  493. <listitem>
  494. <para>Expand the <emphasis role="bold">Software</emphasis>
  495. section, if necessary, in the Navigator panel on the left side, by
  496. clicking on the <inlinegraphic
  497. fileref="images/expandButton.png" /> button.</para>
  498. </listitem>
  499. </itemizedlist>
  500. </sect2>
  501. <sect2>
  502. <title>Software Section</title>
  503. <para>Use the software components section to configure software
  504. components of the HPCC platform. Most software components are actual
  505. running processes; however, some are just definitions used by the
  506. system. These definitions are used by the configuration
  507. generator.</para>
  508. <para>Items that appear in red indicate optional values. They are only
  509. written to the environment if you add to or change that value. If
  510. untouched, they will not appear in the environment XML file.</para>
  511. <sect3>
  512. <title>Dali</title>
  513. <sect4>
  514. <title>Instances</title>
  515. <para><itemizedlist mark="square">
  516. <listitem>
  517. <para>Select <emphasis role="bold">Dali Server</emphasis> in
  518. the Navigator panel on the left side.</para>
  519. </listitem>
  520. <listitem>
  521. <para>Select the Instances tab.</para>
  522. </listitem>
  523. <listitem>
  524. <?dbfo keep-together="always"?>
  525. <para>In the computer column, choose a node from the drop
  526. list as shown below:<graphic fileref="images/CM-img04.jpg"
  527. vendor="configmgrSS" /></para>
  528. </listitem>
  529. <listitem>
  530. <para>Click the <inlinegraphic
  531. fileref="images/GS-img01c.png" /> disk icon to save</para>
  532. </listitem>
  533. </itemizedlist></para>
  534. </sect4>
  535. <sect4>
  536. <title>DaliServer attributes</title>
  537. <para>This section describes the DaliServer attributes.</para>
  538. <para><graphic fileref="images/CM-img04-1.jpg"
  539. vendor="configmgrSS" /></para>
  540. <para><informaltable colsep="0" frame="none" rowsep="0">
  541. <tgroup cols="2">
  542. <colspec align="left" colwidth="122.40pt" />
  543. <colspec />
  544. <tbody>
  545. <row>
  546. <entry>Attribute</entry>
  547. <entry>Definition</entry>
  548. </row>
  549. <row>
  550. <entry><emphasis>AuditLogDir</emphasis></entry>
  551. <entry>Audit Log Process description</entry>
  552. </row>
  553. <row>
  554. <entry><emphasis>dataPath</emphasis></entry>
  555. <entry>the path to the data</entry>
  556. </row>
  557. <row>
  558. <entry><emphasis>description </emphasis></entry>
  559. <entry>data path description</entry>
  560. </row>
  561. <row>
  562. <entry><emphasis>environment</emphasis></entry>
  563. <entry>the current environment file in use</entry>
  564. </row>
  565. <row>
  566. <entry><emphasis>LogDir</emphasis></entry>
  567. <entry>location of the log files</entry>
  568. </row>
  569. <row>
  570. <entry><emphasis>msgLevel</emphasis></entry>
  571. <entry>description of the msgLevel</entry>
  572. </row>
  573. <row>
  574. <entry><emphasis>name</emphasis></entry>
  575. <entry>Name of the process instance (AlphaNumeric and
  576. underscore only)</entry>
  577. </row>
  578. </tbody>
  579. </tgroup>
  580. </informaltable></para>
  581. </sect4>
  582. <?hard-pagebreak ?>
  583. <sect4>
  584. <title>DaliServer store</title>
  585. <para>This section describes the attributes configuring how Dali
  586. handles the system data store.</para>
  587. <para><graphic fileref="images/CM-img04-2.jpg"
  588. vendor="configmgrSS" /></para>
  589. <para><informaltable colsep="0" frame="none" rowsep="0">
  590. <tgroup cols="2">
  591. <colspec align="left" colwidth="122.40pt" />
  592. <colspec />
  593. <tbody>
  594. <row>
  595. <entry>Attribute name</entry>
  596. <entry>Definition</entry>
  597. </row>
  598. <row>
  599. <entry><emphasis>EndTime</emphasis></entry>
  600. <entry>End Time</entry>
  601. </row>
  602. <row>
  603. <entry><emphasis>IdlePeriod</emphasis></entry>
  604. <entry>Period to remain Idle</entry>
  605. </row>
  606. <row>
  607. <entry><emphasis>IdleRate</emphasis></entry>
  608. <entry>IdleRate</entry>
  609. </row>
  610. <row>
  611. <entry><emphasis>keepStores</emphasis></entry>
  612. <entry></entry>
  613. </row>
  614. <row>
  615. <entry><emphasis>lightweightCoalesce</emphasis></entry>
  616. <entry>lightweight</entry>
  617. </row>
  618. <row>
  619. <entry><emphasis>MinTime</emphasis></entry>
  620. <entry>min. time...</entry>
  621. </row>
  622. <row>
  623. <entry><emphasis>recoverDeltaErrors</emphasis></entry>
  624. <entry>True or False</entry>
  625. </row>
  626. <row>
  627. <entry><emphasis>StartTime</emphasis></entry>
  628. <entry>start time</entry>
  629. </row>
  630. </tbody>
  631. </tgroup>
  632. </informaltable></para>
  633. </sect4>
  634. <?hard-pagebreak ?>
  635. <sect4>
  636. <title>DaliServer LDAP options</title>
  637. <para>This section describes the DaliServer LDAP tab.</para>
  638. <para><graphic fileref="images/CM-img04-4.jpg"
  639. vendor="configmgrSS" /></para>
  640. <para><informaltable colsep="0" frame="none" rowsep="0">
  641. <tgroup cols="2">
  642. <colspec align="left" colwidth="122.40pt" />
  643. <colspec />
  644. <tbody>
  645. <row>
  646. <entry>Attribute name</entry>
  647. <entry>Definition</entry>
  648. </row>
  649. <row>
  650. <entry><emphasis>authMethod</emphasis></entry>
  651. <entry>Authentication Method. Kerberos</entry>
  652. </row>
  653. <row>
  654. <entry><emphasis>checkScopeScans</emphasis></entry>
  655. <entry>True or False</entry>
  656. </row>
  657. <row>
  658. <entry><emphasis>filesDefaultPassword</emphasis></entry>
  659. <entry>Default Password</entry>
  660. </row>
  661. <row>
  662. <entry><emphasis>filesDefaultUser</emphasis></entry>
  663. <entry>Default User</entry>
  664. </row>
  665. <row>
  666. <entry><emphasis>ldapProtocol</emphasis></entry>
  667. <entry>Default Protocol use</entry>
  668. </row>
  669. <row>
  670. <entry><emphasis>ldapServer</emphasis></entry>
  671. <entry>LDAP Server</entry>
  672. </row>
  673. </tbody>
  674. </tgroup>
  675. </informaltable></para>
  676. </sect4>
  677. <sect4>
  678. <title>DaliServer Notes</title>
  679. <para>This tab allows you to add any notes pertinent to the
  680. component's configuration. This can be useful to keep a record of
  681. changes and to communicate this information to peers.</para>
  682. </sect4>
  683. </sect3>
  684. <sect3 id="Dafilesrv-Process">
  685. <title>Dafilesrv Process</title>
  686. <sect4>
  687. <title>Dafilesrv Instances</title>
  688. <para>Dafilesrv is a helper process that every node needs.</para>
  689. <itemizedlist mark="square">
  690. <listitem>
  691. <para>Select Dafilesrv in the Navigator panel on the left
  692. side.</para>
  693. </listitem>
  694. <listitem>
  695. <para>Select the Instances tab.</para>
  696. </listitem>
  697. <listitem>
  698. <para>RT-CLICK on a computer in the computer column, and
  699. select Add Instance .</para>
  700. </listitem>
  701. <listitem>
  702. <?dbfo keep-together="always"?>
  703. <para>Select all computers in the list by checking the
  704. <emphasis role="bold">Select All</emphasis> box, then press
  705. the <emphasis role="bold">OK</emphasis> button.</para>
  706. <para><graphic fileref="images/CM-img12.jpg"
  707. vendor="configmgrSS" /></para>
  708. </listitem>
  709. <listitem>
  710. <para>Click the <inlinegraphic
  711. fileref="images/GS-img01c.png" /> disk icon to save</para>
  712. </listitem>
  713. </itemizedlist>
  714. </sect4>
  715. <?hard-pagebreak ?>
  716. <sect4>
  717. <title>Dafilesrv attributes</title>
  718. <para>This section describes the Dafilesrv attributes.</para>
  719. <para><graphic fileref="images/CM-img12-1.jpg"
  720. vendor="configmgrSS" /></para>
  721. <para><informaltable colsep="0" frame="none" rowsep="0">
  722. <tgroup cols="2">
  723. <colspec align="left" colwidth="122.40pt" />
  724. <colspec />
  725. <tbody>
  726. <row>
  727. <entry>Attribute</entry>
  728. <entry>Definition</entry>
  729. </row>
  730. <row>
  731. <entry><emphasis>description</emphasis></entry>
  732. <entry>DaFileSrv Process description</entry>
  733. </row>
  734. <row>
  735. <entry><emphasis>name</emphasis></entry>
  736. <entry>Name of the process instance (AlphaNumeric and
  737. underscore only)</entry>
  738. </row>
  739. <row>
  740. <entry><emphasis>version</emphasis></entry>
  741. <entry>current version number</entry>
  742. </row>
  743. </tbody>
  744. </tgroup>
  745. </informaltable></para>
  746. </sect4>
  747. </sect3>
  748. <sect3 id="DFU-Server">
  749. <title><emphasis>DFU Server</emphasis></title>
  750. <sect4>
  751. <title>DfuServer Instances</title>
  752. <itemizedlist mark="square">
  753. <listitem>
  754. <para>Select <emphasis role="bold">DFU Server</emphasis> in
  755. the Navigator panel on the left side.</para>
  756. </listitem>
  757. <listitem>
  758. <para>Select the Instances tab.</para>
  759. </listitem>
  760. <listitem>
  761. <para>In the computer column, choose a node from the drop list
  762. as shown below:<graphic fileref="images/CM-img05.jpg"
  763. vendor="configmgrSS" /></para>
  764. </listitem>
  765. <listitem>
  766. <para>Click the <inlinegraphic
  767. fileref="images/GS-img01c.png" /> disk icon to save</para>
  768. </listitem>
  769. </itemizedlist>
  770. </sect4>
  771. <sect4>
  772. <title>DfuServer Attributes Tab</title>
  773. <para>This section describes the DfuServer attributes.</para>
  774. <para><graphic fileref="images/CM-img05-1.jpg"
  775. vendor="configmgrSS" /></para>
  776. <para><informaltable colsep="0" frame="none" rowsep="0">
  777. <tgroup cols="2">
  778. <colspec align="left" colwidth="122.40pt" />
  779. <colspec />
  780. <tbody>
  781. <row>
  782. <entry>Attribute name</entry>
  783. <entry>Definition</entry>
  784. </row>
  785. <row>
  786. <entry><emphasis>daliServers</emphasis></entry>
  787. <entry>The Dali servers to use</entry>
  788. </row>
  789. <row>
  790. <entry><emphasis>description</emphasis></entry>
  791. <entry>Describes the component</entry>
  792. </row>
  793. <row>
  794. <entry><emphasis>dfuLogDir</emphasis></entry>
  795. <entry>The log directory</entry>
  796. </row>
  797. <row>
  798. <entry><emphasis>monitorinterval</emphasis></entry>
  799. <entry>Specifies the polling interval for DFU monitoring
  800. (in seconds). Default is 900 (15 minutes)</entry>
  801. </row>
  802. <row>
  803. <entry><emphasis>monitorque</emphasis></entry>
  804. <entry>the queue to monitor</entry>
  805. </row>
  806. <row>
  807. <entry><emphasis>name</emphasis></entry>
  808. <entry>Name of the process instance (AlphaNumeric and
  809. underscore only)</entry>
  810. </row>
  811. <row>
  812. <entry><emphasis>queue</emphasis></entry>
  813. <entry>the name of the dfu server queue</entry>
  814. </row>
  815. <row>
  816. <entry><emphasis>transferBufferSize</emphasis></entry>
  817. <entry>The value at which...</entry>
  818. </row>
  819. </tbody>
  820. </tgroup>
  821. </informaltable></para>
  822. </sect4>
  823. <sect4>
  824. <title>DfuServer SSH Options</title>
  825. <para>This section describes the DfuServer SSH Options..</para>
  826. <para><graphic fileref="images/CM-img05-2.jpg"
  827. vendor="configmgrSS" /></para>
  828. <para><informaltable colsep="0" frame="none" rowsep="0">
  829. <?dbfo keep-together="always"?>
  830. <tgroup cols="2">
  831. <colspec align="left" colwidth="122.40pt" />
  832. <colspec />
  833. <tbody>
  834. <row>
  835. <entry>Attribute name</entry>
  836. <entry>Definition</entry>
  837. </row>
  838. <row>
  839. <entry><emphasis>SSHidentityfile</emphasis></entry>
  840. <entry>The SSH file used for authentication</entry>
  841. </row>
  842. <row>
  843. <entry><emphasis>SSHpassword</emphasis></entry>
  844. <entry>the SSH Password</entry>
  845. </row>
  846. <row>
  847. <entry><emphasis>SSHretries</emphasis></entry>
  848. <entry>no. of retries to authenticate</entry>
  849. </row>
  850. <row>
  851. <entry><emphasis>SHtimeout</emphasis></entry>
  852. <entry>the timeout interval</entry>
  853. </row>
  854. <row>
  855. <entry><emphasis>SSHusername</emphasis></entry>
  856. <entry>SSH username default is
  857. <emphasis>hpcc</emphasis></entry>
  858. </row>
  859. </tbody>
  860. </tgroup>
  861. </informaltable></para>
  862. </sect4>
  863. <sect4>
  864. <title>DfuServer Notes</title>
  865. <para>This tab allows you to add any notes pertinent to the
  866. component's configuration. This can be useful to keep a record of
  867. changes and to communicate this information to peers.</para>
  868. </sect4>
  869. </sect3>
  870. <sect3>
  871. <title>Directories</title>
  872. <para>The DIrectories component is a global definition used by other
  873. components to determine the directories they will use for various
  874. functions.</para>
  875. <para><graphic fileref="images/CM-161a.jpg"
  876. vendor="configmgrSS" /></para>
  877. <para></para>
  878. <informaltable colsep="0" frame="none" rowsep="0">
  879. <tgroup cols="3">
  880. <colspec align="left" colwidth="122.40pt" />
  881. <colspec />
  882. <tbody>
  883. <row>
  884. <entry>Name</entry>
  885. <entry>Directory</entry>
  886. <entry>Description</entry>
  887. </row>
  888. <row>
  889. <entry><emphasis role="bold">log</emphasis></entry>
  890. <entry>/var/log/[NAME]/[INST]</entry>
  891. <entry>Location for Log files</entry>
  892. </row>
  893. <row>
  894. <entry><emphasis role="bold">temp</emphasis></entry>
  895. <entry>/var/lib/[NAME]/[INST]/temp</entry>
  896. <entry>Location for temp files</entry>
  897. </row>
  898. <row>
  899. <entry><emphasis role="bold">data</emphasis></entry>
  900. <entry></entry>
  901. <entry>Base Location for data files</entry>
  902. </row>
  903. <row>
  904. <entry><emphasis role="bold">data2</emphasis></entry>
  905. <entry></entry>
  906. <entry></entry>
  907. </row>
  908. <row>
  909. <entry><emphasis role="bold">data3</emphasis></entry>
  910. <entry></entry>
  911. <entry></entry>
  912. </row>
  913. <row>
  914. <entry><emphasis role="bold">mirror</emphasis></entry>
  915. <entry></entry>
  916. <entry>Base Location for mirror data files</entry>
  917. </row>
  918. <row>
  919. <entry><emphasis role="bold">query</emphasis></entry>
  920. <entry></entry>
  921. <entry>Base Location for Queries</entry>
  922. </row>
  923. <row>
  924. <entry><emphasis role="bold"></emphasis></entry>
  925. <entry></entry>
  926. <entry></entry>
  927. </row>
  928. </tbody>
  929. </tgroup>
  930. </informaltable>
  931. </sect3>
  932. <sect3 id="Drop-Zone">
  933. <title><emphasis>Drop Zone</emphasis></title>
  934. <sect4>
  935. <title>DropZone Attributes</title>
  936. <itemizedlist mark="square">
  937. <listitem>
  938. <para>Select Drop Zone in the Navigator panel on the left
  939. side.</para>
  940. </listitem>
  941. <listitem>
  942. <para>Select the Attributes tab.</para>
  943. </listitem>
  944. <listitem>
  945. <para>In the Value column of the Computer row, choose a node
  946. from the drop list as shown below:<graphic
  947. fileref="images/CM-img06.jpg" vendor="configmgrSS" /></para>
  948. </listitem>
  949. <listitem>
  950. <para>Click the <inlinegraphic
  951. fileref="images/GS-img01c.png" /> disk icon to save</para>
  952. </listitem>
  953. </itemizedlist>
  954. </sect4>
  955. <sect4>
  956. <title>DropZone Notes</title>
  957. <para>This tab allows you to add any notes pertinent to the
  958. component's configuration. This can be useful to keep a record of
  959. changes and to communicate this information to peers.</para>
  960. </sect4>
  961. </sect3>
  962. <sect3 id="ECL-Agent" role="brk">
  963. <title><emphasis>ECL Agent</emphasis></title>
  964. <sect4>
  965. <title>instances</title>
  966. <itemizedlist mark="square">
  967. <listitem>
  968. <para>Select ECL Agent in the Navigator panel on the left
  969. side.</para>
  970. </listitem>
  971. <listitem>
  972. <para>Select the Instances tab.</para>
  973. </listitem>
  974. <listitem>
  975. <para>In the computer column, choose a node from the drop list
  976. as shown below:<graphic fileref="images/CM-img07.jpg"
  977. vendor="configmgrSS" /></para>
  978. </listitem>
  979. <listitem>
  980. <para>Click the <inlinegraphic
  981. fileref="images/GS-img01c.png" /> disk icon to save</para>
  982. </listitem>
  983. </itemizedlist>
  984. </sect4>
  985. <sect4>
  986. <title>EclAgent Attributes Tab</title>
  987. <para>This section describes the EclAgent Attributes tab.</para>
  988. <para><graphic fileref="images/CM-img07-1.jpg"
  989. vendor="configmgrSS" /></para>
  990. <para><informaltable colsep="0" frame="none" rowsep="0">
  991. <tgroup cols="2">
  992. <colspec align="left" colwidth="122.40pt" />
  993. <colspec />
  994. <tbody>
  995. <row>
  996. <entry>Attribute name</entry>
  997. <entry>Definition</entry>
  998. </row>
  999. <row>
  1000. <entry><emphasis>description</emphasis></entry>
  1001. <entry>Describes the component</entry>
  1002. </row>
  1003. <row>
  1004. <entry><emphasis>name</emphasis></entry>
  1005. <entry>Name of the process instance (AlphaNumeric and
  1006. underscore only)</entry>
  1007. </row>
  1008. </tbody>
  1009. </tgroup>
  1010. </informaltable></para>
  1011. </sect4>
  1012. <sect4>
  1013. <title>EclAgent Options Tab</title>
  1014. <para>This section describes the EclAgent Options tab.</para>
  1015. <para><graphic fileref="images/CM-img07-2.jpg"
  1016. vendor="configmgrSS" /></para>
  1017. <para><informaltable colsep="0" frame="none" rowsep="0">
  1018. <tgroup cols="2">
  1019. <colspec align="left" colwidth="122.40pt" />
  1020. <colspec />
  1021. <tbody>
  1022. <row>
  1023. <entry>Attribute name</entry>
  1024. <entry>Definition</entry>
  1025. </row>
  1026. <row>
  1027. <entry><emphasis>allowedPipePrograms</emphasis></entry>
  1028. <entry>describes allowed Pipe Programs</entry>
  1029. </row>
  1030. <row>
  1031. <entry><emphasis>daliServers</emphasis></entry>
  1032. <entry>the Dali Servers</entry>
  1033. </row>
  1034. <row>
  1035. <entry><emphasis>pluginDirectory</emphasis></entry>
  1036. <entry>the plugin directory</entry>
  1037. </row>
  1038. <row>
  1039. <entry><emphasis>thorConnectTimeout</emphasis></entry>
  1040. <entry>the Thor timeout value</entry>
  1041. </row>
  1042. <row>
  1043. <entry><emphasis>traceLevel</emphasis></entry>
  1044. <entry>the trace level</entry>
  1045. </row>
  1046. <row>
  1047. <entry><emphasis>wuQueueName</emphasis></entry>
  1048. <entry>the name of the workunit queue</entry>
  1049. </row>
  1050. </tbody>
  1051. </tgroup>
  1052. </informaltable></para>
  1053. </sect4>
  1054. <sect4>
  1055. <title>EclAgentProcessNotes</title>
  1056. <para>This tab allows you to add any notes pertinent to the
  1057. component's configuration. This can be useful to keep a record of
  1058. changes and to communicate this information to peers.</para>
  1059. </sect4>
  1060. </sect3>
  1061. <sect3 role="brk">
  1062. <title>ECL CC Server Process</title>
  1063. <sect4>
  1064. <title>Ecl CC Server Instances</title>
  1065. <para><itemizedlist mark="square">
  1066. <listitem>
  1067. <para>Select Ecl CC Server - myeclccserver in the Navigator
  1068. panel on the left side.</para>
  1069. </listitem>
  1070. <listitem>
  1071. <para>Select the Instances tab.</para>
  1072. </listitem>
  1073. <listitem>
  1074. <para>In the computer column, choose a node from the drop
  1075. list as shown below:<graphic
  1076. fileref="images/CM-ECLCC-01.jpg"
  1077. vendor="configmgrSS" /></para>
  1078. </listitem>
  1079. <listitem>
  1080. <para>Click the <inlinegraphic
  1081. fileref="images/GS-img01c.png" /> disk icon to save</para>
  1082. </listitem>
  1083. </itemizedlist></para>
  1084. </sect4>
  1085. <sect4>
  1086. <title>Ecl CC Server Attributes Tab</title>
  1087. <para>This section describes the Ecl CC Server Attributes
  1088. tab.</para>
  1089. <para><graphic fileref="images/CM-ECLCC-02.jpg"
  1090. vendor="configmgrSS" /></para>
  1091. <para><informaltable colsep="0" frame="none" rowsep="0">
  1092. <tgroup cols="2">
  1093. <colspec align="left" colwidth="122.40pt" />
  1094. <colspec />
  1095. <tbody>
  1096. <row>
  1097. <entry>Attribute name</entry>
  1098. <entry>Definition</entry>
  1099. </row>
  1100. <row>
  1101. <entry><emphasis>daliServers</emphasis></entry>
  1102. <entry>The Dali servers to use</entry>
  1103. </row>
  1104. <row>
  1105. <entry><emphasis>description</emphasis></entry>
  1106. <entry>Describes the component</entry>
  1107. </row>
  1108. <row>
  1109. <entry><emphasis>maxEclccProcesses</emphasis></entry>
  1110. <entry>The maximum number of eclcc processes that will
  1111. be launched in parallel</entry>
  1112. </row>
  1113. <row>
  1114. <entry><emphasis>name</emphasis></entry>
  1115. <entry>Name of the process instance (AlphaNumeric and
  1116. underscore only)</entry>
  1117. </row>
  1118. <row>
  1119. <entry><emphasis>queue</emphasis></entry>
  1120. <entry>Name of the Ecl cc server queue</entry>
  1121. </row>
  1122. <row>
  1123. <entry><emphasis>traceLevel</emphasis></entry>
  1124. <entry>The value ***</entry>
  1125. </row>
  1126. </tbody>
  1127. </tgroup>
  1128. </informaltable></para>
  1129. </sect4>
  1130. <sect4>
  1131. <title>EclCC Server Process Options</title>
  1132. <para>To add a custom option, rt-click and select add.</para>
  1133. <!--This feature allows the user to configure any options pertinent to the Ecl CC Server Process -->
  1134. <para></para>
  1135. </sect4>
  1136. <sect4>
  1137. <title>EclCC Server Process Notes</title>
  1138. <para>This tab allows you to add any notes pertinent to the
  1139. component's configuration. This can be useful to keep a record of
  1140. changes and to communicate this information to peers.</para>
  1141. </sect4>
  1142. </sect3>
  1143. <sect3 id="ECL-Scheduler" role="brk">
  1144. <title><emphasis>ECL Scheduler</emphasis></title>
  1145. <sect4>
  1146. <title>instances</title>
  1147. <itemizedlist mark="square">
  1148. <listitem>
  1149. <para>Select <emphasis role="bold">ECL Scheduler</emphasis> in
  1150. the Navigator panel on the left side.</para>
  1151. </listitem>
  1152. <listitem>
  1153. <para>Select the Instances tab.</para>
  1154. </listitem>
  1155. <listitem>
  1156. <para>In the computer column, choose a node from the drop list
  1157. as shown below:<graphic fileref="images/CM-161.jpg"
  1158. vendor="configmgrSS" /></para>
  1159. </listitem>
  1160. <listitem>
  1161. <para>Click the <inlinegraphic
  1162. fileref="images/GS-img01c.png" /> disk icon to save</para>
  1163. </listitem>
  1164. </itemizedlist>
  1165. </sect4>
  1166. <sect4 role="brk">
  1167. <title>EclScheduler Attributes Tab</title>
  1168. <para>This section describes the EclScheduler Attributes
  1169. tab.</para>
  1170. <para><graphic fileref="images/CM-160.jpg"
  1171. vendor="configmgrSS" /></para>
  1172. <para><informaltable colsep="0" frame="none" rowsep="0">
  1173. <tgroup cols="2">
  1174. <colspec align="left" colwidth="122.40pt" />
  1175. <colspec />
  1176. <tbody>
  1177. <row>
  1178. <entry>Attribute name</entry>
  1179. <entry>Definition</entry>
  1180. </row>
  1181. <row>
  1182. <entry><emphasis>description</emphasis></entry>
  1183. <entry>Describes the component</entry>
  1184. </row>
  1185. <row>
  1186. <entry><emphasis>name</emphasis></entry>
  1187. <entry>Name of the process instance (AlphaNumeric and
  1188. underscore only)</entry>
  1189. </row>
  1190. </tbody>
  1191. </tgroup>
  1192. </informaltable></para>
  1193. </sect4>
  1194. <sect4>
  1195. <title>EclScheduler Notes</title>
  1196. <para>This tab allows you to add any notes pertinent to the
  1197. component's configuration. This can be useful to keep a record of
  1198. changes and to communicate this information to peers.</para>
  1199. </sect4>
  1200. </sect3>
  1201. <sect3 id="ESP-Server" role="brk">
  1202. <title><emphasis>ESP Server</emphasis></title>
  1203. <sect4>
  1204. <title>Esp Process Instances</title>
  1205. <itemizedlist mark="square">
  1206. <listitem>
  1207. <para>Select ESP - MyEsp in the Navigator panel on the left
  1208. side.</para>
  1209. </listitem>
  1210. <listitem>
  1211. <para>Select the Instances tab.</para>
  1212. </listitem>
  1213. <listitem>
  1214. <para>In the computer column, choose a node from the drop list
  1215. as shown below:<graphic fileref="images/CM-img08.jpg"
  1216. vendor="configmgrSS" /></para>
  1217. </listitem>
  1218. <listitem>
  1219. <para>Click the <inlinegraphic
  1220. fileref="images/GS-img01c.png" /> disk icon to save</para>
  1221. </listitem>
  1222. </itemizedlist>
  1223. </sect4>
  1224. <?hard-pagebreak ?>
  1225. <sect4>
  1226. <title>Esp - myesp Attributes Tab</title>
  1227. <para>This section describes the Esp - myesp Attributes
  1228. tab.</para>
  1229. <para><graphic fileref="images/CM-img08-1.jpg"
  1230. vendor="configmgrSS" /></para>
  1231. <para><informaltable colsep="0" frame="none" rowsep="0">
  1232. <tgroup cols="2">
  1233. <colspec align="left" colwidth="122.40pt" />
  1234. <colspec />
  1235. <tbody>
  1236. <row>
  1237. <entry>Attribute name</entry>
  1238. <entry>Definition</entry>
  1239. </row>
  1240. <row>
  1241. <entry><emphasis>componentfilesDir</emphasis></entry>
  1242. <entry>the component files directory</entry>
  1243. </row>
  1244. <row>
  1245. <entry><emphasis>daliServers</emphasis></entry>
  1246. <entry>the Dali servers</entry>
  1247. </row>
  1248. <row>
  1249. <entry><emphasis>description</emphasis></entry>
  1250. <entry>Describes the component</entry>
  1251. </row>
  1252. <row>
  1253. <entry><emphasis>enableSEHMapping</emphasis></entry>
  1254. <entry>True or False to enable***</entry>
  1255. </row>
  1256. <row>
  1257. <entry><emphasis>formOptionsAccess</emphasis></entry>
  1258. <entry>True or False to enable...***</entry>
  1259. </row>
  1260. <row>
  1261. <entry><emphasis>httpConfigAccess</emphasis></entry>
  1262. <entry>True or False to enable...***</entry>
  1263. </row>
  1264. <row>
  1265. <entry><emphasis>logLevel</emphasis></entry>
  1266. <entry>The Level of ...***</entry>
  1267. </row>
  1268. <row>
  1269. <entry><emphasis>logRequests</emphasis></entry>
  1270. <entry>True or False to enable...***</entry>
  1271. </row>
  1272. <row>
  1273. <entry><emphasis>logResponses</emphasis></entry>
  1274. <entry>True or False to enable...***</entry>
  1275. </row>
  1276. <row>
  1277. <entry><emphasis>maxBacklogQueueSize</emphasis></entry>
  1278. <entry>The size of the backlog queue</entry>
  1279. </row>
  1280. <row>
  1281. <entry><emphasis>maxConcurrentThreads</emphasis></entry>
  1282. <entry>The maximum number of concurrent threads</entry>
  1283. </row>
  1284. <row>
  1285. <entry><emphasis>maxRequestEntityLegnth</emphasis></entry>
  1286. <entry>The maximum length for entity requests</entry>
  1287. </row>
  1288. <row>
  1289. <entry><emphasis>name</emphasis></entry>
  1290. <entry>Name of the process instance (AlphaNumeric and
  1291. underscore only)</entry>
  1292. </row>
  1293. <row>
  1294. <entry><emphasis>perfReportDelay</emphasis></entry>
  1295. <entry>The value at which...***</entry>
  1296. </row>
  1297. </tbody>
  1298. </tgroup>
  1299. </informaltable></para>
  1300. </sect4>
  1301. <sect4 role="brk">
  1302. <title>Esp - myesp Service BindingsTab</title>
  1303. <para>This section describes the Esp - myesp Service Bindings
  1304. tab.</para>
  1305. <para><graphic fileref="images/CM-img08-2.jpg"
  1306. vendor="configmgrSS" /></para>
  1307. <para><informaltable colsep="0" frame="none" rowsep="0">
  1308. <tgroup cols="2">
  1309. <colspec align="left" colwidth="122.40pt" />
  1310. <colspec />
  1311. <tbody>
  1312. <row>
  1313. <entry><emphasis role="bold">Attribute
  1314. name</emphasis></entry>
  1315. <entry><emphasis
  1316. role="bold">Definition</emphasis></entry>
  1317. </row>
  1318. <row>
  1319. <entry><emphasis>ECLWatch</emphasis></entry>
  1320. <entry>provides ECL Watch interface</entry>
  1321. </row>
  1322. <row>
  1323. <entry><emphasis>Ws_ecl</emphasis></entry>
  1324. <entry>Provides Web access to published queries</entry>
  1325. </row>
  1326. <row>
  1327. <entry><emphasis>myecldirect</emphasis></entry>
  1328. <entry>Provides Ecl direct access</entry>
  1329. </row>
  1330. </tbody>
  1331. </tgroup>
  1332. </informaltable></para>
  1333. </sect4>
  1334. <?hard-pagebreak ?>
  1335. <sect4>
  1336. <title>Esp - myesp AuthenticationTab</title>
  1337. <para>This section describes the Esp - myesp Service
  1338. Authentication tab. </para>
  1339. <para><graphic fileref="images/CM-img08-3.jpg"
  1340. vendor="configmgrSS" /></para>
  1341. <para><informaltable colsep="0" frame="none" rowsep="0">
  1342. <tgroup cols="2">
  1343. <colspec align="left" colwidth="165pt" />
  1344. <colspec />
  1345. <tbody>
  1346. <row>
  1347. <entry>Attribute name</entry>
  1348. <entry>Definition</entry>
  1349. </row>
  1350. <row>
  1351. <entry><emphasis>ldapAuthMethod</emphasis></entry>
  1352. <entry>the LDAP Authentication Method</entry>
  1353. </row>
  1354. <row>
  1355. <entry><emphasis>ldapConnections</emphasis></entry>
  1356. <entry>the number of LDAP Connections</entry>
  1357. </row>
  1358. <row>
  1359. <entry><emphasis>ldapServer</emphasis></entry>
  1360. <entry>the LDAP server</entry>
  1361. </row>
  1362. <row>
  1363. <entry><emphasis>method</emphasis></entry>
  1364. <entry>the method...</entry>
  1365. </row>
  1366. <row>
  1367. <entry><emphasis>passwordExpirationWarningDays</emphasis></entry>
  1368. <entry>the number of days advance warning of password
  1369. expiration</entry>
  1370. </row>
  1371. </tbody>
  1372. </tgroup>
  1373. </informaltable></para>
  1374. </sect4>
  1375. <?hard-pagebreak ?>
  1376. <sect4>
  1377. <title>Esp - myesp HTTPS Tab</title>
  1378. <para>This section describes the Esp - myesp HTTPS tab.</para>
  1379. <para><graphic fileref="images/CM-img08-4.jpg"
  1380. vendor="configmgrSS" /></para>
  1381. <para><informaltable colsep="0" frame="none" rowsep="0">
  1382. <tgroup cols="2">
  1383. <colspec align="left" colwidth="122.40pt" />
  1384. <colspec />
  1385. <tbody>
  1386. <row>
  1387. <entry>Attribute name</entry>
  1388. <entry>Definition</entry>
  1389. </row>
  1390. <row>
  1391. <entry><emphasis>acceptSelfSigned</emphasis></entry>
  1392. <entry>True or False to enable self signed
  1393. certificate...</entry>
  1394. </row>
  1395. <row>
  1396. <entry><emphasis>CA_Certificates_Path</emphasis></entry>
  1397. <entry>the location of the CA Certificates</entry>
  1398. </row>
  1399. <row>
  1400. <entry><emphasis>certificateFileName</emphasis></entry>
  1401. <entry>name of the CA Certificate</entry>
  1402. </row>
  1403. <row>
  1404. <entry><emphasis>Name of the city</emphasis></entry>
  1405. <entry>name of the city.</entry>
  1406. </row>
  1407. <row>
  1408. <entry><emphasis>Name of the country</emphasis></entry>
  1409. <entry>name of the country.</entry>
  1410. </row>
  1411. <row>
  1412. <entry><emphasis>Number of days the certificate is
  1413. valid.</emphasis></entry>
  1414. <entry>The Number of days the certificate is
  1415. valid.</entry>
  1416. </row>
  1417. <row>
  1418. <entry><emphasis>enableVerification</emphasis></entry>
  1419. <entry>True or False to enable verification
  1420. of...</entry>
  1421. </row>
  1422. <row>
  1423. <entry><emphasis>organization</emphasis></entry>
  1424. <entry>name of the organization...</entry>
  1425. </row>
  1426. <row>
  1427. <entry><emphasis>organizationalUnit</emphasis></entry>
  1428. <entry>OU to use</entry>
  1429. </row>
  1430. <row>
  1431. <entry><emphasis>passphrase</emphasis></entry>
  1432. <entry>passphrase to use</entry>
  1433. </row>
  1434. <row>
  1435. <entry><emphasis>privateKeyFileName</emphasis></entry>
  1436. <entry>The privatekey name file (such as,
  1437. privatekey.cer)</entry>
  1438. </row>
  1439. <row>
  1440. <entry><emphasis>regenerateCredentials</emphasis></entry>
  1441. <entry>True or False to enable generation of
  1442. credentials.</entry>
  1443. </row>
  1444. <row>
  1445. <entry><emphasis>requireAddressMatch</emphasis></entry>
  1446. <entry>True or False to enable address match</entry>
  1447. </row>
  1448. <row>
  1449. <entry><emphasis>Name of the State</emphasis></entry>
  1450. <entry>name of the state</entry>
  1451. </row>
  1452. <row>
  1453. <entry><emphasis>TrustedPeers</emphasis></entry>
  1454. <entry>The names of trusted peers.</entry>
  1455. </row>
  1456. </tbody>
  1457. </tgroup>
  1458. </informaltable></para>
  1459. </sect4>
  1460. <sect4>
  1461. <title>EspProcess Notes</title>
  1462. <para>This tab allows you to add any notes pertinent to the
  1463. component's configuration. This can be useful to keep a record of
  1464. changes and to communicate this information to peers.</para>
  1465. </sect4>
  1466. </sect3>
  1467. <sect3 id="FTSlave-Process" role="brk">
  1468. <title><emphasis>FTSlave Process</emphasis></title>
  1469. <para>FTSlave is a helper process that every node needs.</para>
  1470. <sect4>
  1471. <title>Instances</title>
  1472. <itemizedlist mark="square">
  1473. <listitem>
  1474. <para>Select FTSlave in the Navigator panel on the left
  1475. side.</para>
  1476. </listitem>
  1477. <listitem>
  1478. <para>Select the Instances tab.</para>
  1479. </listitem>
  1480. <listitem>
  1481. <?dbfo keep-together="always"?>
  1482. <para>RT-CLICK on a computer in the computer column, and
  1483. select Add Instance .</para>
  1484. <para><graphic fileref="images/CM-190.jpg"
  1485. vendor="configmgrSS" /></para>
  1486. </listitem>
  1487. <listitem>
  1488. <?dbfo keep-together="always"?>
  1489. <para>Select all computers in the list, then press the
  1490. <emphasis role="bold">OK</emphasis> button.</para>
  1491. <para><graphic fileref="images/CM-112-4.jpg"
  1492. vendor="configmgrSS" /></para>
  1493. </listitem>
  1494. <listitem>
  1495. <para>Click the <inlinegraphic
  1496. fileref="images/GS-img01c.png" /> disk icon to save</para>
  1497. </listitem>
  1498. </itemizedlist>
  1499. </sect4>
  1500. <sect4>
  1501. <title>FtSlave attributes</title>
  1502. <para>This section describes the FTSlave attributes tab.</para>
  1503. <para><informaltable colsep="0" frame="none" rowsep="0">
  1504. <tgroup cols="2">
  1505. <colspec align="left" colwidth="122.40pt" />
  1506. <colspec />
  1507. <tbody>
  1508. <row>
  1509. <entry>Attribute</entry>
  1510. <entry>Definition</entry>
  1511. </row>
  1512. <row>
  1513. <entry><emphasis>description</emphasis></entry>
  1514. <entry>FTSlave Process description</entry>
  1515. </row>
  1516. <row>
  1517. <entry><emphasis>name</emphasis></entry>
  1518. <entry>Name of the process instance (AlphaNumeric and
  1519. underscore only)</entry>
  1520. </row>
  1521. <row>
  1522. <entry><emphasis>version</emphasis></entry>
  1523. <entry>current version number</entry>
  1524. </row>
  1525. </tbody>
  1526. </tgroup>
  1527. </informaltable></para>
  1528. </sect4>
  1529. <sect4>
  1530. <title>FtSlave Process Notes</title>
  1531. <para>This tab allows you to add any notes pertinent to the
  1532. component's configuration. This can be useful to keep a record of
  1533. changes and to communicate this information to peers.</para>
  1534. </sect4>
  1535. </sect3>
  1536. <sect3>
  1537. <title><emphasis>Sasha Server</emphasis></title>
  1538. <sect4>
  1539. <title>Instances</title>
  1540. <itemizedlist mark="square">
  1541. <listitem>
  1542. <para>Select Sasha Server in the menu on the left side.</para>
  1543. </listitem>
  1544. <listitem>
  1545. <para>Select the Instances tab.</para>
  1546. </listitem>
  1547. <listitem>
  1548. <para>In the computer column, choose a node from the drop list
  1549. as shown below:</para>
  1550. </listitem>
  1551. </itemizedlist>
  1552. <graphic fileref="images/CM-img17.jpg" vendor="configmgrSS" />
  1553. </sect4>
  1554. <?hard-pagebreak ?>
  1555. <sect4>
  1556. <title>SashaServer Process Archiver</title>
  1557. <para>This section describes the SashaServer Process Archiver
  1558. tab.</para>
  1559. <para><graphic fileref="images/CM-img17-1.jpg"
  1560. vendor="configmgrSS" /></para>
  1561. <para><informaltable colsep="0" frame="none" rowsep="0">
  1562. <tgroup cols="2">
  1563. <colspec align="left" colwidth="122.40pt" />
  1564. <colspec />
  1565. <tbody>
  1566. <row>
  1567. <entry>Attribute</entry>
  1568. <entry>Definition</entry>
  1569. </row>
  1570. <row>
  1571. <entry><emphasis>cachedWUat</emphasis></entry>
  1572. <entry>SashaServer Archiver Process description</entry>
  1573. </row>
  1574. <row>
  1575. <entry><emphasis>cachedWUinterval</emphasis></entry>
  1576. <entry>SashaServer Archiver Process description</entry>
  1577. </row>
  1578. <row>
  1579. <entry><emphasis>cachedWUlimit</emphasis></entry>
  1580. <entry>SashaServer Archiver Process description</entry>
  1581. </row>
  1582. <row>
  1583. <entry><emphasis>DFUrecoveryAt</emphasis></entry>
  1584. <entry>SashaServer Archiver Process description</entry>
  1585. </row>
  1586. <row>
  1587. <entry><emphasis>DFUrecoveryCutoff</emphasis></entry>
  1588. <entry>SashaServer Archiver Process description</entry>
  1589. </row>
  1590. <row>
  1591. <entry><emphasis>DFUrecoveryInterval</emphasis></entry>
  1592. <entry>SashaServer Archiver Process description</entry>
  1593. </row>
  1594. <row>
  1595. <entry><emphasis>DFUrecoveryLimit</emphasis></entry>
  1596. <entry>SashaServer Archiver Process description</entry>
  1597. </row>
  1598. <row>
  1599. <entry><emphasis>DFUWUat</emphasis></entry>
  1600. <entry>SashaServer Archiver Process description</entry>
  1601. </row>
  1602. <row>
  1603. <entry><emphasis>DFUWUcutoff</emphasis></entry>
  1604. <entry>SashaServer Archiver Process description</entry>
  1605. </row>
  1606. <row>
  1607. <entry><emphasis>DFUWUduration</emphasis></entry>
  1608. <entry>SashaServer Archiver Process description</entry>
  1609. </row>
  1610. <row>
  1611. <entry><emphasis>DFUWUinterval</emphasis></entry>
  1612. <entry>SashaServer Archiver Process description</entry>
  1613. </row>
  1614. <row>
  1615. <entry><emphasis>DFUWUlimit</emphasis></entry>
  1616. <entry>SashaServer Archiver Process description</entry>
  1617. </row>
  1618. <row>
  1619. <entry><emphasis>DFUWUthrottle</emphasis></entry>
  1620. <entry>SashaServer Archiver Process description</entry>
  1621. </row>
  1622. <row>
  1623. <entry><emphasis>keepResultFiles</emphasis></entry>
  1624. <entry>Keep result files, True or False</entry>
  1625. </row>
  1626. <row>
  1627. <entry><emphasis>WUat</emphasis></entry>
  1628. <entry>SashaServer Archiver Process description</entry>
  1629. </row>
  1630. <row>
  1631. <entry><emphasis>WUbackup</emphasis></entry>
  1632. <entry>SashaServer Archiver Process description</entry>
  1633. </row>
  1634. <row>
  1635. <entry><emphasis>WUcutof</emphasis></entry>
  1636. <entry>SashaServer Archiver Process description</entry>
  1637. </row>
  1638. <row>
  1639. <entry><emphasis>WUduration</emphasis></entry>
  1640. <entry>SashaServer Archiver Process description</entry>
  1641. </row>
  1642. <row>
  1643. <entry><emphasis>WUinterval</emphasis></entry>
  1644. <entry>SashaServer Archiver Process description</entry>
  1645. </row>
  1646. <row>
  1647. <entry><emphasis>WUlimit</emphasis></entry>
  1648. <entry>SashaServer Archiver Process description</entry>
  1649. </row>
  1650. <row>
  1651. <entry><emphasis>WUretryinterval</emphasis></entry>
  1652. <entry>SashaServer Archiver Process description</entry>
  1653. </row>
  1654. <row>
  1655. <entry><emphasis>WUthrottle</emphasis></entry>
  1656. <entry>SashaServer Archiver Process description</entry>
  1657. </row>
  1658. </tbody>
  1659. </tgroup>
  1660. </informaltable></para>
  1661. </sect4>
  1662. <sect4>
  1663. <title>SashaServer Process Coalescer</title>
  1664. <para>This section describes the SashaServer Process Coalescer
  1665. tab.</para>
  1666. <para><graphic fileref="images/CM-img17-2.jpg"
  1667. vendor="configmgrSS" /></para>
  1668. <para><informaltable colsep="0" frame="none" rowsep="0">
  1669. <tgroup cols="2">
  1670. <colspec align="left" colwidth="122.40pt" />
  1671. <colspec />
  1672. <tbody>
  1673. <row>
  1674. <entry>Attribute</entry>
  1675. <entry>Definition</entry>
  1676. </row>
  1677. <row>
  1678. <entry><emphasis>coalesceAt</emphasis></entry>
  1679. <entry>SashaServer Coalesce Process description</entry>
  1680. </row>
  1681. <row>
  1682. <entry><emphasis>coalesceInterval</emphasis></entry>
  1683. <entry>SashaServer Coalesce Process description</entry>
  1684. </row>
  1685. <row>
  1686. <entry><emphasis>minDeltaSize</emphasis></entry>
  1687. <entry>SashaServer Coalesce Process description</entry>
  1688. </row>
  1689. <row>
  1690. <entry><emphasis>recoverDeltaErrors</emphasis></entry>
  1691. <entry>SashaServer Coalesce Process description</entry>
  1692. </row>
  1693. </tbody>
  1694. </tgroup>
  1695. </informaltable></para>
  1696. </sect4>
  1697. <?hard-pagebreak ?>
  1698. <sect4>
  1699. <title>SashaServer Process DfuXRef</title>
  1700. <para>This section describes the SashaServer Process DfuXref
  1701. tab.</para>
  1702. <para><graphic fileref="images/CM-img17-3.jpg"
  1703. vendor="configmgrSS" /></para>
  1704. <para><informaltable colsep="0" frame="none" rowsep="0">
  1705. <tgroup cols="2">
  1706. <colspec align="left" colwidth="122.40pt" />
  1707. <colspec />
  1708. <tbody>
  1709. <row>
  1710. <entry>Attribute</entry>
  1711. <entry>Definition</entry>
  1712. </row>
  1713. <row>
  1714. <entry><emphasis>memoryLimit</emphasis></entry>
  1715. <entry>set value for Memory Limit</entry>
  1716. </row>
  1717. <row>
  1718. <entry><emphasis>xrefAt</emphasis></entry>
  1719. <entry>SashaServer DfuXRef Attribute
  1720. description...</entry>
  1721. </row>
  1722. <row>
  1723. <entry><emphasis>xrefCutoff</emphasis></entry>
  1724. <entry>SashaServer DfuXRef Attribute
  1725. description...</entry>
  1726. </row>
  1727. <row>
  1728. <entry><emphasis>xrefEclWatchProvider</emphasis></entry>
  1729. <entry>Xref Ecl Watch Provider, True or False</entry>
  1730. </row>
  1731. <row>
  1732. <entry><emphasis>xrefInterval</emphasis></entry>
  1733. <entry>value of SashaServer DfuXRef Attribute</entry>
  1734. </row>
  1735. <row>
  1736. <entry><emphasis>xrefList</emphasis></entry>
  1737. <entry>SashaServer DfuXRef Attribute
  1738. description...</entry>
  1739. </row>
  1740. <row>
  1741. <entry><emphasis>xrefMaxScanThreads</emphasis></entry>
  1742. <entry>SashaServer DfuXRef Attribute
  1743. description...</entry>
  1744. </row>
  1745. </tbody>
  1746. </tgroup>
  1747. </informaltable></para>
  1748. </sect4>
  1749. <?hard-pagebreak ?>
  1750. <sect4>
  1751. <title>SashaServer Process DfuExpiry</title>
  1752. <para>This section describes the SashaServer Process DfuExpiry
  1753. tab.</para>
  1754. <para><graphic fileref="images/CM-img17-4.jpg"
  1755. vendor="configmgrSS" /></para>
  1756. <para><informaltable colsep="0" frame="none" rowsep="0">
  1757. <tgroup cols="2">
  1758. <colspec align="left" colwidth="122.40pt" />
  1759. <colspec />
  1760. <tbody>
  1761. <row>
  1762. <entry>Attribute</entry>
  1763. <entry>Definition</entry>
  1764. </row>
  1765. <row>
  1766. <entry><emphasis>ExpiryAt</emphasis></entry>
  1767. <entry>SashaServer DfuExpiry tab description</entry>
  1768. </row>
  1769. <row>
  1770. <entry><emphasis>ExpiryInterval</emphasis></entry>
  1771. <entry>Interval in hours at which the Dfu
  1772. expires</entry>
  1773. </row>
  1774. </tbody>
  1775. </tgroup>
  1776. </informaltable></para>
  1777. </sect4>
  1778. <?hard-pagebreak ?>
  1779. <sect4>
  1780. <title>SashaServer Process ThorQMon</title>
  1781. <para>This section describes the SashaServer Process ThorQMon
  1782. tab.</para>
  1783. <para><graphic fileref="images/CM-img17-5.jpg"
  1784. vendor="configmgrSS" /></para>
  1785. <para><informaltable colsep="0" frame="none" rowsep="0">
  1786. <tgroup cols="2">
  1787. <colspec align="left" colwidth="155.50pt" />
  1788. <colspec />
  1789. <tbody>
  1790. <row>
  1791. <entry>Attribute</entry>
  1792. <entry>Definition</entry>
  1793. </row>
  1794. <row>
  1795. <entry><emphasis>ThorQMonInterval</emphasis></entry>
  1796. <entry>ThorQMonInterval description</entry>
  1797. </row>
  1798. <row>
  1799. <entry><emphasis>ThorQMonQueues</emphasis></entry>
  1800. <entry>ThorQMonQueues description</entry>
  1801. </row>
  1802. <row>
  1803. <entry><emphasis>ThorQMonSwitchMinTime</emphasis></entry>
  1804. <entry>ThorQMonSwitchMinTime description</entry>
  1805. </row>
  1806. </tbody>
  1807. </tgroup>
  1808. </informaltable></para>
  1809. </sect4>
  1810. <?hard-pagebreak ?>
  1811. <sect4>
  1812. <title>SashaServer Process DaFileSrvMonitor</title>
  1813. <para>This section describes the SashaServer Process
  1814. DaFileSrvMonitor tab.</para>
  1815. <para><graphic fileref="images/CM-img17-6.jpg"
  1816. vendor="configmgrSS" /></para>
  1817. <para><informaltable colsep="0" frame="none" rowsep="0">
  1818. <tgroup cols="2">
  1819. <colspec align="left" colwidth="122.40pt" />
  1820. <colspec />
  1821. <tbody>
  1822. <row>
  1823. <entry>Attribute</entry>
  1824. <entry>Definition</entry>
  1825. </row>
  1826. <row>
  1827. <entry><emphasis>dafsmonAt</emphasis></entry>
  1828. <entry>dafsmon description</entry>
  1829. </row>
  1830. <row>
  1831. <entry><emphasis>dafsmonInterval</emphasis></entry>
  1832. <entry>dafsmon description</entry>
  1833. </row>
  1834. <row>
  1835. <entry><emphasis>dafsmonList</emphasis></entry>
  1836. <entry>dafsmon description</entry>
  1837. </row>
  1838. </tbody>
  1839. </tgroup>
  1840. </informaltable></para>
  1841. </sect4>
  1842. <sect4>
  1843. <title>SashaServer Process Notes</title>
  1844. <para>This tab allows you to add any notes pertinent to the
  1845. component's configuration. This can be useful to keep a record of
  1846. changes and to communicate this information to peers.</para>
  1847. </sect4>
  1848. </sect3>
  1849. <sect3 id="Thor">
  1850. <title><emphasis>Thor</emphasis></title>
  1851. <para>This section details how to define a Data Refinery (Thor)
  1852. cluster. Before you begin, you should decide the width of the
  1853. cluster (i.e., how many slave nodes will you have).</para>
  1854. <itemizedlist mark="square">
  1855. <listitem>
  1856. <para>Select <emphasis role="bold">Thor Cluster -
  1857. mythor</emphasis> in the Navigator panel on the left
  1858. side.</para>
  1859. </listitem>
  1860. <listitem>
  1861. <para>Select the <emphasis role="bold">Topology</emphasis>
  1862. tab.</para>
  1863. </listitem>
  1864. <listitem>
  1865. <para>Expand the Topology, if needed, then RT-CLICK the Master
  1866. and select Delete.</para>
  1867. </listitem>
  1868. </itemizedlist>
  1869. <para>This deletes the sample one-node Thor.</para>
  1870. <para>You will replace this with a multi-node cluster.</para>
  1871. <itemizedlist mark="square">
  1872. <listitem>
  1873. <?dbfo keep-together="always"?>
  1874. <para>RT-CLICK on the Topology and select Add Master.</para>
  1875. <para><graphic fileref="images/CM-img13.jpg"
  1876. vendor="configmgrSS" /></para>
  1877. </listitem>
  1878. </itemizedlist>
  1879. <itemizedlist mark="square">
  1880. <listitem>
  1881. <?dbfo keep-together="always"?>
  1882. <para>Select a computer from the list, then press the OK
  1883. button.</para>
  1884. <para><graphic fileref="images/CM-112-5.jpg"
  1885. vendor="configmgrSS" /></para>
  1886. </listitem>
  1887. </itemizedlist>
  1888. <itemizedlist mark="square">
  1889. <listitem>
  1890. <?dbfo keep-together="always"?>
  1891. <para>RT-CLICK on the Master and select Add Slaves.</para>
  1892. <para><graphic fileref="images/CM-111.jpg"
  1893. vendor="configmgrSS" /></para>
  1894. </listitem>
  1895. </itemizedlist>
  1896. <itemizedlist mark="square">
  1897. <listitem>
  1898. <?dbfo keep-together="always"?>
  1899. <para>Select the computers to use as slaves from the list, then
  1900. press the OK button. Use CTRL+CLICK to multi-select or
  1901. SHIFT+CLICK to select a range.</para>
  1902. <para><graphic fileref="images/CM-112-3.jpg"
  1903. vendor="configmgrSS" />The Nodes now display below the Thor
  1904. Master node.</para>
  1905. <para><graphic fileref="images/CM-img14.jpg"
  1906. vendor="configmgrSS" /></para>
  1907. </listitem>
  1908. </itemizedlist>
  1909. <itemizedlist>
  1910. <listitem>
  1911. <para>Select Thor Cluster - mythor in the Navigator panel on the
  1912. left side.</para>
  1913. </listitem>
  1914. <listitem>
  1915. <?dbfo keep-together="always"?>
  1916. <para>Select the Attributes tab.</para>
  1917. <para><graphic fileref="images/CM-img15.jpg"
  1918. vendor="configmgrSS" /></para>
  1919. </listitem>
  1920. <listitem>
  1921. <para>Change the value of the localThor to <emphasis
  1922. role="bold">false</emphasis></para>
  1923. </listitem>
  1924. <listitem>
  1925. <para>Click the <inlinegraphic fileref="images/GS-img01c.png" />
  1926. disk icon to save</para>
  1927. </listitem>
  1928. </itemizedlist>
  1929. <?hard-pagebreak ?>
  1930. <sect4>
  1931. <title>Changing Thor topology</title>
  1932. <para>If you want to designate a different node as the Thor master
  1933. when setting up a multi-node system, follow these steps.</para>
  1934. <itemizedlist>
  1935. <listitem>
  1936. <para>Select <emphasis role="bold">Thor Cluster -
  1937. mythor</emphasis> in the Navigator panel on the left
  1938. side.</para>
  1939. </listitem>
  1940. <listitem>
  1941. <para>Select the <emphasis role="bold">Topology</emphasis>
  1942. tab.</para>
  1943. </listitem>
  1944. <listitem>
  1945. <para>RT-CLICK on the Master node</para>
  1946. </listitem>
  1947. <listitem>
  1948. <?dbfo keep-together="always"?>
  1949. <para>Select the <emphasis role="bold">Swap Master</emphasis>
  1950. option.</para>
  1951. <para><graphic fileref="images/CM-111-2.jpg"
  1952. vendor="configmgrSS" /></para>
  1953. <para><informaltable colsep="1" frame="all" rowsep="1">
  1954. <?dbfo keep-together="always"?>
  1955. <tgroup cols="2">
  1956. <colspec colwidth="49.50pt" />
  1957. <colspec />
  1958. <tbody>
  1959. <row>
  1960. <entry><inlinegraphic
  1961. fileref="images/caution.png" /></entry>
  1962. <entry>You should only use this feature when
  1963. initially setting up your system. If there is data
  1964. on the nodes when attempting to Swap Master, you run
  1965. the risk of losing or corrupting some data.</entry>
  1966. </row>
  1967. </tbody>
  1968. </tgroup>
  1969. </informaltable></para>
  1970. </listitem>
  1971. </itemizedlist>
  1972. </sect4>
  1973. <?hard-pagebreak ?>
  1974. <sect4>
  1975. <title>ThorCluster Attributes</title>
  1976. <para>This section describes the Thor Cluster Attributes
  1977. tab.</para>
  1978. <para><graphic fileref="images/CM-img18-1.jpg"
  1979. vendor="configmgrSS" /></para>
  1980. <para><informaltable colsep="0" frame="none" rowsep="0">
  1981. <tgroup cols="2">
  1982. <colspec align="left" colwidth="155.50pt" />
  1983. <colspec />
  1984. <tbody>
  1985. <row>
  1986. <entry>Attribute</entry>
  1987. <entry>Definition</entry>
  1988. </row>
  1989. <row>
  1990. <entry><emphasis>allowedPipePrograms</emphasis></entry>
  1991. <entry>ThorCluster Process description</entry>
  1992. </row>
  1993. <row>
  1994. <entry><emphasis>autoCopyBackup</emphasis></entry>
  1995. <entry>True or False</entry>
  1996. </row>
  1997. <row>
  1998. <entry><emphasis>checkPointRecovery</emphasis></entry>
  1999. <entry>True or False</entry>
  2000. </row>
  2001. <row>
  2002. <entry><emphasis>daliServers</emphasis></entry>
  2003. <entry>The Dali Server</entry>
  2004. </row>
  2005. <row>
  2006. <entry><emphasis>defaultOutputNodeGroup</emphasis></entry>
  2007. <entry></entry>
  2008. </row>
  2009. <row>
  2010. <entry><emphasis>description</emphasis></entry>
  2011. <entry>ThorCluster Process description</entry>
  2012. </row>
  2013. <row>
  2014. <entry><emphasis>externalProgDir</emphasis></entry>
  2015. <entry>Location of externals</entry>
  2016. </row>
  2017. <row>
  2018. <entry><emphasis>globalMemorySize</emphasis></entry>
  2019. <entry>ThorCluster Process description</entry>
  2020. </row>
  2021. <row>
  2022. <entry><emphasis>idleRestartPeriod</emphasis></entry>
  2023. <entry>ThorCluster Process description</entry>
  2024. </row>
  2025. <row>
  2026. <entry><emphasis>largeMemSize</emphasis></entry>
  2027. <entry>ThorCluster Process description</entry>
  2028. </row>
  2029. <row>
  2030. <entry><emphasis>LCR</emphasis></entry>
  2031. <entry>True or False</entry>
  2032. </row>
  2033. <row>
  2034. <entry><emphasis>localThor</emphasis></entry>
  2035. <entry>True or False</entry>
  2036. </row>
  2037. <row>
  2038. <entry><emphasis>localThorPortBase</emphasis></entry>
  2039. <entry></entry>
  2040. </row>
  2041. <row>
  2042. <entry><emphasis>localThorPortInc</emphasis></entry>
  2043. <entry></entry>
  2044. </row>
  2045. <row>
  2046. <entry><emphasis>masterport</emphasis></entry>
  2047. <entry></entry>
  2048. </row>
  2049. <row>
  2050. <entry><emphasis>monitorDaliFileServer</emphasis></entry>
  2051. <entry>Specifies whether to monitor for DaFileSrv
  2052. process (True or False )</entry>
  2053. </row>
  2054. <row>
  2055. <entry><emphasis>multiSlaves</emphasis></entry>
  2056. <entry>True or False</entry>
  2057. </row>
  2058. <row>
  2059. <entry><emphasis>multiThorExclusionLockName</emphasis></entry>
  2060. <entry></entry>
  2061. </row>
  2062. <row>
  2063. <entry><emphasis>multiThorMemoryThreshold</emphasis></entry>
  2064. <entry></entry>
  2065. </row>
  2066. <row>
  2067. <entry><emphasis>multiThorPriorityLock</emphasis></entry>
  2068. <entry>True or False</entry>
  2069. </row>
  2070. <row>
  2071. <entry><emphasis>name</emphasis></entry>
  2072. <entry>Name of cluster</entry>
  2073. </row>
  2074. <row>
  2075. <entry><emphasis>nodeGroup</emphasis></entry>
  2076. <entry></entry>
  2077. </row>
  2078. <row>
  2079. <entry><emphasis>pluginsPath</emphasis></entry>
  2080. <entry>Location of plugins</entry>
  2081. </row>
  2082. <row>
  2083. <entry><emphasis>queueName</emphasis></entry>
  2084. <entry></entry>
  2085. </row>
  2086. <row>
  2087. <entry><emphasis>replicateAsync</emphasis></entry>
  2088. <entry>True or False</entry>
  2089. </row>
  2090. <row>
  2091. <entry><emphasis>replicateOutputs</emphasis></entry>
  2092. <entry>True or False</entry>
  2093. </row>
  2094. <row>
  2095. <entry><emphasis>slaveDownTimeout</emphasis></entry>
  2096. <entry></entry>
  2097. </row>
  2098. <row>
  2099. <entry><emphasis>slaveport</emphasis></entry>
  2100. <entry></entry>
  2101. </row>
  2102. <row>
  2103. <entry><emphasis>smallSortThreshold</emphasis></entry>
  2104. <entry></entry>
  2105. </row>
  2106. <row>
  2107. <entry><emphasis>verifyDaliConnectionInterval</emphasis></entry>
  2108. <entry></entry>
  2109. </row>
  2110. <row>
  2111. <entry><emphasis>watchdogEnabled</emphasis></entry>
  2112. <entry>True or False</entry>
  2113. </row>
  2114. <row>
  2115. <entry><emphasis>watchdogProgressEnabled</emphasis></entry>
  2116. <entry>True or False</entry>
  2117. </row>
  2118. <row>
  2119. <entry><emphasis>watchdogProgressInterval</emphasis></entry>
  2120. <entry>ThorCluster Process description</entry>
  2121. </row>
  2122. </tbody>
  2123. </tgroup>
  2124. </informaltable></para>
  2125. </sect4>
  2126. <?hard-pagebreak ?>
  2127. <sect4>
  2128. <title>ThorCluster SSH Options</title>
  2129. <para>This section describes the ThorCluster SSH Options
  2130. tab.</para>
  2131. <para><graphic fileref="images/CM-img18-2.jpg"
  2132. vendor="configmgrSS" /></para>
  2133. <para><informaltable colsep="0" frame="none" rowsep="0">
  2134. <tgroup cols="2">
  2135. <colspec align="left" colwidth="122.40pt" />
  2136. <colspec />
  2137. <tbody>
  2138. <row>
  2139. <entry>Attribute</entry>
  2140. <entry>Definition</entry>
  2141. </row>
  2142. <row>
  2143. <entry><emphasis>SSHidentityfile</emphasis></entry>
  2144. <entry>Location of the SSH keys component files.</entry>
  2145. </row>
  2146. <row>
  2147. <entry><emphasis>SSHpassword</emphasis></entry>
  2148. <entry></entry>
  2149. </row>
  2150. <row>
  2151. <entry><emphasis>SSHretries</emphasis></entry>
  2152. <entry>The number of times...</entry>
  2153. </row>
  2154. <row>
  2155. <entry><emphasis>SSHtimeout</emphasis></entry>
  2156. <entry>Timeout</entry>
  2157. </row>
  2158. <row>
  2159. <entry><emphasis>SSHusername</emphasis></entry>
  2160. <entry>The user name of the account the SSH keys are
  2161. associated with</entry>
  2162. </row>
  2163. </tbody>
  2164. </tgroup>
  2165. </informaltable></para>
  2166. </sect4>
  2167. <sect4>
  2168. <title>ThorCluster Debug</title>
  2169. <para>The debug tab is for internal use only</para>
  2170. </sect4>
  2171. <?hard-pagebreak ?>
  2172. <sect4>
  2173. <title>ThorCluster Swap Node</title>
  2174. <para>This section describes the ThorCluster Swap Node tab.</para>
  2175. <para><graphic fileref="images/CM-img18-4.jpg"
  2176. vendor="configmgrSS" /></para>
  2177. <para><informaltable colsep="0" frame="none" rowsep="0">
  2178. <tgroup cols="2">
  2179. <colspec align="left" colwidth="155.50pt" />
  2180. <colspec />
  2181. <tbody>
  2182. <row>
  2183. <entry>Attribute</entry>
  2184. <entry>Definition</entry>
  2185. </row>
  2186. <row>
  2187. <entry><emphasis>AutoSwapNode</emphasis></entry>
  2188. <entry>True or False. Set to True to enable
  2189. AutoSwapNode</entry>
  2190. </row>
  2191. <row>
  2192. <entry><emphasis>CheckAfterEveryJob</emphasis></entry>
  2193. <entry>True or False. Set to True to Check after Every
  2194. Job</entry>
  2195. </row>
  2196. <row>
  2197. <entry><emphasis>SwapNodeCheckC</emphasis></entry>
  2198. <entry>True or False. Set to True to ...</entry>
  2199. </row>
  2200. <row>
  2201. <entry><emphasis>SwapNodeCheckD</emphasis></entry>
  2202. <entry>True or False. Set to True to...</entry>
  2203. </row>
  2204. <row>
  2205. <entry><emphasis>SwapNodeCheckScript</emphasis></entry>
  2206. <entry></entry>
  2207. </row>
  2208. <row>
  2209. <entry><emphasis>SwapNodeCheckScriptTimeout</emphasis></entry>
  2210. <entry>The number ...</entry>
  2211. </row>
  2212. <row>
  2213. <entry><emphasis>SwapNodeInterval</emphasis></entry>
  2214. <entry>The number ...</entry>
  2215. </row>
  2216. <row>
  2217. <entry><emphasis>SwapNodeMaxConcurrent</emphasis></entry>
  2218. <entry>value of Maximum number of concurrent...</entry>
  2219. </row>
  2220. <row>
  2221. <entry><emphasis>SwapNodeRestartJob</emphasis></entry>
  2222. <entry>True or False. Set to True...</entry>
  2223. </row>
  2224. </tbody>
  2225. </tgroup>
  2226. </informaltable></para>
  2227. </sect4>
  2228. <?hard-pagebreak ?>
  2229. <sect4>
  2230. <title>ThorCluster Backup</title>
  2231. <para>This section describes the ThorCluster Backup tab.</para>
  2232. <para><graphic fileref="images/CM-img18-5.jpg"
  2233. vendor="configmgrSS" /></para>
  2234. <para><informaltable colsep="0" frame="none" rowsep="0">
  2235. <tgroup cols="2">
  2236. <colspec align="left" colwidth="122.40pt" />
  2237. <colspec />
  2238. <tbody>
  2239. <row>
  2240. <entry>Attribute</entry>
  2241. <entry>Definition</entry>
  2242. </row>
  2243. <row>
  2244. <entry><emphasis>breakoutLimit</emphasis></entry>
  2245. <entry>value of...</entry>
  2246. </row>
  2247. <row>
  2248. <entry><emphasis>refreshRate</emphasis></entry>
  2249. <entry>value of...</entry>
  2250. </row>
  2251. </tbody>
  2252. </tgroup>
  2253. </informaltable></para>
  2254. </sect4>
  2255. <sect4>
  2256. <title>ThorCluster Notes</title>
  2257. <para>This tab allows you to add any notes pertinent to the
  2258. component's configuration. This can be useful to keep a record of
  2259. changes and to communicate this information to peers.</para>
  2260. </sect4>
  2261. <sect4>
  2262. <title>Swap Master</title>
  2263. <para>The swap master option now allows you to easily swap out the
  2264. Thor Master.***</para>
  2265. <para><graphic fileref="images/CM-186.jpg"
  2266. vendor="configmgrSS" /></para>
  2267. </sect4>
  2268. </sect3>
  2269. <sect3 id="Roxie" role="brk">
  2270. <title><emphasis>Roxie</emphasis></title>
  2271. <para>This section details how to define a Rapid Data Delivery
  2272. Engine (Roxie) cluster. Before you begin, you should decide the
  2273. width of the cluster (i.e., how many agent nodes will you
  2274. have).***Change the value of the localslave to <emphasis
  2275. role="bold">false***</emphasis></para>
  2276. <itemizedlist mark="square">
  2277. <listitem>
  2278. <para>Select Roxie Cluster in the Navigator panel on the left
  2279. side.</para>
  2280. </listitem>
  2281. <listitem>
  2282. <para>Select the Servers tab.</para>
  2283. </listitem>
  2284. <listitem>
  2285. <para>Expand the RoxieCluster &gt;&gt; farm1, if needed, then
  2286. RT-CLICK the Server and select
  2287. <guimenuitem>Delete</guimenuitem>.</para>
  2288. <para><graphic fileref="images/CM-112.jpg"
  2289. vendor="configmgrSS" /></para>
  2290. </listitem>
  2291. </itemizedlist>
  2292. <para>This deletes the sample one-node Roxie Server.</para>
  2293. <para>You will replace this with several servers to act as Roxie
  2294. Servers.</para>
  2295. <itemizedlist mark="square">
  2296. <listitem>
  2297. <?dbfo keep-together="always"?>
  2298. <para>RT-CLICK on the Roxie Cluster and select Add Farm.</para>
  2299. <para><graphic fileref="images/CM-112-1.jpg"
  2300. vendor="configmgrSS" /></para>
  2301. </listitem>
  2302. <listitem>
  2303. <?dbfo keep-together="always"?>
  2304. <para>Select the computers to use as Servers from the list, then
  2305. press the OK button. Use Ctrl+click to multi-select or
  2306. shift+click to select a range.</para>
  2307. <para><graphic fileref="images/CM-112-2.jpg"
  2308. vendor="configmgrSS" /></para>
  2309. </listitem>
  2310. </itemizedlist>
  2311. <itemizedlist mark="square">
  2312. <listitem>
  2313. <para>Select the Agents tab.</para>
  2314. </listitem>
  2315. <listitem>
  2316. <?dbfo keep-together="always"?>
  2317. <para>Select the RoxieCluster, then RT-CLICK select Reconfigure
  2318. Agents.</para>
  2319. <para>This allows you to replace the single agent with the
  2320. multiple nodes you added as Servers.</para>
  2321. <para><graphic fileref="images/CM-img16.jpg"
  2322. vendor="configmgrSS" /></para>
  2323. </listitem>
  2324. </itemizedlist>
  2325. <itemizedlist mark="square">
  2326. <listitem>
  2327. <?dbfo keep-together="always"?>
  2328. <para>Select the computers to use as Agents from the list, then
  2329. press the <emphasis role="bold">OK</emphasis> button. Use
  2330. Ctrl+click to multi-select or shift+click to select a
  2331. range.</para>
  2332. <para><graphic fileref="images/CM-112-2.jpg"
  2333. vendor="configmgrSS" /><emphasis role="bold">Note:</emphasis> In
  2334. this example, we are using the same five nodes that were made to
  2335. be Servers. This is a typical configuration.</para>
  2336. </listitem>
  2337. </itemizedlist>
  2338. <itemizedlist mark="square">
  2339. <listitem>
  2340. <?dbfo keep-together="always"?>
  2341. <para>Select the redundancy scheme to use. Typically, this is
  2342. Circular Redundancy, as shown below.</para>
  2343. <para><graphic fileref="images/GS-img25.png"
  2344. vendor="configmgrSS" /></para>
  2345. </listitem>
  2346. <listitem>
  2347. <para>Click the <inlinegraphic fileref="images/GS-img01c.png" />
  2348. disk icon to save</para>
  2349. </listitem>
  2350. <listitem>
  2351. <para>Close Configuration Manager by pressing ctrl+C in the
  2352. command window where it is running.</para>
  2353. </listitem>
  2354. </itemizedlist>
  2355. </sect3>
  2356. <sect3 id="Topology" role="brk">
  2357. <title>Topology</title>
  2358. <para>This section describes the topology tab.</para>
  2359. <para></para>
  2360. <para><graphic fileref="images/CM-img20.jpg"
  2361. vendor="configmgrSS" /><informaltable colsep="0" frame="none"
  2362. rowsep="0">
  2363. <tgroup cols="2">
  2364. <colspec align="left" colwidth="122.40pt" />
  2365. <colspec />
  2366. <tbody>
  2367. <row>
  2368. <entry>Attribute name</entry>
  2369. <entry>Definition</entry>
  2370. </row>
  2371. <row>
  2372. <entry><emphasis>Topology</emphasis></entry>
  2373. <entry>describes the system topology</entry>
  2374. </row>
  2375. <row>
  2376. <entry><emphasis>Cluster - thor</emphasis></entry>
  2377. <entry>describes the Thor clusters</entry>
  2378. </row>
  2379. <row>
  2380. <entry><emphasis>Cluster - hthor</emphasis></entry>
  2381. <entry>describes the hthor clusters</entry>
  2382. </row>
  2383. <row>
  2384. <entry><emphasis>Cluster - roxie</emphasis></entry>
  2385. <entry>describes the Roxie clusters</entry>
  2386. </row>
  2387. </tbody>
  2388. </tgroup>
  2389. </informaltable></para>
  2390. </sect3>
  2391. <sect3 id="Propogate-configuration-changes">
  2392. <title><emphasis>Distribute Configuration Changes to all Nodes
  2393. </emphasis></title>
  2394. <para>Once your environment is set up as desired, you must copy the
  2395. configuration file out to the other nodes.</para>
  2396. <para></para>
  2397. <itemizedlist>
  2398. <listitem>
  2399. <para>If it is running, stop the system</para>
  2400. <para><informaltable colsep="1" frame="all" rowsep="1">
  2401. <?dbfo keep-together="always"?>
  2402. <tgroup cols="2">
  2403. <colspec colwidth="49.50pt" />
  2404. <colspec />
  2405. <tbody>
  2406. <row>
  2407. <entry><inlinegraphic
  2408. fileref="images/caution.png" /></entry>
  2409. <entry>Be sure system is stopped before attempting to
  2410. move the Environment.xml file.</entry>
  2411. </row>
  2412. </tbody>
  2413. </tgroup>
  2414. </informaltable></para>
  2415. </listitem>
  2416. <listitem>
  2417. <para>Back up the original environment.xml file</para>
  2418. <programlisting># for example
  2419. sudo -u hpcc cp /etc/HPCCSystems/environment.xml /etc/HPCCSystems/environment.bak </programlisting>
  2420. <para>Note: the "live environment.xml file is located in your
  2421. <emphasis role="bold">/etc/HPCCSystems/</emphasis> directory.
  2422. ConfigManager works on files in <emphasis
  2423. role="bold">/etc/HPCCSystems/source</emphasis> directory. You
  2424. must copy from this location to make an environment.xml file
  2425. active.</para>
  2426. </listitem>
  2427. <listitem>
  2428. <para>Copy the NewEnvironment.xml file from the source directory
  2429. to the /etc/HPCCSystems and rename the file to
  2430. environment.xml</para>
  2431. <programlisting># for example
  2432. sudo -u hpcc cp /etc/HPCCSystems/source/NewEnvironment.xml /etc/HPCCSystems/environment.xml</programlisting>
  2433. <para></para>
  2434. </listitem>
  2435. <listitem>
  2436. <para>Copy the /etc/HPCCSystems/environment.xml to the
  2437. /etc/HPCCSystems/ on every node.</para>
  2438. <para></para>
  2439. </listitem>
  2440. <listitem>
  2441. <para>Restart the HPCC system</para>
  2442. <para>You might prefer to script this process, especially if you
  2443. have many nodes. See the Example Scripts section in the Appendix
  2444. of the Installing_and_RunningtheHPCCPlatform document. You can
  2445. use the scripts as a model to create your own script to copy the
  2446. environment.xml file out to all your nodes.</para>
  2447. </listitem>
  2448. </itemizedlist>
  2449. </sect3>
  2450. </sect2>
  2451. </sect1>
  2452. </chapter>
  2453. </book>