123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295 |
- <?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="FooterInfo"
- xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="common/Version.xml" xpointer="DateVer"
- xmlns:xi="http://www.w3.org/2001/XInclude" />
- <corpname>HPCC Systems<superscript>®</superscript></corpname>
- <xi:include href="common/Version.xml" xpointer="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.</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.</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 /sbin/service 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 /sbin/service 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 /sbin/service 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>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="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="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="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="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="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="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="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>
- <sect3>
- <title>DropZone Attributes</title>
- <orderedlist>
- <listitem>
- <para>Select Drop Zone in the Navigator panel on the left
- side.</para>
- </listitem>
- <listitem>
- <para>Select the Attributes tab.</para>
- </listitem>
- <listitem>
- <para>In the Value column of the Computer row, choose a node
- from the drop list as shown below:<graphic
- fileref="images/CM-img06.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>DropZone 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="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="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="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="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 ESP - MyEsp 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="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="ESP.t1"
- xmlns:xi="http://www.w3.org/2001/XInclude" />
-
- </para>
- <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="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="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="ESP.t4"
- xmlns:xi="http://www.w3.org/2001/XInclude" />
-
- </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>
- <!--MyESP-HTTPS.t5-XXX-17-->
- <para>
- <xi:include href="XMLGeneration/xml/esp.xsd.mod.xml"
- xpointer="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="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="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="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="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="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="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="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="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="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="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>
- <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>
- <para>
- <emphasis role="bold">Thor Memory Settings</emphasis>
- </para>
- <para>If <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>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="Th.t1"
- xmlns:xi="http://www.w3.org/2001/XInclude" />
- </para>
- </sect3>
- <?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="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="Th.t4"
- xmlns:xi="http://www.w3.org/2001/XInclude" />
- </para>
- </sect3>
- <?hard-pagebreak ?>
- <sect3>
- <title>ThorCluster Backup</title>
- <para>This section describes the ThorCluster Backup tab.</para>
- <para>
- <graphic fileref="images/CM-img18-5.jpg" vendor="configmgrSS" />
- </para>
- <!--configMgr-Thor-Backup-Include-XXX-->
- <para>
- <xi:include href="XMLGeneration/xml/thor.xsd.mod.xml"
- xpointer="Th.t5"
- xmlns:xi="http://www.w3.org/2001/XInclude" />
- </para>
- </sect3>
- <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>
- </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 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>
- </sect2>
- <sect2 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>
- </sect2>
- </sect1>
- </chapter>
- </book>
|