Author: jstephens
Date: 2008-12-06 16:08:02 +0100 (Sat, 06 Dec 2008)
New Revision: 12820
Log:
Some wording fixes; define 'global configuration file'
Modified:
trunk/refman-4.1/mysql-cluster-configuration.xml
trunk/refman-5.0/mysql-cluster-configuration.xml
trunk/refman-5.1/mysql-cluster-configuration.xml
Modified: trunk/refman-4.1/mysql-cluster-configuration.xml
===================================================================
--- trunk/refman-4.1/mysql-cluster-configuration.xml 2008-12-06 14:38:37 UTC (rev 12819)
+++ trunk/refman-4.1/mysql-cluster-configuration.xml 2008-12-06 15:08:02 UTC (rev 12820)
Changed blocks: 4, Lines Added: 54, Lines Deleted: 46; 7612 bytes
@@ -403,12 +403,13 @@
<listitem>
<para>
- <filename>config.ini</filename>: This file is read only by the
- MySQL Cluster management server, which then distributes the
- information contained therein to all processes participating
- in the cluster. <filename>config.ini</filename> contains a
- description of each node involved in the cluster. This
- includes configuration parameters for data nodes and
+ <filename>config.ini</filename>: This file, sometimes known as
+ the <firstterm>global configuration file</firstterm>, is read
+ only by the MySQL Cluster management server, which then
+ distributes the information contained therein to all processes
+ participating in the cluster. <filename>config.ini</filename>
+ contains a description of each node involved in the cluster.
+ This includes configuration parameters for data nodes and
configuration parameters for connections between all nodes in
the cluster. For a quick reference to the sections that can
appear in this file, and what sorts of configuration
@@ -452,22 +453,25 @@
<para>
To support MySQL Cluster, you will need to update
<filename>my.cnf</filename> as shown in the following example.
- Note that the options shown here should not be confused with
- those that are used in <filename>config.ini</filename> files.
You may also specify these parameters on the command line when
invoking the executables.
</para>
<para>
- From version 4.1.8 some simplifications in
- <filename>my.cnf</filename> were made, including new sections
- for <literal>ndbcluster</literal> executables. However, these
- should not be confused with those occurring in
- <filename>config.ini</filename> files. As always, you may
- specify these parameters when invoking those executables from
- the command line.
+ In MySQL 4.1.8, some simplifications in
+ <filename>my.cnf</filename> were introduced, including new
+ sections for <literal>ndbcluster</literal> executables.
</para>
+ <note>
+ <para>
+ The options shown here should not be confused with those that
+ are used in <filename>config.ini</filename> global
+ configuration files. Global configuration options are
+ discussed later in this section.
+ </para>
+ </note>
+
<programlisting>
# my.cnf
# example additions to my.cnf for MySQL Cluster
@@ -545,10 +549,10 @@
</para>
<para>
- The configuration file is named <filename>config.ini</filename>
- by default. It is read by <command>ndb_mgmd</command> at startup
- and can be placed anywhere. Its location and name are specified
- by using
+ The MySQL Cluster global configuration file is named
+ <filename>config.ini</filename> by default. It is read by
+ <command>ndb_mgmd</command> at startup and can be placed
+ anywhere. Its location and name are specified by using
<option>--config-file=<replaceable>path_name</replaceable></option>
on the <command>ndb_mgmd</command> command line. If the
configuration file is not specified, <command>ndb_mgmd</command>
@@ -558,40 +562,44 @@
</para>
<para>
- Currently, the configuration file is in INI format, which
- consists of sections preceded by section headings (surrounded by
- square brackets), followed by the appropriate parameter names
- and values. One deviation from the standard INI format is that
- the parameter name and value can be separated by a colon
- (<quote><literal>:</literal></quote>) as well as the equals sign
- (<quote><literal>=</literal></quote>); however, the equals sign
- is preferred. Another deviation is that sections are not
- uniquely identified by section name. Instead, unique sections
- (such as two different nodes of the same type) are identified by
- a unique ID specified as a parameter within the section.
+ The global configuration file for MySQL Cluster uses INI format,
+ which consists of sections preceded by section headings
+ (surrounded by square brackets), followed by the appropriate
+ parameter names and values. One deviation from the standard INI
+ format is that the parameter name and value can be separated by
+ a colon (<quote><literal>:</literal></quote>) as well as the
+ equals sign (<quote><literal>=</literal></quote>); however, the
+ equals sign is preferred. Another deviation is that sections are
+ not uniquely identified by section name. Instead, unique
+ sections (such as two different nodes of the same type) are
+ identified by a unique ID specified as a parameter within the
+ section.
</para>
<para>
Default values are defined for most parameters, and can also be
- specified in <filename>config.ini</filename>. To create a
- default value section, simply add the word
- <literal>default</literal> to the section name. For example, an
- <literal>[ndbd]</literal> section contains parameters that apply
- to a particular data node, whereas an <literal>[ndbd
- default]</literal> section contains parameters that apply to all
- data nodes. Suppose that all data nodes should use the same data
- memory size. To configure them all, create an <literal>[ndbd
- default]</literal> section that contains a
- <literal>DataMemory</literal> line to specify the data memory
- size.
+ specified in <filename>config.ini</filename>.
+ (<emphasis>Exception</emphasis>: The
+ <literal>NoOfReplicas</literal> configuration parameter has no
+ default value, and must always be specified explicitly in the
+ <literal>[ndbd default]</literal> section.) To create a default
+ value section, simply add the word <literal>default</literal> to
+ the section name. For example, an <literal>[ndbd]</literal>
+ section contains parameters that apply to a particular data
+ node, whereas an <literal>[ndbd default]</literal> section
+ contains parameters that apply to all data nodes. Suppose that
+ all data nodes should use the same data memory size. To
+ configure them all, create an <literal>[ndbd default]</literal>
+ section that contains a <literal>DataMemory</literal> line to
+ specify the data memory size.
</para>
<para>
- At a minimum, the configuration file must define the computers
- and nodes involved in the cluster and on which computers these
- nodes are located. An example of a simple configuration file for
- a cluster consisting of one management server, two data nodes
- and two MySQL servers is shown here:
+ The global configuration file must define the computers and
+ nodes involved in the cluster and on which computers these nodes
+ are located. An example of a simple configuration file for a
+ cluster consisting of one management server, two data nodes and
+ two MySQL servers is shown here:
</para>
<programlisting>
Modified: trunk/refman-5.0/mysql-cluster-configuration.xml
===================================================================
--- trunk/refman-5.0/mysql-cluster-configuration.xml 2008-12-06 14:38:37 UTC (rev 12819)
+++ trunk/refman-5.0/mysql-cluster-configuration.xml 2008-12-06 15:08:02 UTC (rev 12820)
Changed blocks: 4, Lines Added: 51, Lines Deleted: 39; 6997 bytes
@@ -402,12 +402,13 @@
<listitem>
<para>
- <filename>config.ini</filename>: This file is read only by the
- MySQL Cluster management server, which then distributes the
- information contained therein to all processes participating
- in the cluster. <filename>config.ini</filename> contains a
- description of each node involved in the cluster. This
- includes configuration parameters for data nodes and
+ <filename>config.ini</filename>: This file, sometimes known as
+ the <firstterm>global configuration file</firstterm>, is read
+ only by the MySQL Cluster management server, which then
+ distributes the information contained therein to all processes
+ participating in the cluster. <filename>config.ini</filename>
+ contains a description of each node involved in the cluster.
+ This includes configuration parameters for data nodes and
configuration parameters for connections between all nodes in
the cluster. For a quick reference to the sections that can
appear in this file, and what sorts of configuration
@@ -451,12 +452,19 @@
<para>
To support MySQL Cluster, you will need to update
<filename>my.cnf</filename> as shown in the following example.
- Note that the options shown here should not be confused with
- those that are used in <filename>config.ini</filename> files.
You may also specify these parameters on the command line when
invoking the executables.
</para>
+ <note>
+ <para>
+ The options shown here should not be confused with those that
+ are used in <filename>config.ini</filename> global
+ configuration files. Global configuration options are
+ discussed later in this section.
+ </para>
+ </note>
+
<programlisting>
# my.cnf
# example additions to my.cnf for MySQL Cluster
@@ -533,10 +541,10 @@
</para>
<para>
- The configuration file is named <filename>config.ini</filename>
- by default. It is read by <command>ndb_mgmd</command> at startup
- and can be placed anywhere. Its location and name are specified
- by using
+ The MySQL Cluster global configuration file is named
+ <filename>config.ini</filename> by default. It is read by
+ <command>ndb_mgmd</command> at startup and can be placed
+ anywhere. Its location and name are specified by using
<option>--config-file=<replaceable>path_name</replaceable></option>
on the <command>ndb_mgmd</command> command line. If the
configuration file is not specified, <command>ndb_mgmd</command>
@@ -546,40 +554,44 @@
</para>
<para>
- Currently, the configuration file is in INI format, which
- consists of sections preceded by section headings (surrounded by
- square brackets), followed by the appropriate parameter names
- and values. One deviation from the standard INI format is that
- the parameter name and value can be separated by a colon
- (<quote><literal>:</literal></quote>) as well as the equals sign
- (<quote><literal>=</literal></quote>); however, the equals sign
- is preferred. Another deviation is that sections are not
- uniquely identified by section name. Instead, unique sections
- (such as two different nodes of the same type) are identified by
- a unique ID specified as a parameter within the section.
+ The global configuration file for MySQL Cluster uses INI format,
+ which consists of sections preceded by section headings
+ (surrounded by square brackets), followed by the appropriate
+ parameter names and values. One deviation from the standard INI
+ format is that the parameter name and value can be separated by
+ a colon (<quote><literal>:</literal></quote>) as well as the
+ equals sign (<quote><literal>=</literal></quote>); however, the
+ equals sign is preferred. Another deviation is that sections are
+ not uniquely identified by section name. Instead, unique
+ sections (such as two different nodes of the same type) are
+ identified by a unique ID specified as a parameter within the
+ section.
</para>
<para>
Default values are defined for most parameters, and can also be
- specified in <filename>config.ini</filename>. To create a
- default value section, simply add the word
- <literal>default</literal> to the section name. For example, an
- <literal>[ndbd]</literal> section contains parameters that apply
- to a particular data node, whereas an <literal>[ndbd
- default]</literal> section contains parameters that apply to all
- data nodes. Suppose that all data nodes should use the same data
- memory size. To configure them all, create an <literal>[ndbd
- default]</literal> section that contains a
- <literal>DataMemory</literal> line to specify the data memory
- size.
+ specified in <filename>config.ini</filename>.
+ (<emphasis>Exception</emphasis>: The
+ <literal>NoOfReplicas</literal> configuration parameter has no
+ default value, and must always be specified explicitly in the
+ <literal>[ndbd default]</literal> section.) To create a default
+ value section, simply add the word <literal>default</literal> to
+ the section name. For example, an <literal>[ndbd]</literal>
+ section contains parameters that apply to a particular data
+ node, whereas an <literal>[ndbd default]</literal> section
+ contains parameters that apply to all data nodes. Suppose that
+ all data nodes should use the same data memory size. To
+ configure them all, create an <literal>[ndbd default]</literal>
+ section that contains a <literal>DataMemory</literal> line to
+ specify the data memory size.
</para>
<para>
- At a minimum, the configuration file must define the computers
- and nodes involved in the cluster and on which computers these
- nodes are located. An example of a simple configuration file for
- a cluster consisting of one management server, two data nodes
- and two MySQL servers is shown here:
+ The global configuration file must define the computers and
+ nodes involved in the cluster and on which computers these nodes
+ are located. An example of a simple configuration file for a
+ cluster consisting of one management server, two data nodes and
+ two MySQL servers is shown here:
</para>
<programlisting>
Modified: trunk/refman-5.1/mysql-cluster-configuration.xml
===================================================================
--- trunk/refman-5.1/mysql-cluster-configuration.xml 2008-12-06 14:38:37 UTC (rev 12819)
+++ trunk/refman-5.1/mysql-cluster-configuration.xml 2008-12-06 15:08:02 UTC (rev 12820)
Changed blocks: 4, Lines Added: 51, Lines Deleted: 39; 6997 bytes
@@ -413,12 +413,13 @@
<listitem>
<para>
- <filename>config.ini</filename>: This file is read only by the
- MySQL Cluster management server, which then distributes the
- information contained therein to all processes participating
- in the cluster. <filename>config.ini</filename> contains a
- description of each node involved in the cluster. This
- includes configuration parameters for data nodes and
+ <filename>config.ini</filename>: This file, sometimes known as
+ the <firstterm>global configuration file</firstterm>, is read
+ only by the MySQL Cluster management server, which then
+ distributes the information contained therein to all processes
+ participating in the cluster. <filename>config.ini</filename>
+ contains a description of each node involved in the cluster.
+ This includes configuration parameters for data nodes and
configuration parameters for connections between all nodes in
the cluster. For a quick reference to the sections that can
appear in this file, and what sorts of configuration
@@ -462,12 +463,19 @@
<para>
To support MySQL Cluster, you will need to update
<filename>my.cnf</filename> as shown in the following example.
- Note that the options shown here should not be confused with
- those that are used in <filename>config.ini</filename> files.
You may also specify these parameters on the command line when
invoking the executables.
</para>
+ <note>
+ <para>
+ The options shown here should not be confused with those that
+ are used in <filename>config.ini</filename> global
+ configuration files. Global configuration options are
+ discussed later in this section.
+ </para>
+ </note>
+
<programlisting>
# my.cnf
# example additions to my.cnf for MySQL Cluster
@@ -544,10 +552,10 @@
</para>
<para>
- The configuration file is named <filename>config.ini</filename>
- by default. It is read by <command>ndb_mgmd</command> at startup
- and can be placed anywhere. Its location and name are specified
- by using
+ The MySQL Cluster global configuration file is named
+ <filename>config.ini</filename> by default. It is read by
+ <command>ndb_mgmd</command> at startup and can be placed
+ anywhere. Its location and name are specified by using
<option>--config-file=<replaceable>path_name</replaceable></option>
on the <command>ndb_mgmd</command> command line. If the
configuration file is not specified, <command>ndb_mgmd</command>
@@ -557,40 +565,44 @@
</para>
<para>
- Currently, the configuration file is in INI format, which
- consists of sections preceded by section headings (surrounded by
- square brackets), followed by the appropriate parameter names
- and values. One deviation from the standard INI format is that
- the parameter name and value can be separated by a colon
- (<quote><literal>:</literal></quote>) as well as the equals sign
- (<quote><literal>=</literal></quote>); however, the equals sign
- is preferred. Another deviation is that sections are not
- uniquely identified by section name. Instead, unique sections
- (such as two different nodes of the same type) are identified by
- a unique ID specified as a parameter within the section.
+ The global configuration file for MySQL Cluster uses INI format,
+ which consists of sections preceded by section headings
+ (surrounded by square brackets), followed by the appropriate
+ parameter names and values. One deviation from the standard INI
+ format is that the parameter name and value can be separated by
+ a colon (<quote><literal>:</literal></quote>) as well as the
+ equals sign (<quote><literal>=</literal></quote>); however, the
+ equals sign is preferred. Another deviation is that sections are
+ not uniquely identified by section name. Instead, unique
+ sections (such as two different nodes of the same type) are
+ identified by a unique ID specified as a parameter within the
+ section.
</para>
<para>
Default values are defined for most parameters, and can also be
- specified in <filename>config.ini</filename>. To create a
- default value section, simply add the word
- <literal>default</literal> to the section name. For example, an
- <literal>[ndbd]</literal> section contains parameters that apply
- to a particular data node, whereas an <literal>[ndbd
- default]</literal> section contains parameters that apply to all
- data nodes. Suppose that all data nodes should use the same data
- memory size. To configure them all, create an <literal>[ndbd
- default]</literal> section that contains a
- <literal>DataMemory</literal> line to specify the data memory
- size.
+ specified in <filename>config.ini</filename>.
+ (<emphasis>Exception</emphasis>: The
+ <literal>NoOfReplicas</literal> configuration parameter has no
+ default value, and must always be specified explicitly in the
+ <literal>[ndbd default]</literal> section.) To create a default
+ value section, simply add the word <literal>default</literal> to
+ the section name. For example, an <literal>[ndbd]</literal>
+ section contains parameters that apply to a particular data
+ node, whereas an <literal>[ndbd default]</literal> section
+ contains parameters that apply to all data nodes. Suppose that
+ all data nodes should use the same data memory size. To
+ configure them all, create an <literal>[ndbd default]</literal>
+ section that contains a <literal>DataMemory</literal> line to
+ specify the data memory size.
</para>
<para>
- At a minimum, the configuration file must define the computers
- and nodes involved in the cluster and on which computers these
- nodes are located. An example of a simple configuration file for
- a cluster consisting of one management server, two data nodes
- and two MySQL servers is shown here:
+ The global configuration file must define the computers and
+ nodes involved in the cluster and on which computers these nodes
+ are located. An example of a simple configuration file for a
+ cluster consisting of one management server, two data nodes and
+ two MySQL servers is shown here:
</para>
<programlisting>
| Thread |
|---|
| • svn commit - mysqldoc@docsrva: r12820 - in trunk: refman-4.1 refman-5.0 refman-5.1 | jon | 6 Dec |
