1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476 |
- <?xml version="1.0" encoding="UTF-8"?>
- <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
- "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
- <book xml:base="../">
- <bookinfo>
- <title>HPCC Configuration Manager</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/redswooshWithLogo3.jpg" />
- </imageobject>
- </mediaobject>
- <author>
- <surname>Boca Raton Documentation Team</surname>
- </author>
- <legalnotice>
- <para>We welcome your comments and feedback about this document via
- email to <email>docfeedback@hpccsystems.com</email></para>
- <para>Please include <emphasis role="bold">Documentation
- Feedback</emphasis> in the subject line and reference the document name,
- page numbers, and current Version Number in the text of the
- message.</para>
- <para>LexisNexis and the Knowledge Burst logo are registered trademarks
- of Reed Elsevier Properties Inc., used under license.</para>
- <para>HPCC Systems<superscript>®</superscript> is a registered trademark
- of LexisNexis Risk Data Management Inc.</para>
- <para>Other products, logos, and services may be trademarks or
- registered trademarks of their respective companies.</para>
- <para>All names and example data used in this manual are fictitious. Any
- similarity to actual persons, living or dead, is purely
- coincidental.</para>
- <para></para>
- </legalnotice>
- <xi:include href="common/Version.xml"
- xpointer="xpointer(//*[@id='FooterInfo'])"
- xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="common/Version.xml"
- xpointer="xpointer(//*[@id='DateVer'])"
- xmlns:xi="http://www.w3.org/2001/XInclude" />
- <corpname>HPCC Systems<superscript>®</superscript></corpname>
- <xi:include href="common/Version.xml"
- xpointer="xpointer(//*[@id='Copyright'])"
- xmlns:xi="http://www.w3.org/2001/XInclude" />
- <mediaobject role="logo">
- <imageobject>
- <imagedata fileref="images/LN_Rightjustified.jpg" />
- </imageobject>
- </mediaobject>
- </bookinfo>
- <chapter id="Buildin-HPCC-from-Source">
- <title>Using Configuration Manager</title>
- <para>Configuration Manager is the utility with which we configure the
- HPCC platform. The HPCC platform's configuration is stored in an XML file
- named <emphasis role="bold">environment.xml</emphasis>. When you install a
- package, a default single-node environment.xml is generated. After that,
- you can use the Configuration Manager to modify it and add nodes and
- configure components.</para>
- <para>The Configuration Manager Wizard creates a similar file, but after
- it is generated, you must rename it and put it into place on each
- node.</para>
- <para>Configuration Manager also offers an <emphasis role="bold">Advanced
- View</emphasis> which allows you to add instances of components or change
- the default settings for components. Even if you plane to use Advanced
- View, it is a good idea to start with a wizard generated configuration and
- use Advanced View to finish it.</para>
- <para>This document will guide you through configuring an HPCC environment
- using the Configuration Manager.</para>
- <sect1 id="configuring-a-multi-node-system">
- <title>Running the Configuration Manager</title>
- <para>This document will guide you through configuring an HPCC
- environment using the Configuration Manager.</para>
- <para>The HPCC package should already be installed on ALL nodes.</para>
- <para>You can use any tool or shell script you choose.</para>
- <orderedlist>
- <listitem>
- <para>SSH to a node in your environment and login as a user with
- sudo privileges. We would suggest that it would be the first node,
- and that it is a support node, however that is up to your
- discretion.</para>
- </listitem>
- <listitem>
- <para>Start the Configuration Manager service on the node (again we
- would suggest that it should be on a support node, and further that
- you use the same node to start the Configuration Manager every time,
- but this is also entirely up to you).</para>
- <programlisting>sudo /opt/HPCCSystems/sbin/configmgr</programlisting>
- <para><graphic fileref="images/gs_img_configmgrStart.jpg" /></para>
- </listitem>
- <listitem>
- <para>Using a Web browser, go to the Configuration Manager's
- interface:</para>
- <programlisting>http://<<emphasis>ip of installed system</emphasis>>:8015</programlisting>
- <para>The Configuration Manager startup wizard displays.</para>
- </listitem>
- </orderedlist>
- <para>There are different ways to configure your HPCC system. You can
- use the <emphasis role="bold">Generate environment wizard</emphasis> and
- use that environment or experienced users can then use the <emphasis
- role="bold">Advanced View</emphasis> for more specific customization.
- There is also the option of using <emphasis role="bold">Create blank
- environment</emphasis> to generate an empty environment that you could
- then go in and add only the components you would want.</para>
- <sect2 id="Env_Wizard">
- <title>Environment Wizard</title>
- <orderedlist>
- <listitem>
- <?dbfo keep-together="always"?>
- <para>To use the wizard select the <emphasis role="bold">Generate
- new environment using wizard</emphasis> button.</para>
- <para><graphic fileref="images/GS_ConfigMgrWizStart.jpg"
- vendor="configmgrSS" /></para>
- </listitem>
- <listitem>
- <para>Provide a name for the environment file.</para>
- <para>This will then be the name of the configuration XML file.
- For example, we will name our environment
- <emphasis>NewEnvironment</emphasis> and this will produce a
- configuration XML file named
- <emphasis>NewEnvironment.xml</emphasis> that we will
- use.<emphasis> </emphasis></para>
- </listitem>
- <listitem>
- <para>Press the Next button.</para>
- <para>Next you will need to define the IP addresses that your HPCC
- system will be using.</para>
- </listitem>
- <listitem>
- <?dbfo keep-together="always"?>
- <para>Enter the IP addresses or hostname(s).</para>
- <para>IP Addresses can be specified individually using semi-colon
- delimiters. You can also specify a range of IPs using a hyphen
- (for example, nnn.nnn.nnn.x-y). In the image below, we specified
- the IP addresses 10.239.219.1 through 10.239.219.100 using the
- range syntax, and also a single IP 10.239.219.111. Alternatively,
- you can enter the hostnames.</para>
- <para><graphic fileref="images/GS_ConfigMgrWiz002.jpg"
- vendor="configmgrSS" /></para>
- </listitem>
- <listitem>
- <para>Press the Next button.</para>
- <para>Now you will define how many nodes to use for the Roxie and
- Thor clusters.</para>
- </listitem>
- <listitem>
- <?dbfo keep-together="always"?>
- <para>Enter the appropriate values as indicated.</para>
- <para><graphic fileref="images/GS_CMWiz003.jpg"
- vendor="configmgrSS" /></para>
- <variablelist>
- <varlistentry>
- <term>Number of support nodes:</term>
- <listitem>
- <para>Specify the number of nodes to use for support
- components. The default is 1.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Number of nodes for Roxie cluster:</term>
- <listitem>
- <para>Specify the number of nodes to use for your Roxie
- cluster. Enter zero (0) if you do not want a Roxie
- cluster.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Number of slave nodes for Thor cluster</term>
- <listitem>
- <para>Specify the number of slave nodes to use in your Thor
- cluster. A Thor master node will be added automatically.
- Enter zero (0) if you do not want any Thor slaves.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Number of Thor slaves per node (default 1)</term>
- <listitem>
- <para>Specify the number of Thor slave processes to
- instantiate on each slave node. Enter zero (0) if you do not
- want a Thor cluster.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Enable Roxie on demand</term>
- <listitem>
- <para>Specify whether or not to allow queries to be run
- immediately on Roxie. This must be enabled to run the
- debugger. (Default is true)</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </listitem>
- <listitem>
- <para>Press the <emphasis role="bold">Next</emphasis>
- button</para>
- <para>The wizard displays the configuration parameters.</para>
- </listitem>
- <listitem>
- <?dbfo keep-together="always"?>
- <para>Press the <emphasis role="bold">Finish</emphasis> button to
- accept these values or press the <emphasis role="bold">Advanced
- View</emphasis> button to edit in advanced mode.</para>
- <graphic fileref="images/GS_ConfigMgrWiz004.jpg" />
- </listitem>
- </orderedlist>
- <para>You will now be notified that you have completed the
- wizard.</para>
- <para><graphic fileref="images/GS_ConfigMgrWiz005.jpg" /></para>
- <para>At this point, you have created a file named NewEnvironment.xml
- in the <emphasis role="bold">/etc/HPCCSystems/source</emphasis>
- directory</para>
- <informaltable colsep="1" frame="all" rowsep="1">
- <?dbfo keep-together="always"?>
- <tgroup cols="2">
- <colspec colwidth="49.50pt" />
- <colspec />
- <tbody>
- <row>
- <entry><inlinegraphic fileref="images/OSSgr3.png" /></entry>
- <entry>Keep in mind, that your HPCC configuration may be
- different depending on your needs. For example, you may not
- need a Roxie or you may need several smaller Roxie clusters.
- In addition, in a production [Thor] system, you would ensure
- that Thor and Roxie nodes are dedicated and have no other
- processes running on them. This document is intended to show
- you how to use the configuration tools. Capacity planning and
- system design is covered in a training module.</entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable>
- <sect3 id="Distrib_Conf" role="brk">
- <title>Distribute the Configuration</title>
- <orderedlist>
- <listitem>
- <?dbfo keep-together="always"?>
- <para>Stop the HPCC system.</para>
- <para>If it is running stop the HPCC system (on every node),
- using a command such as this:</para>
- <para><programlisting>sudo /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="xpointer(//*[@id='da.t1'])"
- xmlns:xi="http://www.w3.org/2001/XInclude" />
- </para>
- </sect3>
- <?hard-pagebreak ?>
- <sect3>
- <title>DaliServer store</title>
- <para>This section describes the attributes configuring how Dali
- handles the system data store.</para>
- <para>
- <graphic fileref="images/CM-img04-2.jpg" vendor="configmgrSS" />
- </para>
- <para />
- <!--configMgr-Dali-Server-Include-XXX2-->
- <para>
- <xi:include href="XMLGeneration/xml/dali.xsd.mod.xml"
- xpointer="xpointer(//*[@id='da.t2'])"
- xmlns:xi="http://www.w3.org/2001/XInclude" />
- </para>
- </sect3>
- <?hard-pagebreak ?>
- <sect3>
- <title>DaliServer LDAP options</title>
- <para>This section describes the DaliServer LDAP tab.</para>
- <para>
- <graphic fileref="images/CM-img04-4.jpg" vendor="configmgrSS" />
- </para>
- <!--configMgr-DaliServer-LDAP-Include-XXX3-->
- <para>
- <xi:include href="XMLGeneration/xml/dali.xsd.mod.xml"
- xpointer="xpointer(//*[@id='da.t4'])"
- xmlns:xi="http://www.w3.org/2001/XInclude" />
- </para>
- </sect3>
- <sect3>
- <title>DaliServer Notes</title>
- <para>This tab allows you to add any notes pertinent to the
- component's configuration. This can be useful to keep a record of
- changes and to communicate this information to peers.</para>
- </sect3>
- </sect2>
- <sect2 id="Dafilesrv-Process" role="brk">
- <title>Dafilesrv Process</title>
- <sect3>
- <title>Dafilesrv Instances</title>
- <para>Dafilesrv is a helper process that every node needs.</para>
- <orderedlist>
- <listitem>
- <para>Select Dafilesrv in the Navigator panel on the left
- side.</para>
- </listitem>
- <listitem>
- <para>Select the Instances tab.</para>
- </listitem>
- <listitem>
- <para>right-click on a computer in the computer column, and
- select Add Instance .</para>
- </listitem>
- <listitem>
- <?dbfo keep-together="always"?>
- <para>Select all computers in the list by checking the <emphasis
- role="bold">Select All</emphasis> box, then press the <emphasis
- role="bold">OK</emphasis> button.</para>
- <para>
- <graphic fileref="images/CM-img12.jpg" vendor="configmgrSS" />
- </para>
- </listitem>
- <listitem>
- <para>Click the <inlinegraphic fileref="images/GS-img01c.png" />
- disk icon to save</para>
- </listitem>
- </orderedlist>
- </sect3>
- <?hard-pagebreak ?>
- <sect3>
- <title>Dafilesrv attributes</title>
- <para>This section describes the Dafilesrv attributes.</para>
- <para>
- <graphic fileref="images/CM-img12-1.jpg" vendor="configmgrSS" />
- </para>
- <!--configMgr-DaFileSrv-Include-XXX4-->
- <para>
- <xi:include href="XMLGeneration/xml/dafilesrv.xsd.mod.xml"
- xpointer="xpointer(//*[@id='daFs.t'])"
- xmlns:xi="http://www.w3.org/2001/XInclude" />
- </para>
- </sect3>
- </sect2>
- <sect2 id="DFU-Server" role="brk">
- <title>DFU Server</title>
- <sect3>
- <title>DfuServer Instances</title>
- <orderedlist>
- <listitem>
- <para>Select <emphasis role="bold">DFU Server</emphasis> in the
- Navigator panel on the left side.</para>
- </listitem>
- <listitem>
- <para>Select the Instances tab.</para>
- </listitem>
- <listitem>
- <para>In the computer column, choose a node from the drop list
- as shown below:<graphic fileref="images/CM-img05.jpg"
- vendor="configmgrSS" /></para>
- </listitem>
- <listitem>
- <para>Click the <inlinegraphic fileref="images/GS-img01c.png" />
- disk icon to save</para>
- </listitem>
- </orderedlist>
- </sect3>
- <sect3 role="brk">
- <title>DfuServer Attributes Tab</title>
- <para>This section describes the DfuServer attributes.</para>
- <para>
- <graphic fileref="images/CM-img05-1.jpg" vendor="configmgrSS" />
- </para>
- <!--configMgr-DFUSrvr-Attr-Include-XXX6-->
- <para>
- <xi:include href="XMLGeneration/xml/dfuserver.xsd.mod.xml"
- xpointer="xpointer(//*[@id='DF.t1'])"
- xmlns:xi="http://www.w3.org/2001/XInclude" />
- </para>
- </sect3>
- <sect3 role="brk">
- <title>DfuServer SSH Options</title>
- <para>This section describes the DfuServer SSH Options..</para>
- <para>
- <graphic fileref="images/CM-img05-2.jpg" vendor="configmgrSS" />
- </para>
- <!--configMgr-DFUSrvr-SSH-Include-XXX7-->
- <para>
- <xi:include href="XMLGeneration/xml/dfuserver.xsd.mod.xml"
- xpointer="xpointer(//*[@id='DF.t2'])"
- xmlns:xi="http://www.w3.org/2001/XInclude" />
- </para>
- </sect3>
- <sect3>
- <title>DfuServer Notes</title>
- <para>This tab allows you to add any notes pertinent to the
- component's configuration. This can be useful to keep a record of
- changes and to communicate this information to peers.</para>
- </sect3>
- </sect2>
- <sect2 role="brk">
- <title>Directories</title>
- <para>The Directories component is a global definition used by other
- components to determine the directories they will use for various
- functions.</para>
- <para>
- <graphic fileref="images/CM-161a.jpg" vendor="configmgrSS" />
- </para>
- <para />
- <informaltable colsep="1" frame="all" rowsep="1">
- <tgroup cols="3">
- <colspec align="left" colwidth="122.40pt" />
- <tbody>
- <row>
- <entry>Name</entry>
- <entry>Directory</entry>
- <entry>Description</entry>
- </row>
- <row>
- <entry>
- <emphasis role="bold">log</emphasis>
- </entry>
- <entry>/var/log/[NAME]/[INST]</entry>
- <entry>Location for Log files</entry>
- </row>
- <row>
- <entry>
- <emphasis role="bold">temp</emphasis>
- </entry>
- <entry>/var/lib/[NAME]/[INST]/temp</entry>
- <entry>Location for temp files</entry>
- </row>
- <row>
- <entry>
- <emphasis role="bold">data</emphasis>
- </entry>
- <entry />
- <entry>Base Location for data files</entry>
- </row>
- <row>
- <entry>
- <emphasis role="bold">data2</emphasis>
- </entry>
- <entry />
- <entry>Base Location for 2nd copy of roxie data</entry>
- </row>
- <row>
- <entry>
- <emphasis role="bold">data3</emphasis>
- </entry>
- <entry />
- <entry>Reserved for future use</entry>
- </row>
- <row>
- <entry>
- <emphasis role="bold">mirror</emphasis>
- </entry>
- <entry />
- <entry>Base Location for mirror data files</entry>
- </row>
- <row>
- <entry>
- <emphasis role="bold">query</emphasis>
- </entry>
- <entry />
- <entry>Base Location for Queries</entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable>
- </sect2>
- <sect2 id="Drop-Zone" role="brk">
- <title>Drop Zone</title>
- <para>A Drop Zone (or landing zone) is a location where files can be
- transferred to or from your HPCC system. The drop zone is a logical
- combination of a path and one or more servers. Multiple drop zones
- allow you to configure different top level folders for one or more
- servers. Multiple servers for a single drop zone provides a logical
- grouping of distinct locations.</para>
- <para>Multiple drop zones are useful to allow different permissions
- for users or groups.</para>
- <para>To add another drop zone, right-click on the Navigator panel on
- the left side, and choose <emphasis role="bold">New
- Components</emphasis> then <emphasis role="bold">Drop Zone</emphasis>
- from the ensuing dialog.</para>
- <sect3>
- <title>DropZone Attributes</title>
- <para>You can change the configuration of your drop zone using the
- attributes tab. If you have multiple drop zones, select the drop
- zone to configure from the Navigator panel on the left side. To
- change one of the drop zone attributes, double-click on the value on
- the right side of the attribute table.</para>
- <para>
- <graphic fileref="images/CM-img06.jpg" vendor="configmgrSS" />
- </para>
- <para>
- <xi:include href="XMLGeneration/xml/dropzone.xsd.mod.xml"
- xpointer="xpointer(//*[@id='dz.t1'])"
- xmlns:xi="http://www.w3.org/2001/XInclude" />
- </para>
- <!-- /*Attribute table***replace with dynamically generated table*/
- <informaltable>
- <tgroup cols="2">
- <tbody>
- <row>
- <entry>description</entry>
- <entry>a description</entry>
- </row>
- <row>
- <entry>directory</entry>
- <entry>The directory for the drop zone</entry>
- </row>
- <row>
- <entry>name</entry>
- <entry>The name for the drop zone</entry>
- </row>
- <row>
- <entry>umask</entry>
- <entry>umask</entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable>
- -->
- </sect3>
- <sect3 id="DropZoneServerList">
- <title>DropZone Server List</title>
- <para>This tab allows you to add any servers that you wish to
- configure as a part of the selected drop zone. To add a server to
- the current drop zone. <orderedlist>
- <listitem>
- <para>Select the <emphasis role="bold">Drop Zone</emphasis> to
- configure from the Navigator panel on the left side.</para>
- </listitem>
- <listitem>
- <para>Select the <emphasis role="bold">Server List</emphasis>
- tab.</para>
- </listitem>
- <listitem>
- <para>RIght-click on the Server Address field and choose
- <emphasis role="bold">Add</emphasis>. </para>
- </listitem>
- <listitem>
- <para>Enter the hostname or IP address of the server. </para>
- </listitem>
- <listitem>
- <para>Optionally, you can select the <emphasis
- role="bold">Attributes</emphasis> tab, and modify some
- attributes for this drop zone. </para>
- <para>For example, select the <emphasis
- role="bold">name</emphasis> attribute, double click on the
- <emphasis role="bold">value</emphasis> column and provide the
- drop zone with a more meaningful name. </para>
- </listitem>
- <listitem>
- <para>Click the disk icon to save.</para>
- </listitem>
- </orderedlist></para>
- </sect3>
- <sect3 id="DropZoneNotes">
- <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="xpointer(//*[@id='EA.t1'])"
- xmlns:xi="http://www.w3.org/2001/XInclude" />
- </para>
- </sect3>
- <sect3 role="brk">
- <title>EclAgent Options Tab</title>
- <para>This section describes the EclAgent Options tab.</para>
- <para>
- <graphic fileref="images/CM-img07-2.jpg" vendor="configmgrSS" />
- </para>
- <!--configMgr-ECLAgent-Options-Include-XXX9-->
- <para>
- <xi:include href="XMLGeneration/xml/eclagent_config.xsd.mod.xml"
- xpointer="xpointer(//*[@id='EA.t2'])"
- xmlns:xi="http://www.w3.org/2001/XInclude" />
- </para>
- </sect3>
- <sect3>
- <title>EclAgentProcessNotes</title>
- <para>This tab allows you to add any notes pertinent to the
- component's configuration. This can be useful to keep a record of
- changes and to communicate this information to peers.</para>
- </sect3>
- </sect2>
- <sect2 role="brk">
- <title>ECL CC Server Process</title>
- <sect3>
- <title>Ecl CC Server Instances</title>
- <para>
- <orderedlist>
- <listitem>
- <para>Select Ecl CC Server - myeclccserver in the Navigator
- panel on the left side.</para>
- </listitem>
- <listitem>
- <para>Select the Instances tab.</para>
- </listitem>
- <listitem>
- <para>In the computer column, choose a node from the drop list
- as shown below:<graphic fileref="images/CM-ECLCC-01.jpg"
- vendor="configmgrSS" /></para>
- </listitem>
- <listitem>
- <para>Click the <inlinegraphic
- fileref="images/GS-img01c.png" /> disk icon to save</para>
- </listitem>
- </orderedlist>
- </para>
- </sect3>
- <sect3 role="brk">
- <title>Ecl CC Server Attributes Tab</title>
- <para>This section describes the Ecl CC Server Attributes
- tab.</para>
- <para>
- <graphic fileref="images/CM-ECLCC-02.jpg" vendor="configmgrSS" />
- </para>
- <!--ECLCCServer-Include-cc.t2-XXX-X-->
- <para>
- <xi:include href="XMLGeneration/xml/eclccserver.xsd.mod.xml"
- xpointer="xpointer(//*[@id='cc.t2'])"
- xmlns:xi="http://www.w3.org/2001/XInclude" />
- </para>
- </sect3>
- <sect3>
- <title>EclCC Server Process Options</title>
- <para>To add a custom option, right-click and select add. These
- options are passed to the eclcc compiler.</para>
- <para>See the ECL Compiler chapter in the <emphasis
- role="bluebold">Client Tools</emphasis> manual for details.</para>
- <!--This feature allows the user to configure any options pertinent to the Ecl CC Server Process -->
- <para />
- </sect3>
- <sect3>
- <title>EclCC Server Process Notes</title>
- <para>This tab allows you to add any notes pertinent to the
- component's configuration. This can be useful to keep a record of
- changes and to communicate this information to peers.</para>
- </sect3>
- </sect2>
- <sect2 id="ECL-Scheduler" role="brk">
- <title>ECL Scheduler</title>
- <sect3>
- <title>instances</title>
- <orderedlist>
- <listitem>
- <para>Select <emphasis role="bold">ECL Scheduler</emphasis> in
- the Navigator panel on the left side.</para>
- </listitem>
- <listitem>
- <para>Select the Instances tab.</para>
- </listitem>
- <listitem>
- <para>In the computer column, choose a node from the drop list
- as shown below:<graphic fileref="images/CM-161.jpg"
- vendor="configmgrSS" /></para>
- </listitem>
- <listitem>
- <para>Click the <inlinegraphic fileref="images/GS-img01c.png" />
- disk icon to save</para>
- </listitem>
- </orderedlist>
- </sect3>
- <sect3 role="brk">
- <title>EclScheduler Attributes Tab</title>
- <para>This section describes the EclScheduler Attributes tab.</para>
- <para>
- <graphic fileref="images/CM-160.jpg" vendor="configmgrSS" />
- </para>
- <!--configMgr-DaliServer-LDAP-Include-XXX-XI-->
- <para>
- <xi:include href="XMLGeneration/xml/eclscheduler.xsd.mod.xml"
- xpointer="xpointer(//*[@id='ecl.sched'])"
- xmlns:xi="http://www.w3.org/2001/XInclude" />
- </para>
- </sect3>
- <sect3>
- <title>EclScheduler Notes</title>
- <para>This tab allows you to add any notes pertinent to the
- component's configuration. This can be useful to keep a record of
- changes and to communicate this information to peers.</para>
- </sect3>
- </sect2>
- <sect2 id="ESP-Server" role="brk">
- <title>ESP Server</title>
- <sect3>
- <title>Esp Process Instances</title>
- <orderedlist>
- <listitem>
- <para>Select <emphasis role="bold">ESP - myesp</emphasis> in the
- Navigator panel on the left side.</para>
- </listitem>
- <listitem>
- <para>Select the Instances tab.</para>
- </listitem>
- <listitem>
- <para>In the computer column, choose a node from the drop list
- as shown below:<graphic fileref="images/CM-img08.jpg"
- vendor="configmgrSS" /></para>
- </listitem>
- <listitem>
- <para>Click the <inlinegraphic fileref="images/GS-img01c.png" />
- disk icon to save</para>
- </listitem>
- </orderedlist>
- </sect3>
- <?hard-pagebreak ?>
- <sect3>
- <title>Esp - myesp Attributes Tab</title>
- <para>This section describes the Esp - myesp Attributes tab.</para>
- <para>
- <graphic fileref="images/CM-img08-1.jpg" vendor="configmgrSS" />
- </para>
- <!--MyESP-Include-ESP.t6-XXX12-->
- <para>
- <xi:include href="XMLGeneration/xml/esp.xsd.mod.xml"
- xpointer="xpointer(//*[@id='ESP.t6'])"
- xmlns:xi="http://www.w3.org/2001/XInclude" />
- </para>
- </sect3>
- <sect3 role="brk">
- <title>Esp - myesp Service BindingsTab</title>
- <para>This section describes the Esp - myesp Service Bindings tab.
- This tab requires additional steps to configure the service
- bindings.</para>
- <para>
- <graphic fileref="images/CM-img08-2.jpg" vendor="configmgrSS" />
- </para>
- <para>You must first add the service bindings in the first table
- (Right-click, add). Then you would configure the attributes in the
- other tables on that tab. The next table describes the <emphasis
- role="bold">URL Authentication</emphasis> table.</para>
- <!--MyESP-Include-ESP.t1-XXXIII-->
- <para>
- <xi:include href="XMLGeneration/xml/esp.xsd.mod.xml"
- xpointer="xpointer(//*[@id='ESP.t1'])"
- xmlns:xi="http://www.w3.org/2001/XInclude" />
- </para>
- <para>The following tables describe the ESPProcess Service Bindings,
- <emphasis role="bold">Feature Authentications</emphasis>.</para>
- <!--MyESP-Include-ES.t2-XXX-14-->
- <para>
- <xi:include href="XMLGeneration/xml/esp.xsd.mod.xml"
- xpointer="xpointer(//*[@id='ESP.t2'])"
- xmlns:xi="http://www.w3.org/2001/XInclude" />
- </para>
- <para>
- <!--MyESP-Include-ES.t3-XXX-15-->
- <!-- <xi:include href="XMLGeneration/xml/esp.xsd.mod.xml"
- xpointer="xpointer(//*[@id='ES.t3'])"
- xmlns:xi="http://www.w3.org/2001/XInclude" /> -->
- </para>
- <para />
- </sect3>
- <?hard-pagebreak ?>
- <sect3>
- <title>Esp - myesp AuthenticationTab</title>
- <para>This section describes the Esp - myesp Service Authentication
- tab.</para>
- <para>
- <graphic fileref="images/CM-img08-3.jpg" vendor="configmgrSS" />
- </para>
- <!--MyESP-Authentication-ES.t4-XXX-16-->
- <para>
- <xi:include href="XMLGeneration/xml/esp.xsd.mod.xml"
- xpointer="xpointer(//*[@id='ESP.t4'])"
- xmlns:xi="http://www.w3.org/2001/XInclude" />
- </para>
- <para>Additional information about the available Authentication
- methods:</para>
- <para>
- <informaltable colsep="1" frame="all" rowsep="1">
- <tgroup cols="2">
- <colspec colwidth="111.50pt" />
- <colspec />
- <tbody>
- <row>
- <entry>none</entry>
- <entry>uses no authentication</entry>
- </row>
- <row>
- <entry>local</entry>
- <entry>uses the local credentials for the server running
- the ESP</entry>
- </row>
- <row>
- <entry>ldap</entry>
- <entry>uses Lightweight Directory Access Protocol for
- authentication</entry>
- </row>
- <row>
- <entry>ldaps</entry>
- <entry>similar to LDAP but uses a more secure (TLS)
- protocol</entry>
- </row>
- <row>
- <entry>secmgrPlugin</entry>
- <entry>uses the security manager plug-in</entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable>
- </para>
- </sect3>
- <?hard-pagebreak ?>
- <sect3>
- <title>Esp - myesp HTTPS Tab</title>
- <para>This section describes the Esp - myesp HTTPS tab.</para>
- <para>
- <graphic fileref="images/CM-img08-4.jpg" vendor="configmgrSS" />
- </para>
- <!--MyESP-HTTPS.t5-XXX-17-->
- <para>
- <xi:include href="XMLGeneration/xml/esp.xsd.mod.xml"
- xpointer="xpointer(//*[@id='ESP.t5'])"
- xmlns:xi="http://www.w3.org/2001/XInclude" />
- </para>
- </sect3>
- <sect3>
- <title>EspProcess Notes</title>
- <para>This tab allows you to add any notes pertinent to the
- component's configuration. This can be useful to keep a record of
- changes and to communicate this information to peers.</para>
- </sect3>
- </sect2>
- <sect2 id="ESP_Services" role="brk">
- <title>ESP Services</title>
- <para>ESP Services provide a means to add functionality to an ESP
- Server.</para>
- <sect3 id="CfgMgrEclWatch">
- <title>ECL Watch Service</title>
- <para>Ecl Watch allows you to configure options for the ECL Watch
- utility.</para>
- <para>
- <graphic fileref="images/CM-009.jpg" vendor="configmgrSS" />
- </para>
- <para>ECL Watch Attribute definitions.</para>
- <!--ECLWa-Include-TBLZ-1-->
- <para>
- <xi:include href="XMLGeneration/xml/espsmcservice.xsd.mod.xml"
- xpointer="xpointer(//*[@id='SMC-T01'])"
- xmlns:xi="http://www.w3.org/2001/XInclude" />
- </para>
- <para>ECL Watch Monitoring attributes.</para>
- <!--ECLWa-Include-TBLZ-2-->
- <para>
- <xi:include href="XMLGeneration/xml/espsmcservice.xsd.mod.xml"
- xpointer="xpointer(//*[@id='SMC-T02'])"
- xmlns:xi="http://www.w3.org/2001/XInclude" />
- </para>
- </sect3>
- <sect3 id="cfgmgr_WsECL" role="brk">
- <title>WsECL Service</title>
- <para>The WsECL service allows you to configure options for the
- WsECL utility.</para>
- <para>
- <graphic fileref="images/CM-010.jpg" vendor="configmgrSS" />
- </para>
- <para>The Ws ECL configuration attributes.</para>
- <!--WsECL-Include-ZXX-1-->
- <para>
- <xi:include href="XMLGeneration/xml/esp_service_wsecl2.xsd.mod.xml"
- xpointer="xpointer(//*[@id='MyWS2-T01'])"
- xmlns:xi="http://www.w3.org/2001/XInclude" />
- </para>
- <para>Ws ECL VIPS option attributes.</para>
- <!--WsECL-Include-ZXX-2-->
- <para>
- <xi:include href="XMLGeneration/xml/esp_service_wsecl2.xsd.mod.xml"
- xpointer="xpointer(//*[@id='MyWS2-T02'])"
- xmlns:xi="http://www.w3.org/2001/XInclude" />
- </para>
- <para>Ws ECL Target Restrictions table.</para>
- <!--WsECL-Include-ZXX-3-->
- <para>
- <xi:include href="XMLGeneration/xml/esp_service_wsecl2.xsd.mod.xml"
- xpointer="xpointer(//*[@id='MyWS2-T03'])"
- xmlns:xi="http://www.w3.org/2001/XInclude" />
- </para>
- </sect3>
- </sect2>
- <sect2 id="FTSlave-Process" role="brk">
- <title>FTSlave Process</title>
- <para>FTSlave is a helper process that every node needs. This section
- depicts an FTSlave installation.</para>
- <sect3>
- <title>Instances</title>
- <orderedlist>
- <listitem>
- <para>Select FTSlave in the Navigator panel on the left
- side.</para>
- </listitem>
- <listitem>
- <para>Select the Instances tab.</para>
- </listitem>
- <listitem>
- <?dbfo keep-together="always"?>
- <para>right-click on a computer in the computer column, and
- select Add Instance.</para>
- <para>
- <graphic fileref="images/CM-190.jpg" vendor="configmgrSS" />
- </para>
- </listitem>
- <listitem>
- <?dbfo keep-together="always"?>
- <para>Select all computers in the list, then press the <emphasis
- role="bold">OK</emphasis> button.</para>
- <para>
- <graphic fileref="images/CM-112-4.jpg" vendor="configmgrSS" />
- </para>
- </listitem>
- <listitem>
- <para>Click the <inlinegraphic fileref="images/GS-img01c.png" />
- disk icon to save</para>
- </listitem>
- </orderedlist>
- </sect3>
- <sect3>
- <title>FtSlave attributes</title>
- <para>This section describes an FTSlaveProcess attributes
- tab.</para>
- <!--FTSlave-Include-XXX-18-->
- <para>
- <xi:include href="XMLGeneration/xml/ftslave_linux.xsd.mod.xml"
- xpointer="xpointer(//*[@id='FTS.t1'])"
- xmlns:xi="http://www.w3.org/2001/XInclude" />
- </para>
- </sect3>
- <sect3>
- <title>FtSlave Process Notes</title>
- <para>This tab allows you to add any notes pertinent to the
- component's configuration. This can be useful to keep a record of
- changes and to communicate this information to peers.</para>
- </sect3>
- </sect2>
- <sect2 id="LDAPServer_Process" role="brk">
- <title>LDAP Server Process</title>
- <para>This section describes the configuration attributes of an
- LDAPServer Installation in ConfigManager. For a complete description
- of how to add LDAP Authentication see <emphasis>Using LDAP
- Authentication</emphasis> section in the <emphasis
- role="bluebold">Installing and Running The HPCC Platform</emphasis>
- document.</para>
- <para>
- <graphic fileref="images/LDAP_004.jpg" />
- </para>
- <!--LdapServer-Include-fullDoc-XXX-19-->
- <xi:include href="XMLGeneration/xml/ldapserver.xsd.mod.xml"
- xpointer="xpointer(//*[@id='ldapSrv'])"
- xmlns:xi="http://www.w3.org/2001/XInclude" />
- <sect3>
- <title>LDAP Server Process Instances</title>
- <para>This tab allows you to add instances to your LDAP
- Configuration. In order to add instances you would have previously
- added the LDAP computers in the Hardware section. For a complete
- description of how to add LDAP Authentication see <emphasis>Using
- LDAP Authentication</emphasis> section in the <emphasis
- role="bluebold">Installing and Running The HPCC Platform</emphasis>
- document.</para>
- <orderedlist>
- <listitem>
- <para>On the <emphasis role="bold">Instances</emphasis> tab,
- right-click on the table on the right hand side, choose
- <emphasis role="bold">Add Instances...</emphasis></para>
- </listitem>
- <listitem>
- <para>Select the computer to use by checking the box next to
- it.</para>
- <para>This is the computer you added in the <emphasis
- role="bold">Hardware</emphasis> / <emphasis role="bold">Add New
- Computers</emphasis> portion earlier.</para>
- </listitem>
- </orderedlist>
- </sect3>
- <sect3>
- <title>LDAP Server Process Notes</title>
- <para>This tab allows you to add any notes pertinent to the
- component's configuration. This can be useful to keep a record of
- changes and to communicate this information to peers.</para>
- </sect3>
- </sect2>
- <sect2 role="brk">
- <title>Sasha Server</title>
- <sect3>
- <title>Instances</title>
- <orderedlist>
- <listitem>
- <para>Select Sasha Server in the menu on the left side.</para>
- </listitem>
- <listitem>
- <para>Select the Instances tab.</para>
- </listitem>
- <listitem>
- <para>In the computer column, choose a node from the drop list
- as shown below:</para>
- </listitem>
- </orderedlist>
- <graphic fileref="images/CM-img17.jpg" vendor="configmgrSS" />
- </sect3>
- <sect3 role="brk">
- <title>Sasha Server Attributes</title>
- <!--***Might-Want-to-add-CM-Sasha17A.jpg-image-***-->
- <para>This section described the SashaServerProcess <emphasis
- role="bold">Attribute</emphasis> tab values.</para>
- <graphic fileref="images/CM-Sasha17A.jpg" vendor="configmgrSS" />
- <!--configMgr-Sasha-t1-Include-XXX-20-->
- <para>
- <xi:include href="XMLGeneration/xml/sasha.xsd.mod.xml"
- xpointer="xpointer(//*[@id='sh.t1'])"
- xmlns:xi="http://www.w3.org/2001/XInclude" />
- </para>
- </sect3>
- <?hard-pagebreak ?>
- <sect3>
- <title>SashaServer Process Archiver</title>
- <para>This section describes the SashaServer Process Archiver
- tab.</para>
- <para>
- <graphic fileref="images/CM-img17-1.jpg" vendor="configmgrSS" />
- </para>
- <!--configMgr-Sasha-Archiver-Include-XXX-21-->
- <para>
- <xi:include href="XMLGeneration/xml/sasha.xsd.mod.xml"
- xpointer="xpointer(//*[@id='sh.t2'])"
- xmlns:xi="http://www.w3.org/2001/XInclude" />
- </para>
- <para />
- </sect3>
- <sect3 role="brk">
- <title>SashaServer Process Coalescer</title>
- <para>This section describes the SashaServer Process Coalescer
- tab.</para>
- <para>
- <graphic fileref="images/CM-img17-2.jpg" vendor="configmgrSS" />
- </para>
- <!--configMgr-Sasha-Coaleser-Include-XXX-22-->
- <para>
- <xi:include href="XMLGeneration/xml/sasha.xsd.mod.xml"
- xpointer="xpointer(//*[@id='sh.t3'])"
- xmlns:xi="http://www.w3.org/2001/XInclude" />
- </para>
- </sect3>
- <?hard-pagebreak ?>
- <sect3>
- <title>SashaServer Process DfuXRef</title>
- <para>This section describes the SashaServer Process DfuXref
- tab.</para>
- <para>
- <graphic fileref="images/CM-img17-3.jpg" vendor="configmgrSS" />
- </para>
- <!--configMgr-Sasha-DfuXref-Include-XXX-23-->
- <para>
- <xi:include href="XMLGeneration/xml/sasha.xsd.mod.xml"
- xpointer="xpointer(//*[@id='sh.t4'])"
- xmlns:xi="http://www.w3.org/2001/XInclude" />
- </para>
- </sect3>
- <?hard-pagebreak ?>
- <sect3>
- <title>SashaServer Process DfuExpiry</title>
- <para>This section describes the SashaServer Process DfuExpiry
- tab.</para>
- <para>
- <graphic fileref="images/CM-img17-4.jpg" vendor="configmgrSS" />
- </para>
- <para />
- <!--configMgr-Sasha-DfuExpiry-Include-XXX-24-->
- <para>
- <xi:include href="XMLGeneration/xml/sasha.xsd.mod.xml"
- xpointer="xpointer(//*[@id='sh.t5'])"
- xmlns:xi="http://www.w3.org/2001/XInclude" />
- </para>
- </sect3>
- <?hard-pagebreak ?>
- <sect3>
- <title>SashaServer Process ThorQMon</title>
- <para>This section describes the SashaServer Process ThorQMon
- tab.</para>
- <para>
- <graphic fileref="images/CM-img17-5.jpg" vendor="configmgrSS" />
- </para>
- <!--configMgr-Sasha-ThorQMon-IncludeXXX-25-->
- <para>
- <xi:include href="XMLGeneration/xml/sasha.xsd.mod.xml"
- xpointer="xpointer(//*[@id='sh.t6'])"
- xmlns:xi="http://www.w3.org/2001/XInclude" />
- </para>
- </sect3>
- <?hard-pagebreak ?>
- <sect3>
- <title>SashaServer Process DaFileSrvMonitor</title>
- <para>This section describes the SashaServer Process
- DaFileSrvMonitor tab.</para>
- <para>
- <graphic fileref="images/CM-img17-6.jpg" vendor="configmgrSS" />
- </para>
- <!--configMgr-Sasha-DafiSrvMon-Include-XXX26-->
- <para>
- <xi:include href="XMLGeneration/xml/sasha.xsd.mod.xml"
- xpointer="xpointer(//*[@id='sh.t7'])"
- xmlns:xi="http://www.w3.org/2001/XInclude" />
- </para>
- </sect3>
- <sect3>
- <title>SashaServer Process Notes</title>
- <para>This tab allows you to add any notes pertinent to the
- component's configuration. This can be useful to keep a record of
- changes and to communicate this information to peers.</para>
- </sect3>
- </sect2>
- <sect2 id="Thor" role="brk">
- <title>Thor</title>
- <para>This section details how to define a Data Refinery (Thor)
- cluster. Before you begin, you should decide the width of the cluster
- (i.e., how many slave nodes will you have).</para>
- <orderedlist>
- <listitem>
- <para>Select <emphasis role="bold">Thor Cluster -
- mythor</emphasis> in the Navigator panel on the left side.</para>
- </listitem>
- <listitem>
- <para>Select the <emphasis role="bold">Topology</emphasis>
- tab.</para>
- </listitem>
- <listitem>
- <para>Expand the Topology, if needed, then right-click the Master
- and select Delete.</para>
- </listitem>
- </orderedlist>
- <para>This deletes the sample one-node Thor.</para>
- <para>You will replace this with a multi-node cluster.</para>
- <orderedlist>
- <listitem>
- <?dbfo keep-together="always"?>
- <para>right-click on the Topology and select Add Master.</para>
- <para>
- <graphic fileref="images/CM-img13.jpg" vendor="configmgrSS" />
- </para>
- </listitem>
- <listitem>
- <?dbfo keep-together="always"?>
- <para>Select a computer from the list, then press the OK
- button.</para>
- <para>
- <graphic fileref="images/CM-112-5.jpg" vendor="configmgrSS" />
- </para>
- </listitem>
- <listitem>
- <?dbfo keep-together="always"?>
- <para>Right-click on the Master and select Add Slaves.</para>
- <para>
- <graphic fileref="images/CM-111.jpg" vendor="configmgrSS" />
- </para>
- </listitem>
- <listitem>
- <?dbfo keep-together="always"?>
- <para>Select the computers to use as slaves from the list, then
- press the OK button. Use CTRL+CLICK to multi-select or SHIFT+CLICK
- to select a range.</para>
- <para><graphic fileref="images/CM-112-3.jpg"
- vendor="configmgrSS" />The Nodes now display below the Thor Master
- node.</para>
- <para>
- <graphic fileref="images/CM-img14.jpg" vendor="configmgrSS" />
- </para>
- </listitem>
- <listitem>
- <para>Select Thor Cluster - mythor in the Navigator panel on the
- left side.</para>
- </listitem>
- <listitem>
- <?dbfo keep-together="always"?>
- <para>Select the Attributes tab.</para>
- <para>
- <graphic fileref="images/CM-img15.jpg" vendor="configmgrSS" />
- </para>
- </listitem>
- <listitem>
- <para>Change the value of the localThor to <emphasis
- role="bold">false</emphasis></para>
- </listitem>
- <listitem>
- <para>Click the <inlinegraphic fileref="images/GS-img01c.png" />
- disk icon to save</para>
- </listitem>
- </orderedlist>
- <?hard-pagebreak ?>
- <sect3>
- <title>Changing Thor topology</title>
- <para>If you want to designate a different node as the Thor master
- when setting up a multi-node system, follow these steps.</para>
- <orderedlist>
- <listitem>
- <para>Select <emphasis role="bold">Thor Cluster -
- mythor</emphasis> in the Navigator panel on the left
- side.</para>
- </listitem>
- <listitem>
- <para>Select the <emphasis role="bold">Topology</emphasis>
- tab.</para>
- </listitem>
- <listitem>
- <para>right-click on the Master node</para>
- </listitem>
- <listitem>
- <?dbfo keep-together="always"?>
- <para>Select the <emphasis role="bold">Replace Master</emphasis>
- option.</para>
- <para>
- <graphic fileref="images/CM-111-2.jpg" vendor="configmgrSS" />
- </para>
- <para>
- <informaltable colsep="1" frame="all" rowsep="1">
- <?dbfo keep-together="always"?>
- <tgroup cols="2">
- <colspec colwidth="49.50pt" />
- <colspec />
- <tbody>
- <row>
- <entry>
- <inlinegraphic fileref="images/caution.png" />
- </entry>
- <entry>You should only use this feature when initially
- setting up your system. If there is data on the nodes
- when attempting to Swap Master, you run the risk of
- losing or corrupting some data.</entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable>
- </para>
- </listitem>
- </orderedlist>
- </sect3>
- <?hard-pagebreak ?>
- <sect3>
- <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>if <emphasis role="bold">localThor</emphasis> is set to true
- and <emphasis role="bold">masterMemorySize</emphasis> and <emphasis
- role="bold">globalMemorySize</emphasis> are unspecified, then the
- defaults will be 50% for <emphasis
- role="bold">globalMemorySize</emphasis> (divided by <emphasis
- role="bold">slavesPerNode</emphasis>) and 25% for <emphasis
- role="bold">masterMemorySize.</emphasis></para>
- <para>Although a configuration may be set using upper memory limits
- that exceed total physical memory, Thor will not actually reserve
- the memory ahead of time and will only hit memory problems when and
- if your jobs use all of memory. So, for example, two Thors that are
- configured to use all available memory could peacefully co-exist
- until a query on each are simultaneously using more memory than the
- node has available.</para>
- <!--configMgr-Thor-Attribute-Include-XXX-->
- <para>
- <xi:include href="XMLGeneration/xml/thor.xsd.mod.xml"
- xpointer="xpointer(//*[@id='Th.t1'])"
- xmlns:xi="http://www.w3.org/2001/XInclude" />
- </para>
- </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="xpointer(//*[@id='Th.t3'])"
- xmlns:xi="http://www.w3.org/2001/XInclude" />
- </para>
- </sect3>
- <sect3>
- <title>ThorCluster Debug</title>
- <para>The debug tab is for internal use only</para>
- </sect3>
- <?hard-pagebreak ?>
- <sect3>
- <title>ThorCluster Swap Node</title>
- <para>This section describes the ThorCluster Swap Node tab.</para>
- <para>
- <graphic fileref="images/CM-img18-4.jpg" vendor="configmgrSS" />
- </para>
- <!--configMgr-Thor-SwapNode-Include-XXX-->
- <para>
- <xi:include href="XMLGeneration/xml/thor.xsd.mod.xml"
- xpointer="xpointer(//*[@id='Th.t4'])"
- xmlns:xi="http://www.w3.org/2001/XInclude" />
- </para>
- </sect3>
- <?hard-pagebreak ?>
- <sect3>
- <title>ThorCluster Notes</title>
- <para>This tab allows you to add any notes pertinent to the
- component's configuration. This can be useful to keep a record of
- changes and to communicate this information to peers.</para>
- </sect3>
- </sect2>
- <sect2 id="Roxie" role="brk">
- <title>Roxie</title>
- <para>This section details how to define a Rapid Data Delivery Engine
- (Roxie) cluster. Before you begin, you should decide the width of the
- cluster (i.e., how many agent nodes will you have).</para>
- <!--***This section appears to have had signifcent changes*** -->
- <orderedlist>
- <listitem>
- <para>Select <emphasis role="bold">Roxie Cluster</emphasis> in the
- Navigator panel on the left side.</para>
- <para><emphasis role="bold">Note:</emphasis> If you did not
- specify a value in the <emphasis>Number of nodes for Roxie cluster
- </emphasis>field when you first set up your environment, you will
- not have a Roxie Cluster. To add a Roxie Cluster component:
- Right-click on the <emphasis role="bold">Software</emphasis>
- component in the Navigator Panel, then select <emphasis
- role="bold">New Components</emphasis> then <emphasis
- role="bold">roxie</emphasis> from the drop lists.</para>
- </listitem>
- <listitem>
- <para>Select the <emphasis role="bold">Servers</emphasis>
- tab.</para>
- </listitem>
- <listitem>
- <?dbfo keep-together="always"?>
- <para>Right-click the Roxie Servers and select
- <guimenuitem>Reconfigure Servers</guimenuitem>.</para>
- <para>
- <graphic fileref="images/CM-112.jpg" vendor="configmgrSS" />
- </para>
- </listitem>
- <listitem>
- <?dbfo keep-together="always"?>
- <para>Select the computers to use as Servers from the list, then
- press the OK button.</para>
- <para>
- <graphic fileref="images/CM-112-2.jpg" vendor="configmgrSS" />
- </para>
- </listitem>
- <listitem>
- <para>Select the <emphasis role="bold">Redundancy</emphasis>
- tab.</para>
- </listitem>
- <listitem>
- <?dbfo keep-together="always"?>
- <para>Select the redundancy scheme to use. Typically, this is
- cyclic redundancy, as shown below.</para>
- <para>
- <graphic fileref="images/CM-112-1.jpg" vendor="configmgrSS" />
- </para>
- </listitem>
- <listitem>
- <para>Click the <inlinegraphic fileref="images/GS-img01c.png" />
- disk icon to save</para>
- </listitem>
- <listitem>
- <para>Close Configuration Manager by pressing ctrl+C in the
- command window where it is running.</para>
- </listitem>
- </orderedlist>
- </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>
|