1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391 |
- <?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> 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. HPCC Systems 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. 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</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>
- <itemizedlist mark="square">
- <listitem>
- <para>The HPCC packages should already be installed on ALL
- nodes.</para>
- <para>You can use any tool or shell script you choose.</para>
- </listitem>
- <listitem>
- <para>SSH to the first box in your environment and login as a user
- with sudo privileges.</para>
- </listitem>
- </itemizedlist>
- <itemizedlist mark="square">
- <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>
- </itemizedlist>
- <itemizedlist>
- <listitem>
- <para>Using a Web browser, go to the Configuration Manager's
- interface:</para>
- <programlisting>http://<<emphasis>ip of installed system</emphasis>>:8015</programlisting>
- </listitem>
- </itemizedlist>
- <itemizedlist mark="square">
- <listitem>
- <para>The Configuration Manager startup wizard displays.</para>
- <para>There are a few different ways to configure your HPCC. You can
- use the Generate environment wizard or experienced users can use the
- Advanced View.</para>
- <itemizedlist>
- <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. For
- example we will name our environment
- <emphasis>NewEnvironment</emphasis>. This will produce an XML
- file named<emphasis> NewEnvironment.xml</emphasis>.</para>
- </listitem>
- <listitem>
- <para>Press the Next button.</para>
- <para>Next you will need to define the IP addresses that your
- HPCC will be using.</para>
- </listitem>
- </itemizedlist>
- <itemizedlist>
- <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>Alternatively, you could find the IP addresses using Auto
- Discovery by selecting the Auto Discovery button.</para>
- <para>Now you will define how many nodes to use for the Roxie
- and Thor clusters.</para>
- </listitem>
- </itemizedlist>
- <itemizedlist>
- <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.</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>
- </itemizedlist>
- <itemizedlist>
- <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>
- </itemizedlist>
- <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 HPPC 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>
- </listitem>
- <listitem>
- <?dbfo keep-together="always"?>
- <para>Stop the HPCC</para>
- <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 move
- 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 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
- <emphasis>every</emphasis> node.</para>
- <para>You may want to use a script to push out XML file to all
- 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>
- <listitem>
- <para>Restart the HPCC platform.</para>
- </listitem>
- </itemizedlist>
- </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.</para>
- <para><itemizedlist mark="square">
- <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:</para>
- <para><programlisting>sudo /sbin/service hpcc-init stop</programlisting><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>
- </itemizedlist><itemizedlist mark="square">
- <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 configmgr</programlisting>
- <para><graphic
- fileref="images/gs_img_configmgrStart.jpg" /></para>
- </listitem>
- </itemizedlist><itemizedlist>
- <listitem>
- <para>Using a Web browser, go to the Configuration Manager's
- interface:</para>
- <programlisting>http://<<emphasis>ip of installed system</emphasis>>:8015</programlisting>
- </listitem>
- </itemizedlist><itemizedlist mark="square">
- <listitem>
- <para>The Configuration Manager startup wizard displays.</para>
- <para>There are a few different ways to configure your system. You
- can use the Generate environment wizard or experienced users can
- use the Advanced set up.</para>
- <itemizedlist>
- <listitem>
- <para>Select <emphasis role="bold">Advanced View</emphasis>,
- then press the <emphasis role="bold">Next
- </emphasis>button.</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>
- </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>
- </itemizedlist>
- </listitem>
- </itemizedlist></para>
- <itemizedlist mark="circle">
- <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>
- </itemizedlist>
- <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, RT-CLICK on
- one of the components then you can choose to add an attribute.</para>
- <para><graphic fileref="images/CM-121.jpg" /></para>
- </sect2>
- <sect2 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>
- <itemizedlist mark="circle">
- <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>
- </itemizedlist>
- <itemizedlist mark="square">
- <listitem>
- <para>Select the <emphasis role="bold">Computers</emphasis>
- tab.</para>
- </listitem>
- <listitem>
- <?dbfo keep-together="always"?>
- <para>RT-CLICK on one of computers listed, then select New
- Range.</para>
- <para><graphic fileref="images/CM-img02.jpg"
- vendor="configmgrSS" /></para>
- </listitem>
- </itemizedlist>
- <itemizedlist mark="square">
- <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>
- </itemizedlist>
- <itemizedlist mark="square">
- <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>
- </itemizedlist>
- <itemizedlist mark="square">
- <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>
- </itemizedlist>
- </sect2>
- <sect2>
- <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 red 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>
- <sect3>
- <title>Dali</title>
- <sect4>
- <title>Instances</title>
- <para><itemizedlist mark="square">
- <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>
- </itemizedlist></para>
- </sect4>
- <sect4>
- <title>DaliServer attributes</title>
- <para>This section describes the DaliServer attributes.</para>
- <para><graphic fileref="images/CM-img04-1.jpg"
- vendor="configmgrSS" /></para>
- <para><informaltable colsep="0" frame="none" rowsep="0">
- <tgroup cols="2">
- <colspec align="left" colwidth="122.40pt" />
- <colspec />
- <tbody>
- <row>
- <entry>Attribute</entry>
- <entry>Definition</entry>
- </row>
- <row>
- <entry><emphasis>AuditLogDir</emphasis></entry>
- <entry>Audit Log Process description</entry>
- </row>
- <row>
- <entry><emphasis>dataPath</emphasis></entry>
- <entry>the path to the data</entry>
- </row>
- <row>
- <entry><emphasis>description </emphasis></entry>
- <entry>data path description</entry>
- </row>
- <row>
- <entry><emphasis>environment</emphasis></entry>
- <entry>the current environment file in use</entry>
- </row>
- <row>
- <entry><emphasis>LogDir</emphasis></entry>
- <entry>location of the log files</entry>
- </row>
- <row>
- <entry><emphasis>msgLevel</emphasis></entry>
- <entry>description of the msgLevel</entry>
- </row>
- <row>
- <entry><emphasis>name</emphasis></entry>
- <entry>Name of the process instance (AlphaNumeric and
- underscore only)</entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable></para>
- </sect4>
- <?hard-pagebreak ?>
- <sect4>
- <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><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>EndTime</emphasis></entry>
- <entry>End Time</entry>
- </row>
- <row>
- <entry><emphasis>IdlePeriod</emphasis></entry>
- <entry>Period to remain Idle</entry>
- </row>
- <row>
- <entry><emphasis>IdleRate</emphasis></entry>
- <entry>IdleRate</entry>
- </row>
- <row>
- <entry><emphasis>keepStores</emphasis></entry>
- <entry></entry>
- </row>
- <row>
- <entry><emphasis>lightweightCoalesce</emphasis></entry>
- <entry>lightweight</entry>
- </row>
- <row>
- <entry><emphasis>MinTime</emphasis></entry>
- <entry>min. time...</entry>
- </row>
- <row>
- <entry><emphasis>recoverDeltaErrors</emphasis></entry>
- <entry>True or False</entry>
- </row>
- <row>
- <entry><emphasis>StartTime</emphasis></entry>
- <entry>start time</entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable></para>
- </sect4>
- <?hard-pagebreak ?>
- <sect4>
- <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>
- <para><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>authMethod</emphasis></entry>
- <entry>Authentication Method. Kerberos</entry>
- </row>
- <row>
- <entry><emphasis>checkScopeScans</emphasis></entry>
- <entry>True or False</entry>
- </row>
- <row>
- <entry><emphasis>filesDefaultPassword</emphasis></entry>
- <entry>Default Password</entry>
- </row>
- <row>
- <entry><emphasis>filesDefaultUser</emphasis></entry>
- <entry>Default User</entry>
- </row>
- <row>
- <entry><emphasis>ldapProtocol</emphasis></entry>
- <entry>Default Protocol use</entry>
- </row>
- <row>
- <entry><emphasis>ldapServer</emphasis></entry>
- <entry>LDAP Server</entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable></para>
- </sect4>
- <sect4>
- <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>
- </sect4>
- </sect3>
- <sect3 id="Dafilesrv-Process">
- <title>Dafilesrv Process</title>
- <sect4>
- <title>Dafilesrv Instances</title>
- <para>Dafilesrv is a helper process that every node needs.</para>
- <itemizedlist mark="square">
- <listitem>
- <para>Select Dafilesrv in the Navigator panel on the left
- side.</para>
- </listitem>
- <listitem>
- <para>Select the Instances tab.</para>
- </listitem>
- <listitem>
- <para>RT-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>
- </itemizedlist>
- </sect4>
- <?hard-pagebreak ?>
- <sect4>
- <title>Dafilesrv attributes</title>
- <para>This section describes the Dafilesrv attributes.</para>
- <para><graphic fileref="images/CM-img12-1.jpg"
- vendor="configmgrSS" /></para>
- <para><informaltable colsep="0" frame="none" rowsep="0">
- <tgroup cols="2">
- <colspec align="left" colwidth="122.40pt" />
- <colspec />
- <tbody>
- <row>
- <entry>Attribute</entry>
- <entry>Definition</entry>
- </row>
- <row>
- <entry><emphasis>description</emphasis></entry>
- <entry>DaFileSrv Process description</entry>
- </row>
- <row>
- <entry><emphasis>name</emphasis></entry>
- <entry>Name of the process instance (AlphaNumeric and
- underscore only)</entry>
- </row>
- <row>
- <entry><emphasis>version</emphasis></entry>
- <entry>current version number</entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable></para>
- </sect4>
- </sect3>
- <sect3 id="DFU-Server">
- <title><emphasis>DFU Server</emphasis></title>
- <sect4>
- <title>DfuServer Instances</title>
- <itemizedlist mark="square">
- <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>
- </itemizedlist>
- </sect4>
- <sect4>
- <title>DfuServer Attributes Tab</title>
- <para>This section describes the DfuServer attributes.</para>
- <para><graphic fileref="images/CM-img05-1.jpg"
- vendor="configmgrSS" /></para>
- <para><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>daliServers</emphasis></entry>
- <entry>The Dali servers to use</entry>
- </row>
- <row>
- <entry><emphasis>description</emphasis></entry>
- <entry>Describes the component</entry>
- </row>
- <row>
- <entry><emphasis>dfuLogDir</emphasis></entry>
- <entry>The log directory</entry>
- </row>
- <row>
- <entry><emphasis>monitorinterval</emphasis></entry>
- <entry>Specifies the polling interval for DFU monitoring
- (in seconds). Default is 900 (15 minutes)</entry>
- </row>
- <row>
- <entry><emphasis>monitorque</emphasis></entry>
- <entry>the queue to monitor</entry>
- </row>
- <row>
- <entry><emphasis>name</emphasis></entry>
- <entry>Name of the process instance (AlphaNumeric and
- underscore only)</entry>
- </row>
- <row>
- <entry><emphasis>queue</emphasis></entry>
- <entry>the name of the dfu server queue</entry>
- </row>
- <row>
- <entry><emphasis>transferBufferSize</emphasis></entry>
- <entry>The value at which...</entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable></para>
- </sect4>
- <sect4>
- <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>
- <para><informaltable colsep="0" frame="none" rowsep="0">
- <?dbfo keep-together="always"?>
- <tgroup cols="2">
- <colspec align="left" colwidth="122.40pt" />
- <colspec />
- <tbody>
- <row>
- <entry>Attribute name</entry>
- <entry>Definition</entry>
- </row>
- <row>
- <entry><emphasis>SSHidentityfile</emphasis></entry>
- <entry>The SSH file used for authentication</entry>
- </row>
- <row>
- <entry><emphasis>SSHpassword</emphasis></entry>
- <entry>the SSH Password</entry>
- </row>
- <row>
- <entry><emphasis>SSHretries</emphasis></entry>
- <entry>no. of retries to authenticate</entry>
- </row>
- <row>
- <entry><emphasis>SHtimeout</emphasis></entry>
- <entry>the timeout interval</entry>
- </row>
- <row>
- <entry><emphasis>SSHusername</emphasis></entry>
- <entry>SSH username default is
- <emphasis>hpcc</emphasis></entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable></para>
- </sect4>
- <sect4>
- <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>
- </sect4>
- </sect3>
- <sect3>
- <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></para>
- <informaltable colsep="0" frame="none" rowsep="0">
- <tgroup cols="3">
- <colspec align="left" colwidth="122.40pt" />
- <colspec />
- <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>
- <entry>Base Location for data files</entry>
- </row>
- <row>
- <entry><emphasis role="bold">data2</emphasis></entry>
- <entry></entry>
- <entry></entry>
- </row>
- <row>
- <entry><emphasis role="bold">data3</emphasis></entry>
- <entry></entry>
- <entry></entry>
- </row>
- <row>
- <entry><emphasis role="bold">mirror</emphasis></entry>
- <entry></entry>
- <entry>Base Location for mirror data files</entry>
- </row>
- <row>
- <entry><emphasis role="bold">query</emphasis></entry>
- <entry></entry>
- <entry>Base Location for Queries</entry>
- </row>
- <row>
- <entry><emphasis role="bold"></emphasis></entry>
- <entry></entry>
- <entry></entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable>
- </sect3>
- <sect3 id="Drop-Zone">
- <title><emphasis>Drop Zone</emphasis></title>
- <sect4>
- <title>DropZone Attributes</title>
- <itemizedlist mark="square">
- <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>
- </itemizedlist>
- </sect4>
- <sect4>
- <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>
- </sect4>
- </sect3>
- <sect3 id="ECL-Agent" role="brk">
- <title><emphasis>ECL Agent</emphasis></title>
- <sect4>
- <title>instances</title>
- <itemizedlist mark="square">
- <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>
- </itemizedlist>
- </sect4>
- <sect4>
- <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>
- <para><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>description</emphasis></entry>
- <entry>Describes the component</entry>
- </row>
- <row>
- <entry><emphasis>name</emphasis></entry>
- <entry>Name of the process instance (AlphaNumeric and
- underscore only)</entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable></para>
- </sect4>
- <sect4>
- <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>
- <para><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>allowedPipePrograms</emphasis></entry>
- <entry>describes allowed Pipe Programs</entry>
- </row>
- <row>
- <entry><emphasis>daliServers</emphasis></entry>
- <entry>the Dali Servers</entry>
- </row>
- <row>
- <entry><emphasis>pluginDirectory</emphasis></entry>
- <entry>the plugin directory</entry>
- </row>
- <row>
- <entry><emphasis>thorConnectTimeout</emphasis></entry>
- <entry>the Thor timeout value</entry>
- </row>
- <row>
- <entry><emphasis>traceLevel</emphasis></entry>
- <entry>the trace level</entry>
- </row>
- <row>
- <entry><emphasis>wuQueueName</emphasis></entry>
- <entry>the name of the workunit queue</entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable></para>
- </sect4>
- <sect4>
- <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>
- </sect4>
- </sect3>
- <sect3 role="brk">
- <title>ECL CC Server Process</title>
- <sect4>
- <title>Ecl CC Server Instances</title>
- <para><itemizedlist mark="square">
- <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>
- </itemizedlist></para>
- </sect4>
- <sect4>
- <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>
- <para><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>daliServers</emphasis></entry>
- <entry>The Dali servers to use</entry>
- </row>
- <row>
- <entry><emphasis>description</emphasis></entry>
- <entry>Describes the component</entry>
- </row>
- <row>
- <entry><emphasis>maxEclccProcesses</emphasis></entry>
- <entry>The maximum number of eclcc processes that will
- be launched in parallel</entry>
- </row>
- <row>
- <entry><emphasis>name</emphasis></entry>
- <entry>Name of the process instance (AlphaNumeric and
- underscore only)</entry>
- </row>
- <row>
- <entry><emphasis>queue</emphasis></entry>
- <entry>Name of the Ecl cc server queue</entry>
- </row>
- <row>
- <entry><emphasis>traceLevel</emphasis></entry>
- <entry>The value ***</entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable></para>
- </sect4>
- <sect4>
- <title>EclCC Server Process Options</title>
- <para>To add a custom option, rt-click and select add.</para>
- <!--This feature allows the user to configure any options pertinent to the Ecl CC Server Process -->
- <para></para>
- </sect4>
- <sect4>
- <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>
- </sect4>
- </sect3>
- <sect3 id="ECL-Scheduler" role="brk">
- <title><emphasis>ECL Scheduler</emphasis></title>
- <sect4>
- <title>instances</title>
- <itemizedlist mark="square">
- <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>
- </itemizedlist>
- </sect4>
- <sect4 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>
- <para><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>description</emphasis></entry>
- <entry>Describes the component</entry>
- </row>
- <row>
- <entry><emphasis>name</emphasis></entry>
- <entry>Name of the process instance (AlphaNumeric and
- underscore only)</entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable></para>
- </sect4>
- <sect4>
- <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>
- </sect4>
- </sect3>
- <sect3 id="ESP-Server" role="brk">
- <title><emphasis>ESP Server</emphasis></title>
- <sect4>
- <title>Esp Process Instances</title>
- <itemizedlist mark="square">
- <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>
- </itemizedlist>
- </sect4>
- <?hard-pagebreak ?>
- <sect4>
- <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>
- <para><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>componentfilesDir</emphasis></entry>
- <entry>the component files directory</entry>
- </row>
- <row>
- <entry><emphasis>daliServers</emphasis></entry>
- <entry>the Dali servers</entry>
- </row>
- <row>
- <entry><emphasis>description</emphasis></entry>
- <entry>Describes the component</entry>
- </row>
- <row>
- <entry><emphasis>enableSEHMapping</emphasis></entry>
- <entry>True or False to enable***</entry>
- </row>
- <row>
- <entry><emphasis>formOptionsAccess</emphasis></entry>
- <entry>True or False to enable...***</entry>
- </row>
- <row>
- <entry><emphasis>httpConfigAccess</emphasis></entry>
- <entry>True or False to enable...***</entry>
- </row>
- <row>
- <entry><emphasis>logLevel</emphasis></entry>
- <entry>The Level of ...***</entry>
- </row>
- <row>
- <entry><emphasis>logRequests</emphasis></entry>
- <entry>True or False to enable...***</entry>
- </row>
- <row>
- <entry><emphasis>logResponses</emphasis></entry>
- <entry>True or False to enable...***</entry>
- </row>
- <row>
- <entry><emphasis>maxBacklogQueueSize</emphasis></entry>
- <entry>The size of the backlog queue</entry>
- </row>
- <row>
- <entry><emphasis>maxConcurrentThreads</emphasis></entry>
- <entry>The maximum number of concurrent threads</entry>
- </row>
- <row>
- <entry><emphasis>maxRequestEntityLegnth</emphasis></entry>
- <entry>The maximum length for entity requests</entry>
- </row>
- <row>
- <entry><emphasis>name</emphasis></entry>
- <entry>Name of the process instance (AlphaNumeric and
- underscore only)</entry>
- </row>
- <row>
- <entry><emphasis>perfReportDelay</emphasis></entry>
- <entry>The value at which...***</entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable></para>
- </sect4>
- <sect4 role="brk">
- <title>Esp - myesp Service BindingsTab</title>
- <para>This section describes the Esp - myesp Service Bindings
- tab.</para>
- <para><graphic fileref="images/CM-img08-2.jpg"
- vendor="configmgrSS" /></para>
- <para><informaltable colsep="0" frame="none" rowsep="0">
- <tgroup cols="2">
- <colspec align="left" colwidth="122.40pt" />
- <colspec />
- <tbody>
- <row>
- <entry><emphasis role="bold">Attribute
- name</emphasis></entry>
- <entry><emphasis
- role="bold">Definition</emphasis></entry>
- </row>
- <row>
- <entry><emphasis>ECLWatch</emphasis></entry>
- <entry>provides ECL Watch interface</entry>
- </row>
- <row>
- <entry><emphasis>Ws_ecl</emphasis></entry>
- <entry>Provides Web access to published queries</entry>
- </row>
- <row>
- <entry><emphasis>myecldirect</emphasis></entry>
- <entry>Provides Ecl direct access</entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable></para>
- </sect4>
- <?hard-pagebreak ?>
- <sect4>
- <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>
- <para><informaltable colsep="0" frame="none" rowsep="0">
- <tgroup cols="2">
- <colspec align="left" colwidth="165pt" />
- <colspec />
- <tbody>
- <row>
- <entry>Attribute name</entry>
- <entry>Definition</entry>
- </row>
- <row>
- <entry><emphasis>ldapAuthMethod</emphasis></entry>
- <entry>the LDAP Authentication Method</entry>
- </row>
- <row>
- <entry><emphasis>ldapConnections</emphasis></entry>
- <entry>the number of LDAP Connections</entry>
- </row>
- <row>
- <entry><emphasis>ldapServer</emphasis></entry>
- <entry>the LDAP server</entry>
- </row>
- <row>
- <entry><emphasis>method</emphasis></entry>
- <entry>the method...</entry>
- </row>
- <row>
- <entry><emphasis>passwordExpirationWarningDays</emphasis></entry>
- <entry>the number of days advance warning of password
- expiration</entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable></para>
- </sect4>
- <?hard-pagebreak ?>
- <sect4>
- <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><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>acceptSelfSigned</emphasis></entry>
- <entry>True or False to enable self signed
- certificate...</entry>
- </row>
- <row>
- <entry><emphasis>CA_Certificates_Path</emphasis></entry>
- <entry>the location of the CA Certificates</entry>
- </row>
- <row>
- <entry><emphasis>certificateFileName</emphasis></entry>
- <entry>name of the CA Certificate</entry>
- </row>
- <row>
- <entry><emphasis>Name of the city</emphasis></entry>
- <entry>name of the city.</entry>
- </row>
- <row>
- <entry><emphasis>Name of the country</emphasis></entry>
- <entry>name of the country.</entry>
- </row>
- <row>
- <entry><emphasis>Number of days the certificate is
- valid.</emphasis></entry>
- <entry>The Number of days the certificate is
- valid.</entry>
- </row>
- <row>
- <entry><emphasis>enableVerification</emphasis></entry>
- <entry>True or False to enable verification
- of...</entry>
- </row>
- <row>
- <entry><emphasis>organization</emphasis></entry>
- <entry>name of the organization...</entry>
- </row>
- <row>
- <entry><emphasis>organizationalUnit</emphasis></entry>
- <entry>OU to use</entry>
- </row>
- <row>
- <entry><emphasis>passphrase</emphasis></entry>
- <entry>passphrase to use</entry>
- </row>
- <row>
- <entry><emphasis>privateKeyFileName</emphasis></entry>
- <entry>The privatekey name file (such as,
- privatekey.cer)</entry>
- </row>
- <row>
- <entry><emphasis>regenerateCredentials</emphasis></entry>
- <entry>True or False to enable generation of
- credentials.</entry>
- </row>
- <row>
- <entry><emphasis>requireAddressMatch</emphasis></entry>
- <entry>True or False to enable address match</entry>
- </row>
- <row>
- <entry><emphasis>Name of the State</emphasis></entry>
- <entry>name of the state</entry>
- </row>
- <row>
- <entry><emphasis>TrustedPeers</emphasis></entry>
- <entry>The names of trusted peers.</entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable></para>
- </sect4>
- <sect4>
- <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>
- </sect4>
- </sect3>
- <sect3 id="FTSlave-Process" role="brk">
- <title><emphasis>FTSlave Process</emphasis></title>
- <para>FTSlave is a helper process that every node needs.</para>
- <sect4>
- <title>Instances</title>
- <itemizedlist mark="square">
- <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>RT-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>
- </itemizedlist>
- </sect4>
- <sect4>
- <title>FtSlave attributes</title>
- <para>This section describes the FTSlave attributes tab.</para>
- <para><informaltable colsep="0" frame="none" rowsep="0">
- <tgroup cols="2">
- <colspec align="left" colwidth="122.40pt" />
- <colspec />
- <tbody>
- <row>
- <entry>Attribute</entry>
- <entry>Definition</entry>
- </row>
- <row>
- <entry><emphasis>description</emphasis></entry>
- <entry>FTSlave Process description</entry>
- </row>
- <row>
- <entry><emphasis>name</emphasis></entry>
- <entry>Name of the process instance (AlphaNumeric and
- underscore only)</entry>
- </row>
- <row>
- <entry><emphasis>version</emphasis></entry>
- <entry>current version number</entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable></para>
- </sect4>
- <sect4>
- <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>
- </sect4>
- </sect3>
- <sect3>
- <title><emphasis>Sasha Server</emphasis></title>
- <sect4>
- <title>Instances</title>
- <itemizedlist mark="square">
- <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>
- </itemizedlist>
- <graphic fileref="images/CM-img17.jpg" vendor="configmgrSS" />
- </sect4>
- <?hard-pagebreak ?>
- <sect4>
- <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>
- <para><informaltable colsep="0" frame="none" rowsep="0">
- <tgroup cols="2">
- <colspec align="left" colwidth="122.40pt" />
- <colspec />
- <tbody>
- <row>
- <entry>Attribute</entry>
- <entry>Definition</entry>
- </row>
- <row>
- <entry><emphasis>cachedWUat</emphasis></entry>
- <entry>SashaServer Archiver Process description</entry>
- </row>
- <row>
- <entry><emphasis>cachedWUinterval</emphasis></entry>
- <entry>SashaServer Archiver Process description</entry>
- </row>
- <row>
- <entry><emphasis>cachedWUlimit</emphasis></entry>
- <entry>SashaServer Archiver Process description</entry>
- </row>
- <row>
- <entry><emphasis>DFUrecoveryAt</emphasis></entry>
- <entry>SashaServer Archiver Process description</entry>
- </row>
- <row>
- <entry><emphasis>DFUrecoveryCutoff</emphasis></entry>
- <entry>SashaServer Archiver Process description</entry>
- </row>
- <row>
- <entry><emphasis>DFUrecoveryInterval</emphasis></entry>
- <entry>SashaServer Archiver Process description</entry>
- </row>
- <row>
- <entry><emphasis>DFUrecoveryLimit</emphasis></entry>
- <entry>SashaServer Archiver Process description</entry>
- </row>
- <row>
- <entry><emphasis>DFUWUat</emphasis></entry>
- <entry>SashaServer Archiver Process description</entry>
- </row>
- <row>
- <entry><emphasis>DFUWUcutoff</emphasis></entry>
- <entry>SashaServer Archiver Process description</entry>
- </row>
- <row>
- <entry><emphasis>DFUWUduration</emphasis></entry>
- <entry>SashaServer Archiver Process description</entry>
- </row>
- <row>
- <entry><emphasis>DFUWUinterval</emphasis></entry>
- <entry>SashaServer Archiver Process description</entry>
- </row>
- <row>
- <entry><emphasis>DFUWUlimit</emphasis></entry>
- <entry>SashaServer Archiver Process description</entry>
- </row>
- <row>
- <entry><emphasis>DFUWUthrottle</emphasis></entry>
- <entry>SashaServer Archiver Process description</entry>
- </row>
- <row>
- <entry><emphasis>keepResultFiles</emphasis></entry>
- <entry>Keep result files, True or False</entry>
- </row>
- <row>
- <entry><emphasis>WUat</emphasis></entry>
- <entry>SashaServer Archiver Process description</entry>
- </row>
- <row>
- <entry><emphasis>WUbackup</emphasis></entry>
- <entry>SashaServer Archiver Process description</entry>
- </row>
- <row>
- <entry><emphasis>WUcutof</emphasis></entry>
- <entry>SashaServer Archiver Process description</entry>
- </row>
- <row>
- <entry><emphasis>WUduration</emphasis></entry>
- <entry>SashaServer Archiver Process description</entry>
- </row>
- <row>
- <entry><emphasis>WUinterval</emphasis></entry>
- <entry>SashaServer Archiver Process description</entry>
- </row>
- <row>
- <entry><emphasis>WUlimit</emphasis></entry>
- <entry>SashaServer Archiver Process description</entry>
- </row>
- <row>
- <entry><emphasis>WUretryinterval</emphasis></entry>
- <entry>SashaServer Archiver Process description</entry>
- </row>
- <row>
- <entry><emphasis>WUthrottle</emphasis></entry>
- <entry>SashaServer Archiver Process description</entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable></para>
- </sect4>
- <sect4>
- <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>
- <para><informaltable colsep="0" frame="none" rowsep="0">
- <tgroup cols="2">
- <colspec align="left" colwidth="122.40pt" />
- <colspec />
- <tbody>
- <row>
- <entry>Attribute</entry>
- <entry>Definition</entry>
- </row>
- <row>
- <entry><emphasis>coalesceAt</emphasis></entry>
- <entry>SashaServer Coalesce Process description</entry>
- </row>
- <row>
- <entry><emphasis>coalesceInterval</emphasis></entry>
- <entry>SashaServer Coalesce Process description</entry>
- </row>
- <row>
- <entry><emphasis>minDeltaSize</emphasis></entry>
- <entry>SashaServer Coalesce Process description</entry>
- </row>
- <row>
- <entry><emphasis>recoverDeltaErrors</emphasis></entry>
- <entry>SashaServer Coalesce Process description</entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable></para>
- </sect4>
- <?hard-pagebreak ?>
- <sect4>
- <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>
- <para><informaltable colsep="0" frame="none" rowsep="0">
- <tgroup cols="2">
- <colspec align="left" colwidth="122.40pt" />
- <colspec />
- <tbody>
- <row>
- <entry>Attribute</entry>
- <entry>Definition</entry>
- </row>
- <row>
- <entry><emphasis>memoryLimit</emphasis></entry>
- <entry>set value for Memory Limit</entry>
- </row>
- <row>
- <entry><emphasis>xrefAt</emphasis></entry>
- <entry>SashaServer DfuXRef Attribute
- description...</entry>
- </row>
- <row>
- <entry><emphasis>xrefCutoff</emphasis></entry>
- <entry>SashaServer DfuXRef Attribute
- description...</entry>
- </row>
- <row>
- <entry><emphasis>xrefEclWatchProvider</emphasis></entry>
- <entry>Xref Ecl Watch Provider, True or False</entry>
- </row>
- <row>
- <entry><emphasis>xrefInterval</emphasis></entry>
- <entry>value of SashaServer DfuXRef Attribute</entry>
- </row>
- <row>
- <entry><emphasis>xrefList</emphasis></entry>
- <entry>SashaServer DfuXRef Attribute
- description...</entry>
- </row>
- <row>
- <entry><emphasis>xrefMaxScanThreads</emphasis></entry>
- <entry>SashaServer DfuXRef Attribute
- description...</entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable></para>
- </sect4>
- <?hard-pagebreak ?>
- <sect4>
- <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><informaltable colsep="0" frame="none" rowsep="0">
- <tgroup cols="2">
- <colspec align="left" colwidth="122.40pt" />
- <colspec />
- <tbody>
- <row>
- <entry>Attribute</entry>
- <entry>Definition</entry>
- </row>
- <row>
- <entry><emphasis>ExpiryAt</emphasis></entry>
- <entry>SashaServer DfuExpiry tab description</entry>
- </row>
- <row>
- <entry><emphasis>ExpiryInterval</emphasis></entry>
- <entry>Interval in hours at which the Dfu
- expires</entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable></para>
- </sect4>
- <?hard-pagebreak ?>
- <sect4>
- <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>
- <para><informaltable colsep="0" frame="none" rowsep="0">
- <tgroup cols="2">
- <colspec align="left" colwidth="155.50pt" />
- <colspec />
- <tbody>
- <row>
- <entry>Attribute</entry>
- <entry>Definition</entry>
- </row>
- <row>
- <entry><emphasis>ThorQMonInterval</emphasis></entry>
- <entry>ThorQMonInterval description</entry>
- </row>
- <row>
- <entry><emphasis>ThorQMonQueues</emphasis></entry>
- <entry>ThorQMonQueues description</entry>
- </row>
- <row>
- <entry><emphasis>ThorQMonSwitchMinTime</emphasis></entry>
- <entry>ThorQMonSwitchMinTime description</entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable></para>
- </sect4>
- <?hard-pagebreak ?>
- <sect4>
- <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>
- <para><informaltable colsep="0" frame="none" rowsep="0">
- <tgroup cols="2">
- <colspec align="left" colwidth="122.40pt" />
- <colspec />
- <tbody>
- <row>
- <entry>Attribute</entry>
- <entry>Definition</entry>
- </row>
- <row>
- <entry><emphasis>dafsmonAt</emphasis></entry>
- <entry>dafsmon description</entry>
- </row>
- <row>
- <entry><emphasis>dafsmonInterval</emphasis></entry>
- <entry>dafsmon description</entry>
- </row>
- <row>
- <entry><emphasis>dafsmonList</emphasis></entry>
- <entry>dafsmon description</entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable></para>
- </sect4>
- <sect4>
- <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>
- </sect4>
- </sect3>
- <sect3 id="Thor">
- <title><emphasis>Thor</emphasis></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>
- <itemizedlist mark="square">
- <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 RT-CLICK the Master
- and select Delete.</para>
- </listitem>
- </itemizedlist>
- <para>This deletes the sample one-node Thor.</para>
- <para>You will replace this with a multi-node cluster.</para>
- <itemizedlist mark="square">
- <listitem>
- <?dbfo keep-together="always"?>
- <para>RT-CLICK on the Topology and select Add Master.</para>
- <para><graphic fileref="images/CM-img13.jpg"
- vendor="configmgrSS" /></para>
- </listitem>
- </itemizedlist>
- <itemizedlist mark="square">
- <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>
- </itemizedlist>
- <itemizedlist mark="square">
- <listitem>
- <?dbfo keep-together="always"?>
- <para>RT-CLICK on the Master and select Add Slaves.</para>
- <para><graphic fileref="images/CM-111.jpg"
- vendor="configmgrSS" /></para>
- </listitem>
- </itemizedlist>
- <itemizedlist mark="square">
- <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>
- </itemizedlist>
- <itemizedlist>
- <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>
- </itemizedlist>
- <?hard-pagebreak ?>
- <sect4>
- <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>
- <itemizedlist>
- <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>RT-CLICK on the Master node</para>
- </listitem>
- <listitem>
- <?dbfo keep-together="always"?>
- <para>Select the <emphasis role="bold">Swap 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>
- </itemizedlist>
- </sect4>
- <?hard-pagebreak ?>
- <sect4>
- <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><informaltable colsep="0" frame="none" rowsep="0">
- <tgroup cols="2">
- <colspec align="left" colwidth="155.50pt" />
- <colspec />
- <tbody>
- <row>
- <entry>Attribute</entry>
- <entry>Definition</entry>
- </row>
- <row>
- <entry><emphasis>allowedPipePrograms</emphasis></entry>
- <entry>ThorCluster Process description</entry>
- </row>
- <row>
- <entry><emphasis>autoCopyBackup</emphasis></entry>
- <entry>True or False</entry>
- </row>
- <row>
- <entry><emphasis>checkPointRecovery</emphasis></entry>
- <entry>True or False</entry>
- </row>
- <row>
- <entry><emphasis>daliServers</emphasis></entry>
- <entry>The Dali Server</entry>
- </row>
- <row>
- <entry><emphasis>defaultOutputNodeGroup</emphasis></entry>
- <entry></entry>
- </row>
- <row>
- <entry><emphasis>description</emphasis></entry>
- <entry>ThorCluster Process description</entry>
- </row>
- <row>
- <entry><emphasis>externalProgDir</emphasis></entry>
- <entry>Location of externals</entry>
- </row>
- <row>
- <entry><emphasis>globalMemorySize</emphasis></entry>
- <entry>ThorCluster Process description</entry>
- </row>
- <row>
- <entry><emphasis>idleRestartPeriod</emphasis></entry>
- <entry>ThorCluster Process description</entry>
- </row>
- <row>
- <entry><emphasis>largeMemSize</emphasis></entry>
- <entry>ThorCluster Process description</entry>
- </row>
- <row>
- <entry><emphasis>LCR</emphasis></entry>
- <entry>True or False</entry>
- </row>
- <row>
- <entry><emphasis>localThor</emphasis></entry>
- <entry>True or False</entry>
- </row>
- <row>
- <entry><emphasis>localThorPortBase</emphasis></entry>
- <entry></entry>
- </row>
- <row>
- <entry><emphasis>localThorPortInc</emphasis></entry>
- <entry></entry>
- </row>
- <row>
- <entry><emphasis>masterport</emphasis></entry>
- <entry></entry>
- </row>
- <row>
- <entry><emphasis>monitorDaliFileServer</emphasis></entry>
- <entry>Specifies whether to monitor for DaFileSrv
- process (True or False )</entry>
- </row>
- <row>
- <entry><emphasis>multiSlaves</emphasis></entry>
- <entry>True or False</entry>
- </row>
- <row>
- <entry><emphasis>multiThorExclusionLockName</emphasis></entry>
- <entry></entry>
- </row>
- <row>
- <entry><emphasis>multiThorMemoryThreshold</emphasis></entry>
- <entry></entry>
- </row>
- <row>
- <entry><emphasis>multiThorPriorityLock</emphasis></entry>
- <entry>True or False</entry>
- </row>
- <row>
- <entry><emphasis>name</emphasis></entry>
- <entry>Name of cluster</entry>
- </row>
- <row>
- <entry><emphasis>nodeGroup</emphasis></entry>
- <entry></entry>
- </row>
- <row>
- <entry><emphasis>pluginsPath</emphasis></entry>
- <entry>Location of plugins</entry>
- </row>
- <row>
- <entry><emphasis>queueName</emphasis></entry>
- <entry></entry>
- </row>
- <row>
- <entry><emphasis>replicateAsync</emphasis></entry>
- <entry>True or False</entry>
- </row>
- <row>
- <entry><emphasis>replicateOutputs</emphasis></entry>
- <entry>True or False</entry>
- </row>
- <row>
- <entry><emphasis>slaveDownTimeout</emphasis></entry>
- <entry></entry>
- </row>
- <row>
- <entry><emphasis>slaveport</emphasis></entry>
- <entry></entry>
- </row>
- <row>
- <entry><emphasis>smallSortThreshold</emphasis></entry>
- <entry></entry>
- </row>
- <row>
- <entry><emphasis>verifyDaliConnectionInterval</emphasis></entry>
- <entry></entry>
- </row>
- <row>
- <entry><emphasis>watchdogEnabled</emphasis></entry>
- <entry>True or False</entry>
- </row>
- <row>
- <entry><emphasis>watchdogProgressEnabled</emphasis></entry>
- <entry>True or False</entry>
- </row>
- <row>
- <entry><emphasis>watchdogProgressInterval</emphasis></entry>
- <entry>ThorCluster Process description</entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable></para>
- </sect4>
- <?hard-pagebreak ?>
- <sect4>
- <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>
- <para><informaltable colsep="0" frame="none" rowsep="0">
- <tgroup cols="2">
- <colspec align="left" colwidth="122.40pt" />
- <colspec />
- <tbody>
- <row>
- <entry>Attribute</entry>
- <entry>Definition</entry>
- </row>
- <row>
- <entry><emphasis>SSHidentityfile</emphasis></entry>
- <entry>Location of the SSH keys component files.</entry>
- </row>
- <row>
- <entry><emphasis>SSHpassword</emphasis></entry>
- <entry></entry>
- </row>
- <row>
- <entry><emphasis>SSHretries</emphasis></entry>
- <entry>The number of times...</entry>
- </row>
- <row>
- <entry><emphasis>SSHtimeout</emphasis></entry>
- <entry>Timeout</entry>
- </row>
- <row>
- <entry><emphasis>SSHusername</emphasis></entry>
- <entry>The user name of the account the SSH keys are
- associated with</entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable></para>
- </sect4>
- <sect4>
- <title>ThorCluster Debug</title>
- <para>The debug tab is for internal use only</para>
- </sect4>
- <?hard-pagebreak ?>
- <sect4>
- <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>
- <para><informaltable colsep="0" frame="none" rowsep="0">
- <tgroup cols="2">
- <colspec align="left" colwidth="155.50pt" />
- <colspec />
- <tbody>
- <row>
- <entry>Attribute</entry>
- <entry>Definition</entry>
- </row>
- <row>
- <entry><emphasis>AutoSwapNode</emphasis></entry>
- <entry>True or False. Set to True to enable
- AutoSwapNode</entry>
- </row>
- <row>
- <entry><emphasis>CheckAfterEveryJob</emphasis></entry>
- <entry>True or False. Set to True to Check after Every
- Job</entry>
- </row>
- <row>
- <entry><emphasis>SwapNodeCheckC</emphasis></entry>
- <entry>True or False. Set to True to ...</entry>
- </row>
- <row>
- <entry><emphasis>SwapNodeCheckD</emphasis></entry>
- <entry>True or False. Set to True to...</entry>
- </row>
- <row>
- <entry><emphasis>SwapNodeCheckScript</emphasis></entry>
- <entry></entry>
- </row>
- <row>
- <entry><emphasis>SwapNodeCheckScriptTimeout</emphasis></entry>
- <entry>The number ...</entry>
- </row>
- <row>
- <entry><emphasis>SwapNodeInterval</emphasis></entry>
- <entry>The number ...</entry>
- </row>
- <row>
- <entry><emphasis>SwapNodeMaxConcurrent</emphasis></entry>
- <entry>value of Maximum number of concurrent...</entry>
- </row>
- <row>
- <entry><emphasis>SwapNodeRestartJob</emphasis></entry>
- <entry>True or False. Set to True...</entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable></para>
- </sect4>
- <?hard-pagebreak ?>
- <sect4>
- <title>ThorCluster Backup</title>
- <para>This section describes the ThorCluster Backup tab.</para>
- <para><graphic fileref="images/CM-img18-5.jpg"
- vendor="configmgrSS" /></para>
- <para><informaltable colsep="0" frame="none" rowsep="0">
- <tgroup cols="2">
- <colspec align="left" colwidth="122.40pt" />
- <colspec />
- <tbody>
- <row>
- <entry>Attribute</entry>
- <entry>Definition</entry>
- </row>
- <row>
- <entry><emphasis>breakoutLimit</emphasis></entry>
- <entry>value of...</entry>
- </row>
- <row>
- <entry><emphasis>refreshRate</emphasis></entry>
- <entry>value of...</entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable></para>
- </sect4>
- <sect4>
- <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>
- </sect4>
- <sect4>
- <title>Swap Master</title>
- <para>The swap master option now allows you to easily swap out the
- Thor Master.***</para>
- <para><graphic fileref="images/CM-186.jpg"
- vendor="configmgrSS" /></para>
- </sect4>
- </sect3>
- <sect3 id="Roxie" role="brk">
- <title><emphasis>Roxie</emphasis></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).***Change the value of the localslave to <emphasis
- role="bold">false***</emphasis></para>
- <itemizedlist mark="square">
- <listitem>
- <para>Select Roxie Cluster in the Navigator panel on the left
- side.</para>
- </listitem>
- <listitem>
- <para>Select the Servers tab.</para>
- </listitem>
- <listitem>
- <para>Expand the RoxieCluster >> farm1, if needed, then
- RT-CLICK the Server and select
- <guimenuitem>Delete</guimenuitem>.</para>
- <para><graphic fileref="images/CM-112.jpg"
- vendor="configmgrSS" /></para>
- </listitem>
- </itemizedlist>
- <para>This deletes the sample one-node Roxie Server.</para>
- <para>You will replace this with several servers to act as Roxie
- Servers.</para>
- <itemizedlist mark="square">
- <listitem>
- <?dbfo keep-together="always"?>
- <para>RT-CLICK on the Roxie Cluster and select Add Farm.</para>
- <para><graphic fileref="images/CM-112-1.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. Use Ctrl+click to multi-select or
- shift+click to select a range.</para>
- <para><graphic fileref="images/CM-112-2.jpg"
- vendor="configmgrSS" /></para>
- </listitem>
- </itemizedlist>
- <itemizedlist mark="square">
- <listitem>
- <para>Select the Agents tab.</para>
- </listitem>
- <listitem>
- <?dbfo keep-together="always"?>
- <para>Select the RoxieCluster, then RT-CLICK select Reconfigure
- Agents.</para>
- <para>This allows you to replace the single agent with the
- multiple nodes you added as Servers.</para>
- <para><graphic fileref="images/CM-img16.jpg"
- vendor="configmgrSS" /></para>
- </listitem>
- </itemizedlist>
- <itemizedlist mark="square">
- <listitem>
- <?dbfo keep-together="always"?>
- <para>Select the computers to use as Agents from the list, then
- press the <emphasis role="bold">OK</emphasis> button. Use
- Ctrl+click to multi-select or shift+click to select a
- range.</para>
- <para><graphic fileref="images/CM-112-2.jpg"
- vendor="configmgrSS" /><emphasis role="bold">Note:</emphasis> In
- this example, we are using the same five nodes that were made to
- be Servers. This is a typical configuration.</para>
- </listitem>
- </itemizedlist>
- <itemizedlist mark="square">
- <listitem>
- <?dbfo keep-together="always"?>
- <para>Select the redundancy scheme to use. Typically, this is
- Circular Redundancy, as shown below.</para>
- <para><graphic fileref="images/GS-img25.png"
- 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>
- </itemizedlist>
- </sect3>
- <sect3 id="Topology" role="brk">
- <title>Topology</title>
- <para>This section describes the topology tab.</para>
- <para></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>
- <sect3 id="Propogate-configuration-changes">
- <title><emphasis>Distribute Configuration Changes to all Nodes
- </emphasis></title>
- <para>Once your environment is set up as desired, you must copy the
- configuration file out to the other nodes.</para>
- <para></para>
- <itemizedlist>
- <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
- move 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></para>
- </listitem>
- <listitem>
- <para>Copy the /etc/HPCCSystems/environment.xml to the
- /etc/HPCCSystems/ on every node.</para>
- <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>
- </itemizedlist>
- </sect3>
- </sect2>
- </sect1>
- </chapter>
- </book>
|