You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@uima.apache.org by cw...@apache.org on 2013/01/02 20:12:11 UTC
svn commit: r1427917 [3/8] - in
/uima/sandbox/uima-ducc/trunk/uima-ducc-ducbook/docbook: ./ images/
images/ducc-overview/ images/job-manager/ part-admin/ part-admin/admin/
part-introduction/ part-user/ part-user/cli/ unused/
Propchange: uima/sandbox/uima-ducc/trunk/uima-ducc-ducbook/docbook/part-admin/admin/ducc-properties.xml
------------------------------------------------------------------------------
svn:eol-style = native
Added: uima/sandbox/uima-ducc/trunk/uima-ducc-ducbook/docbook/part-admin/admin/logs.xml
URL: http://svn.apache.org/viewvc/uima/sandbox/uima-ducc/trunk/uima-ducc-ducbook/docbook/part-admin/admin/logs.xml?rev=1427917&view=auto
==============================================================================
--- uima/sandbox/uima-ducc/trunk/uima-ducc-ducbook/docbook/part-admin/admin/logs.xml (added)
+++ uima/sandbox/uima-ducc/trunk/uima-ducc-ducbook/docbook/part-admin/admin/logs.xml Wed Jan 2 19:12:10 2013
@@ -0,0 +1,150 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+-->
+ <!-- ************************************ Logs ********************************** -->
+ <section>
+ <title>Logs</title>
+
+ <para>
+ <emphasis>The source for this chapter is ducc_ducbook/documents/admin/logs.xml</emphasis>
+ </para>
+
+ <para>
+ There are two sets of DUCC logs:
+ <orderedlist>
+ <listitem><para>daemon logs</para></listitem>
+ <listitem><para>user logs</para></listitem>
+ </orderedlist>
+ </para>
+
+ <para>
+ User logs are <link linkend="ducc.user.logs">described</link> in the User's Guide section of this book.
+ </para>
+
+ <para>
+ The DUCC logs are managed by <emphasis>log4j</emphasis> and are configured using
+ <filename>ducc_runtime/log4j.xml.</filename> It is not in the scope of this document
+ to describe <emphasis>log4j</emphasis> or its configuration mechanism. Details on <emphasis>log4j</emphasis>
+ can be found at <ulink url="http://logging.apache.org/log4j/1.2/">http://logging.apache.org/log4j/1.2/</ulink>.
+ </para>
+
+ <para>
+ The <emphasis>daemon</emphasis> logs are written by the DUCC administrative
+ processes and reside in <filename class="directory">ducc_runtime/logs</filename>.
+ </para>
+
+ <para>
+ The logs are based on log4j's <emphasis>RollingFileAppender </emphasis> and are configured
+ to roll over after they reach a certain size to prevent them from overflowing their disk
+ space. When a log file reaches a maximum size it is renamed and a new generation of log is
+ created. The maximum size and the number of generations is configured
+ in <filename>ducc_runtime/log4j.xml</filename>.
+ </para>
+
+ <para>
+ To configure the size and number of generations of files for each log, the following
+ parameters, specific to each log, may be updated in <filename>log4j.xml</filename>:
+ <variablelist>
+ <varlistentry>
+ <term><emphasis role="bold">maxBackupIndex</emphasis></term>
+ <listitem>
+ <para>
+ This is the maximum number of generations of the log that will be created. For example,
+ to configure a maximum of 20 generations:
+ <screen><![CDATA[<param name="maxBackupIndex" value="20" /> ]]></screen>
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><emphasis role="bold">maxFileSize</emphasis></term>
+ <listitem>
+ <para>
+ This is the maximum size of any generation of log file. For example, to configure the
+ maximum to 20 MB:
+ <screen><![CDATA[<param name="maxFileSize" value="20MB" /> ]]></screen>
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+
+ <para>
+ The relevant <emphasis>log4j</emphasis> appenders include:
+
+ <variablelist>
+ <varlistentry>
+ <term><emphasis role="bold">rmlog</emphasis></term>
+ <listitem>
+ <para>
+ This is the log for the Resource Manager.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><emphasis role="bold">pmlog</emphasis></term>
+ <listitem>
+ <para>
+ This is the log for the Process Manager.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><emphasis role="bold">orlog</emphasis></term>
+ <listitem>
+ <para>
+ This is the log for the Orchestrator.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><emphasis role="bold">smlog</emphasis></term>
+ <listitem>
+ <para>
+ This is the log for the Service Manager.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><emphasis role="bold">wslog</emphasis></term>
+ <listitem>
+ <para>
+ This is the log for the Web Server.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><emphasis role="bold">agentlog</emphasis></term>
+ <listitem>
+ <para>
+ This is the log for the Agents.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+
+ </para>
+
+ </section>
+
Propchange: uima/sandbox/uima-ducc/trunk/uima-ducc-ducbook/docbook/part-admin/admin/logs.xml
------------------------------------------------------------------------------
svn:eol-style = native
Added: uima/sandbox/uima-ducc/trunk/uima-ducc-ducbook/docbook/part-admin/admin/start-ducc.xml
URL: http://svn.apache.org/viewvc/uima/sandbox/uima-ducc/trunk/uima-ducc-ducbook/docbook/part-admin/admin/start-ducc.xml?rev=1427917&view=auto
==============================================================================
--- uima/sandbox/uima-ducc/trunk/uima-ducc-ducbook/docbook/part-admin/admin/start-ducc.xml (added)
+++ uima/sandbox/uima-ducc/trunk/uima-ducc-ducbook/docbook/part-admin/admin/start-ducc.xml Wed Jan 2 19:12:10 2013
@@ -0,0 +1,293 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+-->
+ <!-- ************************************ start_ducc ********************************** -->
+ <section>
+ <title>start_ducc</title>
+
+ <para>
+ <emphasis>The source for this chapter is ducc_ducbook/documents/admin/start-ducc.xml</emphasis>
+ </para>
+
+ <para>
+ <emphasis>Description:</emphasis>
+ <variablelist>
+ <varlistentry>
+ <term />
+ <listitem>
+
+ <para>
+ Start_ducc is used to start DUCC processes. If run with no parameters it takes the following
+ actions:
+
+ <variablelist>
+ <varlistentry>
+ <term />
+ <listitem>
+ <para>
+ Starts the management processes Resource Manager, Orchestrator, Process Manager, Services Manager,
+ and Web Server on the local node (where <emphasis>start_ducc</emphasis> is executed.
+ </para>
+ <para>
+ Starts an agent process on every node named in the default node list.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+
+ <para>
+ <emphasis>Usage:</emphasis>
+ <variablelist>
+
+ <varlistentry>
+ <term />
+ <listitem>
+ <para>
+ <emphasis role="bold">start_ducc [options]</emphasis>
+ </para>
+ <para>
+ If no options are given, all DUCC processes are started, using the default
+ node list, ducc_runtime/resources/ducc.nodes. This is the equivalent of
+ </para>
+ <screen>start_ducc -n $DUCC_HOME/resources/ducc.nodes -m</screen>
+
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+
+ <para>
+ <emphasis>Options:</emphasis>
+ <variablelist>
+
+ <varlistentry>
+ <term />
+ <listitem>
+ <para>
+ <emphasis role="bold">-n, --nodelist [nodefile]</emphasis>
+
+ <variablelist>
+ <varlistentry>
+ <term />
+ <listitem>
+ <para>
+ Start agents on the nodes in the nodefile. Multiple nodefiles may be specified:
+ </para>
+ <para>
+ <screen>start_ducc -n foo.nodes -n bar.nodes -n baz.nodes</screen>
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term />
+ <listitem>
+ <para>
+ <emphasis role="bold">-m, --management</emphasis>
+
+ <variablelist>
+ <varlistentry>
+ <term />
+ <listitem>
+ <para>
+ Start the management processes (rm, sm, pm, orchestrator) on the local node. The
+ webserver is started on the local node, or the node configured in
+ <emphasis>ducc.properties.</emphasis>
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term />
+ <listitem>
+ <para>
+ <emphasis role="bold">-c, --component [component]</emphasis>
+ <variablelist>
+ <varlistentry>
+ <term />
+ <listitem>
+ <para>
+ Start a specific DUCC component, optionally on a specific node. If the component name
+ is qualified with a nodename, the component is started on that node. To qualify a
+ component name with a destination node, use the notation component@nodename.
+ Multiple components may be specified:
+ </para>
+ <para>
+ <screen>start_ducc -c sm -c pm -c rm -c or@bj22 -c agent@n1 -c agent@n2</screen>
+ </para>
+ <para>
+ Components include:
+ <variablelist>
+ <varlistentry>
+ <term> <emphasis role="bold">rm</emphasis></term>
+ <listitem>
+ <para>
+ The Resource Manager.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term> <emphasis role="bold">or</emphasis></term>
+ <listitem>
+ <para>
+ The Orchestrator.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term> <emphasis role="bold">pm</emphasis></term>
+ <listitem>
+ <para>
+ The Process Manager.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term> <emphasis role="bold">sm</emphasis></term>
+ <listitem>
+ <para>
+ The Service Manager.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term> <emphasis role="bold">ws</emphasis></term>
+ <listitem>
+ <para>
+ The Web Server.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term> <emphasis role="bold">agent</emphasis></term>
+ <listitem>
+ <para>
+ Node Agents.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ </variablelist>
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </listitem>
+ </varlistentry>
+
+ </variablelist>
+
+ </para>
+
+
+ <para>
+ <emphasis>Notes:</emphasis>
+ <variablelist>
+ <varlistentry>
+ <term />
+ <listitem>
+
+ <para>
+ A different nodelist may be used to specify where Agents are started. As well multiple node lists
+ may be specified, in which case Agents are started on all the nodes in the multiple node lists.
+ </para>
+
+ <para>
+ To start only agents, run <emphasis>start_ducc</emphasis> specifying a nodelist explicitly. When
+ started like this, the management daemons are not started unless explicitly requested.
+ </para>
+
+ <para>
+ To start only management processes, run <emphasis>start_ducc</emphasis> with the
+ <emphasis>-m or --management</emphasis> flags. When started like the the agents are not started
+ unless explicitly requested.
+ </para>
+
+ <para>
+ To start a specific management process, run <emphasis>start_ducc</emphasis> with the
+ <emphasis>-c component</emphasis> parameter, specify the component that should be
+ started.
+ </para>
+
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+
+ <para>
+ <emphasis>Examples:</emphasis>
+ <variablelist>
+ <varlistentry>
+ <term />
+ <listitem>
+
+ <para>
+ Start all DUCC processes, using custom nodelists:
+ <screen>start_ducc -m -n foo.nodes -n bar.nodes</screen>
+ <screen></screen>
+ </para>
+
+ <para>
+ Start just management processes:
+ <screen>start_ducc -m</screen>
+ <screen></screen>
+ </para>
+
+ <para>
+ Start just agents on a specific set of nodes:
+ <screen>start_ducc -n foo.nodes -n bar.nodes</screen>
+ <screen></screen>
+ </para>
+
+ <para>
+ Start and agent on a specific node:
+ <screen>start_ducc -c agent@a.specific.node</screen>
+ <screen></screen>
+ </para>
+
+ <para>
+ Start the webserver on node 'bingle':
+ <screen>start_ducc -c ws@bingle</screen>
+ <screen></screen>
+ </para>
+
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+
+ </section>
Propchange: uima/sandbox/uima-ducc/trunk/uima-ducc-ducbook/docbook/part-admin/admin/start-ducc.xml
------------------------------------------------------------------------------
svn:eol-style = native
Added: uima/sandbox/uima-ducc/trunk/uima-ducc-ducbook/docbook/part-admin/admin/stop-ducc.xml
URL: http://svn.apache.org/viewvc/uima/sandbox/uima-ducc/trunk/uima-ducc-ducbook/docbook/part-admin/admin/stop-ducc.xml?rev=1427917&view=auto
==============================================================================
--- uima/sandbox/uima-ducc/trunk/uima-ducc-ducbook/docbook/part-admin/admin/stop-ducc.xml (added)
+++ uima/sandbox/uima-ducc/trunk/uima-ducc-ducbook/docbook/part-admin/admin/stop-ducc.xml Wed Jan 2 19:12:10 2013
@@ -0,0 +1,273 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+-->
+ <!-- ************************************ stop_ducc ********************************** -->
+ <section>
+ <title>stop_ducc</title>
+
+ <para>
+ <emphasis>The source for this chapter is ducc_ducbook/documents/admin/stop-ducc.xml</emphasis>
+ </para>
+
+ <para>
+ <emphasis>Description:</emphasis>
+ <variablelist>
+ <varlistentry>
+ <term />
+ <listitem>
+
+ <para>
+ Stop_ducc is used to stop DUCC processes. If run with no parameters it takes the following
+ actions the help text is printed to the console.
+ </para>
+
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+
+ <para>
+ <emphasis>Usage:</emphasis>
+ <variablelist>
+ <varlistentry>
+ <term />
+ <listitem>
+
+ <para>
+ <emphasis role="bold"> ducc_stop [options]</emphasis>
+ </para>
+ <para>
+ If no options are given, help text is presented. At least one option is required, to avoid
+ accidental cluster shutdown.
+ </para>
+
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+
+ <para>
+ <emphasis>Options:</emphasis>
+ <variablelist>
+
+ <varlistentry>
+ <term />
+ <listitem>
+ <para>
+ <emphasis role="bold">-a --all</emphasis>
+ <variablelist>
+ <varlistentry>
+ <term />
+ <listitem>
+ <para>
+ Stop all the DUCC processes, including agents and management processes. This broadcasts
+ a "shutdown" command to all DUCC processes. Shutdown is normally performed gracefully
+ will all process including job processes given time to save state.
+ All user processes, both jobs and services, are sent shutdown signals. Job and service processes which do not
+ shutdown within a designated grace period are then forcibly terminated with
+ <emphasis>kill -9.</emphasis>
+ </para>
+
+ <para>
+ <screen>stop_ducc -a</screen>
+ </para>
+
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term />
+ <listitem>
+ <para>
+ <emphasis role="bold">-n, --nodelist [nodefile]</emphasis>
+ <variablelist>
+ <varlistentry>
+ <term />
+ <listitem>
+ <para>
+ Only the DUCC agents in the designated nodelists are shutdown. The processes
+ are sent <emphasis>kill -INT</emphasis> signals which triggers the Java shutdown
+ hooks and enables graceful shutdown. All user processes on the indicated nodes,
+ both jobs and services, are sent "shutdown" signals and are given a minute to
+ shutdown gracefully. Job and service processes which do not shutdown within a
+ designated grace period are then forcibly terminated with
+ <emphasis>kill -9.</emphasis>
+ </para>
+
+ <para>
+ <screen>stop_ducc -n foo.nodes -n bar.nodes -n baz.nodes</screen>
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term />
+ <listitem>
+ <para>
+ <emphasis role="bold">-m, --management</emphasis>
+ <variablelist>
+ <varlistentry>
+ <term />
+ <listitem>
+ <para>
+ Stop only the management processes <emphasis>rm, pm, or, sm, and ws.</emphasis> All
+ agents are left running; all job drivers are left running, all job processes are
+ left running.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term />
+ <listitem>
+ <para>
+ <emphasis role="bold">-c, --component [component]</emphasis>
+ <variablelist>
+ <varlistentry>
+ <term />
+ <listitem>
+ <para>
+ Stop a specific DUCC component.
+ </para>
+ <para>
+ This may be used to stop an errant management component and subsequently
+ restart it (with <emphasis>start_ducc</emphasis>).
+ </para>
+ <para>
+ This may also be used to stop a specific agent and the job and services processes
+ it is managing, without the need to specify a nodelist.
+ </para>
+
+ <para>
+ Stop agents on nodes n1 and n2:
+ <screen>stop_ducc -c agent@n1 -c agent@n2</screen>
+ </para>
+
+ <para>
+ Stop and restart the rm:
+ <screen>stop_ducc -c rm</screen>
+ <screen>start_ducc -c rmc</screen>
+ </para>
+
+ <para>
+ Components include:
+ <variablelist>
+ <varlistentry>
+ <term> <emphasis role="bold">rm</emphasis></term>
+ <listitem>
+ <para>
+ The Resource Manager.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term> <emphasis role="bold">or</emphasis></term>
+ <listitem>
+ <para>
+ The Orchestrator.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term> <emphasis role="bold">pm</emphasis></term>
+ <listitem>
+ <para>
+ The Process Manager.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term> <emphasis role="bold">sm</emphasis></term>
+ <listitem>
+ <para>
+ The Service Manager.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term> <emphasis role="bold">ws</emphasis></term>
+ <listitem>
+ <para>
+ The Web Server.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term> <emphasis role="bold">agent</emphasis></term>
+ <listitem>
+ <para>
+ Node Agents.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ </variablelist>
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term />
+ <listitem>
+ <para>
+ <emphasis role="bold">-k, --kill</emphasis>
+ <variablelist>
+ <varlistentry>
+ <term />
+ <listitem>
+ <para>
+ Use this to forcibly kill a component using <emphasis>kill -9</emphasis>. This
+ should only be used if the <emphasis>-a</emphasis> option does not work. This
+ normally has the same effect as <emphasis>check_ducc -k</emphasis>, with the
+ difference that <emphasis>check_ducc</emphasis> indiscriminately kills all
+ the DUCC processes it can find, whereas <emphasis>stop_ducc-k </emphasis>
+ can be directed to a specific instance of a component.
+ </para>
+
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </listitem>
+ </varlistentry>
+
+ </variablelist>
+
+ </para>
+
+ </section>
Propchange: uima/sandbox/uima-ducc/trunk/uima-ducc-ducbook/docbook/part-admin/admin/stop-ducc.xml
------------------------------------------------------------------------------
svn:eol-style = native
Added: uima/sandbox/uima-ducc/trunk/uima-ducc-ducbook/docbook/part-admin/admin/verify-ducc.xml
URL: http://svn.apache.org/viewvc/uima/sandbox/uima-ducc/trunk/uima-ducc-ducbook/docbook/part-admin/admin/verify-ducc.xml?rev=1427917&view=auto
==============================================================================
--- uima/sandbox/uima-ducc/trunk/uima-ducc-ducbook/docbook/part-admin/admin/verify-ducc.xml (added)
+++ uima/sandbox/uima-ducc/trunk/uima-ducc-ducbook/docbook/part-admin/admin/verify-ducc.xml Wed Jan 2 19:12:10 2013
@@ -0,0 +1,222 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+-->
+ <!-- ************************************ verify_ducc ********************************** -->
+ <section>
+ <title>verify_ducc</title>
+
+ <para>
+ <emphasis>The source for this chapter is ducc_ducbook/documents/admin/verify-ducc.xml</emphasis>
+ </para>
+
+ <para>
+ <emphasis>Description:</emphasis>
+ <variablelist>
+ <varlistentry>
+ <term />
+ <listitem>
+
+ <para>
+ <emphasis>verify_ducc</emphasis> performs a number of internal consistency checks
+ to insure the DUCC installation is complete and has no obvious configuration errors.
+ The following checks are performed:
+ </para>
+
+ <itemizedlist>
+ <listitem>
+ <para>
+ Insure <emphasis>ducc_ling</emphasis> is installed in the configured
+ location and has correct permission and ownership on all nodes.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Insure ActiveMQ is installed and configured in a way compatible with the
+ ActiveMQ URL in ducc.properties.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Insure all nodelists exist and are readable.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Insure all nodes can be reached via ssh.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Insure all nodes are running identical versions of DUCC.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Insure java is installed in the location configured in ducc.properties on all
+ nodes.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Print the version of java on all nodes.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Print the version of operating system on all nodes.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Print the amount of RAM on all nodes.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Insure all configured nodepools in ducc.classes exist and reference nodes
+ are configured in the nodelists.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Insure that all nodepools referenced by classes also defined.
+ </para>
+ </listitem>
+
+ </itemizedlist>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+
+ <para>
+ <emphasis>Usage:</emphasis>
+ <variablelist>
+ <varlistentry>
+ <term />
+ <listitem>
+ <para>
+ <emphasis role="bold">verify_ducc [options]</emphasis>
+
+ <variablelist>
+ <varlistentry>
+ <term />
+ <listitem>
+ <para>
+ If no options are given, the nodes in <filename>ducc_runtime/resources/ducc.nodes</filename>
+ are used and the default ActiveMQ broker location of <filename>~ducc/activemq</filename>
+ is used.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+
+ <para>
+ <emphasis>Options:</emphasis>
+ <variablelist>
+
+ <varlistentry>
+ <term />
+ <listitem>
+ <para>
+ <emphasis role="bold">-b [broker_install_dir]</emphasis>
+ </para>
+
+ <variablelist>
+ <varlistentry>
+ <term />
+ <listitem>
+ <para>
+ This specifies the name of the ActiveMQ broker configuration file that you are using.
+ </para>
+ <para>
+ <screen>verify_ducc -b /home/challngr/amqbroker/amq/conf/activemq-nojournal5.xml</screen>
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term />
+ <listitem>
+ <para>
+ <emphasis role="bold">-n [nodelist]</emphasis>
+ </para>
+
+ <variablelist>
+ <varlistentry>
+ <term />
+ <listitem>
+ <para>
+ This specifies the nodelist against which the DUCC installation is verified.
+ This nodelist should be the same nodelist that DUCC will be started with.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+
+ <para>
+ <emphasis>Notes:</emphasis>
+ <variablelist>
+ <varlistentry>
+ <term />
+ <listitem>
+
+ <para>
+ It may take a couple attempts to get <emphasis>verify_ducc</emphasis> to run
+ without error. It is important that all problems reported by <emphasis>
+ verify_ducc</emphasis> are handled before trying to start DUCC the first time.
+ </para>
+
+ <para>
+ It is recommended that <emphasis>verify_ducc</emphasis> be run after any
+ update to the DUCC configuration, most importantly, the addition of nodes.
+ <emphasis>Verify_ducc</emphasis> checks the <emphasis>ducc_ling</emphasis>
+ configuration on the new nodes as well as verifies network and <emphasis>ssh</emphasis>
+ connectivity.
+ </para>
+
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+
+ </section>
+
Propchange: uima/sandbox/uima-ducc/trunk/uima-ducc-ducbook/docbook/part-admin/admin/verify-ducc.xml
------------------------------------------------------------------------------
svn:eol-style = native
Added: uima/sandbox/uima-ducc/trunk/uima-ducc-ducbook/docbook/part-admin/chapter-admin.xml
URL: http://svn.apache.org/viewvc/uima/sandbox/uima-ducc/trunk/uima-ducc-ducbook/docbook/part-admin/chapter-admin.xml?rev=1427917&view=auto
==============================================================================
--- uima/sandbox/uima-ducc/trunk/uima-ducc-ducbook/docbook/part-admin/chapter-admin.xml (added)
+++ uima/sandbox/uima-ducc/trunk/uima-ducc-ducbook/docbook/part-admin/chapter-admin.xml Wed Jan 2 19:12:10 2013
@@ -0,0 +1,140 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+-->
+<chapter id="ducc.admin">
+ <title>Administration</title>
+
+ <para>
+ <emphasis>The source for this chapter is ducc_ducbook/documents/chapter-admin.xml</emphasis>
+ </para>
+
+ <para>
+ This chapter describes how to start, stop, and generally administer DUCC.
+ </para>
+
+ <para>
+ There are several files used to configure DUCC:
+ <variablelist>
+ <varlistentry>
+ <term><emphasis role="bold">ducc.properties</emphasis></term>
+ <listitem>
+ <para>
+ <emphasis>Ducc.properties</emphasis> contains primary configuration for all the DUCC
+ processes including URL and port specifications, tuning parameters, and protocols.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><emphasis role="bold">ducc.classes</emphasis></term>
+ <listitem>
+ <para>
+ <emphasis>Ducc.classes</emphasis> configures the scheduling classes used by the
+ Resource Manager.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><emphasis role="bold">Node lists</emphasis></term>
+ <listitem>
+ <para>
+ <emphasis>Node lists</emphasis> contain the names of the machines that comprise
+ a DUCC cluster. The default nodelist is called <emphasis>ducc.nodes</emphasis>
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><emphasis role="bold">Node pools</emphasis></term>
+ <listitem>
+ <para>
+ <emphasis>Nodepool files</emphasis> are used by the Resource Manager to logically group
+ nodes by function. Jobs, reservations, and services may be restricted to specific
+ pools of nodes.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+
+ <para>
+ These are several administrative commands. To use these one should add
+ <emphasis>ducc_runtime/admin</emphasis> to their PATH. It is not necessary to
+ add DUCC_HOME to the environment as the commands infer its location from where
+ they are invoked.
+
+ <variablelist>
+
+ <varlistentry>
+ <term> <emphasis role="bold">start_ducc</emphasis></term>
+ <listitem>
+ <para>
+ Use <emphasis>start_ducc</emphasis> to start DUCC administrative processes and agents. The DUCC
+ processes may be started individually or at once.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term> <emphasis role="bold">stop_ducc</emphasis></term>
+ <listitem>
+ <para>
+ Use <emphasis>stop_ducc</emphasis> to stop DUCC administrative processes and agents. The DUCC
+ processes may be stopped individually or at once.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term> <emphasis role="bold">check_ducc</emphasis></term>
+ <listitem>
+ <para>
+ Use <emphasis>check_ducc</emphasis> to query the state of DUCC processes in the cluster. It may
+ be used to force-kill DUCC processes and user processes that cannot be stopped by
+ <emphasis>stop_ducc</emphasis> for any reason.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term> <emphasis role="bold">verify_ducc</emphasis></term>
+ <listitem>
+ <para>
+ Use <emphasis>verify_ducc</emphasis> validate the integrity of your DUCC installation. It performs
+ extensive checks to insure components are installed as expected.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ </variablelist>
+ </para>
+
+
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="admin/ducc-properties.xml" />
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="admin/ducc-classes.xml" />
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="admin/ducc-nodes.xml" />
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="admin/ducc-nodepool.xml" />
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="admin/start-ducc.xml" />
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="admin/stop-ducc.xml" />
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="admin/check-ducc.xml" />
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="admin/verify-ducc.xml" />
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="admin/logs.xml" />
+
+</chapter>
Propchange: uima/sandbox/uima-ducc/trunk/uima-ducc-ducbook/docbook/part-admin/chapter-admin.xml
------------------------------------------------------------------------------
svn:eol-style = native