UsingConfigManager.xml 72 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222
  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. <para>The HPCC package should already be installed on ALL nodes.</para>
  66. <para>You can use any tool or shell script you choose.</para>
  67. <orderedlist>
  68. <listitem>
  69. <para>SSH to a node in your environment and login as a user with
  70. sudo privileges. We would suggest that it would be the first node,
  71. and that it is a support node, however that is up to your
  72. discretion.</para>
  73. </listitem>
  74. <listitem>
  75. <para>Start the Configuration Manager service on the node (again we
  76. would suggest that it should be on a support node, and further that
  77. you use the same node to start the Configuration Manager every time,
  78. but this is also entirely up to you).</para>
  79. <programlisting>sudo /opt/HPCCSystems/sbin/configmgr</programlisting>
  80. <para><graphic fileref="images/gs_img_configmgrStart.jpg" /></para>
  81. </listitem>
  82. <listitem>
  83. <para>Using a Web browser, go to the Configuration Manager's
  84. interface:</para>
  85. <programlisting>http://&lt;<emphasis>ip of installed system</emphasis>&gt;:8015</programlisting>
  86. <para>The Configuration Manager startup wizard displays.</para>
  87. </listitem>
  88. </orderedlist>
  89. <para>There are different ways to configure your HPCC system. You can
  90. use the <emphasis role="bold">Generate environment wizard</emphasis> and
  91. use that environment or experienced users can then use the <emphasis
  92. role="bold">Advanced View</emphasis> for more specific customization.
  93. There is also the option of using <emphasis role="bold">Create blank
  94. environment</emphasis> to generate an empty environment that you could
  95. then go in and add only the components you would want.</para>
  96. <sect2 id="Env_Wizard">
  97. <title>Environment Wizard</title>
  98. <orderedlist>
  99. <listitem>
  100. <?dbfo keep-together="always"?>
  101. <para>To use the wizard select the <emphasis role="bold">Generate
  102. new environment using wizard</emphasis> button.</para>
  103. <para><graphic fileref="images/GS_ConfigMgrWizStart.jpg"
  104. vendor="configmgrSS" /></para>
  105. </listitem>
  106. <listitem>
  107. <para>Provide a name for the environment file.</para>
  108. <para>This will then be the name of the configuration XML file.
  109. For example, we will name our environment
  110. <emphasis>NewEnvironment</emphasis> and this will produce a
  111. configuration XML file named
  112. <emphasis>NewEnvironment.xml</emphasis> that we will
  113. use.<emphasis> </emphasis></para>
  114. </listitem>
  115. <listitem>
  116. <para>Press the Next button.</para>
  117. <para>Next you will need to define the IP addresses that your HPCC
  118. system will be using.</para>
  119. </listitem>
  120. <listitem>
  121. <?dbfo keep-together="always"?>
  122. <para>Enter the IP addresses.</para>
  123. <para>IP Addresses can be specified individually using semi-colon
  124. delimiters. You can also specify a range of IPs using a hyphen
  125. (for example, nnn.nnn.nnn.x-y). In the image below, we specified
  126. the IP addresses 10.239.219.1 through 10.239.219.100 using the
  127. range syntax, and also a single IP 10.239.219.111.</para>
  128. <para><graphic fileref="images/GS_ConfigMgrWiz002.jpg"
  129. vendor="configmgrSS" /></para>
  130. </listitem>
  131. <listitem>
  132. <para>Press the Next button.</para>
  133. <para>Now you will define how many nodes to use for the Roxie and
  134. Thor clusters.</para>
  135. </listitem>
  136. <listitem>
  137. <?dbfo keep-together="always"?>
  138. <para>Enter the appropriate values as indicated.</para>
  139. <para><graphic fileref="images/GS_CMWiz003.jpg"
  140. vendor="configmgrSS" /></para>
  141. <variablelist>
  142. <varlistentry>
  143. <term>Number of support nodes:</term>
  144. <listitem>
  145. <para>Specify the number of nodes to use for support
  146. components. The default is 1.</para>
  147. </listitem>
  148. </varlistentry>
  149. <varlistentry>
  150. <term>Number of nodes for Roxie cluster:</term>
  151. <listitem>
  152. <para>Specify the number of nodes to use for your Roxie
  153. cluster. Enter zero (0) if you do not want a Roxie
  154. cluster.</para>
  155. </listitem>
  156. </varlistentry>
  157. <varlistentry>
  158. <term>Number of slave nodes for Thor cluster</term>
  159. <listitem>
  160. <para>Specify the number of slave nodes to use in your Thor
  161. cluster. A Thor master node will be added automatically.
  162. Enter zero (0) if you do not want any Thor slaves.</para>
  163. </listitem>
  164. </varlistentry>
  165. <varlistentry>
  166. <term>Number of Thor slaves per node (default 1)</term>
  167. <listitem>
  168. <para>Specify the number of Thor slave processes to
  169. instantiate on each slave node. Enter zero (0) if you do not
  170. want a Thor cluster.</para>
  171. </listitem>
  172. </varlistentry>
  173. <varlistentry>
  174. <term>Enable Roxie on demand</term>
  175. <listitem>
  176. <para>Specify whether or not to allow queries to be run
  177. immediately on Roxie. This must be enabled to run the
  178. debugger. (Default is true)</para>
  179. </listitem>
  180. </varlistentry>
  181. </variablelist>
  182. </listitem>
  183. <listitem>
  184. <para>Press the <emphasis role="bold">Next</emphasis>
  185. button</para>
  186. <para>The wizard displays the configuration parameters.</para>
  187. </listitem>
  188. <listitem>
  189. <?dbfo keep-together="always"?>
  190. <para>Press the <emphasis role="bold">Finish</emphasis> button to
  191. accept these values or press the <emphasis role="bold">Advanced
  192. View</emphasis> button to edit in advanced mode.</para>
  193. <graphic fileref="images/GS_ConfigMgrWiz004.jpg" />
  194. </listitem>
  195. </orderedlist>
  196. <para>You will now be notified that you have completed the
  197. wizard.</para>
  198. <para><graphic fileref="images/GS_ConfigMgrWiz005.jpg" /></para>
  199. <para>At this point, you have created a file named NewEnvironment.xml
  200. in the <emphasis role="bold">/etc/HPCCSystems/source</emphasis>
  201. directory</para>
  202. <informaltable colsep="1" frame="all" rowsep="1">
  203. <?dbfo keep-together="always"?>
  204. <tgroup cols="2">
  205. <colspec colwidth="49.50pt" />
  206. <colspec />
  207. <tbody>
  208. <row>
  209. <entry><inlinegraphic fileref="images/OSSgr3.png" /></entry>
  210. <entry>Keep in mind, that your HPCC configuration may be
  211. different depending on your needs. For example, you may not
  212. need a Roxie or you may need several smaller Roxie clusters.
  213. In addition, in a production [Thor] system, you would ensure
  214. that Thor and Roxie nodes are dedicated and have no other
  215. processes running on them. This document is intended to show
  216. you how to use the configuration tools. Capacity planning and
  217. system design is covered in a training module.</entry>
  218. </row>
  219. </tbody>
  220. </tgroup>
  221. </informaltable>
  222. <sect3 id="Distrib_Conf" role="brk">
  223. <title>Distribute the Configuration</title>
  224. <orderedlist>
  225. <listitem>
  226. <?dbfo keep-together="always"?>
  227. <para>Stop the HPCC system.</para>
  228. <para>If it is running stop the HPCC system (on every node),
  229. using a command such as this:</para>
  230. <para><programlisting>sudo /sbin/service hpcc-init stop</programlisting></para>
  231. <variablelist>
  232. <varlistentry>
  233. <term>Note:</term>
  234. <listitem>
  235. <para>You may have a multi-node system and a custom script
  236. such as the one illustrated in Appendix of the <emphasis
  237. role="bluebold">Installing and Running the HPCC
  238. Platform</emphasis> document to start and stop your
  239. system. If that is the case please use the appropriate
  240. command for stopping your system on every node.</para>
  241. </listitem>
  242. </varlistentry>
  243. </variablelist>
  244. <para><informaltable colsep="1" frame="all" rowsep="1">
  245. <tgroup cols="2">
  246. <colspec colwidth="49.50pt" />
  247. <colspec />
  248. <tbody>
  249. <row>
  250. <entry><inlinegraphic
  251. fileref="images/caution.png" /></entry>
  252. <entry>Be sure HPCC is stopped before attempting to
  253. copy the environment.xml file.</entry>
  254. </row>
  255. </tbody>
  256. </tgroup>
  257. </informaltable></para>
  258. </listitem>
  259. <listitem>
  260. <para>Back up the original environment.xml file.</para>
  261. <programlisting># For example
  262. sudo -u hpcc cp /etc/HPCCSystems/environment.xml /etc/HPCCSystems/source/environment-date.xml </programlisting>
  263. <variablelist>
  264. <varlistentry>
  265. <term>Note:</term>
  266. <listitem>
  267. <para>The live environment.xml file is located in your
  268. <emphasis role="bold">/etc/HPCCSystems/</emphasis>
  269. directory. ConfigManager works on files in <emphasis
  270. role="bold">/etc/HPCCSystems/source</emphasis> directory.
  271. You must copy from this location to make an
  272. environment.xml file active.</para>
  273. </listitem>
  274. </varlistentry>
  275. </variablelist>
  276. <para>You can also choose to give the environment file a more
  277. descriptive name, to help differentiate any differences.</para>
  278. <para>Having environment files under source control is a good
  279. way to archive your environment settings.</para>
  280. </listitem>
  281. <listitem>
  282. <para>Copy the new .xml file from the source directory to the
  283. /etc/HPCCSystems and rename the file to
  284. <emphasis>environment.xml</emphasis></para>
  285. <programlisting># for example
  286. sudo -u hpcc cp /etc/HPCCSystems/source/NewEnvironment.xml /etc/HPCCSystems/environment.xml</programlisting>
  287. <para></para>
  288. </listitem>
  289. <listitem>
  290. <para>Copy the <emphasis
  291. role="bold">/etc/HPCCSystems/environment.xml</emphasis> to the
  292. <emphasis role="bold">/etc/HPCCSystems/</emphasis> on to
  293. <emphasis>every</emphasis> node.</para>
  294. <para>You may want to use a script to push out the XML file to
  295. all nodes. See the <emphasis>Example Scripts</emphasis> section
  296. in the Appendix of the <emphasis role="bluebold">Installing and
  297. Running the HPCC Platform</emphasis> document. You can use the
  298. scripts as a model to create your own script to copy the
  299. environment.xml file out to all your nodes.</para>
  300. </listitem>
  301. <listitem>
  302. <para>Restart the HPCC platform on all nodes.</para>
  303. </listitem>
  304. </orderedlist>
  305. </sect3>
  306. </sect2>
  307. </sect1>
  308. </chapter>
  309. <chapter>
  310. <title>Configuration Manager Advanced View</title>
  311. <para>For the advanced user, the Advanced View offers access to adding
  312. additional instances of components or making configuration settings for
  313. individual components.</para>
  314. <sect1 id="configuring-advanced-setup">
  315. <title>Using ConfigMgr in Advanced Mode</title>
  316. <para>This section shows some of the configuration options in Advanced
  317. Mode. There are a few different ways to configure your system. If you
  318. are not an experienced user you can use the Generate environment wizard
  319. discussed in the previous section. The following steps will detail the
  320. Advanced set up.</para>
  321. <orderedlist>
  322. <listitem>
  323. <para>SSH to the first box in your environment and login as a user
  324. with sudo privileges.</para>
  325. </listitem>
  326. <listitem>
  327. <para>If it is running, stop the HPCC system using this command on
  328. every node:</para>
  329. <para><programlisting>sudo /sbin/service hpcc-init stop</programlisting></para>
  330. <variablelist>
  331. <varlistentry>
  332. <term>Note:</term>
  333. <listitem>
  334. <para>If you have a large system with many nodes, you may want
  335. to use a script to perform this step. See the
  336. <emphasis>Example Scripts</emphasis> section in the Appendix
  337. of the <emphasis role="bluebold">Installing and Running the
  338. HPCC Platform</emphasis> document.</para>
  339. </listitem>
  340. </varlistentry>
  341. </variablelist>
  342. <para><informaltable colsep="1" frame="all" rowsep="1">
  343. <?dbfo keep-together="always"?>
  344. <tgroup cols="2">
  345. <colspec colwidth="49.50pt" />
  346. <colspec />
  347. <tbody>
  348. <row>
  349. <entry><inlinegraphic
  350. fileref="images/OSSgr3.png" /></entry>
  351. <entry>You can use this command to confirm HPCC processes
  352. are stopped: <para><programlisting>sudo /sbin/service hpcc-init status</programlisting></para></entry>
  353. </row>
  354. </tbody>
  355. </tgroup>
  356. </informaltable></para>
  357. </listitem>
  358. <listitem>
  359. <para>Start the Configuration Manager service on one node (usually
  360. the first node is considered the head node and is used for this
  361. task, but this is up to you).</para>
  362. <programlisting>sudo /opt/HPCCSystems/sbin/configmgr</programlisting>
  363. <para><graphic fileref="images/gs_img_configmgrStart.jpg" /></para>
  364. </listitem>
  365. <listitem>
  366. <para>Using a Web browser, go to the Configuration Manager's
  367. interface:</para>
  368. <programlisting>http://&lt;<emphasis>ip of installed system</emphasis>&gt;:8015</programlisting>
  369. <para>The Configuration Manager startup wizard displays.</para>
  370. </listitem>
  371. <listitem>
  372. <para>Select <emphasis role="bold">Advanced View</emphasis>, then
  373. press the <emphasis role="bold">Next </emphasis>button.</para>
  374. <para>There are a few different ways to configure your system. If
  375. you are not an experienced user you can use the Generate environment
  376. wizard discussed in the previous section.</para>
  377. </listitem>
  378. <listitem>
  379. <para>Select an XML file from the drop list.</para>
  380. <para>This list is populated from versions of an environment XML
  381. file in your server's /etc/HPCCSystems/source/ directory.</para>
  382. <para>The system will check the current environment file and if a
  383. match is found here it will highlight in blue the current
  384. environment file being used.</para>
  385. </listitem>
  386. <listitem>
  387. <?dbfo keep-together="always"?>
  388. <para>Press the <emphasis role="bold">Next</emphasis> button.
  389. <graphic fileref="images/CM-WizStart.jpg"
  390. vendor="configmgrSS" /></para>
  391. </listitem>
  392. <listitem>
  393. <para>The Configuration Manager interface displays.</para>
  394. <para><informaltable colsep="1" frame="all" rowsep="1">
  395. <?dbfo keep-together="always"?>
  396. <tgroup cols="2">
  397. <colspec colwidth="49.50pt" />
  398. <colspec />
  399. <tbody>
  400. <row>
  401. <entry><inlinegraphic
  402. fileref="images/OSSgr3.png" /></entry>
  403. <entry>Default access is read-only. Many options are only
  404. available when write-access is enabled. <para>Gain write
  405. access by checking the <emphasis role="bold">Write
  406. Access</emphasis> checkbox. </para><para>Unchecking this
  407. box returns the environment to read-only mode. All menu
  408. items are disabled in read-only mode. </para><para>Closing
  409. the web page automatically removes any write-access
  410. locks.</para></entry>
  411. </row>
  412. </tbody>
  413. </tgroup>
  414. </informaltable></para>
  415. </listitem>
  416. <listitem>
  417. <para>Check the <emphasis role="bold">Write Access</emphasis>
  418. box.</para>
  419. <para><graphic fileref="images/CM-img101.jpg"
  420. vendor="configmgrSS" />The <emphasis role="bold">Save</emphasis>
  421. button<inlinegraphic fileref="images/GS-img01c.png"
  422. vendor="configmgrSS" /> validates and saves the environment.</para>
  423. <para>The <emphasis role="bold">Save Environment As</emphasis>
  424. button <inlinegraphic fileref="images/CM-img181.jpg"
  425. vendor="configmgrSS" /> validates and lets you specify the
  426. environment filename to save.</para>
  427. <para>The <emphasis role="bold">Validate Environment</emphasis>
  428. button<inlinegraphic fileref="images/GS-img01d.png"
  429. vendor="configmgrSS" /> just validates the current environment
  430. including any changes that have not yet been saved.</para>
  431. <para>The <emphasis role="bold">Open Environment</emphasis> button
  432. <inlinegraphic fileref="images/CM-img18.jpg" vendor="configmgrSS" />
  433. allows you to open a new environment file to work on.</para>
  434. <para>The <emphasis role="bold">Wizard</emphasis> button
  435. <inlinegraphic fileref="images/CM-img19.jpg" vendor="configmgrSS" />
  436. will bring up the Configuration Manager chooser form which will
  437. allow you to create or view an environment file where you can also
  438. launch the configuration wizard.</para>
  439. <para>These buttons are only enabled in Write Access mode.</para>
  440. </listitem>
  441. </orderedlist>
  442. <sect2 role="brk">
  443. <title>XML View</title>
  444. <para>In the advanced view of Configuration Manager, you can
  445. optionally choose to work with the XML View.</para>
  446. <para>To see the the configuration in XML View, click on the
  447. Environment heading in the Navigator panel on the left side.</para>
  448. <para><graphic fileref="images/CM-120.jpg" />You can access all
  449. attributes through the XML view.</para>
  450. <para>If you wish to add an attribute that does not exist, right-click
  451. on one of the components then you can choose to add an
  452. attribute.</para>
  453. <para><graphic fileref="images/CM-121.jpg" /></para>
  454. </sect2>
  455. </sect1>
  456. <sect1 role="brk">
  457. <title>Hardware Section</title>
  458. <para>This section allows you to define your list of servers. When
  459. defining instances of components, you will choose from servers in this
  460. list.</para>
  461. <orderedlist>
  462. <listitem>
  463. <?dbfo keep-together="always"?>
  464. <para>Select <emphasis role="bold">Hardware</emphasis> in the
  465. Navigator panel on the left side.</para>
  466. <para><graphic fileref="images/CM-img01.jpg"
  467. vendor="configmgrSS" /></para>
  468. </listitem>
  469. <listitem>
  470. <para>Select the <emphasis role="bold">Computers</emphasis>
  471. tab.</para>
  472. </listitem>
  473. <listitem>
  474. <?dbfo keep-together="always"?>
  475. <para>right-click on one of computers listed, then select New
  476. Range.</para>
  477. <para><graphic fileref="images/CM-img02.jpg"
  478. vendor="configmgrSS" /></para>
  479. </listitem>
  480. <listitem>
  481. <para>Specify the following:</para>
  482. <itemizedlist>
  483. <listitem>
  484. <para>Name Prefix - any name that will help you to identify the
  485. node or range</para>
  486. </listitem>
  487. <listitem>
  488. <para>Start IP Address</para>
  489. </listitem>
  490. <listitem>
  491. <para>Stop IP Address</para>
  492. <para>The IP Addresses can be specified in a range if all your
  493. host IP addresses are consecutively numbered. If the IP
  494. addresses are not sequential you should repeat the process for
  495. each individual IP address and just add the IP address in both
  496. the start and stop IP address field. You will then need to
  497. repeat the process for each node.</para>
  498. </listitem>
  499. </itemizedlist>
  500. </listitem>
  501. <listitem>
  502. <?dbfo keep-together="always"?>
  503. <para>Press the <emphasis role="bold">OK</emphasis> button.</para>
  504. <para>The list of nodes now displays with the nodes that you just
  505. added.</para>
  506. <para><inlinegraphic fileref="images/CM-img03.jpg"
  507. vendor="configmgrSS" /></para>
  508. <para>Next, edit each System Server component instance and set it to
  509. a newly defined node.</para>
  510. <!--***The steps that follow are using one component per node. You can allocate more components per node, if needed.-->
  511. </listitem>
  512. <listitem>
  513. <para>Click the <inlinegraphic fileref="images/GS-img01c.png" />
  514. disk icon to save</para>
  515. </listitem>
  516. <listitem>
  517. <para>Expand the <emphasis role="bold">Software</emphasis> section,
  518. if necessary, in the Navigator panel on the left side, by clicking
  519. on the <inlinegraphic fileref="images/expandButton.png" />
  520. button.</para>
  521. </listitem>
  522. </orderedlist>
  523. </sect1>
  524. <sect1>
  525. <title>Software Section</title>
  526. <para>Use the software components section to configure software
  527. components of the HPCC platform. Most software components are actual
  528. running processes; however, some are just definitions used by the
  529. system. These definitions are used by the configuration
  530. generator.</para>
  531. <para>Items that appear in <emphasis role="red">red</emphasis> indicate
  532. optional values. They are only written to the environment if you add to
  533. or change that value. If untouched, they will not appear in the
  534. environment XML file.</para>
  535. <sect2 role="brk">
  536. <title>Dali</title>
  537. <sect3>
  538. <title>Instances</title>
  539. <para>
  540. <orderedlist>
  541. <listitem>
  542. <para>Select <emphasis role="bold">Dali Server</emphasis> in
  543. the Navigator panel on the left side.</para>
  544. </listitem>
  545. <listitem>
  546. <para>Select the Instances tab.</para>
  547. </listitem>
  548. <listitem>
  549. <?dbfo keep-together="always"?>
  550. <para>In the computer column, choose a node from the drop list
  551. as shown below:<graphic fileref="images/CM-img04.jpg"
  552. vendor="configmgrSS" /></para>
  553. </listitem>
  554. <listitem>
  555. <para>Click the <inlinegraphic
  556. fileref="images/GS-img01c.png" /> disk icon to save</para>
  557. </listitem>
  558. </orderedlist>
  559. </para>
  560. </sect3>
  561. <sect3 role="brk">
  562. <title>DaliServer attributes</title>
  563. <para>This section describes the DaliServer attributes.</para>
  564. <para>
  565. <graphic fileref="images/CM-img04-1.jpg" vendor="configmgrSS" />
  566. </para>
  567. <para />
  568. <!--configMgr-Dali-Server-Include-XXX-->
  569. <para>
  570. <xi:include href="UsingConfigManager/CM_Mods/dali.xsd.mod.xml"
  571. xpointer="da.tbl1"
  572. xmlns:xi="http://www.w3.org/2001/XInclude" />
  573. </para>
  574. </sect3>
  575. <?hard-pagebreak ?>
  576. <sect3>
  577. <title>DaliServer store</title>
  578. <para>This section describes the attributes configuring how Dali
  579. handles the system data store.</para>
  580. <para>
  581. <graphic fileref="images/CM-img04-2.jpg" vendor="configmgrSS" />
  582. </para>
  583. <para />
  584. <!--configMgr-Dali-Server-Include-XXX-->
  585. <para>
  586. <xi:include href="UsingConfigManager/CM_Mods/dali.xsd.mod.xml"
  587. xpointer="da.tbl2"
  588. xmlns:xi="http://www.w3.org/2001/XInclude" />
  589. </para>
  590. </sect3>
  591. <?hard-pagebreak ?>
  592. <sect3>
  593. <title>DaliServer LDAP options</title>
  594. <para>This section describes the DaliServer LDAP tab.</para>
  595. <para>
  596. <graphic fileref="images/CM-img04-4.jpg" vendor="configmgrSS" />
  597. </para>
  598. <!--configMgr-DaliServer-LDAP-Include-XXX-->
  599. <para>
  600. <xi:include href="UsingConfigManager/CM_Mods/dali.xsd.mod.xml"
  601. xpointer="da.tbl4"
  602. xmlns:xi="http://www.w3.org/2001/XInclude" />
  603. </para>
  604. </sect3>
  605. <sect3>
  606. <title>DaliServer Notes</title>
  607. <para>This tab allows you to add any notes pertinent to the
  608. component's configuration. This can be useful to keep a record of
  609. changes and to communicate this information to peers.</para>
  610. </sect3>
  611. </sect2>
  612. <sect2 id="Dafilesrv-Process" role="brk">
  613. <title>Dafilesrv Process</title>
  614. <sect3>
  615. <title>Dafilesrv Instances</title>
  616. <para>Dafilesrv is a helper process that every node needs.</para>
  617. <orderedlist>
  618. <listitem>
  619. <para>Select Dafilesrv in the Navigator panel on the left
  620. side.</para>
  621. </listitem>
  622. <listitem>
  623. <para>Select the Instances tab.</para>
  624. </listitem>
  625. <listitem>
  626. <para>right-click on a computer in the computer column, and
  627. select Add Instance .</para>
  628. </listitem>
  629. <listitem>
  630. <?dbfo keep-together="always"?>
  631. <para>Select all computers in the list by checking the <emphasis
  632. role="bold">Select All</emphasis> box, then press the <emphasis
  633. role="bold">OK</emphasis> button.</para>
  634. <para>
  635. <graphic fileref="images/CM-img12.jpg" vendor="configmgrSS" />
  636. </para>
  637. </listitem>
  638. <listitem>
  639. <para>Click the <inlinegraphic fileref="images/GS-img01c.png" />
  640. disk icon to save</para>
  641. </listitem>
  642. </orderedlist>
  643. </sect3>
  644. <?hard-pagebreak ?>
  645. <sect3>
  646. <title>Dafilesrv attributes</title>
  647. <para>This section describes the Dafilesrv attributes.</para>
  648. <para>
  649. <graphic fileref="images/CM-img12-1.jpg" vendor="configmgrSS" />
  650. </para>
  651. <!--configMgr-DaFileSrv-Include-XXX-->
  652. <para>
  653. <xi:include href="UsingConfigManager/CM_Mods/dafilesrv.xsd.mod.xml"
  654. xpointer="daFs.t"
  655. xmlns:xi="http://www.w3.org/2001/XInclude" />
  656. </para>
  657. </sect3>
  658. </sect2>
  659. <sect2 id="DFU-Server" role="brk">
  660. <title>DFU Server</title>
  661. <sect3>
  662. <title>DfuServer Instances</title>
  663. <orderedlist>
  664. <listitem>
  665. <para>Select <emphasis role="bold">DFU Server</emphasis> in the
  666. Navigator panel on the left side.</para>
  667. </listitem>
  668. <listitem>
  669. <para>Select the Instances tab.</para>
  670. </listitem>
  671. <listitem>
  672. <para>In the computer column, choose a node from the drop list
  673. as shown below:<graphic fileref="images/CM-img05.jpg"
  674. vendor="configmgrSS" /></para>
  675. </listitem>
  676. <listitem>
  677. <para>Click the <inlinegraphic fileref="images/GS-img01c.png" />
  678. disk icon to save</para>
  679. </listitem>
  680. </orderedlist>
  681. </sect3>
  682. <sect3 role="brk">
  683. <title>DfuServer Attributes Tab</title>
  684. <para>This section describes the DfuServer attributes.</para>
  685. <para>
  686. <graphic fileref="images/CM-img05-1.jpg" vendor="configmgrSS" />
  687. </para>
  688. <!--configMgr-DFUSrvr-Attr-Include-XXX-->
  689. <para>
  690. <xi:include href="UsingConfigManager/CM_Mods/dfuserver.xsd.mod.xml"
  691. xpointer="DF.t2"
  692. xmlns:xi="http://www.w3.org/2001/XInclude" />
  693. </para>
  694. </sect3>
  695. <sect3 role="brk">
  696. <title>DfuServer SSH Options</title>
  697. <para>This section describes the DfuServer SSH Options..</para>
  698. <para>
  699. <graphic fileref="images/CM-img05-2.jpg" vendor="configmgrSS" />
  700. </para>
  701. <!--configMgr-DFUSrvr-SSH-Include-XXX-->
  702. <para>
  703. <xi:include href="UsingConfigManager/CM_Mods/dfuserver.xsd.mod.xml"
  704. xpointer="DF.t1"
  705. xmlns:xi="http://www.w3.org/2001/XInclude" />
  706. </para>
  707. </sect3>
  708. <sect3>
  709. <title>DfuServer Notes</title>
  710. <para>This tab allows you to add any notes pertinent to the
  711. component's configuration. This can be useful to keep a record of
  712. changes and to communicate this information to peers.</para>
  713. </sect3>
  714. </sect2>
  715. <sect2 role="brk">
  716. <title>Directories</title>
  717. <para>The Directories component is a global definition used by other
  718. components to determine the directories they will use for various
  719. functions.</para>
  720. <para>
  721. <graphic fileref="images/CM-161a.jpg" vendor="configmgrSS" />
  722. </para>
  723. <para />
  724. <informaltable colsep="1" frame="all" rowsep="1">
  725. <tgroup cols="3">
  726. <colspec align="left" colwidth="122.40pt" />
  727. <tbody>
  728. <row>
  729. <entry>Name</entry>
  730. <entry>Directory</entry>
  731. <entry>Description</entry>
  732. </row>
  733. <row>
  734. <entry>
  735. <emphasis role="bold">log</emphasis>
  736. </entry>
  737. <entry>/var/log/[NAME]/[INST]</entry>
  738. <entry>Location for Log files</entry>
  739. </row>
  740. <row>
  741. <entry>
  742. <emphasis role="bold">temp</emphasis>
  743. </entry>
  744. <entry>/var/lib/[NAME]/[INST]/temp</entry>
  745. <entry>Location for temp files</entry>
  746. </row>
  747. <row>
  748. <entry>
  749. <emphasis role="bold">data</emphasis>
  750. </entry>
  751. <entry />
  752. <entry>Base Location for data files</entry>
  753. </row>
  754. <row>
  755. <entry>
  756. <emphasis role="bold">data2</emphasis>
  757. </entry>
  758. <entry />
  759. <entry>Base Location for 2nd copy of roxie data</entry>
  760. </row>
  761. <row>
  762. <entry>
  763. <emphasis role="bold">data3</emphasis>
  764. </entry>
  765. <entry />
  766. <entry>Reserved for future use</entry>
  767. </row>
  768. <row>
  769. <entry>
  770. <emphasis role="bold">mirror</emphasis>
  771. </entry>
  772. <entry />
  773. <entry>Base Location for mirror data files</entry>
  774. </row>
  775. <row>
  776. <entry>
  777. <emphasis role="bold">query</emphasis>
  778. </entry>
  779. <entry />
  780. <entry>Base Location for Queries</entry>
  781. </row>
  782. </tbody>
  783. </tgroup>
  784. </informaltable>
  785. </sect2>
  786. <sect2 id="Drop-Zone" role="brk">
  787. <title>Drop Zone</title>
  788. <sect3>
  789. <title>DropZone Attributes</title>
  790. <orderedlist>
  791. <listitem>
  792. <para>Select Drop Zone in the Navigator panel on the left
  793. side.</para>
  794. </listitem>
  795. <listitem>
  796. <para>Select the Attributes tab.</para>
  797. </listitem>
  798. <listitem>
  799. <para>In the Value column of the Computer row, choose a node
  800. from the drop list as shown below:<graphic
  801. fileref="images/CM-img06.jpg" vendor="configmgrSS" /></para>
  802. </listitem>
  803. <listitem>
  804. <para>Click the <inlinegraphic fileref="images/GS-img01c.png" />
  805. disk icon to save</para>
  806. </listitem>
  807. </orderedlist>
  808. </sect3>
  809. <sect3>
  810. <title>DropZone Notes</title>
  811. <para>This tab allows you to add any notes pertinent to the
  812. component's configuration. This can be useful to keep a record of
  813. changes and to communicate this information to peers.</para>
  814. </sect3>
  815. </sect2>
  816. <sect2 id="ECL-Agent" role="brk">
  817. <title>ECL Agent</title>
  818. <sect3>
  819. <title>instances</title>
  820. <orderedlist>
  821. <listitem>
  822. <para>Select ECL Agent in the Navigator panel on the left
  823. side.</para>
  824. </listitem>
  825. <listitem>
  826. <para>Select the Instances tab.</para>
  827. </listitem>
  828. <listitem>
  829. <para>In the computer column, choose a node from the drop list
  830. as shown below:<graphic fileref="images/CM-img07.jpg"
  831. vendor="configmgrSS" /></para>
  832. </listitem>
  833. <listitem>
  834. <para>Click the <inlinegraphic fileref="images/GS-img01c.png" />
  835. disk icon to save</para>
  836. </listitem>
  837. </orderedlist>
  838. </sect3>
  839. <sect3 role="brk">
  840. <title>EclAgent Attributes Tab</title>
  841. <para>This section describes the EclAgent Attributes tab.</para>
  842. <para>
  843. <graphic fileref="images/CM-img07-1.jpg" vendor="configmgrSS" />
  844. </para>
  845. <!--configMgr-ECLAgent-Attr-Include-RRR-->
  846. <para>
  847. <xi:include href="UsingConfigManager/CM_Mods/eclagent_config.xsd.mod.xml"
  848. xpointer="EA.t1"
  849. xmlns:xi="http://www.w3.org/2001/XInclude" />
  850. </para>
  851. </sect3>
  852. <sect3 role="brk">
  853. <title>EclAgent Options Tab</title>
  854. <para>This section describes the EclAgent Options tab.</para>
  855. <para>
  856. <graphic fileref="images/CM-img07-2.jpg" vendor="configmgrSS" />
  857. </para>
  858. <!--configMgr-ECLAgent-Options-Include-RRR-->
  859. <para>
  860. <xi:include href="UsingConfigManager/CM_Mods/eclagent_config.xsd.mod.xml"
  861. xpointer="EA.t2"
  862. xmlns:xi="http://www.w3.org/2001/XInclude" />
  863. </para>
  864. </sect3>
  865. <sect3>
  866. <title>EclAgentProcessNotes</title>
  867. <para>This tab allows you to add any notes pertinent to the
  868. component's configuration. This can be useful to keep a record of
  869. changes and to communicate this information to peers.</para>
  870. </sect3>
  871. </sect2>
  872. <sect2 role="brk">
  873. <title>ECL CC Server Process</title>
  874. <sect3>
  875. <title>Ecl CC Server Instances</title>
  876. <para>
  877. <orderedlist>
  878. <listitem>
  879. <para>Select Ecl CC Server - myeclccserver in the Navigator
  880. panel on the left side.</para>
  881. </listitem>
  882. <listitem>
  883. <para>Select the Instances tab.</para>
  884. </listitem>
  885. <listitem>
  886. <para>In the computer column, choose a node from the drop list
  887. as shown below:<graphic fileref="images/CM-ECLCC-01.jpg"
  888. vendor="configmgrSS" /></para>
  889. </listitem>
  890. <listitem>
  891. <para>Click the <inlinegraphic
  892. fileref="images/GS-img01c.png" /> disk icon to save</para>
  893. </listitem>
  894. </orderedlist>
  895. </para>
  896. </sect3>
  897. <sect3 role="brk">
  898. <title>Ecl CC Server Attributes Tab</title>
  899. <para>This section describes the Ecl CC Server Attributes
  900. tab.</para>
  901. <para>
  902. <graphic fileref="images/CM-ECLCC-02.jpg" vendor="configmgrSS" />
  903. </para>
  904. <!--ECLCCServer-Include-cc.t2-XXX-->
  905. <para>
  906. <xi:include href="UsingConfigManager/CM_Mods/eclccserver.xsd.mod.xml"
  907. xpointer="cc.t2"
  908. xmlns:xi="http://www.w3.org/2001/XInclude" />
  909. </para>
  910. </sect3>
  911. <sect3>
  912. <title>EclCC Server Process Options</title>
  913. <para>To add a custom option, right-click and select add. These
  914. options are passed to the eclcc compiler.</para>
  915. <para>See the ECL Compiler chapter in the <emphasis
  916. role="bluebold">Client Tools</emphasis> manual for details.</para>
  917. <!--This feature allows the user to configure any options pertinent to the Ecl CC Server Process -->
  918. <para />
  919. </sect3>
  920. <sect3>
  921. <title>EclCC Server Process Notes</title>
  922. <para>This tab allows you to add any notes pertinent to the
  923. component's configuration. This can be useful to keep a record of
  924. changes and to communicate this information to peers.</para>
  925. </sect3>
  926. </sect2>
  927. <sect2 id="ECL-Scheduler" role="brk">
  928. <title>ECL Scheduler</title>
  929. <sect3>
  930. <title>instances</title>
  931. <orderedlist>
  932. <listitem>
  933. <para>Select <emphasis role="bold">ECL Scheduler</emphasis> in
  934. the Navigator panel on the left side.</para>
  935. </listitem>
  936. <listitem>
  937. <para>Select the Instances tab.</para>
  938. </listitem>
  939. <listitem>
  940. <para>In the computer column, choose a node from the drop list
  941. as shown below:<graphic fileref="images/CM-161.jpg"
  942. vendor="configmgrSS" /></para>
  943. </listitem>
  944. <listitem>
  945. <para>Click the <inlinegraphic fileref="images/GS-img01c.png" />
  946. disk icon to save</para>
  947. </listitem>
  948. </orderedlist>
  949. </sect3>
  950. <sect3 role="brk">
  951. <title>EclScheduler Attributes Tab</title>
  952. <para>This section describes the EclScheduler Attributes tab.</para>
  953. <para>
  954. <graphic fileref="images/CM-160.jpg" vendor="configmgrSS" />
  955. </para>
  956. <!--configMgr-DaliServer-LDAP-Include-XXX-->
  957. <para>
  958. <xi:include href="UsingConfigManager/CM_Mods/eclscheduler.xsd.mod.xml"
  959. xpointer="ecl.sched"
  960. xmlns:xi="http://www.w3.org/2001/XInclude" />
  961. </para>
  962. </sect3>
  963. <sect3>
  964. <title>EclScheduler Notes</title>
  965. <para>This tab allows you to add any notes pertinent to the
  966. component's configuration. This can be useful to keep a record of
  967. changes and to communicate this information to peers.</para>
  968. </sect3>
  969. </sect2>
  970. <sect2 id="ESP-Server" role="brk">
  971. <title>ESP Server</title>
  972. <sect3>
  973. <title>Esp Process Instances</title>
  974. <orderedlist>
  975. <listitem>
  976. <para>Select ESP - MyEsp in the Navigator panel on the left
  977. side.</para>
  978. </listitem>
  979. <listitem>
  980. <para>Select the Instances tab.</para>
  981. </listitem>
  982. <listitem>
  983. <para>In the computer column, choose a node from the drop list
  984. as shown below:<graphic fileref="images/CM-img08.jpg"
  985. vendor="configmgrSS" /></para>
  986. </listitem>
  987. <listitem>
  988. <para>Click the <inlinegraphic fileref="images/GS-img01c.png" />
  989. disk icon to save</para>
  990. </listitem>
  991. </orderedlist>
  992. </sect3>
  993. <?hard-pagebreak ?>
  994. <sect3>
  995. <title>Esp - myesp Attributes Tab</title>
  996. <para>This section describes the Esp - myesp Attributes tab.</para>
  997. <para>
  998. <graphic fileref="images/CM-img08-1.jpg" vendor="configmgrSS" />
  999. </para>
  1000. <!--MyESP-Include-ES.t6-XXX-->
  1001. <para>
  1002. <xi:include href="UsingConfigManager/CM_Mods/esp.xsd.mod.xml"
  1003. xpointer="ES.t6"
  1004. xmlns:xi="http://www.w3.org/2001/XInclude" />
  1005. </para>
  1006. </sect3>
  1007. <sect3 role="brk">
  1008. <title>Esp - myesp Service BindingsTab</title>
  1009. <para>This section describes the Esp - myesp Service Bindings tab.
  1010. This tab requires additional steps to configure the service
  1011. bindings.</para>
  1012. <para>
  1013. <graphic fileref="images/CM-img08-2.jpg" vendor="configmgrSS" />
  1014. </para>
  1015. <para>You must first add the service bindings in the first table
  1016. (Right-click, add). Then you would configure the attributes in the
  1017. other tables on that tab. The next table describes the <emphasis
  1018. role="bold">URL Authentication</emphasis> table.</para>
  1019. <!--MyESP-Include-ES.t1-XXX-URL-AuthXXX-->
  1020. <para>
  1021. <xi:include href="UsingConfigManager/CM_Mods/esp.xsd.mod.xml"
  1022. xpointer="ES.t1"
  1023. xmlns:xi="http://www.w3.org/2001/XInclude" />
  1024. </para>
  1025. <para>The following tables describe the ESPProcess Service Bindings,
  1026. <emphasis role="bold">Feature Authentications</emphasis>.</para>
  1027. <!--MyESP-Include-ES.t2-XXX-Feature-AuthXXX-->
  1028. <para>
  1029. <xi:include href="UsingConfigManager/CM_Mods/esp.xsd.mod.xml"
  1030. xpointer="ES.t2"
  1031. xmlns:xi="http://www.w3.org/2001/XInclude" />
  1032. </para>
  1033. <para>
  1034. <!--MyESP-Include-ES.t3-XXX-Feature-AuthXXX-->
  1035. <xi:include href="UsingConfigManager/CM_Mods/esp.xsd.mod.xml"
  1036. xpointer="ES.t3"
  1037. xmlns:xi="http://www.w3.org/2001/XInclude" />
  1038. </para>
  1039. <para />
  1040. </sect3>
  1041. <?hard-pagebreak ?>
  1042. <sect3>
  1043. <title>Esp - myesp AuthenticationTab</title>
  1044. <para>This section describes the Esp - myesp Service Authentication
  1045. tab.</para>
  1046. <para>
  1047. <graphic fileref="images/CM-img08-3.jpg" vendor="configmgrSS" />
  1048. </para>
  1049. <!--MyESP-Authentication-ES.t4-XOKDXX-->
  1050. <para>
  1051. <xi:include href="UsingConfigManager/CM_Mods/esp.xsd.mod.xml"
  1052. xpointer="ES.t4"
  1053. xmlns:xi="http://www.w3.org/2001/XInclude" />
  1054. </para>
  1055. </sect3>
  1056. <?hard-pagebreak ?>
  1057. <sect3>
  1058. <title>Esp - myesp HTTPS Tab</title>
  1059. <para>This section describes the Esp - myesp HTTPS tab.</para>
  1060. <para>
  1061. <graphic fileref="images/CM-img08-4.jpg" vendor="configmgrSS" />
  1062. </para>
  1063. <!--MyESP-HTTPS.t5-XXX-->
  1064. <para>
  1065. <xi:include href="UsingConfigManager/CM_Mods/esp.xsd.mod.xml"
  1066. xpointer="ES.t5"
  1067. xmlns:xi="http://www.w3.org/2001/XInclude" />
  1068. </para>
  1069. </sect3>
  1070. <sect3>
  1071. <title>EspProcess Notes</title>
  1072. <para>This tab allows you to add any notes pertinent to the
  1073. component's configuration. This can be useful to keep a record of
  1074. changes and to communicate this information to peers.</para>
  1075. </sect3>
  1076. </sect2>
  1077. <sect2 id="FTSlave-Process" role="brk">
  1078. <title>FTSlave Process</title>
  1079. <para>FTSlave is a helper process that every node needs. This section
  1080. depicts an FTSlave installation.</para>
  1081. <sect3>
  1082. <title>Instances</title>
  1083. <orderedlist>
  1084. <listitem>
  1085. <para>Select FTSlave in the Navigator panel on the left
  1086. side.</para>
  1087. </listitem>
  1088. <listitem>
  1089. <para>Select the Instances tab.</para>
  1090. </listitem>
  1091. <listitem>
  1092. <?dbfo keep-together="always"?>
  1093. <para>right-click on a computer in the computer column, and
  1094. select Add Instance.</para>
  1095. <para>
  1096. <graphic fileref="images/CM-190.jpg" vendor="configmgrSS" />
  1097. </para>
  1098. </listitem>
  1099. <listitem>
  1100. <?dbfo keep-together="always"?>
  1101. <para>Select all computers in the list, then press the <emphasis
  1102. role="bold">OK</emphasis> button.</para>
  1103. <para>
  1104. <graphic fileref="images/CM-112-4.jpg" vendor="configmgrSS" />
  1105. </para>
  1106. </listitem>
  1107. <listitem>
  1108. <para>Click the <inlinegraphic fileref="images/GS-img01c.png" />
  1109. disk icon to save</para>
  1110. </listitem>
  1111. </orderedlist>
  1112. </sect3>
  1113. <sect3>
  1114. <title>FtSlave attributes</title>
  1115. <para>This section describes an FTSlaveProcess attributes
  1116. tab.</para>
  1117. <!--FTSlave-Include-XXX-->
  1118. <para>
  1119. <xi:include href="UsingConfigManager/CM_Mods/ftslave.xsd.mod.xml"
  1120. xpointer="FTS"
  1121. xmlns:xi="http://www.w3.org/2001/XInclude" />
  1122. </para>
  1123. </sect3>
  1124. <sect3>
  1125. <title>FtSlave Process Notes</title>
  1126. <para>This tab allows you to add any notes pertinent to the
  1127. component's configuration. This can be useful to keep a record of
  1128. changes and to communicate this information to peers.</para>
  1129. </sect3>
  1130. </sect2>
  1131. <sect2 id="LDAPServer_Process" role="brk">
  1132. <title>LDAP Server Process</title>
  1133. <para>This section describes the configuration attributes of an
  1134. LDAPServer Installation in ConfigManager. For a complete description
  1135. of how to add LDAP Authentication see <emphasis>Using LDAP
  1136. Authentication</emphasis> section in the <emphasis
  1137. role="bluebold">Installing and Running The HPCC Platform</emphasis>
  1138. document.</para>
  1139. <para>
  1140. <graphic fileref="images/LDAP_004.jpg" />
  1141. </para>
  1142. <!--LdapServer-Include-fullDoc-XXX-->
  1143. <xi:include href="UsingConfigManager/CM_Mods/ldapserver.xsd.mod.xml"
  1144. xpointer="Active_Directory_LDAP_process_mod"
  1145. xmlns:xi="http://www.w3.org/2001/XInclude" />
  1146. <sect3>
  1147. <title>LDAP Server Process Instances</title>
  1148. <para>This tab allows you to add instances to your LDAP
  1149. Configuration. In order to add instances you would have previously
  1150. added the LDAP computers in the Hardware section. For a complete
  1151. description of how to add LDAP Authentication see <emphasis>Using
  1152. LDAP Authentication</emphasis> section in the <emphasis
  1153. role="bluebold">Installing and Running The HPCC Platform</emphasis>
  1154. document.</para>
  1155. <orderedlist>
  1156. <listitem>
  1157. <para>On the <emphasis role="bold">Instances</emphasis> tab,
  1158. Rt-click on the table on the right hand side, choose <emphasis
  1159. role="bold">Add Instances…</emphasis></para>
  1160. </listitem>
  1161. <listitem>
  1162. <para>Select the computer to use by checking the box next to
  1163. it.</para>
  1164. <para>This is the computer you added in the <emphasis
  1165. role="bold">Hardware</emphasis> / <emphasis role="bold">Add New
  1166. Computers</emphasis> portion earlier.</para>
  1167. </listitem>
  1168. </orderedlist>
  1169. </sect3>
  1170. <sect3>
  1171. <title>LDAP Server Process Notes</title>
  1172. <para>This tab allows you to add any notes pertinent to the
  1173. component's configuration. This can be useful to keep a record of
  1174. changes and to communicate this information to peers.</para>
  1175. </sect3>
  1176. </sect2>
  1177. <sect2 role="brk">
  1178. <title>Sasha Server</title>
  1179. <sect3>
  1180. <title>Instances</title>
  1181. <orderedlist>
  1182. <listitem>
  1183. <para>Select Sasha Server in the menu on the left side.</para>
  1184. </listitem>
  1185. <listitem>
  1186. <para>Select the Instances tab.</para>
  1187. </listitem>
  1188. <listitem>
  1189. <para>In the computer column, choose a node from the drop list
  1190. as shown below:</para>
  1191. </listitem>
  1192. </orderedlist>
  1193. <graphic fileref="images/CM-img17.jpg" vendor="configmgrSS" />
  1194. </sect3>
  1195. <sect3 role="brk">
  1196. <title>Sasha Server Attributes</title>
  1197. <!--***Might-Want-to-add-CM-Sasha17A.jpg-image-***-->
  1198. <para>This section described the SashaServerProcess <emphasis
  1199. role="bold">Attribute</emphasis> tab values.</para>
  1200. <graphic fileref="images/CM-Sasha17A.jpg" vendor="configmgrSS" />
  1201. <!--configMgr-Sasha-t1-Include-->
  1202. <para>
  1203. <xi:include href="UsingConfigManager/CM_Mods/sasha.xsd.mod.xml"
  1204. xpointer="sh.t1"
  1205. xmlns:xi="http://www.w3.org/2001/XInclude" />
  1206. </para>
  1207. </sect3>
  1208. <?hard-pagebreak ?>
  1209. <sect3>
  1210. <title>SashaServer Process Archiver</title>
  1211. <para>This section describes the SashaServer Process Archiver
  1212. tab.</para>
  1213. <para>
  1214. <graphic fileref="images/CM-img17-1.jpg" vendor="configmgrSS" />
  1215. </para>
  1216. <!--configMgr-Sasha-Archiver-Include-->
  1217. <para>
  1218. <xi:include href="UsingConfigManager/CM_Mods/sasha.xsd.mod.xml"
  1219. xpointer="sh.t2"
  1220. xmlns:xi="http://www.w3.org/2001/XInclude" />
  1221. </para>
  1222. <para />
  1223. </sect3>
  1224. <sect3 role="brk">
  1225. <title>SashaServer Process Coalescer</title>
  1226. <para>This section describes the SashaServer Process Coalescer
  1227. tab.</para>
  1228. <para>
  1229. <graphic fileref="images/CM-img17-2.jpg" vendor="configmgrSS" />
  1230. </para>
  1231. <!--configMgr-Sasha-Coaleser-Include-->
  1232. <para>
  1233. <xi:include href="UsingConfigManager/CM_Mods/sasha.xsd.mod.xml"
  1234. xpointer="sh.t3"
  1235. xmlns:xi="http://www.w3.org/2001/XInclude" />
  1236. </para>
  1237. </sect3>
  1238. <?hard-pagebreak ?>
  1239. <sect3>
  1240. <title>SashaServer Process DfuXRef</title>
  1241. <para>This section describes the SashaServer Process DfuXref
  1242. tab.</para>
  1243. <para>
  1244. <graphic fileref="images/CM-img17-3.jpg" vendor="configmgrSS" />
  1245. </para>
  1246. <!--configMgr-Sasha-DfuXref-Include-->
  1247. <para>
  1248. <xi:include href="UsingConfigManager/CM_Mods/sasha.xsd.mod.xml"
  1249. xpointer="sh.t4"
  1250. xmlns:xi="http://www.w3.org/2001/XInclude" />
  1251. </para>
  1252. </sect3>
  1253. <?hard-pagebreak ?>
  1254. <sect3>
  1255. <title>SashaServer Process DfuExpiry</title>
  1256. <para>This section describes the SashaServer Process DfuExpiry
  1257. tab.</para>
  1258. <para>
  1259. <graphic fileref="images/CM-img17-4.jpg" vendor="configmgrSS" />
  1260. </para>
  1261. <para />
  1262. <!--configMgr-Sasha-DfuExpiry-Include-->
  1263. <para>
  1264. <xi:include href="UsingConfigManager/CM_Mods/sasha.xsd.mod.xml"
  1265. xpointer="sh.t5"
  1266. xmlns:xi="http://www.w3.org/2001/XInclude" />
  1267. </para>
  1268. </sect3>
  1269. <?hard-pagebreak ?>
  1270. <sect3>
  1271. <title>SashaServer Process ThorQMon</title>
  1272. <para>This section describes the SashaServer Process ThorQMon
  1273. tab.</para>
  1274. <para>
  1275. <graphic fileref="images/CM-img17-5.jpg" vendor="configmgrSS" />
  1276. </para>
  1277. <!--configMgr-Sasha-ThorQMon-Include-->
  1278. <para>
  1279. <xi:include href="UsingConfigManager/CM_Mods/sasha.xsd.mod.xml"
  1280. xpointer="sh.t6"
  1281. xmlns:xi="http://www.w3.org/2001/XInclude" />
  1282. </para>
  1283. </sect3>
  1284. <?hard-pagebreak ?>
  1285. <sect3>
  1286. <title>SashaServer Process DaFileSrvMonitor</title>
  1287. <para>This section describes the SashaServer Process
  1288. DaFileSrvMonitor tab.</para>
  1289. <para>
  1290. <graphic fileref="images/CM-img17-6.jpg" vendor="configmgrSS" />
  1291. </para>
  1292. <!--configMgr-Sasha-DafiSrvMon-Include-XXX-->
  1293. <para>
  1294. <xi:include href="UsingConfigManager/CM_Mods/sasha.xsd.mod.xml"
  1295. xpointer="sh.t7"
  1296. xmlns:xi="http://www.w3.org/2001/XInclude" />
  1297. </para>
  1298. </sect3>
  1299. <sect3>
  1300. <title>SashaServer Process Notes</title>
  1301. <para>This tab allows you to add any notes pertinent to the
  1302. component's configuration. This can be useful to keep a record of
  1303. changes and to communicate this information to peers.</para>
  1304. </sect3>
  1305. </sect2>
  1306. <sect2 id="Thor" role="brk">
  1307. <title>Thor</title>
  1308. <para>This section details how to define a Data Refinery (Thor)
  1309. cluster. Before you begin, you should decide the width of the cluster
  1310. (i.e., how many slave nodes will you have).</para>
  1311. <orderedlist>
  1312. <listitem>
  1313. <para>Select <emphasis role="bold">Thor Cluster -
  1314. mythor</emphasis> in the Navigator panel on the left side.</para>
  1315. </listitem>
  1316. <listitem>
  1317. <para>Select the <emphasis role="bold">Topology</emphasis>
  1318. tab.</para>
  1319. </listitem>
  1320. <listitem>
  1321. <para>Expand the Topology, if needed, then right-click the Master
  1322. and select Delete.</para>
  1323. </listitem>
  1324. </orderedlist>
  1325. <para>This deletes the sample one-node Thor.</para>
  1326. <para>You will replace this with a multi-node cluster.</para>
  1327. <orderedlist>
  1328. <listitem>
  1329. <?dbfo keep-together="always"?>
  1330. <para>right-click on the Topology and select Add Master.</para>
  1331. <para>
  1332. <graphic fileref="images/CM-img13.jpg" vendor="configmgrSS" />
  1333. </para>
  1334. </listitem>
  1335. <listitem>
  1336. <?dbfo keep-together="always"?>
  1337. <para>Select a computer from the list, then press the OK
  1338. button.</para>
  1339. <para>
  1340. <graphic fileref="images/CM-112-5.jpg" vendor="configmgrSS" />
  1341. </para>
  1342. </listitem>
  1343. <listitem>
  1344. <?dbfo keep-together="always"?>
  1345. <para>right-click on the Master and select Add Slaves.</para>
  1346. <para>
  1347. <graphic fileref="images/CM-111.jpg" vendor="configmgrSS" />
  1348. </para>
  1349. </listitem>
  1350. <listitem>
  1351. <?dbfo keep-together="always"?>
  1352. <para>Select the computers to use as slaves from the list, then
  1353. press the OK button. Use CTRL+CLICK to multi-select or SHIFT+CLICK
  1354. to select a range.</para>
  1355. <para><graphic fileref="images/CM-112-3.jpg"
  1356. vendor="configmgrSS" />The Nodes now display below the Thor Master
  1357. node.</para>
  1358. <para>
  1359. <graphic fileref="images/CM-img14.jpg" vendor="configmgrSS" />
  1360. </para>
  1361. </listitem>
  1362. <listitem>
  1363. <para>Select Thor Cluster - mythor in the Navigator panel on the
  1364. left side.</para>
  1365. </listitem>
  1366. <listitem>
  1367. <?dbfo keep-together="always"?>
  1368. <para>Select the Attributes tab.</para>
  1369. <para>
  1370. <graphic fileref="images/CM-img15.jpg" vendor="configmgrSS" />
  1371. </para>
  1372. </listitem>
  1373. <listitem>
  1374. <para>Change the value of the localThor to <emphasis
  1375. role="bold">false</emphasis></para>
  1376. </listitem>
  1377. <listitem>
  1378. <para>Click the <inlinegraphic fileref="images/GS-img01c.png" />
  1379. disk icon to save</para>
  1380. </listitem>
  1381. </orderedlist>
  1382. <?hard-pagebreak ?>
  1383. <sect3>
  1384. <title>Changing Thor topology</title>
  1385. <para>If you want to designate a different node as the Thor master
  1386. when setting up a multi-node system, follow these steps.</para>
  1387. <orderedlist>
  1388. <listitem>
  1389. <para>Select <emphasis role="bold">Thor Cluster -
  1390. mythor</emphasis> in the Navigator panel on the left
  1391. side.</para>
  1392. </listitem>
  1393. <listitem>
  1394. <para>Select the <emphasis role="bold">Topology</emphasis>
  1395. tab.</para>
  1396. </listitem>
  1397. <listitem>
  1398. <para>right-click on the Master node</para>
  1399. </listitem>
  1400. <listitem>
  1401. <?dbfo keep-together="always"?>
  1402. <para>Select the <emphasis role="bold">Replace Master</emphasis>
  1403. option.</para>
  1404. <para>
  1405. <graphic fileref="images/CM-111-2.jpg" vendor="configmgrSS" />
  1406. </para>
  1407. <para>
  1408. <informaltable colsep="1" frame="all" rowsep="1">
  1409. <?dbfo keep-together="always"?>
  1410. <tgroup cols="2">
  1411. <colspec colwidth="49.50pt" />
  1412. <colspec />
  1413. <tbody>
  1414. <row>
  1415. <entry>
  1416. <inlinegraphic fileref="images/caution.png" />
  1417. </entry>
  1418. <entry>You should only use this feature when initially
  1419. setting up your system. If there is data on the nodes
  1420. when attempting to Swap Master, you run the risk of
  1421. losing or corrupting some data.</entry>
  1422. </row>
  1423. </tbody>
  1424. </tgroup>
  1425. </informaltable>
  1426. </para>
  1427. </listitem>
  1428. </orderedlist>
  1429. </sect3>
  1430. <?hard-pagebreak ?>
  1431. <sect3>
  1432. <title>ThorCluster Attributes</title>
  1433. <para>This section describes the Thor Cluster Attributes tab.</para>
  1434. <para>
  1435. <graphic fileref="images/CM-img18-1.jpg" vendor="configmgrSS" />
  1436. </para>
  1437. <!--configMgr-Thor-Attribute-Include-XXX-->
  1438. <para>
  1439. <xi:include href="UsingConfigManager/CM_Mods/thor.xsd.mod.xml"
  1440. xpointer="th.t1"
  1441. xmlns:xi="http://www.w3.org/2001/XInclude" />
  1442. </para>
  1443. </sect3>
  1444. <?hard-pagebreak ?>
  1445. <sect3>
  1446. <title>ThorCluster SSH Options</title>
  1447. <para>This section describes the ThorCluster SSH Options tab.</para>
  1448. <para>
  1449. <graphic fileref="images/CM-img18-2.jpg" vendor="configmgrSS" />
  1450. </para>
  1451. <!--configMgr-Thor-SSH-Include-XXX-->
  1452. <para>
  1453. <xi:include href="UsingConfigManager/CM_Mods/thor.xsd.mod.xml"
  1454. xpointer="th.t2"
  1455. xmlns:xi="http://www.w3.org/2001/XInclude" />
  1456. </para>
  1457. </sect3>
  1458. <sect3>
  1459. <title>ThorCluster Debug</title>
  1460. <para>The debug tab is for internal use only</para>
  1461. </sect3>
  1462. <?hard-pagebreak ?>
  1463. <sect3>
  1464. <title>ThorCluster Swap Node</title>
  1465. <para>This section describes the ThorCluster Swap Node tab.</para>
  1466. <para>
  1467. <graphic fileref="images/CM-img18-4.jpg" vendor="configmgrSS" />
  1468. </para>
  1469. <!--configMgr-Thor-SwapNode-Include-XXX-->
  1470. <para>
  1471. <xi:include href="UsingConfigManager/CM_Mods/thor.xsd.mod.xml"
  1472. xpointer="th.t4"
  1473. xmlns:xi="http://www.w3.org/2001/XInclude" />
  1474. </para>
  1475. </sect3>
  1476. <?hard-pagebreak ?>
  1477. <sect3>
  1478. <title>ThorCluster Backup</title>
  1479. <para>This section describes the ThorCluster Backup tab.</para>
  1480. <para>
  1481. <graphic fileref="images/CM-img18-5.jpg" vendor="configmgrSS" />
  1482. </para>
  1483. <!--configMgr-Thor-Backup-Include-XXX-->
  1484. <para>
  1485. <xi:include href="UsingConfigManager/CM_Mods/thor.xsd.mod.xml"
  1486. xpointer="th.t5"
  1487. xmlns:xi="http://www.w3.org/2001/XInclude" />
  1488. </para>
  1489. </sect3>
  1490. <sect3>
  1491. <title>ThorCluster Notes</title>
  1492. <para>This tab allows you to add any notes pertinent to the
  1493. component's configuration. This can be useful to keep a record of
  1494. changes and to communicate this information to peers.</para>
  1495. </sect3>
  1496. </sect2>
  1497. <sect2 id="Roxie" role="brk">
  1498. <title>Roxie</title>
  1499. <para>This section details how to define a Rapid Data Delivery Engine
  1500. (Roxie) cluster. Before you begin, you should decide the width of the
  1501. cluster (i.e., how many agent nodes will you have).</para>
  1502. <!--***This section appears to have had signifcent changes*** -->
  1503. <orderedlist>
  1504. <listitem>
  1505. <para>Select <emphasis role="bold">Roxie Cluster</emphasis> in the
  1506. Navigator panel on the left side.</para>
  1507. <para><emphasis role="bold">Note:</emphasis> If you did not
  1508. specify a value in the <emphasis>Number of nodes for Roxie cluster
  1509. </emphasis>field when you first set up your environment, you will
  1510. not have a Roxie Cluster. To add a Roxie Cluster component:
  1511. Right-click on the <emphasis role="bold">Software</emphasis>
  1512. component in the Navigator Panel, then select <emphasis
  1513. role="bold">New Components</emphasis> then <emphasis
  1514. role="bold">roxie</emphasis> from the drop lists.</para>
  1515. </listitem>
  1516. <listitem>
  1517. <para>Select the <emphasis role="bold">Servers</emphasis>
  1518. tab.</para>
  1519. </listitem>
  1520. <listitem>
  1521. <?dbfo keep-together="always"?>
  1522. <para>Right-click the Roxie Servers and select
  1523. <guimenuitem>Reconfigure Servers</guimenuitem>.</para>
  1524. <para>
  1525. <graphic fileref="images/CM-112.jpg" vendor="configmgrSS" />
  1526. </para>
  1527. </listitem>
  1528. <listitem>
  1529. <?dbfo keep-together="always"?>
  1530. <para>Select the computers to use as Servers from the list, then
  1531. press the OK button.</para>
  1532. <para>
  1533. <graphic fileref="images/CM-112-2.jpg" vendor="configmgrSS" />
  1534. </para>
  1535. </listitem>
  1536. <listitem>
  1537. <para>Select the <emphasis role="bold">Redundancy</emphasis>
  1538. tab.</para>
  1539. </listitem>
  1540. <listitem>
  1541. <?dbfo keep-together="always"?>
  1542. <para>Select the redundancy scheme to use. Typically, this is
  1543. cyclic redundancy, as shown below.</para>
  1544. <para>
  1545. <graphic fileref="images/CM-112-1.jpg" vendor="configmgrSS" />
  1546. </para>
  1547. </listitem>
  1548. <listitem>
  1549. <para>Click the <inlinegraphic fileref="images/GS-img01c.png" />
  1550. disk icon to save</para>
  1551. </listitem>
  1552. <listitem>
  1553. <para>Close Configuration Manager by pressing ctrl+C in the
  1554. command window where it is running.</para>
  1555. </listitem>
  1556. </orderedlist>
  1557. </sect2>
  1558. <!--configMgr-ROXIE-Include-SEC4-->
  1559. <?hard-pagebreak ?>
  1560. <xi:include href="UsingConfigManager/CM_Mods/roxie.xsd.mod.xml"
  1561. xpointer="RoxieCluster_mod"
  1562. xmlns:xi="http://www.w3.org/2001/XInclude" />
  1563. <sect2 id="Topology" role="brk">
  1564. <title>Topology</title>
  1565. <para>This section describes the topology tab.</para>
  1566. <para>
  1567. <graphic fileref="images/CM-img20.jpg" vendor="configmgrSS" />
  1568. <informaltable colsep="0" frame="none" rowsep="0">
  1569. <tgroup cols="2">
  1570. <colspec align="left" colwidth="122.40pt" />
  1571. <colspec />
  1572. <tbody>
  1573. <row>
  1574. <entry>Attribute name</entry>
  1575. <entry>Definition</entry>
  1576. </row>
  1577. <row>
  1578. <entry>
  1579. <emphasis>Topology</emphasis>
  1580. </entry>
  1581. <entry>describes the system topology</entry>
  1582. </row>
  1583. <row>
  1584. <entry>
  1585. <emphasis>Cluster - thor</emphasis>
  1586. </entry>
  1587. <entry>describes the Thor clusters</entry>
  1588. </row>
  1589. <row>
  1590. <entry>
  1591. <emphasis>Cluster - hthor</emphasis>
  1592. </entry>
  1593. <entry>describes the hthor clusters</entry>
  1594. </row>
  1595. <row>
  1596. <entry>
  1597. <emphasis>Cluster - roxie</emphasis>
  1598. </entry>
  1599. <entry>describes the Roxie clusters</entry>
  1600. </row>
  1601. </tbody>
  1602. </tgroup>
  1603. </informaltable>
  1604. </para>
  1605. </sect2>
  1606. <sect2 id="Propogate-configuration-changes" role="brk">
  1607. <title>Distribute Configuration Changes to all Nodes</title>
  1608. <para>Once your environment is set up as desired, you must copy the
  1609. configuration file to the other nodes.</para>
  1610. <para />
  1611. <orderedlist>
  1612. <listitem>
  1613. <para>If it is running, stop the system</para>
  1614. <para>
  1615. <informaltable colsep="1" frame="all" rowsep="1">
  1616. <?dbfo keep-together="always"?>
  1617. <tgroup cols="2">
  1618. <colspec colwidth="49.50pt" />
  1619. <colspec />
  1620. <tbody>
  1621. <row>
  1622. <entry>
  1623. <inlinegraphic fileref="images/caution.png" />
  1624. </entry>
  1625. <entry>Be sure system is stopped before attempting to
  1626. copy the Environment.xml file.</entry>
  1627. </row>
  1628. </tbody>
  1629. </tgroup>
  1630. </informaltable>
  1631. </para>
  1632. </listitem>
  1633. <listitem>
  1634. <para>Back up the original environment.xml file</para>
  1635. <programlisting># for example
  1636. sudo -u hpcc cp /etc/HPCCSystems/environment.xml /etc/HPCCSystems/environment.bak </programlisting>
  1637. <para>Note: the "live environment.xml file is located in your
  1638. <emphasis role="bold">/etc/HPCCSystems/</emphasis> directory.
  1639. ConfigManager works on files in <emphasis
  1640. role="bold">/etc/HPCCSystems/source</emphasis> directory. You must
  1641. copy from this location to make an environment.xml file
  1642. active.</para>
  1643. </listitem>
  1644. <listitem>
  1645. <para>Copy the NewEnvironment.xml file from the source directory
  1646. to the /etc/HPCCSystems and rename the file to
  1647. environment.xml</para>
  1648. <programlisting># for example
  1649. sudo -u hpcc cp /etc/HPCCSystems/source/NewEnvironment.xml /etc/HPCCSystems/environment.xml</programlisting>
  1650. <para />
  1651. </listitem>
  1652. <listitem>
  1653. <para>Copy the /etc/HPCCSystems/environment.xml to the
  1654. /etc/HPCCSystems/ on every node.</para>
  1655. <para />
  1656. </listitem>
  1657. <listitem>
  1658. <para>Restart the HPCC system</para>
  1659. <para>You might prefer to script this process, especially if you
  1660. have many nodes. See the Example Scripts section in the Appendix
  1661. of the Installing_and_RunningtheHPCCPlatform document. You can use
  1662. the scripts as a model to create your own script to copy the
  1663. environment.xml file out to all your nodes.</para>
  1664. </listitem>
  1665. </orderedlist>
  1666. </sect2>
  1667. </sect1>
  1668. </chapter>
  1669. </book>