12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783 |
- <?xml version="1.0" encoding="UTF-8"?>
- <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
- "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
- <book xml:base="../">
- <bookinfo>
- <title>HPCC Configuration Manager</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/redswooshWithLogo3.jpg" />
- </imageobject>
- </mediaobject>
- <author>
- <surname>Boca Raton Documentation Team</surname>
- </author>
- <legalnotice>
- <para>We welcome your comments and feedback about this document via
- email to <email>docfeedback@hpccsystems.com</email></para>
- <para>Please include <emphasis role="bold">Documentation
- Feedback</emphasis> in the subject line and reference the document name,
- page numbers, and current Version Number in the text of the
- message.</para>
- <para>LexisNexis and the Knowledge Burst logo are registered trademarks
- of Reed Elsevier Properties Inc., used under license.</para>
- <para>HPCC Systems<superscript>®</superscript> is a registered trademark
- of LexisNexis Risk Data Management Inc.</para>
- <para>Other products, logos, and services may be trademarks or
- registered trademarks of their respective companies.</para>
- <para>All names and example data used in this manual are fictitious. Any
- similarity to actual persons, living or dead, is purely
- coincidental.</para>
- <para></para>
- </legalnotice>
- <xi:include href="common/Version.xml"
- xpointer="xpointer(//*[@id='FooterInfo'])"
- xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="common/Version.xml"
- xpointer="xpointer(//*[@id='DateVer'])"
- xmlns:xi="http://www.w3.org/2001/XInclude" />
- <corpname>HPCC Systems<superscript>®</superscript></corpname>
- <xi:include href="common/Version.xml"
- xpointer="xpointer(//*[@id='Copyright'])"
- xmlns:xi="http://www.w3.org/2001/XInclude" />
- <mediaobject role="logo">
- <imageobject>
- <imagedata fileref="images/LN_Rightjustified.jpg" />
- </imageobject>
- </mediaobject>
- </bookinfo>
- <chapter id="Buildin-HPCC-from-Source">
- <title>Using Configuration Manager</title>
- <para>Configuration Manager is the utility with which we configure the
- HPCC platform. The HPCC platform's configuration is stored in an XML file
- named <emphasis role="bold">environment.xml</emphasis>. When you install a
- package, a default single-node environment.xml is generated. After that,
- you can use the Configuration Manager to modify it and add nodes and
- configure components.</para>
- <para>The Configuration Manager Wizard creates a similar file, but after
- it is generated, you must rename it and put it into place on each
- node.</para>
- <para>Configuration Manager also offers an <emphasis role="bold">Advanced
- View</emphasis> which allows you to add instances of components or change
- the default settings for components. Even if you plane to use Advanced
- View, it is a good idea to start with a wizard generated configuration and
- use Advanced View to finish it.</para>
- <para>This document will guide you through configuring an HPCC environment
- using the Configuration Manager.</para>
- <sect1 id="configuring-a-multi-node-system">
- <title>Running the Configuration Manager</title>
- <para>This document will guide you through configuring an HPCC
- environment using the Configuration Manager.</para>
- <para>The HPCC package should already be installed on ALL nodes.</para>
- <para>You can use any tool or shell script you choose.</para>
- <orderedlist>
- <listitem>
- <para>SSH to a node in your environment and login as a user with
- sudo privileges. We would suggest that it would be the first node,
- and that it is a support node, however that is up to your
- discretion.</para>
- </listitem>
- <listitem>
- <para>Start the Configuration Manager service on the node (again we
- would suggest that it should be on a support node, and further that
- you use the same node to start the Configuration Manager every time,
- but this is also entirely up to you).</para>
- <programlisting>sudo /opt/HPCCSystems/sbin/configmgr</programlisting>
- <para><graphic fileref="images/gs_img_configmgrStart.jpg" /></para>
- </listitem>
- <listitem>
- <para>Using a Web browser, go to the Configuration Manager's
- interface:</para>
- <programlisting>http://<<emphasis>ip of installed system</emphasis>>:8015</programlisting>
- <para>The Configuration Manager startup wizard displays.</para>
- </listitem>
- </orderedlist>
- <para>There are different ways to configure your HPCC system. You can
- use the <emphasis role="bold">Generate environment wizard</emphasis> and
- use that environment or experienced users can then use the <emphasis
- role="bold">Advanced View</emphasis> for more specific customization.
- There is also the option of using <emphasis role="bold">Create blank
- environment</emphasis> to generate an empty environment that you could
- then go in and add only the components you would want.</para>
- <sect2 id="Env_Wizard">
- <title>Environment Wizard</title>
- <orderedlist>
- <listitem>
- <?dbfo keep-together="always"?>
- <para>To use the wizard select the <emphasis role="bold">Generate
- new environment using wizard</emphasis> button.</para>
- <para><graphic fileref="images/GS_ConfigMgrWizStart.jpg"
- vendor="configmgrSS" /></para>
- </listitem>
- <listitem>
- <para>Provide a name for the environment file.</para>
- <para>This will then be the name of the configuration XML file.
- For example, we will name our environment
- <emphasis>NewEnvironment</emphasis> and this will produce a
- configuration XML file named
- <emphasis>NewEnvironment.xml</emphasis> that we will
- use.<emphasis> </emphasis></para>
- </listitem>
- <listitem>
- <para>Press the Next button.</para>
- <para>Next you will need to define the IP addresses that your HPCC
- system will be using.</para>
- </listitem>
- <listitem>
- <?dbfo keep-together="always"?>
- <para>Enter the IP addresses or hostname(s).</para>
- <para>IP Addresses can be specified individually using semi-colon
- delimiters. You can also specify a range of IPs using a hyphen
- (for example, nnn.nnn.nnn.x-y). In the image below, we specified
- the IP addresses 10.239.219.1 through 10.239.219.100 using the
- range syntax, and also a single IP 10.239.219.111. Alternatively,
- you can enter the hostnames.</para>
- <para><graphic fileref="images/GS_ConfigMgrWiz002.jpg"
- vendor="configmgrSS" /></para>
- </listitem>
- <listitem>
- <para>Press the Next button.</para>
- <para>Now you will define how many nodes to use for the Roxie and
- Thor clusters.</para>
- </listitem>
- <listitem>
- <?dbfo keep-together="always"?>
- <para>Enter the appropriate values as indicated.</para>
- <para><graphic fileref="images/GS_CMWiz003.jpg"
- vendor="configmgrSS" /></para>
- <variablelist>
- <varlistentry>
- <term>Number of support nodes:</term>
- <listitem>
- <para>Specify the number of nodes to use for support
- components. The default is 1.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Number of nodes for Roxie cluster:</term>
- <listitem>
- <para>Specify the number of nodes to use for your Roxie
- cluster. Enter zero (0) if you do not want a Roxie
- cluster.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Number of slave nodes for Thor cluster</term>
- <listitem>
- <para>Specify the number of slave nodes to use in your Thor
- cluster. A Thor master node will be added automatically.
- Enter zero (0) if you do not want any Thor slaves.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Number of Thor slaves per node (default 1)</term>
- <listitem>
- <para>Specify the number of Thor slave processes to
- instantiate on each slave node. Enter zero (0) if you do not
- want a Thor cluster.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Enable Roxie on demand</term>
- <listitem>
- <para>Specify whether or not to allow queries to be run
- immediately on Roxie. This must be enabled to run the
- debugger. (Default is true)</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </listitem>
- <listitem>
- <para>Press the <emphasis role="bold">Next</emphasis>
- button</para>
- <para>The wizard displays the configuration parameters.</para>
- </listitem>
- <listitem>
- <?dbfo keep-together="always"?>
- <para>Press the <emphasis role="bold">Finish</emphasis> button to
- accept these values or press the <emphasis role="bold">Advanced
- View</emphasis> button to edit in advanced mode.</para>
- <graphic fileref="images/GS_ConfigMgrWiz004.jpg" />
- </listitem>
- </orderedlist>
- <para>You will now be notified that you have completed the
- wizard.</para>
- <para><graphic fileref="images/GS_ConfigMgrWiz005.jpg" /></para>
- <para>At this point, you have created a file named NewEnvironment.xml
- in the <emphasis role="bold">/etc/HPCCSystems/source</emphasis>
- directory</para>
- <informaltable colsep="1" frame="all" rowsep="1">
- <?dbfo keep-together="always"?>
- <tgroup cols="2">
- <colspec colwidth="49.50pt" />
- <colspec />
- <tbody>
- <row>
- <entry><inlinegraphic fileref="images/OSSgr3.png" /></entry>
- <entry>Keep in mind, that your HPCC configuration may be
- different depending on your needs. For example, you may not
- need a Roxie or you may need several smaller Roxie clusters.
- In addition, in a production [Thor] system, you would ensure
- that Thor and Roxie nodes are dedicated and have no other
- processes running on them. This document is intended to show
- you how to use the configuration tools. Capacity planning and
- system design is covered in a training module.</entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable>
- <sect3 id="Distrib_Conf" role="brk">
- <title>Distribute the Configuration</title>
- <orderedlist>
- <listitem>
- <?dbfo keep-together="always"?>
- <para>Stop the HPCC system.</para>
- <para>If it is running stop the HPCC system (on every node),
- using a command such as this:</para>
- <para><programlisting>sudo /etc/init.d/hpcc-init stop</programlisting></para>
- <variablelist>
- <varlistentry>
- <term>Note:</term>
- <listitem>
- <para>You may have a multi-node system and a custom script
- such as the one illustrated in Appendix of the <emphasis
- role="bluebold">Installing and Running the HPCC
- Platform</emphasis> document to start and stop your
- system. If that is the case please use the appropriate
- command for stopping your system on every node.</para>
- </listitem>
- </varlistentry>
- </variablelist>
- <para><informaltable colsep="1" frame="all" rowsep="1">
- <tgroup cols="2">
- <colspec colwidth="49.50pt" />
- <colspec />
- <tbody>
- <row>
- <entry><inlinegraphic
- fileref="images/caution.png" /></entry>
- <entry>Be sure HPCC is stopped before attempting to
- copy the environment.xml file.</entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable></para>
- </listitem>
- <listitem>
- <para>Back up the original environment.xml file.</para>
- <programlisting># For example
- sudo -u hpcc cp /etc/HPCCSystems/environment.xml /etc/HPCCSystems/source/environment-date.xml </programlisting>
- <variablelist>
- <varlistentry>
- <term>Note:</term>
- <listitem>
- <para>The live environment.xml file is located in your
- <emphasis role="bold">/etc/HPCCSystems/</emphasis>
- directory. ConfigManager works on files in <emphasis
- role="bold">/etc/HPCCSystems/source</emphasis> directory.
- You must copy from this location to make an
- environment.xml file active.</para>
- </listitem>
- </varlistentry>
- </variablelist>
- <para>You can also choose to give the environment file a more
- descriptive name, to help differentiate any differences.</para>
- <para>Having environment files under source control is a good
- way to archive your environment settings.</para>
- </listitem>
- <listitem>
- <para>Copy the new .xml file from the source directory to the
- /etc/HPCCSystems and rename the file to
- <emphasis>environment.xml</emphasis></para>
- <programlisting># for example
- sudo -u hpcc cp /etc/HPCCSystems/source/NewEnvironment.xml /etc/HPCCSystems/environment.xml</programlisting>
- <para></para>
- </listitem>
- <listitem>
- <para>Copy the <emphasis
- role="bold">/etc/HPCCSystems/environment.xml</emphasis> to the
- <emphasis role="bold">/etc/HPCCSystems/</emphasis> on to
- <emphasis>every</emphasis> node.</para>
- <para>You may want to use a script to push out the XML file to
- all nodes. See the <emphasis>Example Scripts</emphasis> section
- in the Appendix of the <emphasis role="bluebold">Installing and
- Running the HPCC Platform</emphasis> document. You can use the
- scripts as a model to create your own script to copy the
- environment.xml file out to all your nodes.</para>
- </listitem>
- <listitem>
- <para>Restart the HPCC platform on all nodes.</para>
- </listitem>
- </orderedlist>
- </sect3>
- </sect2>
- </sect1>
- </chapter>
- <chapter>
- <title>Configuration Manager Advanced View</title>
- <para>For the advanced user, the Advanced View offers access to adding
- additional instances of components or making configuration settings for
- individual components.</para>
- <sect1 id="configuring-advanced-setup">
- <title>Using ConfigMgr in Advanced Mode</title>
- <para>This section shows some of the configuration options in Advanced
- Mode. There are a few different ways to configure your system. If you
- are not an experienced user you can use the Generate environment wizard
- discussed in the previous section. The following steps will detail the
- Advanced set up.</para>
- <orderedlist>
- <listitem>
- <para>SSH to the first box in your environment and login as a user
- with sudo privileges.</para>
- </listitem>
- <listitem>
- <para>If it is running, stop the HPCC system using this command on
- every node:</para>
- <para><programlisting>sudo /etc/init.d/hpcc-init stop</programlisting></para>
- <variablelist>
- <varlistentry>
- <term>Note:</term>
- <listitem>
- <para>If you have a large system with many nodes, you may want
- to use a script to perform this step. See the
- <emphasis>Example Scripts</emphasis> section in the Appendix
- of the <emphasis role="bluebold">Installing and Running the
- HPCC Platform</emphasis> document.</para>
- </listitem>
- </varlistentry>
- </variablelist>
- <para><informaltable colsep="1" frame="all" rowsep="1">
- <?dbfo keep-together="always"?>
- <tgroup cols="2">
- <colspec colwidth="49.50pt" />
- <colspec />
- <tbody>
- <row>
- <entry><inlinegraphic
- fileref="images/OSSgr3.png" /></entry>
- <entry>You can use this command to confirm HPCC processes
- are stopped: <para><programlisting>sudo /etc/init.d/hpcc-init status</programlisting></para></entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable></para>
- </listitem>
- <listitem>
- <para>Start the Configuration Manager service on one node (usually
- the first node is considered the head node and is used for this
- task, but this is up to you).</para>
- <programlisting>sudo /opt/HPCCSystems/sbin/configmgr</programlisting>
- <para><graphic fileref="images/gs_img_configmgrStart.jpg" /></para>
- </listitem>
- <listitem>
- <para>Using a Web browser, go to the Configuration Manager's
- interface:</para>
- <programlisting>http://<<emphasis>ip of installed system</emphasis>>:8015</programlisting>
- <para>The Configuration Manager startup wizard displays.</para>
- </listitem>
- <listitem>
- <para>Select <emphasis role="bold">Advanced View</emphasis>, then
- press the <emphasis role="bold">Next </emphasis>button.</para>
- <para>There are a few different ways to configure your system. If
- you are not an experienced user you can use the Generate environment
- wizard discussed in the previous section.</para>
- </listitem>
- <listitem>
- <para>Select an XML file from the drop list.</para>
- <para>This list is populated from versions of an environment XML
- file in your server's /etc/HPCCSystems/source/ directory.</para>
- <para>The system will check the current environment file and if a
- match is found here it will highlight in blue the current
- environment file being used.</para>
- </listitem>
- <listitem>
- <?dbfo keep-together="always"?>
- <para>Press the <emphasis role="bold">Next</emphasis> button.
- <graphic fileref="images/CM-WizStart.jpg"
- vendor="configmgrSS" /></para>
- </listitem>
- <listitem>
- <para>The Configuration Manager interface displays.</para>
- <para><informaltable colsep="1" frame="all" rowsep="1">
- <?dbfo keep-together="always"?>
- <tgroup cols="2">
- <colspec colwidth="49.50pt" />
- <colspec />
- <tbody>
- <row>
- <entry><inlinegraphic
- fileref="images/OSSgr3.png" /></entry>
- <entry>Default access is read-only. Many options are only
- available when write-access is enabled. <para>Gain write
- access by checking the <emphasis role="bold">Write
- Access</emphasis> checkbox. </para><para>Unchecking this
- box returns the environment to read-only mode. All menu
- items are disabled in read-only mode. </para><para>Closing
- the web page automatically removes any write-access
- locks.</para></entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable></para>
- </listitem>
- <listitem>
- <para>Check the <emphasis role="bold">Write Access</emphasis>
- box.</para>
- <para><graphic fileref="images/CM-img101.jpg"
- vendor="configmgrSS" />The <emphasis role="bold">Save</emphasis>
- button<inlinegraphic fileref="images/GS-img01c.png"
- vendor="configmgrSS" /> validates and saves the environment.</para>
- <para>The <emphasis role="bold">Save Environment As</emphasis>
- button <inlinegraphic fileref="images/CM-img181.jpg"
- vendor="configmgrSS" /> validates and lets you specify the
- environment filename to save.</para>
- <para>The <emphasis role="bold">Validate Environment</emphasis>
- button<inlinegraphic fileref="images/GS-img01d.png"
- vendor="configmgrSS" /> just validates the current environment
- including any changes that have not yet been saved.</para>
- <para>The <emphasis role="bold">Open Environment</emphasis> button
- <inlinegraphic fileref="images/CM-img18.jpg" vendor="configmgrSS" />
- allows you to open a new environment file to work on.</para>
- <para>The <emphasis role="bold">Wizard</emphasis> button
- <inlinegraphic fileref="images/CM-img19.jpg" vendor="configmgrSS" />
- will bring up the Configuration Manager chooser form which will
- allow you to create or view an environment file where you can also
- launch the configuration wizard.</para>
- <para>These buttons are only enabled in Write Access mode.</para>
- </listitem>
- </orderedlist>
- <sect2 role="brk">
- <title>XML View</title>
- <para>In the advanced view of Configuration Manager, you can
- optionally choose to work with the XML View.</para>
- <para>To see the the configuration in XML View, click on the
- Environment heading in the Navigator panel on the left side.</para>
- <para><graphic fileref="images/CM-120.jpg" />You can access all
- attributes through the XML view.</para>
- <para>If you wish to add an attribute that does not exist, right-click
- on one of the components then you can choose to add an
- attribute.</para>
- <para><graphic fileref="images/CM-121.jpg" /></para>
- </sect2>
- </sect1>
- <sect1 role="brk">
- <title>Hardware Section</title>
- <para>This section allows you to define your list of servers. When
- defining instances of components, you will choose from servers in this
- list.</para>
- <orderedlist>
- <listitem>
- <?dbfo keep-together="always"?>
- <para>Select <emphasis role="bold">Hardware</emphasis> in the
- Navigator panel on the left side.</para>
- <para><graphic fileref="images/CM-img01.jpg"
- vendor="configmgrSS" /></para>
- </listitem>
- <listitem>
- <para>Select the <emphasis role="bold">Computers</emphasis>
- tab.</para>
- </listitem>
- <listitem>
- <?dbfo keep-together="always"?>
- <para>right-click on one of computers listed, then select New
- Range.</para>
- <para><graphic fileref="images/CM-img02.jpg"
- vendor="configmgrSS" /></para>
- </listitem>
- <listitem>
- <para>Specify the following:</para>
- <itemizedlist>
- <listitem>
- <para>Name Prefix - any name that will help you to identify the
- node or range</para>
- </listitem>
- <listitem>
- <para>Start IP Address</para>
- </listitem>
- <listitem>
- <para>Stop IP Address</para>
- <para>The IP Addresses can be specified in a range if all your
- host IP addresses are consecutively numbered. If the IP
- addresses are not sequential you should repeat the process for
- each individual IP address and just add the IP address in both
- the start and stop IP address field. You will then need to
- repeat the process for each node.</para>
- </listitem>
- </itemizedlist>
- </listitem>
- <listitem>
- <?dbfo keep-together="always"?>
- <para>Press the <emphasis role="bold">OK</emphasis> button.</para>
- <para>The list of nodes now displays with the nodes that you just
- added.</para>
- <para><inlinegraphic fileref="images/CM-img03.jpg"
- vendor="configmgrSS" /></para>
- <para>Next, edit each System Server component instance and set it to
- a newly defined node.</para>
- <!--***The steps that follow are using one component per node. You can allocate more components per node, if needed.-->
- </listitem>
- <listitem>
- <para>Click the <inlinegraphic fileref="images/GS-img01c.png" />
- disk icon to save</para>
- </listitem>
- <listitem>
- <para>Expand the <emphasis role="bold">Software</emphasis> section,
- if necessary, in the Navigator panel on the left side, by clicking
- on the <inlinegraphic fileref="images/expandButton.png" />
- button.</para>
- </listitem>
- </orderedlist>
- </sect1>
- <sect1>
- <title>Software Section</title>
- <para>Use the software components section to configure software
- components of the HPCC platform. Most software components are actual
- running processes; however, some are just definitions used by the
- system. These definitions are used by the configuration
- generator.</para>
- <para>Items that appear in <emphasis role="red">red</emphasis> indicate
- optional values. They are only written to the environment if you add to
- or change that value. If untouched, they will not appear in the
- environment XML file.</para>
- <sect2 role="brk">
- <title>Backupnode</title>
- <para>Backupnode allows you to back up Thor clusters at regular
- intervals. The Backupnode component is a way to allow administrators
- to manage the backupnode process without using a cron job.</para>
- <para>To configure scheduled Thor node backups, add the backupnode
- component, choose the hardware instance to run it on and then add Thor
- groups to it. <graphic fileref="images/CM-img21.jpg"
- vendor="configmgrSS" /></para>
- <para><orderedlist>
- <listitem>
- <para>Right click on the <emphasis
- role="bold">Software</emphasis> component in the <emphasis
- role="bold">Navigator</emphasis> panel (on the right side),
- choose <emphasis role="bold">New Components</emphasis> then
- <emphasis role="bold">backupnode</emphasis> from the drop
- list.</para>
- </listitem>
- <listitem>
- <para>From the tabs on the right side, select the <emphasis
- role="bold">Instances</emphasis> tab.</para>
- </listitem>
- <listitem>
- <para>Right click on the <emphasis
- role="bold">computer</emphasis> column and choose <emphasis
- role="bold">Add Instances</emphasis>...<graphic
- fileref="images/CM-img22.jpg" vendor="configmgrSS" /></para>
- </listitem>
- <listitem>
- <para>Select the computer for the backupnode component, or press
- <emphasis role="bold">Add Hardware</emphasis> to add a new
- computer instance. You would always want to run backupnode on
- the Thor master of the cluster.</para>
- </listitem>
- <listitem>
- <para>Select the <emphasis role="bold">Thor Node
- Groups</emphasis> tab.</para>
- </listitem>
- <listitem>
- <para>Right click on the the <emphasis
- role="bold">Interval</emphasis> column and choose the interval
- and/or Thor group to back up.</para>
- </listitem>
- <listitem>
- <para>Click the <inlinegraphic fileref="images/GS-img01c.png" />
- disk icon to save</para>
- </listitem>
- </orderedlist>The default backup locations are:</para>
- <programlisting> /var/lib/HPCCSystems/hpcc-data/backupnode/<thorname>/last_backup </programlisting>
- <para>The interval attribute of the backupnode component determines
- how many hours between backups.</para>
- </sect2>
- <sect2 role="brk">
- <title>Dali</title>
- <sect3>
- <title>Instances</title>
- <para>
- <orderedlist>
- <listitem>
- <para>Select <emphasis role="bold">Dali Server</emphasis> in
- the Navigator panel on the left side.</para>
- </listitem>
- <listitem>
- <para>Select the Instances tab.</para>
- </listitem>
- <listitem>
- <?dbfo keep-together="always"?>
- <para>In the computer column, choose a node from the drop list
- as shown below:<graphic fileref="images/CM-img04.jpg"
- vendor="configmgrSS" /></para>
- </listitem>
- <listitem>
- <para>Click the <inlinegraphic
- fileref="images/GS-img01c.png" /> disk icon to save</para>
- </listitem>
- </orderedlist>
- </para>
- </sect3>
- <sect3 role="brk">
- <title>DaliServer attributes</title>
- <para>This section describes the DaliServer attributes.</para>
- <para>
- <graphic fileref="images/CM-img04-1.jpg" vendor="configmgrSS" />
- </para>
- <para />
- <!--configMgr-Dali-Server-Include-XXX1-->
- <para>
- <xi:include href="XMLGeneration/xml/dali.xsd.mod.xml"
- xpointer="xpointer(//*[@id='da.t1'])"
- xmlns:xi="http://www.w3.org/2001/XInclude" />
- </para>
- </sect3>
- <?hard-pagebreak ?>
- <sect3>
- <title>DaliServer store</title>
- <para>This section describes the attributes configuring how Dali
- handles the system data store.</para>
- <para>
- <graphic fileref="images/CM-img04-2.jpg" vendor="configmgrSS" />
- </para>
- <para />
- <!--configMgr-Dali-Server-Include-XXX2-->
- <para>
- <xi:include href="XMLGeneration/xml/dali.xsd.mod.xml"
- xpointer="xpointer(//*[@id='da.t2'])"
- xmlns:xi="http://www.w3.org/2001/XInclude" />
- </para>
- </sect3>
- <?hard-pagebreak ?>
- <sect3>
- <title>DaliServer LDAP options</title>
- <para>This section describes the DaliServer LDAP tab.</para>
- <para>
- <graphic fileref="images/CM-img04-4.jpg" vendor="configmgrSS" />
- </para>
- <!--configMgr-DaliServer-LDAP-Include-XXX3-->
- <para>
- <xi:include href="XMLGeneration/xml/dali.xsd.mod.xml"
- xpointer="xpointer(//*[@id='da.t4'])"
- xmlns:xi="http://www.w3.org/2001/XInclude" />
- </para>
- </sect3>
- <sect3>
- <title>DaliServer Notes</title>
- <para>This tab allows you to add any notes pertinent to the
- component's configuration. This can be useful to keep a record of
- changes and to communicate this information to peers.</para>
- </sect3>
- </sect2>
- <sect2 id="DaliServerPlugin" role="brk">
- <title>DaliServerPlugin</title>
- <para>DaliServerPlugin allows you to add plugin functionality to a
- Dail server.</para>
- <sect3>
- <title>DaliServerPlugin attributes</title>
- <para>This section describes the DaliServerPlugin attributes.</para>
- <para>
- <graphic fileref="images/Cass2.jpg" vendor="configmgrSS" />
- </para>
- <!--configMgr-daplugin-Include-->
- <para>
- <xi:include href="XMLGeneration/xml/daliplugin.xsd.mod.xml"
- xpointer="xpointer(//*[@id='daplug.t'])"
- xmlns:xi="http://www.w3.org/2001/XInclude" />
- </para>
- </sect3>
- <sect3 role="brk">
- <title>DaliServerPlugin Options</title>
- <para>This section describes the DaliServerPlugin options</para>
- <para>These options are available for the DaliServerplugin when
- configuring a Casandra server. See the System Administrator's Guide
- for more details about configuring a Cassandra server as a system
- datastore.</para>
- <para>
- <informaltable colsep="1" frame="all" id="daliplugoptionstable"
- rowsep="1">
- <tgroup cols="2">
- <colspec align="left" colwidth="125.55pt" />
- <colspec />
- <tbody>
- <row>
- <entry>randomWuidSuffix</entry>
- <entry>An integer value indicating how many randomized
- digits to append to workunits. Set this if you need to
- create workunits at a high rate to reduce the risk of
- collisions (which would slow down the process of creating
- a new unique workunit id).</entry>
- </row>
- <row>
- <entry>traceLevel</entry>
- <entry>An integer value indicating how much tracing to
- output from Cassandra workunit operations. Set to zero or
- do not set in normal usage.</entry>
- </row>
- <row>
- <entry>partitions</entry>
- <entry>An integer value indicating how many ways to
- partition the data on a Cassandra cluster. The default is
- 2. The value only takes effect when a new Cassandra
- workunit repository is created. Larger values permit
- scaling to a more distributed store but at the expense of
- some overhead on smaller stores where the scaling is not
- needed.</entry>
- </row>
- <row>
- <entry>prefixsize</entry>
- <entry>
- <para>An integer value specifying the minimum number of
- characters that must be provided when wildcard searching
- in the repository. Larger values will be more efficient
- but also more restrictive on users. The default is 2. As
- with partitions, this value only takes effect when a new
- Cassandra workunit repository is created.</para>
- </entry>
- </row>
- <row>
- <entry>keyspace</entry>
- <entry>The name of the Cassandra keyspace to use for the
- HPCC data store. The default is
- <emphasis>hpcc</emphasis>.</entry>
- </row>
- <row>
- <entry>user</entry>
- <entry>The username to use if the Cassandra server is
- configured to require credentials.</entry>
- </row>
- <row>
- <entry>password</entry>
- <entry>The password to use if the Cassandra server is
- configured to require credentials.</entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable>
- </para>
- </sect3>
- </sect2>
- <sect2 id="Dafilesrv-Process" role="brk">
- <title>Dafilesrv Process</title>
- <sect3>
- <title>Dafilesrv Instances</title>
- <para>Dafilesrv is a helper process that every node needs.</para>
- <orderedlist>
- <listitem>
- <para>Select Dafilesrv in the Navigator panel on the left
- side.</para>
- </listitem>
- <listitem>
- <para>Select the Instances tab.</para>
- </listitem>
- <listitem>
- <para>Right-click on a computer in the computer column, and
- select Add Instance .</para>
- </listitem>
- <listitem>
- <?dbfo keep-together="always"?>
- <para>Select all computers in the list by checking the <emphasis
- role="bold">Select All</emphasis> box, then press the <emphasis
- role="bold">OK</emphasis> button.</para>
- <para>
- <graphic fileref="images/CM-img12.jpg" vendor="configmgrSS" />
- </para>
- </listitem>
- <listitem>
- <para>Click the <inlinegraphic fileref="images/GS-img01c.png" />
- disk icon to save</para>
- </listitem>
- </orderedlist>
- </sect3>
- <?hard-pagebreak ?>
- <sect3>
- <title>Dafilesrv attributes</title>
- <para>This section describes the Dafilesrv attributes.</para>
- <para>
- <graphic fileref="images/CM-img12-1.jpg" vendor="configmgrSS" />
- </para>
- <!--configMgr-DaFileSrv-Include-XXX4-->
- <para>
- <xi:include href="XMLGeneration/xml/dafilesrv.xsd.mod.xml"
- xpointer="xpointer(//*[@id='daFs.t'])"
- xmlns:xi="http://www.w3.org/2001/XInclude" />
- </para>
- </sect3>
- </sect2>
- <sect2 id="DFU-Server" role="brk">
- <title>DFU Server</title>
- <sect3>
- <title>DfuServer Instances</title>
- <orderedlist>
- <listitem>
- <para>Select <emphasis role="bold">DFU Server</emphasis> in the
- Navigator panel on the left side.</para>
- </listitem>
- <listitem>
- <para>Select the Instances tab.</para>
- </listitem>
- <listitem>
- <para>In the computer column, choose a node from the drop list
- as shown below:<graphic fileref="images/CM-img05.jpg"
- vendor="configmgrSS" /></para>
- </listitem>
- <listitem>
- <para>Click the <inlinegraphic fileref="images/GS-img01c.png" />
- disk icon to save</para>
- </listitem>
- </orderedlist>
- </sect3>
- <sect3 role="brk">
- <title>DfuServer Attributes Tab</title>
- <para>This section describes the DfuServer attributes.</para>
- <para>
- <graphic fileref="images/CM-img05-1.jpg" vendor="configmgrSS" />
- </para>
- <!--configMgr-DFUSrvr-Attr-Include-XXX6-->
- <para>
- <xi:include href="XMLGeneration/xml/dfuserver.xsd.mod.xml"
- xpointer="xpointer(//*[@id='DF.t1'])"
- xmlns:xi="http://www.w3.org/2001/XInclude" />
- </para>
- </sect3>
- <sect3 role="brk">
- <title>DfuServer SSH Options</title>
- <para>This section describes the DfuServer SSH Options..</para>
- <para>
- <graphic fileref="images/CM-img05-2.jpg" vendor="configmgrSS" />
- </para>
- <!--configMgr-DFUSrvr-SSH-Include-XXX7-->
- <para>
- <xi:include href="XMLGeneration/xml/dfuserver.xsd.mod.xml"
- xpointer="xpointer(//*[@id='DF.t2'])"
- xmlns:xi="http://www.w3.org/2001/XInclude" />
- </para>
- </sect3>
- <sect3>
- <title>DfuServer Notes</title>
- <para>This tab allows you to add any notes pertinent to the
- component's configuration. This can be useful to keep a record of
- changes and to communicate this information to peers.</para>
- </sect3>
- </sect2>
- <sect2 role="brk">
- <title>Directories</title>
- <para>The Directories component is a global definition used by other
- components to determine the directories they will use for various
- functions.</para>
- <para>
- <graphic fileref="images/CM-161a.jpg" vendor="configmgrSS" />
- </para>
- <para />
- <informaltable colsep="1" frame="all" rowsep="1">
- <tgroup cols="3">
- <colspec align="left" colwidth="122.40pt" />
- <tbody>
- <row>
- <entry>Name</entry>
- <entry>Directory</entry>
- <entry>Description</entry>
- </row>
- <row>
- <entry>
- <emphasis role="bold">log</emphasis>
- </entry>
- <entry>/var/log/[NAME]/[INST]</entry>
- <entry>Location for Log files</entry>
- </row>
- <row>
- <entry>
- <emphasis role="bold">temp</emphasis>
- </entry>
- <entry>/var/lib/[NAME]/[INST]/temp</entry>
- <entry>Location for temp files</entry>
- </row>
- <row>
- <entry>
- <emphasis role="bold">data</emphasis>
- </entry>
- <entry />
- <entry>Base Location for data files</entry>
- </row>
- <row>
- <entry>
- <emphasis role="bold">data2</emphasis>
- </entry>
- <entry />
- <entry>Base Location for 2nd copy of roxie data</entry>
- </row>
- <row>
- <entry>
- <emphasis role="bold">data3</emphasis>
- </entry>
- <entry />
- <entry>Reserved for future use</entry>
- </row>
- <row>
- <entry>
- <emphasis role="bold">mirror</emphasis>
- </entry>
- <entry />
- <entry>Base Location for mirror data files</entry>
- </row>
- <row>
- <entry>
- <emphasis role="bold">query</emphasis>
- </entry>
- <entry />
- <entry>Base Location for Queries</entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable>
- </sect2>
- <sect2 id="Drop-Zone" role="brk">
- <title>Drop Zone</title>
- <para>A Drop Zone (or landing zone) is a location where files can be
- transferred to or from your HPCC system. The drop zone is a logical
- combination of a path and one or more servers.</para>
- <para>Multiple drop zones allow you to configure different top level
- folders for one or more servers. Multiple servers for a single drop
- zone provides a logical grouping of distinct locations. Multiple drop
- zones are useful to allow different permissions for users or
- groups.</para>
- <para>To add a drop zone:</para>
- <para>
- <orderedlist>
- <listitem>
- <para>Right-click on the Navigator panel on the left side and
- choose <emphasis role="bold">New Components</emphasis></para>
- </listitem>
- <listitem>
- <para>Select <emphasis role="bold">Drop Zone</emphasis></para>
- </listitem>
- </orderedlist>
- </para>
- <sect3>
- <title>Drop Zone Attributes</title>
- <para>You can change the configuration of your drop zone using the
- attributes tab. If you have multiple drop zones, select the drop
- zone to configure from the Navigator panel on the left side.</para>
- <para>To change the drop zone attributes:</para>
- <para>
- <orderedlist>
- <listitem>
- <para>On the <emphasis role="bold">Attributes</emphasis> tab,
- select the Attribute to modify.</para>
- </listitem>
- <listitem>
- <para>Double-click on the value on the right side of the
- attribute table for the value you wish to modify.</para>
- <para>For example, select the <emphasis
- role="bold">name</emphasis> attribute, double click on the
- <emphasis role="bold">value</emphasis> column and provide the
- drop zone with a more meaningful name.</para>
- </listitem>
- <listitem>
- <para>Click the disk icon to save.</para>
- </listitem>
- </orderedlist>
- </para>
- <para>
- <graphic fileref="images/CM-img06.jpg" vendor="configmgrSS" />
- </para>
- <para>
- <xi:include href="XMLGeneration/xml/dropzone.xsd.mod.xml"
- xpointer="xpointer(//*[@id='dz.t1'])"
- xmlns:xi="http://www.w3.org/2001/XInclude" />
- </para>
- <!-- /*Attribute table***replace with dynamically generated table*/
- <informaltable>
- <tgroup cols="2">
- <tbody>
- <row>
- <entry>description</entry>
- <entry>a description</entry>
- </row>
- <row>
- <entry>directory</entry>
- <entry>The directory for the drop zone</entry>
- </row>
- <row>
- <entry>name</entry>
- <entry>The name for the drop zone</entry>
- </row>
- <row>
- <entry>umask</entry>
- <entry>umask</entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable>
- -->
- </sect3>
- <sect3 id="DropZoneServerList">
- <title>Drop Zone Server List</title>
- <para>This tab allows you to add any servers that you wish to
- configure as a part of the selected drop zone.</para>
- <para>To add a server to the current drop zone: <orderedlist>
- <listitem>
- <para>Select the <emphasis role="bold">Drop Zone</emphasis> to
- configure from the Navigator panel on the left side.</para>
- </listitem>
- <listitem>
- <para>Select the <emphasis role="bold">Server List</emphasis>
- tab, right-click on the Server Address field and choose
- <emphasis role="bold">Add</emphasis>.</para>
- </listitem>
- <listitem>
- <para>Enter the hostname or IP address of the server.</para>
- </listitem>
- <listitem>
- <para>Click the disk icon to save.</para>
- </listitem>
- </orderedlist></para>
- </sect3>
- <sect3 id="DropZoneNotes">
- <title>Drop Zone Notes</title>
- <para>This tab allows you to add any notes pertinent to the
- component's configuration. This can be useful to keep a record of
- changes and to communicate this information to peers.</para>
- </sect3>
- </sect2>
- <sect2 id="ECL-Agent" role="brk">
- <title>ECL Agent</title>
- <sect3>
- <title>Instances</title>
- <orderedlist>
- <listitem>
- <para>Select ECL Agent in the Navigator panel on the left
- side.</para>
- </listitem>
- <listitem>
- <para>Select the Instances tab.</para>
- </listitem>
- <listitem>
- <para>In the computer column, choose a node from the drop list
- as shown below:<graphic fileref="images/CM-img07.jpg"
- vendor="configmgrSS" /></para>
- </listitem>
- <listitem>
- <para>Click the <inlinegraphic fileref="images/GS-img01c.png" />
- disk icon to save</para>
- </listitem>
- </orderedlist>
- </sect3>
- <sect3 role="brk">
- <title>EclAgent Attributes Tab</title>
- <para>This section describes the EclAgent Attributes tab.</para>
- <para>
- <graphic fileref="images/CM-img07-1.jpg" vendor="configmgrSS" />
- </para>
- <!--configMgr-ECLAgent-Attr-Include-XXX8-->
- <para>
- <xi:include href="XMLGeneration/xml/eclagent_config.xsd.mod.xml"
- xpointer="xpointer(//*[@id='EA.t1'])"
- xmlns:xi="http://www.w3.org/2001/XInclude" />
- </para>
- </sect3>
- <sect3 role="brk">
- <title>EclAgent Options Tab</title>
- <para>This section describes the EclAgent Options tab.</para>
- <para>
- <graphic fileref="images/CM-img07-2.jpg" vendor="configmgrSS" />
- </para>
- <!--configMgr-ECLAgent-Options-Include-XXX9-->
- <para>
- <xi:include href="XMLGeneration/xml/eclagent_config.xsd.mod.xml"
- xpointer="xpointer(//*[@id='EA.t2'])"
- xmlns:xi="http://www.w3.org/2001/XInclude" />
- </para>
- </sect3>
- <sect3>
- <title>EclAgentProcessNotes</title>
- <para>This tab allows you to add any notes pertinent to the
- component's configuration. This can be useful to keep a record of
- changes and to communicate this information to peers.</para>
- </sect3>
- </sect2>
- <sect2 role="brk">
- <title>ECL CC Server Process</title>
- <sect3>
- <title>Ecl CC Server Instances</title>
- <para>
- <orderedlist>
- <listitem>
- <para>Select Ecl CC Server - myeclccserver in the Navigator
- panel on the left side.</para>
- </listitem>
- <listitem>
- <para>Select the Instances tab.</para>
- </listitem>
- <listitem>
- <para>In the computer column, choose a node from the drop list
- as shown below:<graphic fileref="images/CM-ECLCC-01.jpg"
- vendor="configmgrSS" /></para>
- </listitem>
- <listitem>
- <para>Click the <inlinegraphic
- fileref="images/GS-img01c.png" /> disk icon to save</para>
- </listitem>
- </orderedlist>
- </para>
- </sect3>
- <sect3 role="brk">
- <title>Ecl CC Server Attributes Tab</title>
- <para>This section describes the Ecl CC Server Attributes
- tab.</para>
- <para>
- <graphic fileref="images/CM-ECLCC-02.jpg" vendor="configmgrSS" />
- </para>
- <!--ECLCCServer-Include-cc.t2-XXX-X-->
- <para>
- <xi:include href="XMLGeneration/xml/eclccserver.xsd.mod.xml"
- xpointer="xpointer(//*[@id='cc.t2'])"
- xmlns:xi="http://www.w3.org/2001/XInclude" />
- </para>
- </sect3>
- <sect3>
- <title>EclCC Server Process Options</title>
- <para>To add a custom option, right-click and select add. These
- options are passed to the eclcc compiler.</para>
- <para>See the ECL Compiler chapter in the <emphasis
- role="bluebold">Client Tools</emphasis> manual for details.</para>
- <!--This feature allows the user to configure any options pertinent to the Ecl CC Server Process -->
- <para />
- </sect3>
- <sect3>
- <title>EclCC Server Process Notes</title>
- <para>This tab allows you to add any notes pertinent to the
- component's configuration. This can be useful to keep a record of
- changes and to communicate this information to peers.</para>
- </sect3>
- </sect2>
- <sect2 id="ECL-Scheduler" role="brk">
- <title>ECL Scheduler</title>
- <sect3>
- <title>Instances</title>
- <orderedlist>
- <listitem>
- <para>Select <emphasis role="bold">ECL Scheduler</emphasis> in
- the Navigator panel on the left side.</para>
- </listitem>
- <listitem>
- <para>Select the Instances tab.</para>
- </listitem>
- <listitem>
- <para>In the computer column, choose a node from the drop list
- as shown below:<graphic fileref="images/CM-161.jpg"
- vendor="configmgrSS" /></para>
- </listitem>
- <listitem>
- <para>Click the <inlinegraphic fileref="images/GS-img01c.png" />
- disk icon to save</para>
- </listitem>
- </orderedlist>
- </sect3>
- <sect3 role="brk">
- <title>EclScheduler Attributes Tab</title>
- <para>This section describes the EclScheduler Attributes tab.</para>
- <para>
- <graphic fileref="images/CM-160.jpg" vendor="configmgrSS" />
- </para>
- <!--configMgr-DaliServer-LDAP-Include-XXX-XI-->
- <para>
- <xi:include href="XMLGeneration/xml/eclscheduler.xsd.mod.xml"
- xpointer="xpointer(//*[@id='ecl.sched'])"
- xmlns:xi="http://www.w3.org/2001/XInclude" />
- </para>
- </sect3>
- <sect3>
- <title>EclScheduler Notes</title>
- <para>This tab allows you to add any notes pertinent to the
- component's configuration. This can be useful to keep a record of
- changes and to communicate this information to peers.</para>
- </sect3>
- </sect2>
- <sect2 id="ESP-Server" role="brk">
- <title>ESP Server</title>
- <sect3>
- <title>Esp Process Instances</title>
- <orderedlist>
- <listitem>
- <para>Select <emphasis role="bold">ESP - myesp</emphasis> in the
- Navigator panel on the left side.</para>
- </listitem>
- <listitem>
- <para>Select the Instances tab.</para>
- </listitem>
- <listitem>
- <para>In the computer column, choose a node from the drop list
- as shown below:<graphic fileref="images/CM-img08.jpg"
- vendor="configmgrSS" /></para>
- </listitem>
- <listitem>
- <para>Click the <inlinegraphic fileref="images/GS-img01c.png" />
- disk icon to save</para>
- </listitem>
- </orderedlist>
- </sect3>
- <?hard-pagebreak ?>
- <sect3>
- <title>Esp - myesp Attributes Tab</title>
- <para>This section describes the Esp - myesp Attributes tab.</para>
- <para>
- <graphic fileref="images/CM-img08-1.jpg" vendor="configmgrSS" />
- </para>
- <!--MyESP-Include-ESP.t6-XXX12-->
- <para>
- <xi:include href="XMLGeneration/xml/esp.xsd.mod.xml"
- xpointer="xpointer(//*[@id='ESP.t6'])"
- xmlns:xi="http://www.w3.org/2001/XInclude" />
- </para>
- </sect3>
- <sect3 role="brk">
- <title>Esp - myesp Service BindingsTab</title>
- <para>This section describes the Esp - myesp Service Bindings tab.
- This tab requires additional steps to configure the service
- bindings.</para>
- <para>
- <graphic fileref="images/CM-img08-2.jpg" vendor="configmgrSS" />
- </para>
- <para>You must first add the service bindings in the first table
- (Right-click, add). Then you would configure the attributes in the
- other tables on that tab. The next table describes the <emphasis
- role="bold">URL Authentication</emphasis> table.</para>
- <!--MyESP-Include-ESP.t1-XXXIII-->
- <para>
- <xi:include href="XMLGeneration/xml/esp.xsd.mod.xml"
- xpointer="xpointer(//*[@id='ESP.t1'])"
- xmlns:xi="http://www.w3.org/2001/XInclude" />
- </para>
- <?hard-pagebreak ?>
- <para>The following tables describe the ESPProcess Service Bindings,
- <emphasis role="bold">Feature Authentications</emphasis>.</para>
- <!--MyESP-Include-ES.t2-XXX-14-->
- <para>
- <xi:include href="XMLGeneration/xml/esp.xsd.mod.xml"
- xpointer="xpointer(//*[@id='ESP.t2'])"
- xmlns:xi="http://www.w3.org/2001/XInclude" />
- </para>
- <para>
- <!--MyESP-Include-ES.t3-XXX-15-->
- <!-- <xi:include href="XMLGeneration/xml/esp.xsd.mod.xml"
- xpointer="xpointer(//*[@id='ES.t3'])"
- xmlns:xi="http://www.w3.org/2001/XInclude" /> -->
- </para>
- <para />
- </sect3>
- <?hard-pagebreak ?>
- <sect3>
- <title>Esp - myesp AuthenticationTab</title>
- <para>This section describes the Esp - myesp Service Authentication
- tab.</para>
- <para>
- <graphic fileref="images/CM-img08-3.jpg" vendor="configmgrSS" />
- </para>
- <!--MyESP-Authentication-ES.t4-XXX-16-->
- <para>
- <xi:include href="XMLGeneration/xml/esp.xsd.mod.xml"
- xpointer="xpointer(//*[@id='ESP.t4'])"
- xmlns:xi="http://www.w3.org/2001/XInclude" />
- </para>
- <para>Additional information about the available Authentication
- methods:</para>
- <para>
- <informaltable colsep="1" frame="all" rowsep="1">
- <tgroup cols="2">
- <colspec colwidth="111.50pt" />
- <colspec />
- <tbody>
- <row>
- <entry>none</entry>
- <entry>uses no authentication</entry>
- </row>
- <row>
- <entry>local</entry>
- <entry>uses the local credentials for the server running
- the ESP</entry>
- </row>
- <row>
- <entry>ldap</entry>
- <entry>uses Lightweight Directory Access Protocol for
- authentication</entry>
- </row>
- <row>
- <entry>ldaps</entry>
- <entry>similar to LDAP but uses a more secure (TLS)
- protocol</entry>
- </row>
- <row>
- <entry>secmgrPlugin</entry>
- <entry>uses the security manager plug-in</entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable>
- </para>
- </sect3>
- <?hard-pagebreak ?>
- <sect3>
- <title>Esp - myesp HTTPS Tab</title>
- <para>This section describes the Esp - myesp HTTPS tab.</para>
- <para>
- <graphic fileref="images/CM-img08-4.jpg" vendor="configmgrSS" />
- </para>
- <para>The <emphasis role="bold">cipherList</emphasis> attribute
- allows you to set the ordered list of available ciphers for use by
- openssl. See the documentation at openssl.org for more information
- about ciphers.</para>
- <!--MyESP-HTTPS.t5-XXX-17-->
- <para>
- <xi:include href="XMLGeneration/xml/esp.xsd.mod.xml"
- xpointer="xpointer(//*[@id='ESP.t5'])"
- xmlns:xi="http://www.w3.org/2001/XInclude" />
- </para>
- </sect3>
- <sect3>
- <title>EspProcess Notes</title>
- <para>This tab allows you to add any notes pertinent to the
- component's configuration. This can be useful to keep a record of
- changes and to communicate this information to peers.</para>
- </sect3>
- </sect2>
- <sect2 id="ESP_Services" role="brk">
- <title>ESP Services</title>
- <para>ESP Services provide a means to add functionality to an ESP
- Server.</para>
- <sect3 id="CfgMgrEclWatch">
- <title>ECL Watch Service</title>
- <para>Ecl Watch allows you to configure options for the ECL Watch
- utility.</para>
- <para>
- <graphic fileref="images/CM-009.jpg" vendor="configmgrSS" />
- </para>
- <para>ECL Watch Attribute definitions.</para>
- <!--ECLWa-Include-TBLZ-1-->
- <para>
- <xi:include href="XMLGeneration/xml/espsmcservice.xsd.mod.xml"
- xpointer="xpointer(//*[@id='SMC-T01'])"
- xmlns:xi="http://www.w3.org/2001/XInclude" />
- </para>
- <para>ECL Watch Monitoring attributes.</para>
- <!--ECLWa-Include-TBLZ-2-->
- <para>
- <xi:include href="XMLGeneration/xml/espsmcservice.xsd.mod.xml"
- xpointer="xpointer(//*[@id='SMC-T02'])"
- xmlns:xi="http://www.w3.org/2001/XInclude" />
- </para>
- </sect3>
- <sect3 id="cfgmgr_WsECL" role="brk">
- <title>WsECL Service</title>
- <para>The WsECL service allows you to configure options for the
- WsECL utility.</para>
- <para>
- <graphic fileref="images/CM-010.jpg" vendor="configmgrSS" />
- </para>
- <para>The Ws ECL configuration attributes.</para>
- <!--WsECL-Include-ZXX-1-->
- <para>
- <xi:include href="XMLGeneration/xml/esp_service_wsecl2.xsd.mod.xml"
- xpointer="xpointer(//*[@id='MyWS2-T01'])"
- xmlns:xi="http://www.w3.org/2001/XInclude" />
- </para>
- <?hard-pagebreak ?>
- <para>Ws ECL VIPS option attributes.</para>
- <!--WsECL-Include-ZXX-2-->
- <para>
- <xi:include href="XMLGeneration/xml/esp_service_wsecl2.xsd.mod.xml"
- xpointer="xpointer(//*[@id='MyWS2-T02'])"
- xmlns:xi="http://www.w3.org/2001/XInclude" />
- </para>
- <para>Ws ECL Target Restrictions table.</para>
- <!--WsECL-Include-ZXX-3-->
- <para>
- <xi:include href="XMLGeneration/xml/esp_service_wsecl2.xsd.mod.xml"
- xpointer="xpointer(//*[@id='MyWS2-T03'])"
- xmlns:xi="http://www.w3.org/2001/XInclude" />
- </para>
- </sect3>
- </sect2>
- <sect2 id="FTSlave-Process" role="brk">
- <title>FTSlave Process</title>
- <para>FTSlave is a helper process that every node needs. This section
- depicts an FTSlave installation.</para>
- <sect3>
- <title>Instances</title>
- <orderedlist>
- <listitem>
- <para>Select FTSlave in the Navigator panel on the left
- side.</para>
- </listitem>
- <listitem>
- <para>Select the Instances tab.</para>
- </listitem>
- <listitem>
- <?dbfo keep-together="always"?>
- <para>Right-click on a computer in the computer column, and
- select Add Instance.</para>
- <para>
- <graphic fileref="images/CM-190.jpg" vendor="configmgrSS" />
- </para>
- </listitem>
- <listitem>
- <?dbfo keep-together="always"?>
- <para>Select all computers in the list, then press the <emphasis
- role="bold">OK</emphasis> button.</para>
- <para>
- <graphic fileref="images/CM-112-4.jpg" vendor="configmgrSS" />
- </para>
- </listitem>
- <listitem>
- <para>Click the <inlinegraphic fileref="images/GS-img01c.png" />
- disk icon to save</para>
- </listitem>
- </orderedlist>
- </sect3>
- <sect3>
- <title>FtSlave attributes</title>
- <para>This section describes an FTSlaveProcess attributes
- tab.</para>
- <!--FTSlave-Include-XXX-18-->
- <para>
- <xi:include href="XMLGeneration/xml/ftslave_linux.xsd.mod.xml"
- xpointer="xpointer(//*[@id='FTS.t1'])"
- xmlns:xi="http://www.w3.org/2001/XInclude" />
- </para>
- </sect3>
- <sect3>
- <title>FtSlave Process Notes</title>
- <para>This tab allows you to add any notes pertinent to the
- component's configuration. This can be useful to keep a record of
- changes and to communicate this information to peers.</para>
- </sect3>
- </sect2>
- <sect2 id="LDAPServer_Process" role="brk">
- <title>LDAP Server Process</title>
- <para>This section describes the configuration attributes of an
- LDAPServer Installation in ConfigManager. For a complete description
- of how to add LDAP Authentication see <emphasis>Using LDAP
- Authentication</emphasis> section in the <emphasis
- role="bluebold">Installing and Running The HPCC Platform</emphasis>
- document.</para>
- <para>
- <graphic fileref="images/LDAP_004.jpg" />
- </para>
- <!--LdapServer-Include-fullDoc-XXX-19-->
- <xi:include href="XMLGeneration/xml/ldapserver.xsd.mod.xml"
- xpointer="xpointer(//*[@id='ldapSrv'])"
- xmlns:xi="http://www.w3.org/2001/XInclude" />
- <sect3>
- <title>LDAP Server Process Instances</title>
- <para>This tab allows you to add instances to your LDAP
- Configuration. In order to add instances you would have previously
- added the LDAP computers in the Hardware section. For a complete
- description of how to add LDAP Authentication see <emphasis>Using
- LDAP Authentication</emphasis> section in the <emphasis
- role="bluebold">Installing and Running The HPCC Platform</emphasis>
- document.</para>
- <orderedlist>
- <listitem>
- <para>On the <emphasis role="bold">Instances</emphasis> tab,
- right-click on the table on the right hand side, choose
- <emphasis role="bold">Add Instances...</emphasis></para>
- </listitem>
- <listitem>
- <para>Select the computer to use by checking the box next to
- it.</para>
- <para>This is the computer you added in the <emphasis
- role="bold">Hardware</emphasis> / <emphasis role="bold">Add New
- Computers</emphasis> portion earlier.</para>
- </listitem>
- </orderedlist>
- </sect3>
- <sect3>
- <title>LDAP Server Process Notes</title>
- <para>This tab allows you to add any notes pertinent to the
- component's configuration. This can be useful to keep a record of
- changes and to communicate this information to peers.</para>
- </sect3>
- </sect2>
- <sect2 role="brk">
- <title>Sasha Server</title>
- <sect3>
- <title>Instances</title>
- <orderedlist>
- <listitem>
- <para>Select Sasha Server in the menu on the left side.</para>
- </listitem>
- <listitem>
- <para>Select the Instances tab.</para>
- </listitem>
- <listitem>
- <para>In the computer column, choose a node from the drop list
- as shown below:</para>
- </listitem>
- </orderedlist>
- <graphic fileref="images/CM-img17.jpg" vendor="configmgrSS" />
- </sect3>
- <sect3 role="brk">
- <title>Sasha Server Attributes</title>
- <!--***Might-Want-to-add-CM-Sasha17A.jpg-image-***-->
- <para>This section described the SashaServerProcess <emphasis
- role="bold">Attribute</emphasis> tab values.</para>
- <graphic fileref="images/CM-Sasha17A.jpg" vendor="configmgrSS" />
- <!--configMgr-Sasha-t1-Include-XXX-20-->
- <para>
- <xi:include href="XMLGeneration/xml/sasha.xsd.mod.xml"
- xpointer="xpointer(//*[@id='sh.t1'])"
- xmlns:xi="http://www.w3.org/2001/XInclude" />
- </para>
- </sect3>
- <?hard-pagebreak ?>
- <sect3>
- <title>SashaServer Process Archiver</title>
- <para>This section describes the SashaServer Process Archiver
- tab.</para>
- <para>
- <graphic fileref="images/CM-img17-1.jpg" vendor="configmgrSS" />
- </para>
- <!--configMgr-Sasha-Archiver-Include-XXX-21-->
- <para>
- <xi:include href="XMLGeneration/xml/sasha.xsd.mod.xml"
- xpointer="xpointer(//*[@id='sh.t2'])"
- xmlns:xi="http://www.w3.org/2001/XInclude" />
- </para>
- <para />
- </sect3>
- <sect3 role="brk">
- <title>SashaServer Process Coalescer</title>
- <para>This section describes the SashaServer Process Coalescer
- tab.</para>
- <para>
- <graphic fileref="images/CM-img17-2.jpg" vendor="configmgrSS" />
- </para>
- <!--configMgr-Sasha-Coaleser-Include-XXX-22-->
- <para>
- <xi:include href="XMLGeneration/xml/sasha.xsd.mod.xml"
- xpointer="xpointer(//*[@id='sh.t3'])"
- xmlns:xi="http://www.w3.org/2001/XInclude" />
- </para>
- </sect3>
- <?hard-pagebreak ?>
- <sect3>
- <title>SashaServer Process DfuXRef</title>
- <para>This section describes the SashaServer Process DfuXref
- tab.</para>
- <para>
- <graphic fileref="images/CM-img17-3.jpg" vendor="configmgrSS" />
- </para>
- <!--configMgr-Sasha-DfuXref-Include-XXX-23-->
- <para>
- <xi:include href="XMLGeneration/xml/sasha.xsd.mod.xml"
- xpointer="xpointer(//*[@id='sh.t4'])"
- xmlns:xi="http://www.w3.org/2001/XInclude" />
- </para>
- </sect3>
- <?hard-pagebreak ?>
- <sect3>
- <title>SashaServer Process DfuExpiry</title>
- <para>This section describes the SashaServer Process DfuExpiry
- tab.</para>
- <para>
- <graphic fileref="images/CM-img17-4.jpg" vendor="configmgrSS" />
- </para>
- <para />
- <!--configMgr-Sasha-DfuExpiry-Include-XXX-24-->
- <para>
- <xi:include href="XMLGeneration/xml/sasha.xsd.mod.xml"
- xpointer="xpointer(//*[@id='sh.t5'])"
- xmlns:xi="http://www.w3.org/2001/XInclude" />
- </para>
- </sect3>
- <?hard-pagebreak ?>
- <sect3>
- <title>SashaServer Process ThorQMon</title>
- <para>This section describes the SashaServer Process ThorQMon
- tab.</para>
- <para>
- <graphic fileref="images/CM-img17-5.jpg" vendor="configmgrSS" />
- </para>
- <!--configMgr-Sasha-ThorQMon-IncludeXXX-25-->
- <para>
- <xi:include href="XMLGeneration/xml/sasha.xsd.mod.xml"
- xpointer="xpointer(//*[@id='sh.t6'])"
- xmlns:xi="http://www.w3.org/2001/XInclude" />
- </para>
- </sect3>
- <?hard-pagebreak ?>
- <sect3>
- <title>SashaServer Process DaFileSrvMonitor</title>
- <para>This section describes the SashaServer Process
- DaFileSrvMonitor tab.</para>
- <para>
- <graphic fileref="images/CM-img17-6.jpg" vendor="configmgrSS" />
- </para>
- <!--configMgr-Sasha-DafiSrvMon-Include-XXX26-->
- <para>
- <xi:include href="XMLGeneration/xml/sasha.xsd.mod.xml"
- xpointer="xpointer(//*[@id='sh.t7'])"
- xmlns:xi="http://www.w3.org/2001/XInclude" />
- </para>
- </sect3>
- <sect3>
- <title>SashaServer Process Notes</title>
- <para>This tab allows you to add any notes pertinent to the
- component's configuration. This can be useful to keep a record of
- changes and to communicate this information to peers.</para>
- </sect3>
- </sect2>
- <sect2 id="Thor" role="brk">
- <title>Thor</title>
- <para>This section details how to define a Data Refinery (Thor)
- cluster. Before you begin, you should decide the width of the cluster
- (i.e., how many slave nodes will you have).</para>
- <orderedlist>
- <listitem>
- <para>Select <emphasis role="bold">Thor Cluster -
- mythor</emphasis> in the Navigator panel on the left side.</para>
- </listitem>
- <listitem>
- <para>Select the <emphasis role="bold">Topology</emphasis>
- tab.</para>
- </listitem>
- <listitem>
- <para>Expand the Topology, if needed, then right-click the Master
- and select Delete.</para>
- </listitem>
- </orderedlist>
- <para>This deletes the sample one-node Thor.</para>
- <para>You will replace this with a multi-node cluster.</para>
- <orderedlist>
- <listitem>
- <?dbfo keep-together="always"?>
- <para>right-click on the Topology and select Add Master.</para>
- <para>
- <graphic fileref="images/CM-img13.jpg" vendor="configmgrSS" />
- </para>
- </listitem>
- <listitem>
- <?dbfo keep-together="always"?>
- <para>Select a computer from the list, then press the OK
- button.</para>
- <para>
- <graphic fileref="images/CM-112-5.jpg" vendor="configmgrSS" />
- </para>
- </listitem>
- <listitem>
- <?dbfo keep-together="always"?>
- <para>Right-click on the Master and select Add Slaves.</para>
- <para>
- <graphic fileref="images/CM-111.jpg" vendor="configmgrSS" />
- </para>
- </listitem>
- <listitem>
- <?dbfo keep-together="always"?>
- <para>Select the computers to use as slaves from the list, then
- press the OK button. Use CTRL+CLICK to multi-select or SHIFT+CLICK
- to select a range.</para>
- <para><graphic fileref="images/CM-112-3.jpg"
- vendor="configmgrSS" />The Nodes now display below the Thor Master
- node.</para>
- <para>
- <graphic fileref="images/CM-img14.jpg" vendor="configmgrSS" />
- </para>
- </listitem>
- <listitem>
- <para>Select Thor Cluster - mythor in the Navigator panel on the
- left side.</para>
- </listitem>
- <listitem>
- <?dbfo keep-together="always"?>
- <para>Select the Attributes tab.</para>
- <para>
- <graphic fileref="images/CM-img15.jpg" vendor="configmgrSS" />
- </para>
- </listitem>
- <listitem>
- <para>Change the value of the localThor to <emphasis
- role="bold">false</emphasis></para>
- </listitem>
- <listitem>
- <para>Click the <inlinegraphic fileref="images/GS-img01c.png" />
- disk icon to save</para>
- </listitem>
- </orderedlist>
- <?hard-pagebreak ?>
- <sect3>
- <title>Changing Thor topology</title>
- <para>If you want to designate a different node as the Thor master
- when setting up a multi-node system, follow these steps.</para>
- <orderedlist>
- <listitem>
- <para>Select <emphasis role="bold">Thor Cluster -
- mythor</emphasis> in the Navigator panel on the left
- side.</para>
- </listitem>
- <listitem>
- <para>Select the <emphasis role="bold">Topology</emphasis>
- tab.</para>
- </listitem>
- <listitem>
- <para>Right-click on the Master node</para>
- </listitem>
- <listitem>
- <?dbfo keep-together="always"?>
- <para>Select the <emphasis role="bold">Replace Master</emphasis>
- option.</para>
- <para>
- <graphic fileref="images/CM-111-2.jpg" vendor="configmgrSS" />
- </para>
- <para>
- <informaltable colsep="1" frame="all" rowsep="1">
- <?dbfo keep-together="always"?>
- <tgroup cols="2">
- <colspec colwidth="49.50pt" />
- <colspec />
- <tbody>
- <row>
- <entry>
- <inlinegraphic fileref="images/caution.png" />
- </entry>
- <entry>You should only use this feature when initially
- setting up your system. If there is data on the nodes
- when attempting to Swap Master, you run the risk of
- losing or corrupting some data.</entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable>
- </para>
- </listitem>
- </orderedlist>
- </sect3>
- <?hard-pagebreak ?>
- <sect3 id="ThorClusterAttributesTab">
- <title>ThorCluster Attributes</title>
- <para>This section describes the Thor Cluster Attributes tab.</para>
- <para>
- <graphic fileref="images/CM-img18-1.jpg" vendor="configmgrSS" />
- </para>
- <sect4 id="ThorMemorySettings">
- <title>Thor Memory Settings</title>
- <para>When the <emphasis role="bold">globalMemorySize</emphasis>
- is left unset, Thor[master] detects total physical memory and
- allocates 75% of it. If there are multiple slaves per node
- (slavesPerNode>1) it divides the total among the slaves. If
- globalMemorySize is defined, then it allocates that amount of
- memory to each slave. The masterMemorySize attribute allocates
- memory for the Thor master. If omitted, Thor master uses
- globalMemorySize, or the default 75% of memory.</para>
- <para>On systems with a lot of memory, the default 75% of physical
- memory is probably too conservative and reserving total physical
- minus 2GB (for the OS and other processes) is sensible. You should
- then divide that number by the number of slavesPerNode.</para>
- <para>If there are multiple Thors sharing the same nodes, then
- globalMemorySize must be configured to take that into
- account.</para>
- <para>For example, if there are 2 Thors each with 2 slaves per
- box, that will mean there are 4 slaves per physical node. So you
- should use a formula similar to the following in your calculations
- when configuring globalMemorySize:</para>
- <programlisting>globalMemorySize = (total-physical-memory)-2GB / (2*2) </programlisting>
- <para>Without any specified setting, Thor assumes it has exclusive
- access to the memory and would therefore use too much (because
- each Thor is unaware of the other's configuration and memory
- usage).</para>
- <para>If <emphasis role="bold">localThor</emphasis> is set to true
- and <emphasis role="bold">masterMemorySize</emphasis> and
- <emphasis role="bold">globalMemorySize</emphasis> are unspecified,
- then the defaults will be 50% for <emphasis
- role="bold">globalMemorySize</emphasis> (divided by <emphasis
- role="bold">slavesPerNode</emphasis>) and 25% for <emphasis
- role="bold">masterMemorySize.</emphasis></para>
- <para>Although a configuration may be set using upper memory
- limits that exceed total physical memory, Thor will not actually
- reserve the memory ahead of time and will only hit memory problems
- when and if your jobs use all of memory. So, for example, two
- Thors that are configured to use all available memory could
- peacefully co-exist until a query on each are simultaneously using
- more memory than the node has available.</para>
- <!--configMgr-Thor-Attribute-Include-XXX-->
- <para>
- <xi:include href="XMLGeneration/xml/thor.xsd.mod.xml"
- xpointer="xpointer(//*[@id='Th.t1'])"
- xmlns:xi="http://www.w3.org/2001/XInclude" />
- </para>
- </sect4>
- </sect3>
- <xi:include href="ECLWatch/TheECLWatchMan.xml"
- xpointer="xpointer(//*[@id='ECLWatchXREFMultiThor'])"
- xmlns:xi="http://www.w3.org/2001/XInclude" />
- <?hard-pagebreak ?>
- <sect3>
- <title>ThorCluster SSH Options</title>
- <para>This section describes the ThorCluster SSH Options tab.</para>
- <para>
- <graphic fileref="images/CM-img18-2.jpg" vendor="configmgrSS" />
- </para>
- <!--configMgr-Thor-SSH-Include-XXX-->
- <para>
- <xi:include href="XMLGeneration/xml/thor.xsd.mod.xml"
- xpointer="xpointer(//*[@id='Th.t3'])"
- xmlns:xi="http://www.w3.org/2001/XInclude" />
- </para>
- </sect3>
- <sect3>
- <title>ThorCluster Debug</title>
- <para>The debug tab is for internal use only</para>
- </sect3>
- <?hard-pagebreak ?>
- <sect3>
- <title>ThorCluster Swap Node</title>
- <para>This section describes the ThorCluster Swap Node tab.</para>
- <para>
- <graphic fileref="images/CM-img18-4.jpg" vendor="configmgrSS" />
- </para>
- <!--configMgr-Thor-SwapNode-Include-XXX-->
- <para>
- <xi:include href="XMLGeneration/xml/thor.xsd.mod.xml"
- xpointer="xpointer(//*[@id='Th.t4'])"
- xmlns:xi="http://www.w3.org/2001/XInclude" />
- </para>
- </sect3>
- <?hard-pagebreak ?>
- <sect3>
- <title>ThorCluster Notes</title>
- <para>This tab allows you to add any notes pertinent to the
- component's configuration. This can be useful to keep a record of
- changes and to communicate this information to peers.</para>
- </sect3>
- </sect2>
- <sect2 id="Roxie" role="brk">
- <title>Roxie</title>
- <para>This section details how to define a Rapid Data Delivery Engine
- (Roxie) cluster. Before you begin, you should decide the width of the
- cluster (i.e., how many agent nodes will you have).</para>
- <!--***This section appears to have had signifcent changes*** -->
- <orderedlist>
- <listitem>
- <para>Select <emphasis role="bold">Roxie Cluster</emphasis> in the
- Navigator panel on the left side.</para>
- <para><emphasis role="bold">Note:</emphasis> If you did not
- specify a value in the <emphasis>Number of nodes for Roxie cluster
- </emphasis>field when you first set up your environment, you will
- not have a Roxie Cluster. To add a Roxie Cluster component:
- Right-click on the <emphasis role="bold">Software</emphasis>
- component in the Navigator Panel, then select <emphasis
- role="bold">New Components</emphasis> then <emphasis
- role="bold">roxie</emphasis> from the drop lists.</para>
- </listitem>
- <listitem>
- <para>Select the <emphasis role="bold">Servers</emphasis>
- tab.</para>
- </listitem>
- <listitem>
- <?dbfo keep-together="always"?>
- <para>Right-click the Roxie Servers and select
- <guimenuitem>Reconfigure Servers</guimenuitem>.</para>
- <para>
- <graphic fileref="images/CM-112.jpg" vendor="configmgrSS" />
- </para>
- </listitem>
- <listitem>
- <?dbfo keep-together="always"?>
- <para>Select the computers to use as Servers from the list, then
- press the OK button.</para>
- <para>
- <graphic fileref="images/CM-112-2.jpg" vendor="configmgrSS" />
- </para>
- </listitem>
- <listitem>
- <para>Select the <emphasis role="bold">Redundancy</emphasis>
- tab.</para>
- </listitem>
- <listitem>
- <?dbfo keep-together="always"?>
- <para>Select the redundancy scheme to use. Typically, this is
- cyclic redundancy, as shown below.</para>
- <para>
- <graphic fileref="images/CM-112-1.jpg" vendor="configmgrSS" />
- </para>
- </listitem>
- <listitem>
- <para>Click the <inlinegraphic fileref="images/GS-img01c.png" />
- disk icon to save</para>
- </listitem>
- <listitem>
- <para>Close Configuration Manager by pressing ctrl+C in the
- command window where it is running.</para>
- </listitem>
- </orderedlist>
- <sect3>
- <title>Roxie Configuration Attributes</title>
- <para>Roxie has many configurable attributes which can be used to
- for customizing and tuning to your specific needs. The following
- section expands on each of the Roxie tabs and the available
- attributes. There is additional Roxie configuration information in
- the section immediately following these tables.</para>
- </sect3>
- </sect2>
- <!--configMgr-ROXIE-Include-SEC4-->
- <?hard-pagebreak ?>
- <xi:include href="XMLGeneration/xml/roxie.xsd.mod.xml"
- xpointer="element(/1)"
- xmlns:xi="http://www.w3.org/2001/XInclude" />
- <sect2>
- <title />
- <sect3>
- <title>Additional Roxie Configuration items</title>
- <para>
- <emphasis role="bold">Add Servers to Roxie Farm</emphasis>
- </para>
- <para>To add servers to a Roxie farm</para>
- <para><orderedlist>
- <listitem>
- <para>Select the <emphasis role="bold">Roxie Cluster -
- myroxie</emphasis> (default) from the Navigator window on the
- left side.</para>
- </listitem>
- <listitem>
- <para>Select the <emphasis role="bold">Servers</emphasis>
- tab.</para>
- </listitem>
- <listitem>
- <para>Right-click on <emphasis role="bold">Roxie
- Servers</emphasis>.</para>
- </listitem>
- <listitem>
- <para>Select <emphasis role="bold">Reconfigure
- Servers</emphasis>.</para>
- </listitem>
- <listitem>
- <para>Press the <emphasis role="bold">Add Hardware</emphasis>
- button.</para>
- </listitem>
- <listitem>
- <para>Enter the values for the new server(s) in the dialog
- then press OK.</para>
- </listitem>
- </orderedlist>All configured servers are then used when you create
- a port to listen on.</para>
- <variablelist>
- <varlistentry>
- <term>NOTE</term>
- <listitem>
- <para>If working with an older environment file this process
- has changed. You no longer have to specify for a server to use
- a specific port.</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </sect3>
- <sect3>
- <title>Redundancy</title>
- <para>Roxie can be configured to utilize a few different redundancy
- models. <itemizedlist>
- <listitem>
- <para>Simple Redundancy - One channel per slave. Most commonly
- used for a single node Roxie.</para>
- </listitem>
- <listitem>
- <para>Full Redundancy - More slaves than the number of
- channels. Multiple slaves host each channel.</para>
- </listitem>
- <listitem>
- <para>Overloaded Redundancy - There are multiple channels per
- slave.</para>
- </listitem>
- <listitem>
- <para>Cyclic Redundancy - Each node hosts multiple channels in
- rotation. The most commonly used configuration.</para>
- </listitem>
- </itemizedlist></para>
- </sect3>
- </sect2>
- <sect2 id="Topology" role="brk">
- <title>Topology</title>
- <para>This section describes the topology tab.</para>
- <para>
- <graphic fileref="images/CM-img20.jpg" vendor="configmgrSS" />
- <informaltable colsep="0" frame="none" rowsep="0">
- <tgroup cols="2">
- <colspec align="left" colwidth="122.40pt" />
- <colspec />
- <tbody>
- <row>
- <entry>Attribute name</entry>
- <entry>Definition</entry>
- </row>
- <row>
- <entry>
- <emphasis>Topology</emphasis>
- </entry>
- <entry>describes the system topology</entry>
- </row>
- <row>
- <entry>
- <emphasis>Cluster - thor</emphasis>
- </entry>
- <entry>describes the Thor clusters</entry>
- </row>
- <row>
- <entry>
- <emphasis>Cluster - hthor</emphasis>
- </entry>
- <entry>describes the hthor clusters</entry>
- </row>
- <row>
- <entry>
- <emphasis>Cluster - roxie</emphasis>
- </entry>
- <entry>describes the Roxie clusters</entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable>
- </para>
- <sect3 id="Propogate-configuration-changes" role="brk">
- <title>Distribute Configuration Changes to all Nodes</title>
- <para>Once your environment is set up as desired, you must copy the
- configuration file to the other nodes.</para>
- <para />
- <orderedlist>
- <listitem>
- <para>If it is running, stop the system</para>
- <para>
- <informaltable colsep="1" frame="all" rowsep="1">
- <?dbfo keep-together="always"?>
- <tgroup cols="2">
- <colspec colwidth="49.50pt" />
- <colspec />
- <tbody>
- <row>
- <entry>
- <inlinegraphic fileref="images/caution.png" />
- </entry>
- <entry>Be sure system is stopped before attempting to
- copy the Environment.xml file.</entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable>
- </para>
- </listitem>
- <listitem>
- <para>Back up the original environment.xml file</para>
- <programlisting># for example
- sudo -u hpcc cp /etc/HPCCSystems/environment.xml /etc/HPCCSystems/environment.bak </programlisting>
- <para>Note: the "live environment.xml file is located in your
- <emphasis role="bold">/etc/HPCCSystems/</emphasis> directory.
- ConfigManager works on files in <emphasis
- role="bold">/etc/HPCCSystems/source</emphasis> directory. You
- must copy from this location to make an environment.xml file
- active.</para>
- </listitem>
- <listitem>
- <para>Copy the NewEnvironment.xml file from the source directory
- to the /etc/HPCCSystems and rename the file to
- environment.xml</para>
- <programlisting># for example
- sudo -u hpcc cp /etc/HPCCSystems/source/NewEnvironment.xml /etc/HPCCSystems/environment.xml</programlisting>
- <para />
- </listitem>
- <listitem>
- <para>Copy the /etc/HPCCSystems/environment.xml to the
- /etc/HPCCSystems/ on every node.</para>
- <para />
- </listitem>
- <listitem>
- <para>Restart the HPCC system</para>
- <para>You might prefer to script this process, especially if you
- have many nodes. See the Example Scripts section in the Appendix
- of the Installing_and_RunningtheHPCCPlatform document. You can
- use the scripts as a model to create your own script to copy the
- environment.xml file out to all your nodes.</para>
- </listitem>
- </orderedlist>
- </sect3>
- </sect2>
- </sect1>
- </chapter>
- </book>
|