UsingConfigManager.xml 74 KB

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