Author: jstephens
Date: 2009-11-27 12:45:19 +0100 (Fri, 27 Nov 2009)
New Revision: 17857
Log:
Another chunk of the installation chapter:
config file info
updated dependencies
Modified:
trunk/cluster-manager/Makefile.depends
trunk/cluster-manager/cluster-manager.xml
Modified: trunk/cluster-manager/Makefile.depends
===================================================================
--- trunk/cluster-manager/Makefile.depends 2009-11-27 11:26:15 UTC (rev 17856)
+++ trunk/cluster-manager/Makefile.depends 2009-11-27 11:45:19 UTC (rev 17857)
Changed blocks: 2, Lines Added: 2, Lines Deleted: 0; 1029 bytes
@@ -33,6 +33,7 @@
cluster_manager_SOURCES = cluster-manager.xml $(cluster_manager_INCLUDES)
cluster_manager_IDMAPS = \
../refman-5.1/metadata/mysql-cluster-configuration-core.idmap \
+ ../refman-5.1/metadata/mysql-cluster-management.idmap \
../refman-5.1/metadata/mysql-cluster-multi-computer.idmap \
../refman-5.1/metadata/mysql-cluster-programs-core.idmap \
../refman-5.1/metadata/mysql-cluster-replication.idmap \
@@ -40,6 +41,7 @@
../refman-5.1/metadata/programs-client-core.idmap \
../refman-5.1/metadata/replication-options-core.idmap \
../refman-common/metadata/copyright.en.idmap \
+ ../refman-common/metadata/mysql-proxy-core.idmap \
metadata/cluster-manager.idmap \
metadata/preface.idmap
cluster-manager.validpure: $(cluster_manager_SOURCES)
Modified: trunk/cluster-manager/cluster-manager.xml
===================================================================
--- trunk/cluster-manager/cluster-manager.xml 2009-11-27 11:26:15 UTC (rev 17856)
+++ trunk/cluster-manager/cluster-manager.xml 2009-11-27 11:45:19 UTC (rev 17857)
Changed blocks: 2, Lines Added: 190, Lines Deleted: 74; 11761 bytes
@@ -605,91 +605,112 @@
</para>
</listitem>
- <listitem>
- <para>
- Change to the directory where you placed the extracted &mcm;
- archive and list the contents; you should see something
- similar to what is shown here:
- </para>
+ </orderedlist>
+ <formalpara>
+
+ <title>Contents of the &mcm; distribution package</title>
+
+ <para>
+ If you change to the directory where you placed the extracted
+ &mcm; archive and list the contents; you should see something
+ similar to what is shown here:
+ </para>
+
+ </formalpara>
+
<programlisting>
shell> <userinput>cd ~/mcm</userinput>
shell> <userinput>ls</userinput>
bin etc lib sbin share var
</programlisting>
- <para>
- These directories are described in the following table:
- </para>
+ <para>
+ These directories are described in the following table:
+ </para>
- <informaltable>
- <tgroup cols="2">
- <colspec colwidth="50*"/>
- <colspec colwidth="50*"/>
- <thead>
- <row>
- <entry>Directory</entry>
- <entry>Contents</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry><filename>bin</filename></entry>
- <entry>Startup scripts for &mcm; agent and client</entry>
- </row>
- <row>
- <entry><filename>etc</filename></entry>
- <entry>Contains agent configuration file
- (<filename>mysql-cluster-manager.ini</filename>)</entry>
- </row>
- <row>
- <entry><filename>etc/init.d</filename></entry>
- <entry>Init scripts</entry>
- </row>
- <row>
- <entry><filename>lib/mysql-proxy</filename></entry>
- <entry>Libraries needed to run the &mcm; agent</entry>
- </row>
- <row>
- <entry><filename>sbin</filename></entry>
- <entry>&mcm; agent and client executables</entry>
- </row>
- <row>
- <entry><filename>share</filename></entry>
- <entry>Documentation and resource files: these include
- <filename>README</filename> files (in
- <filename>share/doc</filename>) and language-specific
- messages files (in <filename>share/locale</filename>)</entry>
- </row>
- <row>
- <entry><filename>var</filename></entry>
- <entry>XML files containing information needed by &mcm; about processes,
- attributes, and command syntax</entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable>
+ <informaltable>
+ <tgroup cols="2">
+ <colspec colwidth="50*"/>
+ <colspec colwidth="50*"/>
+ <thead>
+ <row>
+ <entry>Directory</entry>
+ <entry>Contents</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry><filename>bin</filename></entry>
+ <entry>Startup scripts for &mcm; agent and client</entry>
+ </row>
+ <row>
+ <entry><filename>etc</filename></entry>
+ <entry>Contains agent configuration file
+ (<filename>mysql-cluster-manager.ini</filename>)</entry>
+ </row>
+ <row>
+ <entry><filename>etc/init.d</filename></entry>
+ <entry>Init scripts</entry>
+ </row>
+ <row>
+ <entry><filename>lib/mysql-proxy</filename></entry>
+ <entry>Libraries needed to run the &mcm; agent</entry>
+ </row>
+ <row>
+ <entry><filename>sbin</filename></entry>
+ <entry>&mcm; agent and client executables</entry>
+ </row>
+ <row>
+ <entry><filename>share</filename></entry>
+ <entry>Documentation and resource files: these include
+ <filename>README</filename> files (in
+ <filename>share/doc</filename>) and language-specific
+ messages files (in <filename>share/locale</filename>)</entry>
+ </row>
+ <row>
+ <entry><filename>var</filename></entry>
+ <entry>XML files containing information needed by &mcm; about processes,
+ attributes, and command syntax</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
- <para>
- Normally, the only directories of those shown in the preceding
- table that you need be concerned with are the
- <filename>bin</filename> and <filename>etc</filename>
- directories.
- </para>
+ <para>
+ Normally, the only directories of those shown in the preceding
+ table that you need be concerned with are the
+ <filename>bin</filename> and <filename>etc</filename> directories.
+ </para>
- <para>
- Prior to starting the &mcm; agent, you should make any
- necessary changes to the <literal>[mysql-proxy]</literal>
- section of the agent configuration file
- (<filename>mysql-cluster-manager.ini</filename>). By default,
- this reads similarly to what is shown here:
- </para>
+ <formalpara>
+ <title>&mcm; configuration file
+ (<filename>mysql-cluster-manager.ini</filename>)</title>
+
+ <para>
+ Prior to starting the &mcm; agent, you should make any necessary
+ changes to the <literal>[mysql-proxy]</literal> section of the
+ agent configuration file
+ (<filename>mysql-cluster-manager.ini</filename>). By default,
+ this reads similarly to what is shown here:
+ </para>
+
+ </formalpara>
+
+ <note>
+ <para>
+ <literal>##</literal> in the &mcm; configuration file indicates
+ the beginning of a comment; the comment continues to the end of
+ the line.
+ </para>
+ </note>
+
<programlisting>
[mysql-proxy]
## Plugins used
-plugins=manager
+plugins = manager
## TCP/IP port used by &mcm;
##manager-port = :1862
@@ -704,15 +725,110 @@
log-level = message
## Agent process ID
-##pid-file=@@INSTALLDIR@@@@PLATFORM_PATH_SEPARATOR@@mysql-monitor-agent.pid
+##pid-file = @@INSTALLDIR@@@@PLATFORM_PATH_SEPARATOR@@mysql-monitor-agent.pid
## Top-level directory for manager plugins information stored on disk
-manager-directory=manager
+manager-directory = manager
</programlisting>
- </listitem>
- </orderedlist>
+ <para>
+ The meanings of these settings, along with their types and allowed
+ values, are described in the following table:
+ </para>
+ <informaltable>
+ <tgroup cols="4">
+ <colspec colwidth="20*"/>
+ <colspec colwidth="20*"/>
+ <colspec colwidth="20*"/>
+ <colspec colwidth="40*"/>
+ <thead>
+ <row>
+ <entry>Setting</entry>
+ <entry>Type/Format</entry>
+ <entry>Default/Permitted Values</entry>
+ <entry>Description</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry><literal>plugins</literal></entry>
+ <entry>A comma-delimited list of plugin names</entry>
+ <entry>To enable &mcm;, this list must include <literal>manager</literal>.</entry>
+ <entry>To enable &mcm;, this must include <literal>manager</literal> (the
+ default value). For other possibilities, see
+ <xref linkend="mysql-proxy"/>; however, you should be
+ aware that we currently do not test &mcm; with any values
+ for <literal>plugins</literal> other than
+ <literal>manager</literal>.</entry>
+ </row>
+ <row>
+ <entry><literal>manager-port</literal></entry>
+ <entry>[<replaceable>host</replaceable>:]<replaceable>port</replaceable></entry>
+ <entry>Default host: <literal>localhost</literal>; Default port: 1862; Port
+ range: A legal TC/IP port number.</entry>
+ <entry>This is used to specify the port used by &mcm; client connections.
+ Normally there is no need to change it from the default
+ value (port 1862), so there is no need to uncomment this
+ line.</entry>
+ </row>
+ <row>
+ <entry><literal>agent-uuid</literal></entry>
+ <entry>A legal UUID value</entry>
+ <entry>Set internally</entry>
+ <entry>This value needs to be set explicitly only when configuring multiple
+ agents on the same host; normally, there is no need to
+ uncomment this line.</entry>
+ </row>
+ <row>
+ <entry><literal>log-file</literal></entry>
+ <entry>A valid path (optional) and filename (required)</entry>
+ <entry>Default: <filename>mysql-cluster-manager.log</filename></entry>
+ <entry>You can change this if desired, but there is no need to do so. Note that
+ a relative path is in relation to the &mcm; installation
+ directory, and not to the <filename>bin</filename> or
+ <filename>etc</filename> subdirectory.</entry>
+ </row>
+ <row>
+ <entry><literal>log-level</literal></entry>
+ <entry>The log event level</entry>
+ <entry>One of: <literal>debug</literal>, <literal>critical</literal>,
+ <literal>error</literal>, <literal>info</literal>,
+ <literal>message</literal>, <literal>warning</literal>.
+ Default: <literal>message</literal>.</entry>
+ <entry>This is the log event severity level; see
+ <xref linkend="refman-5.1:mysql-cluster-logging-management-commands"/>,
+ for definitions of the levels, which are the same as these
+ except that <literal>ALERT</literal> is mapped to
+ <literal>critical</literal> and the Unix syslog
+ <literal>LOG_NOTICE</literal> level is used, and mapped to
+ <literal>message</literal>. The <literal>debug</literal>,
+ <literal>message</literal>, and <literal>info</literal>
+ levels can result in rapid growth of the agent log, so for
+ normal operations, you may prefer to set this to
+ <literal>warning</literal> or <literal>error</literal>.</entry>
+ </row>
+ <row>
+ <entry><literal>pid-file</literal></entry>
+ <entry>A valid path to a process ID (<filename>.pid</filename>) file</entry>
+ <entry>Not normally used</entry>
+ <entry>By uncommenting this line, you can cause a process ID file to be created
+ as <filename>mysql-monitor-agent.pid</filename> in the
+ &mcm; installation directory, but this is not usually
+ necessary.</entry>
+ </row>
+ <row>
+ <entry><literal>manager-directory</literal></entry>
+ <entry>A valid path (relative to the &mcm; installation directory)</entry>
+ <entry>Default: <literal>manager</literal></entry>
+ <entry>The manager directory contains &mcm; data files and MySQL Cluster
+ configuration and data files. More information is provided
+ later in this section.</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+
<programlisting>
Starting the Agent
| Thread |
|---|
| • svn commit - mysqldoc@docsrva: r17857 - trunk/cluster-manager | jon.stephens | 27 Nov |
