Author: jstephens
Date: 2007-01-19 10:35:04 +0100 (Fri, 19 Jan 2007)
New Revision: 4568
Log:
Added info on RPM installation to Cluster installation/configuration how-to.
Modified:
branches/telcos/refman-5.0/mysql-cluster.xml
branches/telcos/refman-5.1/mysql-cluster.xml
trunk/refman-4.1/mysql-cluster.xml
trunk/refman-5.0/mysql-cluster.xml
trunk/refman-5.1/mysql-cluster.xml
Modified: branches/telcos/refman-5.0/mysql-cluster.xml
===================================================================
--- branches/telcos/refman-5.0/mysql-cluster.xml 2007-01-19 04:33:03 UTC (rev 4567)
+++ branches/telcos/refman-5.0/mysql-cluster.xml 2007-01-19 09:35:04 UTC (rev 4568)
Changed blocks: 10, Lines Added: 216, Lines Deleted: 40; 14493 bytes
@@ -1086,26 +1086,105 @@
<para>
RPMs are also available for both 32-bit and 64-bit Linux
- platforms. (See <xref linkend="linux-rpm"/>, for more
- information about installing MySQL using the RPMs.) After
- installing from RPM, you will still need to configure the
+ platforms. For a MySQL Cluster, four RPMs are required:
+ </para>
+
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ The <emphasis role="bold">Server</emphasis> RPM (for
+ example,
+ <filename>MySQL-server-¤t-version;-0.glibc23.i386.rpm</filename>),
+ which supplies the core files needed to run a MySQL Server.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ The <emphasis role="bold">Server/Max</emphasis> RPM (for
+ example,
+ <filename>MySQL-Max-¤t-version;-0.glibc23.i386.rpm</filename>),
+ which provides a MySQL Server binary with clustering
+ support.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ The <emphasis role="bold">NDB Cluster - Storage
+ engine</emphasis> RPM (for example,
+ <filename>MySQL-ndb-storage-¤t-version;-0.glibc23.i386.rpm</filename>),
+ which supplies the MySQL Cluster data node binary
+ (<command>ndbd</command>).
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ The <emphasis role="bold">NDB Cluster - Storage engine
+ management RPM</emphasis> (for example,
+ <filename>MySQL-ndb-management-¤t-version;-0.glibc23.i386.rpm</filename>),
+ which provides the MySQL Cluster management server binary
+ (<command>ndb_mgmd</command>).
+ </para>
+ </listitem>
+
+ </itemizedlist>
+
+ <para>
+ In addition, you should also obtain the
+ <emphasis role="bold">NDB Cluster - Storage engine basic
+ tools</emphasis> RPM (for example,
+ <filename>MySQL-ndb-tools-5.0.27-0.glibc23.i386.rpm</filename>),
+ which supplies several useful applications for working with a
+ MySQL Cluster. The most important of the these is the MySQL
+ Cluster management client (<command>ndb_mgm</command>). The
+ <emphasis role="bold">NDB Cluster - Storage engine extra
+ tools</emphasis> RPM (for example,
+ <filename>MySQL-ndb-extra-5.0.27-0.glibc23.i386.rpm</filename>)
+ contains some additional testing and monitoring programs, but is
+ not required to install a MySQL Cluster. (For more information
+ about these additional programs, see
+ <xref linkend="mysql-cluster-utilities"/>.)
+ </para>
+
+ <para>
+ The MySQL version number in the RPM filenames (shown here as
+ <literal>¤t-version;</literal>) can vary according to the
+ version which you are actually using. <emphasis>It is very
+ important that all of the Cluster RPMs to be installed have the
+ same MySQL version number</emphasis>. The
+ <literal>glibc</literal> version number (if present —
+ shown here as <literal>glibc23</literal>), and architecture
+ designation (shown here as <literal>i386</literal>) should be
+ appropriate to the machine on which the RPM is to be installed.
+ </para>
+
+ <para>
+ See <xref linkend="linux-rpm"/>, for general information about
+ installing MySQL using RPMs supplied by MySQL AB.
+ </para>
+
+ <para>
+ After installing from RPM, you still need to configure the
cluster as discussed in
<xref linkend="mysql-cluster-multi-config"/>.
</para>
<para>
<emphasis role="bold">Note</emphasis>: After completing the
- installation, do not yet start any of the binaries. We will show
- you how to do so following the configuration of all nodes.
+ installation, do not yet start any of the binaries. We show you
+ how to do so following the configuration of all nodes.
</para>
<para>
- <emphasis role="bold">Storage and SQL Node
- Installation</emphasis>
+ <emphasis role="bold">Data and SQL Node Installation —
+ <filename>.tar.gz</filename> Binary</emphasis>
</para>
<para>
- On each of the three machines designated to host storage or SQL
+ On each of the machines designated to host data or SQL
nodes, perform the following steps as the system
<literal>root</literal> user:
</para>
@@ -1116,7 +1195,7 @@
<para>
Check your <filename>/etc/passwd</filename> and
<filename>/etc/group</filename> files (or use whatever tools
- are provided by your operating system for manging users and
+ are provided by your operating system for managing users and
groups) to see whether there is already a
<literal>mysql</literal> group and <literal>mysql</literal>
user on the system. Some OS distributions create these as
@@ -1223,14 +1302,71 @@
<para>
Remember that the preceding steps must be performed separately
- for each machine on which a storage or SQL node is to reside.
+ on each machine where a data node or SQL node is to reside.
</para>
<para>
- <emphasis role="bold">Management Node Installation</emphasis>
+ <emphasis role="bold">SQL Node Installation — RPM
+ Files</emphasis>
</para>
<para>
+ On each machine to be used for hosting a cluster SQL node,
+ install the <emphasis role="bold">MySQL Max</emphasis> RPM by
+ executing the following command as the system root user,
+ replacing the name shown for the RPM as necessary to match the
+ name of the RPM downloaded from the MySQL AB web site:
+ </para>
+
+<programlisting>
+shell> <userinput>rpm -Uhv MySQL-server-¤t-version;-0.glibc23.i386.rpm</userinput>
+shell> <userinput>rpm -Uhv MySQL-Max-¤t-version;-0.glibc23.i386.rpm</userinput>
+</programlisting>
+
+ <para>
+ This installs the MySQL Max server binary
+ (<command>mysqld-max</command>) in the
+ <filename>/usr/sbin</filename> directory, as well as all needed
+ MySQL Server support files. It also installs the
+ <command>mysql.server</command> and
+ <command>mysqld_safe</command> startup scripts in
+ <filename>/usr/share/mysql</filename> and
+ <filename>/usr/bin</filename>, respectively. The RPM installer
+ should take care of general configuration issues (such as
+ creating the <literal>mysql</literal> user and group, if needed)
+ automatically.
+ </para>
+
+ <para>
+ <emphasis role="bold">Data Node Installation — RPM
+ Files</emphasis>
+ </para>
+
+ <para>
+ On a computer that is to host a cluster data node it is
+ necessary to install only the <emphasis role="bold">NDB Cluster
+ - Storage engine</emphasis> RPM. To do so, copy this RPM to the
+ data node host, and run the following command as the system root
+ user, replacing the name shown for the RPM as necessary to match
+ that of the RPM downloaded from the MySQL AB web site:
+ </para>
+
+<programlisting>
+shell> <userinput>rpm -Uhv MySQL-ndb-storage-¤t-version;-0.glibc23.i386.rpm</userinput>
+</programlisting>
+
+ <para>
+ The previous command installs the MySQL Cluster data node binary
+ (<command>ndbd</command>) in the <filename>/usr/sbin</filename>
+ directory.
+ </para>
+
+ <para>
+ <emphasis role="bold">Management Node Installation —
+ <filename>.tar.gz</filename> Binary</emphasis>
+ </para>
+
+ <para>
Installation for the management (MGM) node does not require
installation of the <command>mysqld</command> binary. Only the
binaries for the MGM server and client are required, which can
@@ -1288,11 +1424,58 @@
</orderedlist>
<para>
- In <xref linkend="mysql-cluster-multi-config"/>, we will create
- and write configuration files for all of the nodes in our
- example Cluster.
+ <emphasis role="bold">Management Node Installation — RPM
+ File</emphasis>
</para>
+ <para>
+ To install the MySQL Cluster management server, it is necessary
+ only to use the <emphasis role="bold">NDB Cluster - Storage
+ engine management</emphasis> RPM. Copy this RPM to the computer
+ intended to host the management node, and then install it by
+ running the following command as the system root user (replace
+ the name shown for the RPM as necessary to match that of the
+ <emphasis role="bold">Storage engine management</emphasis> RPM
+ downloaded from the MySQL AB web site):
+ </para>
+
+<programlisting>
+shell> <userinput>rpm -Uhv MySQL-ndb-management-¤t-version;-0.glibc23.i386.rpm</userinput>
+</programlisting>
+
+ <para>
+ This installs the management server binary
+ (<command>ndb_mgmd</command>) to the
+ <filename>/usr/sbin</filename> directory.
+ </para>
+
+ <para>
+ You should also install the <literal>NDB</literal> management
+ client, which is supplied by the <emphasis role="bold">Storage
+ engine basic tools</emphasis> RPM. Copy this RPM to the same
+ computer as the management node, and then install it by running
+ the following command as the system root user (again, replace
+ the name shown for the RPM as necessary to match that of the
+ <emphasis role="bold">Storage engine basic tools</emphasis> RPM
+ downloaded from the MySQL AB web site):
+ </para>
+
+<programlisting>
+shell> rpm -Uhv <userinput>MySQL-ndb-tools-¤t-version;-0.glibc23.i386.rpm</userinput>
+</programlisting>
+
+ <para>
+ The <emphasis role="bold">Storage engine basic tools</emphasis>
+ RPM installs the MySQL Cluster management client
+ (<command>ndb_mgm</command>) to the
+ <filename>/usr/bin</filename> directory.
+ </para>
+
+ <para>
+ In <xref linkend="mysql-cluster-multi-config"/>, we create
+ configuration files for all of the nodes in our example Cluster.
+ </para>
+
</section>
<section id="mysql-cluster-multi-config">
@@ -1314,8 +1497,8 @@
</indexterm>
<para>
- For our four-node, four-host MySQL Cluster, we will need to
- write four configuration files, one per node/host.
+ For our four-node, four-host MySQL Cluster, it is necessary to
+ write four configuration files, one per node host.
</para>
<itemizedlist>
@@ -1324,18 +1507,12 @@
<para>
Each data node or SQL node requires a
<filename>my.cnf</filename> file that provides two pieces of
- information: a
- <emphasis role="bold">connectstring</emphasis> telling the
- node where to find the MGM node, and a line telling the
- MySQL server on this host (the machine hosting the data
- node) to run in NDB mode.
+ information: a <firstterm>connectstring</firstterm> that
+ tells the node where to find the MGM node, and a line
+ telling the MySQL server on this host (the machine hosting
+ the data node) to run in NDB mode.
</para>
- <remark role="todo">
- Would "connection string" be a better choice than
- "connectstring"?
- </remark>
-
<para>
For more information on connectstrings, see
<xref linkend="mysql-cluster-connectstring"/>.
@@ -1384,12 +1561,12 @@
<programlisting>
# Options for mysqld process:
[MYSQLD]
-ndbcluster # run NDB engine
-ndb-connectstring=192.168.0.10 # location of MGM node
+ndbcluster # run NDB storage engine
+ndb-connectstring=192.168.0.10 # location of management server
# Options for ndbd process:
[MYSQL_CLUSTER]
-ndb-connectstring=192.168.0.10 # location of MGM node
+ndb-connectstring=192.168.0.10 # location of management server
</programlisting>
<para>
@@ -1480,7 +1657,7 @@
(<emphasis role="bold">Note</emphasis>: The
<literal>world</literal> database can be downloaded from
<ulink url="&base-url-docs;"/>, where it can be found listed
- under <quote>Examples.</quote>)
+ under <quote>Examples</quote>.)
</para>
<para>
@@ -1522,10 +1699,9 @@
<para>
Starting the cluster is not very difficult after it has been
configured. Each cluster node process must be started
- separately, and on the host where it resides. Although it is
- possible to start the nodes in any order, it is recommended that
- the management node be started first, followed by the storage
- nodes, and then finally by any SQL nodes:
+ separately, and on the host where it resides. The management
+ node ahould be started first, followed by the data nodes, and
+ then finally by any SQL nodes:
</para>
<orderedlist>
@@ -1581,12 +1757,12 @@
<para>
If you used RPM files to install MySQL on the cluster host
where the SQL node is to reside, you can (and should) use
- the startup script installed in
- <filename>/etc/init.d</filename> to start the MySQL server
- process on the SQL node. Note that you need to install the
- <literal>-max</literal> server RPM <emphasis>in addition
- to</emphasis> the Standard server RPM to run the
- <literal>-max</literal> server binary.
+ the supplied startup script to start the MySQL server
+ process on the SQL node. As mention previously, you must
+ install the <emphasis role="bold">Server / Max</emphasis>
+ RPM <emphasis>in addition to</emphasis> the
+ <emphasis role="bold">Server</emphasis> RPM to obtain and
+ run the <command>mysqld-max</command> server binary.
</para>
</listitem>
Modified: branches/telcos/refman-5.1/mysql-cluster.xml
===================================================================
--- branches/telcos/refman-5.1/mysql-cluster.xml 2007-01-19 04:33:03 UTC (rev 4567)
+++ branches/telcos/refman-5.1/mysql-cluster.xml 2007-01-19 09:35:04 UTC (rev 4568)
Changed blocks: 11, Lines Added: 219, Lines Deleted: 40; 14816 bytes
@@ -1084,26 +1084,105 @@
<para>
RPMs are also available for both 32-bit and 64-bit Linux
- platforms. (See <xref linkend="linux-rpm"/>, for more
- information about installing MySQL using the RPMs.) After
- installing from RPM, you will still need to configure the
+ platforms. For a MySQL Cluster, four RPMs are required:
+ </para>
+
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ The <emphasis role="bold">Server</emphasis> RPM (for
+ example,
+ <filename>MySQL-server-¤t-version;-0.glibc23.i386.rpm</filename>),
+ which supplies the core files needed to run a MySQL Server.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ The <emphasis role="bold">Server/Max</emphasis> RPM (for
+ example,
+ <filename>MySQL-Max-¤t-version;-0.glibc23.i386.rpm</filename>),
+ which provides a MySQL Server binary with clustering
+ support.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ The <emphasis role="bold">NDB Cluster - Storage
+ engine</emphasis> RPM (for example,
+ <filename>MySQL-ndb-storage-¤t-version;-0.glibc23.i386.rpm</filename>),
+ which supplies the MySQL Cluster data node binary
+ (<command>ndbd</command>).
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ The <emphasis role="bold">NDB Cluster - Storage engine
+ management RPM</emphasis> (for example,
+ <filename>MySQL-ndb-management-¤t-version;-0.glibc23.i386.rpm</filename>),
+ which provides the MySQL Cluster management server binary
+ (<command>ndb_mgmd</command>).
+ </para>
+ </listitem>
+
+ </itemizedlist>
+
+ <para>
+ In addition, you should also obtain the
+ <emphasis role="bold">NDB Cluster - Storage engine basic
+ tools</emphasis> RPM (for example,
+ <filename>MySQL-ndb-tools-5.0.27-0.glibc23.i386.rpm</filename>),
+ which supplies several useful applications for working with a
+ MySQL Cluster. The most important of the these is the MySQL
+ Cluster management client (<command>ndb_mgm</command>). The
+ <emphasis role="bold">NDB Cluster - Storage engine extra
+ tools</emphasis> RPM (for example,
+ <filename>MySQL-ndb-extra-5.0.27-0.glibc23.i386.rpm</filename>)
+ contains some additional testing and monitoring programs, but is
+ not required to install a MySQL Cluster. (For more information
+ about these additional programs, see
+ <xref linkend="mysql-cluster-utilities"/>.)
+ </para>
+
+ <para>
+ The MySQL version number in the RPM filenames (shown here as
+ <literal>¤t-version;</literal>) can vary according to the
+ version which you are actually using. <emphasis>It is very
+ important that all of the Cluster RPMs to be installed have the
+ same MySQL version number</emphasis>. The
+ <literal>glibc</literal> version number (if present —
+ shown here as <literal>glibc23</literal>), and architecture
+ designation (shown here as <literal>i386</literal>) should be
+ appropriate to the machine on which the RPM is to be installed.
+ </para>
+
+ <para>
+ See <xref linkend="linux-rpm"/>, for general information about
+ installing MySQL using RPMs supplied by MySQL AB.
+ </para>
+
+ <para>
+ After installing from RPM, you still need to configure the
cluster as discussed in
<xref linkend="mysql-cluster-multi-config"/>.
</para>
<para>
<emphasis role="bold">Note</emphasis>: After completing the
- installation, do not yet start any of the binaries. We will show
- you how to do so following the configuration of all nodes.
+ installation, do not yet start any of the binaries. We show you
+ how to do so following the configuration of all nodes.
</para>
<para>
- <emphasis role="bold">Storage and SQL Node
- Installation</emphasis>
+ <emphasis role="bold">Data and SQL Node Installation —
+ <filename>.tar.gz</filename> Binary</emphasis>
</para>
<para>
- On each of the three machines designated to host storage or SQL
+ On each of the machines designated to host data or SQL
nodes, perform the following steps as the system
<literal>root</literal> user:
</para>
@@ -1114,7 +1193,7 @@
<para>
Check your <filename>/etc/passwd</filename> and
<filename>/etc/group</filename> files (or use whatever tools
- are provided by your operating system for manging users and
+ are provided by your operating system for managing users and
groups) to see whether there is already a
<literal>mysql</literal> group and <literal>mysql</literal>
user on the system. Some OS distributions create these as
@@ -1141,9 +1220,9 @@
<para>
Change location to the directory containing the downloaded
file, unpack the archive, and create a symlink to the
- <filename>mysql</filename> directory. Note that the actual
- file and directory names will vary according to the MySQL
- version number.
+ <filename>mysql</filename>. Note that the actual file and
+ directory names will vary according to the MySQL version
+ number.
</para>
<programlisting>
@@ -1220,14 +1299,71 @@
<para>
Remember that the preceding steps must be performed separately
- for each machine on which a storage or SQL node is to reside.
+ on each machine where a data node or SQL node is to reside.
</para>
<para>
- <emphasis role="bold">Management Node Installation</emphasis>
+ <emphasis role="bold">SQL Node Installation — RPM
+ Files</emphasis>
</para>
<para>
+ On each machine to be used for hosting a cluster SQL node,
+ install the <emphasis role="bold">MySQL Max</emphasis> RPM by
+ executing the following command as the system root user,
+ replacing the name shown for the RPM as necessary to match the
+ name of the RPM downloaded from the MySQL AB web site:
+ </para>
+
+<programlisting>
+shell> <userinput>rpm -Uhv MySQL-server-¤t-version;-0.glibc23.i386.rpm</userinput>
+shell> <userinput>rpm -Uhv MySQL-Max-¤t-version;-0.glibc23.i386.rpm</userinput>
+</programlisting>
+
+ <para>
+ This installs the MySQL Max server binary
+ (<command>mysqld-max</command>) in the
+ <filename>/usr/sbin</filename> directory, as well as all needed
+ MySQL Server support files. It also installs the
+ <command>mysql.server</command> and
+ <command>mysqld_safe</command> startup scripts in
+ <filename>/usr/share/mysql</filename> and
+ <filename>/usr/bin</filename>, respectively. The RPM installer
+ should take care of general configuration issues (such as
+ creating the <literal>mysql</literal> user and group, if needed)
+ automatically.
+ </para>
+
+ <para>
+ <emphasis role="bold">Data Node Installation — RPM
+ Files</emphasis>
+ </para>
+
+ <para>
+ On a computer that is to host a cluster data node it is
+ necessary to install only the <emphasis role="bold">NDB Cluster
+ - Storage engine</emphasis> RPM. To do so, copy this RPM to the
+ data node host, and run the following command as the system root
+ user, replacing the name shown for the RPM as necessary to match
+ that of the RPM downloaded from the MySQL AB web site:
+ </para>
+
+<programlisting>
+shell> <userinput>rpm -Uhv MySQL-ndb-storage-¤t-version;-0.glibc23.i386.rpm</userinput>
+</programlisting>
+
+ <para>
+ The previous command installs the MySQL Cluster data node binary
+ (<command>ndbd</command>) in the <filename>/usr/sbin</filename>
+ directory.
+ </para>
+
+ <para>
+ <emphasis role="bold">Management Node Installation —
+ <filename>.tar.gz</filename> Binary</emphasis>
+ </para>
+
+ <para>
Installation for the management (MGM) node does not require
installation of the <command>mysqld</command> binary. Only the
binaries for the MGM server and client are required, which can
@@ -1285,11 +1421,58 @@
</orderedlist>
<para>
- In <xref linkend="mysql-cluster-multi-config"/>, we will create
- and write configuration files for all of the nodes in our
- example Cluster.
+ <emphasis role="bold">Management Node Installation — RPM
+ File</emphasis>
</para>
+ <para>
+ To install the MySQL Cluster management server, it is necessary
+ only to use the <emphasis role="bold">NDB Cluster - Storage
+ engine management</emphasis> RPM. Copy this RPM to the computer
+ intended to host the management node, and then install it by
+ running the following command as the system root user (replace
+ the name shown for the RPM as necessary to match that of the
+ <emphasis role="bold">Storage engine management</emphasis> RPM
+ downloaded from the MySQL AB web site):
+ </para>
+
+<programlisting>
+shell> <userinput>rpm -Uhv MySQL-ndb-management-¤t-version;-0.glibc23.i386.rpm</userinput>
+</programlisting>
+
+ <para>
+ This installs the management server binary
+ (<command>ndb_mgmd</command>) to the
+ <filename>/usr/sbin</filename> directory.
+ </para>
+
+ <para>
+ You should also install the <literal>NDB</literal> management
+ client, which is supplied by the <emphasis role="bold">Storage
+ engine basic tools</emphasis> RPM. Copy this RPM to the same
+ computer as the management node, and then install it by running
+ the following command as the system root user (again, replace
+ the name shown for the RPM as necessary to match that of the
+ <emphasis role="bold">Storage engine basic tools</emphasis> RPM
+ downloaded from the MySQL AB web site):
+ </para>
+
+<programlisting>
+shell> rpm -Uhv <userinput>MySQL-ndb-tools-¤t-version;-0.glibc23.i386.rpm</userinput>
+</programlisting>
+
+ <para>
+ The <emphasis role="bold">Storage engine basic tools</emphasis>
+ RPM installs the MySQL Cluster management client
+ (<command>ndb_mgm</command>) to the
+ <filename>/usr/bin</filename> directory.
+ </para>
+
+ <para>
+ In <xref linkend="mysql-cluster-multi-config"/>, we create
+ configuration files for all of the nodes in our example Cluster.
+ </para>
+
</section>
<section id="mysql-cluster-multi-config">
@@ -1311,8 +1494,8 @@
</indexterm>
<para>
- For our four-node, four-host MySQL Cluster, we will need to
- write four configuration files, one per node/host.
+ For our four-node, four-host MySQL Cluster, it is necessary to
+ write four configuration files, one per node host.
</para>
<itemizedlist>
@@ -1321,18 +1504,12 @@
<para>
Each data node or SQL node requires a
<filename>my.cnf</filename> file that provides two pieces of
- information: a
- <emphasis role="bold">connectstring</emphasis> telling the
- node where to find the MGM node, and a line telling the
- MySQL server on this host (the machine hosting the data
- node) to run in NDB mode.
+ information: a <firstterm>connectstring</firstterm> that
+ tells the node where to find the MGM node, and a line
+ telling the MySQL server on this host (the machine hosting
+ the data node) to run in NDB mode.
</para>
- <remark role="todo">
- Would "connection string" be a better choice than
- "connectstring"?
- </remark>
-
<para>
For more information on connectstrings, see
<xref linkend="mysql-cluster-connectstring"/>.
@@ -1381,12 +1558,12 @@
<programlisting>
# Options for mysqld process:
[MYSQLD]
-ndbcluster # run NDB engine
-ndb-connectstring=192.168.0.10 # location of MGM node
+ndbcluster # run NDB storage engine
+ndb-connectstring=192.168.0.10 # location of management server
# Options for ndbd process:
[MYSQL_CLUSTER]
-ndb-connectstring=192.168.0.10 # location of MGM node
+ndb-connectstring=192.168.0.10 # location of management server
</programlisting>
<para>
@@ -1477,7 +1654,7 @@
(<emphasis role="bold">Note</emphasis>: The
<literal>world</literal> database can be downloaded from
<ulink url="&base-url-docs;"/>, where it can be found listed
- under <quote>Examples.</quote>)
+ under <quote>Examples</quote>.)
</para>
<para>
@@ -1519,10 +1696,9 @@
<para>
Starting the cluster is not very difficult after it has been
configured. Each cluster node process must be started
- separately, and on the host where it resides. Although it is
- possible to start the nodes in any order, it is recommended that
- the management node be started first, followed by the storage
- nodes, and then finally by any SQL nodes:
+ separately, and on the host where it resides. The management
+ node ahould be started first, followed by the data nodes, and
+ then finally by any SQL nodes:
</para>
<orderedlist>
@@ -1585,9 +1761,12 @@
<para>
If you used RPM files to install MySQL on the cluster host
where the SQL node is to reside, you can (and should) use
- the startup script installed in
- <filename>/etc/init.d</filename> to start the MySQL server
- process on the SQL node.
+ the supplied startup script to start the MySQL server
+ process on the SQL node. As mention previously, you must
+ install the <emphasis role="bold">Server / Max</emphasis>
+ RPM <emphasis>in addition to</emphasis> the
+ <emphasis role="bold">Server</emphasis> RPM to obtain and
+ run the <command>mysqld-max</command> server binary.
</para>
</listitem>
Modified: trunk/refman-4.1/mysql-cluster.xml
===================================================================
--- trunk/refman-4.1/mysql-cluster.xml 2007-01-19 04:33:03 UTC (rev 4567)
+++ trunk/refman-4.1/mysql-cluster.xml 2007-01-19 09:35:04 UTC (rev 4568)
Changed blocks: 11, Lines Added: 220, Lines Deleted: 49; 15555 bytes
@@ -1066,9 +1066,10 @@
have installed on it a MySQL-max binary. For management nodes,
it is not necessary to install the MySQL server binary, but you
do have to install the MGM server daemon and client binaries
- (<command>ndb_mgmd</command> and <command>ndb_mgm</command>,
- respectively). This section covers the steps necessary to
- install the correct binaries for each type of Cluster node.
+ (<command>ndb_mgmd</command> and
+ <command>ndb_mgm</command>, respectively). This section covers
+ the steps necessary to install the correct binaries for each
+ type of Cluster node.
</para>
<para>
@@ -1086,32 +1087,105 @@
<para>
RPMs are also available for both 32-bit and 64-bit Linux
- platforms; as of MySQL 4.1.10a, the <literal>-max</literal>
- binaries installed by the RPMs support the
- <literal>NDBCluster</literal> storage engine. If you choose to
- use these rather than the binary files, be aware that you must
- install <emphasis>both</emphasis> the <literal>-server</literal>
- and <literal>-max</literal> packages on all machines that are to
- host cluster nodes. (See <xref linkend="linux-rpm"/>, for more
- information about installing MySQL using the RPMs.) After
- installing from RPM, you will still need to configure the
+ platforms. For a MySQL Cluster, four RPMs are required:
+ </para>
+
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ The <emphasis role="bold">Server</emphasis> RPM (for
+ example,
+ <filename>MySQL-server-¤t-version;-0.glibc23.i386.rpm</filename>),
+ which supplies the core files needed to run a MySQL Server.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ The <emphasis role="bold">Server/Max</emphasis> RPM (for
+ example,
+ <filename>MySQL-Max-¤t-version;-0.glibc23.i386.rpm</filename>),
+ which provides a MySQL Server binary with clustering
+ support.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ The <emphasis role="bold">NDB Cluster - Storage
+ engine</emphasis> RPM (for example,
+ <filename>MySQL-ndb-storage-¤t-version;-0.glibc23.i386.rpm</filename>),
+ which supplies the MySQL Cluster data node binary
+ (<command>ndbd</command>).
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ The <emphasis role="bold">NDB Cluster - Storage engine
+ management RPM</emphasis> (for example,
+ <filename>MySQL-ndb-management-¤t-version;-0.glibc23.i386.rpm</filename>),
+ which provides the MySQL Cluster management server binary
+ (<command>ndb_mgmd</command>).
+ </para>
+ </listitem>
+
+ </itemizedlist>
+
+ <para>
+ In addition, you should also obtain the
+ <emphasis role="bold">NDB Cluster - Storage engine basic
+ tools</emphasis> RPM (for example,
+ <filename>MySQL-ndb-tools-5.0.27-0.glibc23.i386.rpm</filename>),
+ which supplies several useful applications for working with a
+ MySQL Cluster. The most important of the these is the MySQL
+ Cluster management client (<command>ndb_mgm</command>). The
+ <emphasis role="bold">NDB Cluster - Storage engine extra
+ tools</emphasis> RPM (for example,
+ <filename>MySQL-ndb-extra-5.0.27-0.glibc23.i386.rpm</filename>)
+ contains some additional testing and monitoring programs, but is
+ not required to install a MySQL Cluster. (For more information
+ about these additional programs, see
+ <xref linkend="mysql-cluster-utilities"/>.)
+ </para>
+
+ <para>
+ The MySQL version number in the RPM filenames (shown here as
+ <literal>¤t-version;</literal>) can vary according to the
+ version which you are actually using. <emphasis>It is very
+ important that all of the Cluster RPMs to be installed have the
+ same MySQL version number</emphasis>. The
+ <literal>glibc</literal> version number (if present —
+ shown here as <literal>glibc23</literal>), and architecture
+ designation (shown here as <literal>i386</literal>) should be
+ appropriate to the machine on which the RPM is to be installed.
+ </para>
+
+ <para>
+ See <xref linkend="linux-rpm"/>, for general information about
+ installing MySQL using RPMs supplied by MySQL AB.
+ </para>
+
+ <para>
+ After installing from RPM, you still need to configure the
cluster as discussed in
<xref linkend="mysql-cluster-multi-config"/>.
</para>
<para>
<emphasis role="bold">Note</emphasis>: After completing the
- installation, do not yet start any of the binaries. We will show
- you how to do so following the configuration of all nodes.
+ installation, do not yet start any of the binaries. We show you
+ how to do so following the configuration of all nodes.
</para>
<para>
- <emphasis role="bold">Storage and SQL Node
- Installation</emphasis>
+ <emphasis role="bold">Data and SQL Node Installation —
+ <filename>.tar.gz</filename> Binary</emphasis>
</para>
<para>
- On each of the three machines designated to host storage or SQL
+ On each of the machines designated to host data or SQL
nodes, perform the following steps as the system
<literal>root</literal> user:
</para>
@@ -1122,7 +1196,7 @@
<para>
Check your <filename>/etc/passwd</filename> and
<filename>/etc/group</filename> files (or use whatever tools
- are provided by your operating system for manging users and
+ are provided by your operating system for managing users and
groups) to see whether there is already a
<literal>mysql</literal> group and <literal>mysql</literal>
user on the system. Some OS distributions create these as
@@ -1229,14 +1303,71 @@
<para>
Remember that the preceding steps must be performed separately
- for each machine on which a storage or SQL node is to reside.
+ on each machine where a data node or SQL node is to reside.
</para>
<para>
- <emphasis role="bold">Management Node Installation</emphasis>
+ <emphasis role="bold">SQL Node Installation — RPM
+ Files</emphasis>
</para>
<para>
+ On each machine to be used for hosting a cluster SQL node,
+ install the <emphasis role="bold">MySQL Max</emphasis> RPM by
+ executing the following command as the system root user,
+ replacing the name shown for the RPM as necessary to match the
+ name of the RPM downloaded from the MySQL AB web site:
+ </para>
+
+<programlisting>
+shell> <userinput>rpm -Uhv MySQL-server-¤t-version;-0.glibc23.i386.rpm</userinput>
+shell> <userinput>rpm -Uhv MySQL-Max-¤t-version;-0.glibc23.i386.rpm</userinput>
+</programlisting>
+
+ <para>
+ This installs the MySQL Max server binary
+ (<command>mysqld-max</command>) in the
+ <filename>/usr/sbin</filename> directory, as well as all needed
+ MySQL Server support files. It also installs the
+ <command>mysql.server</command> and
+ <command>mysqld_safe</command> startup scripts in
+ <filename>/usr/share/mysql</filename> and
+ <filename>/usr/bin</filename>, respectively. The RPM installer
+ should take care of general configuration issues (such as
+ creating the <literal>mysql</literal> user and group, if needed)
+ automatically.
+ </para>
+
+ <para>
+ <emphasis role="bold">Data Node Installation — RPM
+ Files</emphasis>
+ </para>
+
+ <para>
+ On a computer that is to host a cluster data node it is
+ necessary to install only the <emphasis role="bold">NDB Cluster
+ - Storage engine</emphasis> RPM. To do so, copy this RPM to the
+ data node host, and run the following command as the system root
+ user, replacing the name shown for the RPM as necessary to match
+ that of the RPM downloaded from the MySQL AB web site:
+ </para>
+
+<programlisting>
+shell> <userinput>rpm -Uhv MySQL-ndb-storage-¤t-version;-0.glibc23.i386.rpm</userinput>
+</programlisting>
+
+ <para>
+ The previous command installs the MySQL Cluster data node binary
+ (<command>ndbd</command>) in the <filename>/usr/sbin</filename>
+ directory.
+ </para>
+
+ <para>
+ <emphasis role="bold">Management Node Installation —
+ <filename>.tar.gz</filename> Binary</emphasis>
+ </para>
+
+ <para>
Installation for the management (MGM) node does not require
installation of the <command>mysqld</command> binary. Only the
binaries for the MGM server and client are required, which can
@@ -1294,11 +1425,58 @@
</orderedlist>
<para>
- In <xref linkend="mysql-cluster-multi-config"/>, we will create
- and write configuration files for all of the nodes in our
- example Cluster.
+ <emphasis role="bold">Management Node Installation — RPM
+ File</emphasis>
</para>
+ <para>
+ To install the MySQL Cluster management server, it is necessary
+ only to use the <emphasis role="bold">NDB Cluster - Storage
+ engine management</emphasis> RPM. Copy this RPM to the computer
+ intended to host the management node, and then install it by
+ running the following command as the system root user (replace
+ the name shown for the RPM as necessary to match that of the
+ <emphasis role="bold">Storage engine management</emphasis> RPM
+ downloaded from the MySQL AB web site):
+ </para>
+
+<programlisting>
+shell> <userinput>rpm -Uhv MySQL-ndb-management-¤t-version;-0.glibc23.i386.rpm</userinput>
+</programlisting>
+
+ <para>
+ This installs the management server binary
+ (<command>ndb_mgmd</command>) to the
+ <filename>/usr/sbin</filename> directory.
+ </para>
+
+ <para>
+ You should also install the <literal>NDB</literal> management
+ client, which is supplied by the <emphasis role="bold">Storage
+ engine basic tools</emphasis> RPM. Copy this RPM to the same
+ computer as the management node, and then install it by running
+ the following command as the system root user (again, replace
+ the name shown for the RPM as necessary to match that of the
+ <emphasis role="bold">Storage engine basic tools</emphasis> RPM
+ downloaded from the MySQL AB web site):
+ </para>
+
+<programlisting>
+shell> rpm -Uhv <userinput>MySQL-ndb-tools-¤t-version;-0.glibc23.i386.rpm</userinput>
+</programlisting>
+
+ <para>
+ The <emphasis role="bold">Storage engine basic tools</emphasis>
+ RPM installs the MySQL Cluster management client
+ (<command>ndb_mgm</command>) to the
+ <filename>/usr/bin</filename> directory.
+ </para>
+
+ <para>
+ In <xref linkend="mysql-cluster-multi-config"/>, we create
+ configuration files for all of the nodes in our example Cluster.
+ </para>
+
</section>
<section id="mysql-cluster-multi-config">
@@ -1320,8 +1498,8 @@
</indexterm>
<para>
- For our four-node, four-host MySQL Cluster, we will need to
- write four configuration files, one per node/host.
+ For our four-node, four-host MySQL Cluster, it is necessary to
+ write four configuration files, one per node host.
</para>
<itemizedlist>
@@ -1330,18 +1508,12 @@
<para>
Each data node or SQL node requires a
<filename>my.cnf</filename> file that provides two pieces of
- information: a
- <emphasis role="bold">connectstring</emphasis> telling the
- node where to find the MGM node, and a line telling the
- MySQL server on this host (the machine hosting the data
- node) to run in NDB mode.
+ information: a <firstterm>connectstring</firstterm> that
+ tells the node where to find the MGM node, and a line
+ telling the MySQL server on this host (the machine hosting
+ the data node) to run in NDB mode.
</para>
- <remark role="todo">
- Would "connection string" be a better choice than
- "connectstring"?
- </remark>
-
<para>
For more information on connectstrings, see
<xref linkend="mysql-cluster-connectstring"/>.
@@ -1390,12 +1562,12 @@
<programlisting>
# Options for mysqld process:
[MYSQLD]
-ndbcluster # run NDB engine
-ndb-connectstring=192.168.0.10 # location of MGM node
+ndbcluster # run NDB storage engine
+ndb-connectstring=192.168.0.10 # location of management server
# Options for ndbd process:
[MYSQL_CLUSTER]
-ndb-connectstring=192.168.0.10 # location of MGM node
+ndb-connectstring=192.168.0.10 # location of management server
</programlisting>
<para>
@@ -1486,7 +1658,7 @@
(<emphasis role="bold">Note</emphasis>: The
<literal>world</literal> database can be downloaded from
<ulink url="&base-url-docs;"/>, where it can be found listed
- under <quote>Examples.</quote>)
+ under <quote>Examples</quote>.)
</para>
<para>
@@ -1528,10 +1700,9 @@
<para>
Starting the cluster is not very difficult after it has been
configured. Each cluster node process must be started
- separately, and on the host where it resides. Although it is
- possible to start the nodes in any order, it is recommended that
- the management node be started first, followed by the storage
- nodes, and then finally by any SQL nodes:
+ separately, and on the host where it resides. The management
+ node ahould be started first, followed by the data nodes, and
+ then finally by any SQL nodes:
</para>
<orderedlist>
@@ -1587,12 +1758,12 @@
<para>
If you used RPM files to install MySQL on the cluster host
where the SQL node is to reside, you can (and should) use
- the startup script installed in
- <filename>/etc/init.d</filename> to start the MySQL server
- process on the SQL node. Note that you need to install the
- <literal>-max</literal> server RPM <emphasis>in addition
- to</emphasis> the Standard server RPM to run the
- <literal>-max</literal> server binary.
+ the supplied startup script to start the MySQL server
+ process on the SQL node. As mention previously, you must
+ install the <emphasis role="bold">Server / Max</emphasis>
+ RPM <emphasis>in addition to</emphasis> the
+ <emphasis role="bold">Server</emphasis> RPM to obtain and
+ run the <command>mysqld-max</command> server binary.
</para>
</listitem>
Modified: trunk/refman-5.0/mysql-cluster.xml
===================================================================
--- trunk/refman-5.0/mysql-cluster.xml 2007-01-19 04:33:03 UTC (rev 4567)
+++ trunk/refman-5.0/mysql-cluster.xml 2007-01-19 09:35:04 UTC (rev 4568)
Changed blocks: 11, Lines Added: 220, Lines Deleted: 43; 15139 bytes
@@ -1066,9 +1066,10 @@
have installed on it a MySQL-max binary. For management nodes,
it is not necessary to install the MySQL server binary, but you
do have to install the MGM server daemon and client binaries
- (<command>ndb_mgmd</command> and <command>ndb_mgm</command>,
- respectively). This section covers the steps necessary to
- install the correct binaries for each type of Cluster node.
+ (<command>ndb_mgmd</command> and
+ <command>ndb_mgm</command>, respectively). This section covers
+ the steps necessary to install the correct binaries for each
+ type of Cluster node.
</para>
<para>
@@ -1086,26 +1087,105 @@
<para>
RPMs are also available for both 32-bit and 64-bit Linux
- platforms. (See <xref linkend="linux-rpm"/>, for more
- information about installing MySQL using the RPMs.) After
- installing from RPM, you will still need to configure the
+ platforms. For a MySQL Cluster, four RPMs are required:
+ </para>
+
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ The <emphasis role="bold">Server</emphasis> RPM (for
+ example,
+ <filename>MySQL-server-¤t-version;-0.glibc23.i386.rpm</filename>),
+ which supplies the core files needed to run a MySQL Server.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ The <emphasis role="bold">Server/Max</emphasis> RPM (for
+ example,
+ <filename>MySQL-Max-¤t-version;-0.glibc23.i386.rpm</filename>),
+ which provides a MySQL Server binary with clustering
+ support.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ The <emphasis role="bold">NDB Cluster - Storage
+ engine</emphasis> RPM (for example,
+ <filename>MySQL-ndb-storage-¤t-version;-0.glibc23.i386.rpm</filename>),
+ which supplies the MySQL Cluster data node binary
+ (<command>ndbd</command>).
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ The <emphasis role="bold">NDB Cluster - Storage engine
+ management RPM</emphasis> (for example,
+ <filename>MySQL-ndb-management-¤t-version;-0.glibc23.i386.rpm</filename>),
+ which provides the MySQL Cluster management server binary
+ (<command>ndb_mgmd</command>).
+ </para>
+ </listitem>
+
+ </itemizedlist>
+
+ <para>
+ In addition, you should also obtain the
+ <emphasis role="bold">NDB Cluster - Storage engine basic
+ tools</emphasis> RPM (for example,
+ <filename>MySQL-ndb-tools-5.0.27-0.glibc23.i386.rpm</filename>),
+ which supplies several useful applications for working with a
+ MySQL Cluster. The most important of the these is the MySQL
+ Cluster management client (<command>ndb_mgm</command>). The
+ <emphasis role="bold">NDB Cluster - Storage engine extra
+ tools</emphasis> RPM (for example,
+ <filename>MySQL-ndb-extra-5.0.27-0.glibc23.i386.rpm</filename>)
+ contains some additional testing and monitoring programs, but is
+ not required to install a MySQL Cluster. (For more information
+ about these additional programs, see
+ <xref linkend="mysql-cluster-utilities"/>.)
+ </para>
+
+ <para>
+ The MySQL version number in the RPM filenames (shown here as
+ <literal>¤t-version;</literal>) can vary according to the
+ version which you are actually using. <emphasis>It is very
+ important that all of the Cluster RPMs to be installed have the
+ same MySQL version number</emphasis>. The
+ <literal>glibc</literal> version number (if present —
+ shown here as <literal>glibc23</literal>), and architecture
+ designation (shown here as <literal>i386</literal>) should be
+ appropriate to the machine on which the RPM is to be installed.
+ </para>
+
+ <para>
+ See <xref linkend="linux-rpm"/>, for general information about
+ installing MySQL using RPMs supplied by MySQL AB.
+ </para>
+
+ <para>
+ After installing from RPM, you still need to configure the
cluster as discussed in
<xref linkend="mysql-cluster-multi-config"/>.
</para>
<para>
<emphasis role="bold">Note</emphasis>: After completing the
- installation, do not yet start any of the binaries. We will show
- you how to do so following the configuration of all nodes.
+ installation, do not yet start any of the binaries. We show you
+ how to do so following the configuration of all nodes.
</para>
<para>
- <emphasis role="bold">Storage and SQL Node
- Installation</emphasis>
+ <emphasis role="bold">Data and SQL Node Installation —
+ <filename>.tar.gz</filename> Binary</emphasis>
</para>
<para>
- On each of the three machines designated to host storage or SQL
+ On each of the machines designated to host data or SQL
nodes, perform the following steps as the system
<literal>root</literal> user:
</para>
@@ -1116,7 +1196,7 @@
<para>
Check your <filename>/etc/passwd</filename> and
<filename>/etc/group</filename> files (or use whatever tools
- are provided by your operating system for manging users and
+ are provided by your operating system for managing users and
groups) to see whether there is already a
<literal>mysql</literal> group and <literal>mysql</literal>
user on the system. Some OS distributions create these as
@@ -1223,14 +1303,71 @@
<para>
Remember that the preceding steps must be performed separately
- for each machine on which a storage or SQL node is to reside.
+ on each machine where a data node or SQL node is to reside.
</para>
<para>
- <emphasis role="bold">Management Node Installation</emphasis>
+ <emphasis role="bold">SQL Node Installation — RPM
+ Files</emphasis>
</para>
<para>
+ On each machine to be used for hosting a cluster SQL node,
+ install the <emphasis role="bold">MySQL Max</emphasis> RPM by
+ executing the following command as the system root user,
+ replacing the name shown for the RPM as necessary to match the
+ name of the RPM downloaded from the MySQL AB web site:
+ </para>
+
+<programlisting>
+shell> <userinput>rpm -Uhv MySQL-server-¤t-version;-0.glibc23.i386.rpm</userinput>
+shell> <userinput>rpm -Uhv MySQL-Max-¤t-version;-0.glibc23.i386.rpm</userinput>
+</programlisting>
+
+ <para>
+ This installs the MySQL Max server binary
+ (<command>mysqld-max</command>) in the
+ <filename>/usr/sbin</filename> directory, as well as all needed
+ MySQL Server support files. It also installs the
+ <command>mysql.server</command> and
+ <command>mysqld_safe</command> startup scripts in
+ <filename>/usr/share/mysql</filename> and
+ <filename>/usr/bin</filename>, respectively. The RPM installer
+ should take care of general configuration issues (such as
+ creating the <literal>mysql</literal> user and group, if needed)
+ automatically.
+ </para>
+
+ <para>
+ <emphasis role="bold">Data Node Installation — RPM
+ Files</emphasis>
+ </para>
+
+ <para>
+ On a computer that is to host a cluster data node it is
+ necessary to install only the <emphasis role="bold">NDB Cluster
+ - Storage engine</emphasis> RPM. To do so, copy this RPM to the
+ data node host, and run the following command as the system root
+ user, replacing the name shown for the RPM as necessary to match
+ that of the RPM downloaded from the MySQL AB web site:
+ </para>
+
+<programlisting>
+shell> <userinput>rpm -Uhv MySQL-ndb-storage-¤t-version;-0.glibc23.i386.rpm</userinput>
+</programlisting>
+
+ <para>
+ The previous command installs the MySQL Cluster data node binary
+ (<command>ndbd</command>) in the <filename>/usr/sbin</filename>
+ directory.
+ </para>
+
+ <para>
+ <emphasis role="bold">Management Node Installation —
+ <filename>.tar.gz</filename> Binary</emphasis>
+ </para>
+
+ <para>
Installation for the management (MGM) node does not require
installation of the <command>mysqld</command> binary. Only the
binaries for the MGM server and client are required, which can
@@ -1288,11 +1425,58 @@
</orderedlist>
<para>
- In <xref linkend="mysql-cluster-multi-config"/>, we will create
- and write configuration files for all of the nodes in our
- example Cluster.
+ <emphasis role="bold">Management Node Installation — RPM
+ File</emphasis>
</para>
+ <para>
+ To install the MySQL Cluster management server, it is necessary
+ only to use the <emphasis role="bold">NDB Cluster - Storage
+ engine management</emphasis> RPM. Copy this RPM to the computer
+ intended to host the management node, and then install it by
+ running the following command as the system root user (replace
+ the name shown for the RPM as necessary to match that of the
+ <emphasis role="bold">Storage engine management</emphasis> RPM
+ downloaded from the MySQL AB web site):
+ </para>
+
+<programlisting>
+shell> <userinput>rpm -Uhv MySQL-ndb-management-¤t-version;-0.glibc23.i386.rpm</userinput>
+</programlisting>
+
+ <para>
+ This installs the management server binary
+ (<command>ndb_mgmd</command>) to the
+ <filename>/usr/sbin</filename> directory.
+ </para>
+
+ <para>
+ You should also install the <literal>NDB</literal> management
+ client, which is supplied by the <emphasis role="bold">Storage
+ engine basic tools</emphasis> RPM. Copy this RPM to the same
+ computer as the management node, and then install it by running
+ the following command as the system root user (again, replace
+ the name shown for the RPM as necessary to match that of the
+ <emphasis role="bold">Storage engine basic tools</emphasis> RPM
+ downloaded from the MySQL AB web site):
+ </para>
+
+<programlisting>
+shell> rpm -Uhv <userinput>MySQL-ndb-tools-¤t-version;-0.glibc23.i386.rpm</userinput>
+</programlisting>
+
+ <para>
+ The <emphasis role="bold">Storage engine basic tools</emphasis>
+ RPM installs the MySQL Cluster management client
+ (<command>ndb_mgm</command>) to the
+ <filename>/usr/bin</filename> directory.
+ </para>
+
+ <para>
+ In <xref linkend="mysql-cluster-multi-config"/>, we create
+ configuration files for all of the nodes in our example Cluster.
+ </para>
+
</section>
<section id="mysql-cluster-multi-config">
@@ -1314,8 +1498,8 @@
</indexterm>
<para>
- For our four-node, four-host MySQL Cluster, we will need to
- write four configuration files, one per node/host.
+ For our four-node, four-host MySQL Cluster, it is necessary to
+ write four configuration files, one per node host.
</para>
<itemizedlist>
@@ -1324,18 +1508,12 @@
<para>
Each data node or SQL node requires a
<filename>my.cnf</filename> file that provides two pieces of
- information: a
- <emphasis role="bold">connectstring</emphasis> telling the
- node where to find the MGM node, and a line telling the
- MySQL server on this host (the machine hosting the data
- node) to run in NDB mode.
+ information: a <firstterm>connectstring</firstterm> that
+ tells the node where to find the MGM node, and a line
+ telling the MySQL server on this host (the machine hosting
+ the data node) to run in NDB mode.
</para>
- <remark role="todo">
- Would "connection string" be a better choice than
- "connectstring"?
- </remark>
-
<para>
For more information on connectstrings, see
<xref linkend="mysql-cluster-connectstring"/>.
@@ -1384,12 +1562,12 @@
<programlisting>
# Options for mysqld process:
[MYSQLD]
-ndbcluster # run NDB engine
-ndb-connectstring=192.168.0.10 # location of MGM node
+ndbcluster # run NDB storage engine
+ndb-connectstring=192.168.0.10 # location of management server
# Options for ndbd process:
[MYSQL_CLUSTER]
-ndb-connectstring=192.168.0.10 # location of MGM node
+ndb-connectstring=192.168.0.10 # location of management server
</programlisting>
<para>
@@ -1480,7 +1658,7 @@
(<emphasis role="bold">Note</emphasis>: The
<literal>world</literal> database can be downloaded from
<ulink url="&base-url-docs;"/>, where it can be found listed
- under <quote>Examples.</quote>)
+ under <quote>Examples</quote>.)
</para>
<para>
@@ -1522,10 +1700,9 @@
<para>
Starting the cluster is not very difficult after it has been
configured. Each cluster node process must be started
- separately, and on the host where it resides. Although it is
- possible to start the nodes in any order, it is recommended that
- the management node be started first, followed by the storage
- nodes, and then finally by any SQL nodes:
+ separately, and on the host where it resides. The management
+ node ahould be started first, followed by the data nodes, and
+ then finally by any SQL nodes:
</para>
<orderedlist>
@@ -1581,12 +1758,12 @@
<para>
If you used RPM files to install MySQL on the cluster host
where the SQL node is to reside, you can (and should) use
- the startup script installed in
- <filename>/etc/init.d</filename> to start the MySQL server
- process on the SQL node. Note that you need to install the
- <literal>-max</literal> server RPM <emphasis>in addition
- to</emphasis> the Standard server RPM to run the
- <literal>-max</literal> server binary.
+ the supplied startup script to start the MySQL server
+ process on the SQL node. As mention previously, you must
+ install the <emphasis role="bold">Server / Max</emphasis>
+ RPM <emphasis>in addition to</emphasis> the
+ <emphasis role="bold">Server</emphasis> RPM to obtain and
+ run the <command>mysqld-max</command> server binary.
</para>
</listitem>
Modified: trunk/refman-5.1/mysql-cluster.xml
===================================================================
--- trunk/refman-5.1/mysql-cluster.xml 2007-01-19 04:33:03 UTC (rev 4567)
+++ trunk/refman-5.1/mysql-cluster.xml 2007-01-19 09:35:04 UTC (rev 4568)
Changed blocks: 12, Lines Added: 223, Lines Deleted: 41; 15310 bytes
@@ -47,7 +47,10 @@
<literal>NDB Cluster</literal> storage engine to enable running
several MySQL servers in a cluster. This storage engine is available
in MySQL ¤t-series; binary releases and in RPMs compatible
- with most modern Linux distributions.
+ with most modern Linux distributions. (If you install using RPM
+ files, note that both the <literal>mysql-server</literal> and
+ <literal>mysql-max</literal> RPMs must be installed to have MySQL
+ Cluster capability.)
</para>
<indexterm>
@@ -1085,26 +1088,105 @@
<para>
RPMs are also available for both 32-bit and 64-bit Linux
- platforms. (See <xref linkend="linux-rpm"/>, for more
- information about installing MySQL using the RPMs.) After
- installing from RPM, you will still need to configure the
+ platforms. For a MySQL Cluster, four RPMs are required:
+ </para>
+
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ The <emphasis role="bold">Server</emphasis> RPM (for
+ example,
+ <filename>MySQL-server-¤t-version;-0.glibc23.i386.rpm</filename>),
+ which supplies the core files needed to run a MySQL Server.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ The <emphasis role="bold">Server/Max</emphasis> RPM (for
+ example,
+ <filename>MySQL-Max-¤t-version;-0.glibc23.i386.rpm</filename>),
+ which provides a MySQL Server binary with clustering
+ support.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ The <emphasis role="bold">NDB Cluster - Storage
+ engine</emphasis> RPM (for example,
+ <filename>MySQL-ndb-storage-¤t-version;-0.glibc23.i386.rpm</filename>),
+ which supplies the MySQL Cluster data node binary
+ (<command>ndbd</command>).
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ The <emphasis role="bold">NDB Cluster - Storage engine
+ management RPM</emphasis> (for example,
+ <filename>MySQL-ndb-management-¤t-version;-0.glibc23.i386.rpm</filename>),
+ which provides the MySQL Cluster management server binary
+ (<command>ndb_mgmd</command>).
+ </para>
+ </listitem>
+
+ </itemizedlist>
+
+ <para>
+ In addition, you should also obtain the
+ <emphasis role="bold">NDB Cluster - Storage engine basic
+ tools</emphasis> RPM (for example,
+ <filename>MySQL-ndb-tools-5.0.27-0.glibc23.i386.rpm</filename>),
+ which supplies several useful applications for working with a
+ MySQL Cluster. The most important of the these is the MySQL
+ Cluster management client (<command>ndb_mgm</command>). The
+ <emphasis role="bold">NDB Cluster - Storage engine extra
+ tools</emphasis> RPM (for example,
+ <filename>MySQL-ndb-extra-5.0.27-0.glibc23.i386.rpm</filename>)
+ contains some additional testing and monitoring programs, but is
+ not required to install a MySQL Cluster. (For more information
+ about these additional programs, see
+ <xref linkend="mysql-cluster-utilities"/>.)
+ </para>
+
+ <para>
+ The MySQL version number in the RPM filenames (shown here as
+ <literal>¤t-version;</literal>) can vary according to the
+ version which you are actually using. <emphasis>It is very
+ important that all of the Cluster RPMs to be installed have the
+ same MySQL version number</emphasis>. The
+ <literal>glibc</literal> version number (if present —
+ shown here as <literal>glibc23</literal>), and architecture
+ designation (shown here as <literal>i386</literal>) should be
+ appropriate to the machine on which the RPM is to be installed.
+ </para>
+
+ <para>
+ See <xref linkend="linux-rpm"/>, for general information about
+ installing MySQL using RPMs supplied by MySQL AB.
+ </para>
+
+ <para>
+ After installing from RPM, you still need to configure the
cluster as discussed in
<xref linkend="mysql-cluster-multi-config"/>.
</para>
<para>
<emphasis role="bold">Note</emphasis>: After completing the
- installation, do not yet start any of the binaries. We will show
- you how to do so following the configuration of all nodes.
+ installation, do not yet start any of the binaries. We show you
+ how to do so following the configuration of all nodes.
</para>
<para>
- <emphasis role="bold">Storage and SQL Node
- Installation</emphasis>
+ <emphasis role="bold">Data and SQL Node Installation —
+ <filename>.tar.gz</filename> Binary</emphasis>
</para>
<para>
- On each of the three machines designated to host storage or SQL
+ On each of the machines designated to host data or SQL
nodes, perform the following steps as the system
<literal>root</literal> user:
</para>
@@ -1115,7 +1197,7 @@
<para>
Check your <filename>/etc/passwd</filename> and
<filename>/etc/group</filename> files (or use whatever tools
- are provided by your operating system for manging users and
+ are provided by your operating system for managing users and
groups) to see whether there is already a
<literal>mysql</literal> group and <literal>mysql</literal>
user on the system. Some OS distributions create these as
@@ -1142,9 +1224,9 @@
<para>
Change location to the directory containing the downloaded
file, unpack the archive, and create a symlink to the
- <filename>mysql</filename> directory. Note that the actual
- file and directory names will vary according to the MySQL
- version number.
+ <filename>mysql</filename>. Note that the actual file and
+ directory names will vary according to the MySQL version
+ number.
</para>
<programlisting>
@@ -1221,14 +1303,71 @@
<para>
Remember that the preceding steps must be performed separately
- for each machine on which a storage or SQL node is to reside.
+ on each machine where a data node or SQL node is to reside.
</para>
<para>
- <emphasis role="bold">Management Node Installation</emphasis>
+ <emphasis role="bold">SQL Node Installation — RPM
+ Files</emphasis>
</para>
<para>
+ On each machine to be used for hosting a cluster SQL node,
+ install the <emphasis role="bold">MySQL Max</emphasis> RPM by
+ executing the following command as the system root user,
+ replacing the name shown for the RPM as necessary to match the
+ name of the RPM downloaded from the MySQL AB web site:
+ </para>
+
+<programlisting>
+shell> <userinput>rpm -Uhv MySQL-server-¤t-version;-0.glibc23.i386.rpm</userinput>
+shell> <userinput>rpm -Uhv MySQL-Max-¤t-version;-0.glibc23.i386.rpm</userinput>
+</programlisting>
+
+ <para>
+ This installs the MySQL Max server binary
+ (<command>mysqld-max</command>) in the
+ <filename>/usr/sbin</filename> directory, as well as all needed
+ MySQL Server support files. It also installs the
+ <command>mysql.server</command> and
+ <command>mysqld_safe</command> startup scripts in
+ <filename>/usr/share/mysql</filename> and
+ <filename>/usr/bin</filename>, respectively. The RPM installer
+ should take care of general configuration issues (such as
+ creating the <literal>mysql</literal> user and group, if needed)
+ automatically.
+ </para>
+
+ <para>
+ <emphasis role="bold">Data Node Installation — RPM
+ Files</emphasis>
+ </para>
+
+ <para>
+ On a computer that is to host a cluster data node it is
+ necessary to install only the <emphasis role="bold">NDB Cluster
+ - Storage engine</emphasis> RPM. To do so, copy this RPM to the
+ data node host, and run the following command as the system root
+ user, replacing the name shown for the RPM as necessary to match
+ that of the RPM downloaded from the MySQL AB web site:
+ </para>
+
+<programlisting>
+shell> <userinput>rpm -Uhv MySQL-ndb-storage-¤t-version;-0.glibc23.i386.rpm</userinput>
+</programlisting>
+
+ <para>
+ The previous command installs the MySQL Cluster data node binary
+ (<command>ndbd</command>) in the <filename>/usr/sbin</filename>
+ directory.
+ </para>
+
+ <para>
+ <emphasis role="bold">Management Node Installation —
+ <filename>.tar.gz</filename> Binary</emphasis>
+ </para>
+
+ <para>
Installation for the management (MGM) node does not require
installation of the <command>mysqld</command> binary. Only the
binaries for the MGM server and client are required, which can
@@ -1286,11 +1425,58 @@
</orderedlist>
<para>
- In <xref linkend="mysql-cluster-multi-config"/>, we will create
- and write configuration files for all of the nodes in our
- example Cluster.
+ <emphasis role="bold">Management Node Installation — RPM
+ File</emphasis>
</para>
+ <para>
+ To install the MySQL Cluster management server, it is necessary
+ only to use the <emphasis role="bold">NDB Cluster - Storage
+ engine management</emphasis> RPM. Copy this RPM to the computer
+ intended to host the management node, and then install it by
+ running the following command as the system root user (replace
+ the name shown for the RPM as necessary to match that of the
+ <emphasis role="bold">Storage engine management</emphasis> RPM
+ downloaded from the MySQL AB web site):
+ </para>
+
+<programlisting>
+shell> <userinput>rpm -Uhv MySQL-ndb-management-¤t-version;-0.glibc23.i386.rpm</userinput>
+</programlisting>
+
+ <para>
+ This installs the management server binary
+ (<command>ndb_mgmd</command>) to the
+ <filename>/usr/sbin</filename> directory.
+ </para>
+
+ <para>
+ You should also install the <literal>NDB</literal> management
+ client, which is supplied by the <emphasis role="bold">Storage
+ engine basic tools</emphasis> RPM. Copy this RPM to the same
+ computer as the management node, and then install it by running
+ the following command as the system root user (again, replace
+ the name shown for the RPM as necessary to match that of the
+ <emphasis role="bold">Storage engine basic tools</emphasis> RPM
+ downloaded from the MySQL AB web site):
+ </para>
+
+<programlisting>
+shell> rpm -Uhv <userinput>MySQL-ndb-tools-¤t-version;-0.glibc23.i386.rpm</userinput>
+</programlisting>
+
+ <para>
+ The <emphasis role="bold">Storage engine basic tools</emphasis>
+ RPM installs the MySQL Cluster management client
+ (<command>ndb_mgm</command>) to the
+ <filename>/usr/bin</filename> directory.
+ </para>
+
+ <para>
+ In <xref linkend="mysql-cluster-multi-config"/>, we create
+ configuration files for all of the nodes in our example Cluster.
+ </para>
+
</section>
<section id="mysql-cluster-multi-config">
@@ -1312,8 +1498,8 @@
</indexterm>
<para>
- For our four-node, four-host MySQL Cluster, we will need to
- write four configuration files, one per node/host.
+ For our four-node, four-host MySQL Cluster, it is necessary to
+ write four configuration files, one per node host.
</para>
<itemizedlist>
@@ -1322,18 +1508,12 @@
<para>
Each data node or SQL node requires a
<filename>my.cnf</filename> file that provides two pieces of
- information: a
- <emphasis role="bold">connectstring</emphasis> telling the
- node where to find the MGM node, and a line telling the
- MySQL server on this host (the machine hosting the data
- node) to run in NDB mode.
+ information: a <firstterm>connectstring</firstterm> that
+ tells the node where to find the MGM node, and a line
+ telling the MySQL server on this host (the machine hosting
+ the data node) to run in NDB mode.
</para>
- <remark role="todo">
- Would "connection string" be a better choice than
- "connectstring"?
- </remark>
-
<para>
For more information on connectstrings, see
<xref linkend="mysql-cluster-connectstring"/>.
@@ -1382,12 +1562,12 @@
<programlisting>
# Options for mysqld process:
[MYSQLD]
-ndbcluster # run NDB engine
-ndb-connectstring=192.168.0.10 # location of MGM node
+ndbcluster # run NDB storage engine
+ndb-connectstring=192.168.0.10 # location of management server
# Options for ndbd process:
[MYSQL_CLUSTER]
-ndb-connectstring=192.168.0.10 # location of MGM node
+ndb-connectstring=192.168.0.10 # location of management server
</programlisting>
<para>
@@ -1478,7 +1658,7 @@
(<emphasis role="bold">Note</emphasis>: The
<literal>world</literal> database can be downloaded from
<ulink url="&base-url-docs;"/>, where it can be found listed
- under <quote>Examples.</quote>)
+ under <quote>Examples</quote>.)
</para>
<para>
@@ -1520,10 +1700,9 @@
<para>
Starting the cluster is not very difficult after it has been
configured. Each cluster node process must be started
- separately, and on the host where it resides. Although it is
- possible to start the nodes in any order, it is recommended that
- the management node be started first, followed by the storage
- nodes, and then finally by any SQL nodes:
+ separately, and on the host where it resides. The management
+ node ahould be started first, followed by the data nodes, and
+ then finally by any SQL nodes:
</para>
<orderedlist>
@@ -1586,9 +1765,12 @@
<para>
If you used RPM files to install MySQL on the cluster host
where the SQL node is to reside, you can (and should) use
- the startup script installed in
- <filename>/etc/init.d</filename> to start the MySQL server
- process on the SQL node.
+ the supplied startup script to start the MySQL server
+ process on the SQL node. As mention previously, you must
+ install the <emphasis role="bold">Server / Max</emphasis>
+ RPM <emphasis>in addition to</emphasis> the
+ <emphasis role="bold">Server</emphasis> RPM to obtain and
+ run the <command>mysqld-max</command> server binary.
</para>
</listitem>
| Thread |
|---|
| • svn commit - mysqldoc@docsrva: r4568 - branches/telcos/refman-5.0 branches/telcos/refman-5.1 trunk/refman-4.1 trunk/refman-5.0 trunk/refman-5.1 | jon | 19 Jan |
