Author: paul
Date: 2006-09-15 19:22:33 +0200 (Fri, 15 Sep 2006)
New Revision: 3369
Log:
Instance Manager: structural changes (just moving sections around)
Modified:
trunk/refman-5.0/database-administration.xml
trunk/refman-5.1/database-administration.xml
Modified: trunk/refman-5.0/database-administration.xml
===================================================================
--- trunk/refman-5.0/database-administration.xml 2006-09-15 15:53:42 UTC (rev 3368)
+++ trunk/refman-5.0/database-administration.xml 2006-09-15 17:22:33 UTC (rev 3369)
Changed blocks: 3, Lines Added: 208, Lines Deleted: 208; 17834 bytes
@@ -13528,6 +13528,141 @@
</refsection>
+ <refsection id="instance-manager-configuration-files">
+
+ <title>MySQL Instance Manager Configuration Files</title>
+
+ <para>
+ Instance Manager uses the standard configuration file, unless
+ started with a <option>--defaults-file</option> option that
+ specifies a different file. On Unix, the standard file is
+ <filename>/etc/my.cnf</filename>. (Prior to MySQL 5.0.10, the
+ MySQL Instance Manager read the same configuration files as
+ the MySQL Server, including <filename>/etc/my.cnf</filename>,
+ <filename>~/.my.cnf</filename>, and so forth.) On Windows, the
+ standard file is <filename>my.ini</filename> in the directory
+ where Instance Manager is installed.
+ </para>
+
+ <para>
+ Instance Manager reads options for itself from the
+ <literal>[manager]</literal> section of the configuration
+ file, and options for server instances from
+ <literal>[mysqld<replaceable>N</replaceable>]</literal>
+ sections. The <literal>[manager]</literal> section contains
+ any of the options listed in
+ <xref linkend="instance-manager-command-options"/>, except for
+ those specified as having to be given as the first option on
+ the command line. Here is an example
+ <literal>[manager]</literal> section:
+ </para>
+
+<programlisting>
+# MySQL Instance Manager options section
+[manager]
+default-mysqld-path = /usr/local/mysql/libexec/mysqld
+socket=/tmp/manager.sock
+pid-file=/tmp/manager.pid
+password-file = /home/cps/.mysqlmanager.passwd
+monitoring-interval = 2
+port = 1999
+bind-address = 192.168.1.5
+</programlisting>
+
+ <warning>
+ <para>
+ The <literal>[mysqld]</literal> section name causes
+ unpredictable results when used in conjunction with the
+ Instance Manager. When using the Instance Manager, check
+ that no section is named <literal>[mysqld]</literal>.
+ </para>
+ </warning>
+
+ <para>
+ Each
<literal>[mysqld<replaceable>N</replaceable>]</literal>
+ instance section specifies options given by Instance Manager
+ to a server instance at startup. These are mainly common MySQL
+ server options (see <xref linkend="server-options"/>). The
+ following list describes additional options that are Instance
+ Manager-specific:
+ </para>
+
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ <literal>mysqld-path =
+ <replaceable>path</replaceable></literal>
+ </para>
+
+ <para>
+ The pathname of the <command>mysqld</command> server
+ binary to use for the instance.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>shutdown-delay =
+ <replaceable>seconds</replaceable></literal>
+ </para>
+
+ <para>
+ The number of seconds Instance Manager should wait for the
+ instance to shut down. The default value is 35 seconds.
+ After the delay expires, Instance Manager assumes that the
+ instance is hanging and attempts to terminate it. If you
+ use <literal>InnoDB</literal> with large tables, you
+ should increase this value.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>nonguarded</literal>
+ </para>
+
+ <para>
+ This option disables Instance Manager monitoring
+ functionality for the instance.
+ </para>
+ </listitem>
+
+ </itemizedlist>
+
+ <para>
+ Here are some sample instance sections:
+ </para>
+
+<programlisting>
+[mysqld1]
+mysqld-path=/usr/local/mysql/libexec/mysqld
+socket=/tmp/mysql.sock
+port=3307
+server_id=1
+skip-stack-trace
+core-file
+skip-bdb
+log-bin
+log-error
+log=mylog
+log-slow-queries
+
+[mysqld2]
+nonguarded
+port=3308
+server_id=2
+mysqld-path= /home/cps/mysql/trees/mysql-¤t-series;/sql/mysqld
+socket = /tmp/mysql.sock5
+pid-file = /tmp/hostname.pid5
+datadir= /home/cps/mysql_data/data_dir1
+language=/home/cps/mysql/trees/mysql-¤t-series;/sql/share/english
+log-bin
+log=/tmp/fordel.log
+</programlisting>
+
+ </refsection>
+
<refsection id="instance-manager-startup-process">
<title>Starting the MySQL Server with MySQL Instance Manager</title>
@@ -13653,76 +13788,62 @@
</refsection>
- <refsection id="instance-manager-security">
+ <refsection id="instance-manager-security-passwords">
- <title>Connecting to the MySQL Instance Manager and Creating User
Accounts</title>
+ <title>Instance Manager User and Password Management</title>
<para>
- The MySQL client-server protocol is used to communicate with
- the MySQL Instance Manager. As such, you can connect to
- Instance Manager using the standard <command>mysql</command>
- client program, as well as the MySQL C API. Instance Manager
- supports the version of the MySQL client-server protocol used
- by the client tools and libraries distributed with MySQL 4.1
- or later.
+ The Instance Manager stores its user information in a password
+ file. The default name of the password file is
+ <filename>/etc/mysqlmanager.passwd</filename>. To specify a
+ different location for the password file, use the
+ <option>--password-file</option> option.
</para>
- <refsection id="instance-manager-security-passwords">
-
- <title>Instance Manager User and Password Management</title>
-
+ <note>
<para>
- The Instance Manager stores its user information in a
- password file. The default name of the password file is
- <filename>/etc/mysqlmanager.passwd</filename>. To specify a
- different location for the password file, use the
- <option>--password-file</option> option.
+ The Instance Manager does not notice changes to the password
+ file. You must restart it after making password entry
+ changes.
</para>
+ </note>
- <note>
- <para>
- The Instance Manager does not notice changes to the
- password file. You must restart it after making password
- entry changes.
- </para>
- </note>
+ <para>
+ Password entries have the following format:
+ </para>
- <para>
- Password entries have the following format:
- </para>
-
<programlisting>
petr:*35110DC9B4D8140F5DE667E28C72DD2597B5C848
</programlisting>
- <para>
- Instance Manager accounts are associated with a username and
- password only. This differs from MySQL Server accounts,
- which also are associated with a hostname (see
- <xref linkend="user-names"/>). This means that a client can
- connect to Instance Manager with a given username from any
- host. To limit connections only from the local host, start
- Instance Manager with the
- <option>--bind-address=127.0.0.1</option> option so that it
- listens only to the local network interface. Clients can
- connect like this:
- </para>
+ <para>
+ Instance Manager accounts are associated with a username and
+ password only. This differs from MySQL Server accounts, which
+ also are associated with a hostname (see
+ <xref linkend="user-names"/>). This means that a client can
+ connect to Instance Manager with a given username from any
+ host. To limit connections only from the local host, start
+ Instance Manager with the
+ <option>--bind-address=127.0.0.1</option> option so that it
+ listens only to the local network interface. Clients can
+ connect like this:
+ </para>
<programlisting>
shell> <userinput>mysql -h 127.0.0.1 -P 2273</userinput>
</programlisting>
- <para>
- If the password file does not exist or contains no password
- entries, you cannot connect to the Instance Manager.
- </para>
+ <para>
+ If the password file does not exist or contains no password
+ entries, you cannot connect to the Instance Manager.
+ </para>
- <para>
- To generate a new entry, invoke Instance Manager with the
- <command>--passwd</command> option and append the output to
- the <filename>/etc/mysqlmanager.passwd</filename> file. Here
- is an example:
- </para>
+ <para>
+ To generate a new entry, invoke Instance Manager with the
+ <command>--passwd</command> option and append the output to
+ the <filename>/etc/mysqlmanager.passwd</filename> file. Here
+ is an example:
+ </para>
<programlisting>
shell> <userinput>mysqlmanager --passwd >>
/etc/mysqlmanager.passwd</userinput>
@@ -13732,185 +13853,64 @@
Re-type password: <userinput>mikepass</userinput>
</programlisting>
- <para>
- At the prompts, enter the username and password for the new
- Instance Manager user. You must enter the password twice. It
- does not echo to the screen, so double entry guards against
- entering a different password than you intend (if the two
- passwords do not match, no entry is generated).
- </para>
+ <para>
+ At the prompts, enter the username and password for the new
+ Instance Manager user. You must enter the password twice. It
+ does not echo to the screen, so double entry guards against
+ entering a different password than you intend (if the two
+ passwords do not match, no entry is generated).
+ </para>
- <para>
- The preceding command causes the following line to be added
- to <filename>/etc/mysqlmanager.passwd</filename>:
- </para>
+ <para>
+ The preceding command causes the following line to be added to
+ <filename>/etc/mysqlmanager.passwd</filename>:
+ </para>
<programlisting>
mike:*BBF1F551DD9DD96A01E66EC7DDC073911BAD17BA
</programlisting>
- </refsection>
-
- <refsection id="instance-manager-security-monitoring">
-
- <title>MySQL Server Accounts for Status Monitoring</title>
-
- <para>
- To monitor the status of a server instance, the MySQL
- Instance Manager attempts to connect to the MySQL server
- instance at regular intervals using the
- <literal>MySQL_Instance_Manager@localhost</literal> user
- account with a password of
- <literal>check_connection</literal>.
- </para>
-
- <para>
- You are <emphasis>not</emphasis> required to create a
- <literal>MySQL_Instance_M@localhost</literal> user account
- in order for the MySQL Instance Manager to monitor server
- status, as a login failure is sufficient to identify that
- the server is operational. However, if the account does not
- exist, failed connection attempts are logged by the server
- to its general query log (see <xref linkend="query-log"/>).
- </para>
-
- </refsection>
-
</refsection>
- <refsection id="instance-manager-configuration-files">
+ <refsection id="instance-manager-security-monitoring">
- <title>MySQL Instance Manager Configuration Files</title>
+ <title>MySQL Server Accounts for Status Monitoring</title>
<para>
- Instance Manager uses the standard configuration file, unless
- started with a <option>--defaults-file</option> option that
- specifies a different file. On Unix, the standard file is
- <filename>/etc/my.cnf</filename>. (Prior to MySQL 5.0.10, the
- MySQL Instance Manager read the same configuration files as
- the MySQL Server, including <filename>/etc/my.cnf</filename>,
- <filename>~/.my.cnf</filename>, and so forth.) On Windows, the
- standard file is <filename>my.ini</filename> in the directory
- where Instance Manager is installed.
+ To monitor the status of a server instance, the MySQL Instance
+ Manager attempts to connect to the MySQL server instance at
+ regular intervals using the
+ <literal>MySQL_Instance_Manager@localhost</literal> user
+ account with a password of
+ <literal>check_connection</literal>.
</para>
<para>
- Instance Manager reads options for itself from the
- <literal>[manager]</literal> section of the configuration
- file, and options for server instances from
- <literal>[mysqld<replaceable>N</replaceable>]</literal>
- sections. The <literal>[manager]</literal> section contains
- any of the options listed in
- <xref linkend="instance-manager-command-options"/>, except for
- those specified as having to be given as the first option on
- the command line. Here is an example
- <literal>[manager]</literal> section:
+ You are <emphasis>not</emphasis> required to create a
+ <literal>MySQL_Instance_M@localhost</literal> user account in
+ order for the MySQL Instance Manager to monitor server status,
+ as a login failure is sufficient to identify that the server
+ is operational. However, if the account does not exist, failed
+ connection attempts are logged by the server to its general
+ query log (see <xref linkend="query-log"/>).
</para>
-<programlisting>
-# MySQL Instance Manager options section
-[manager]
-default-mysqld-path = /usr/local/mysql/libexec/mysqld
-socket=/tmp/manager.sock
-pid-file=/tmp/manager.pid
-password-file = /home/cps/.mysqlmanager.passwd
-monitoring-interval = 2
-port = 1999
-bind-address = 192.168.1.5
-</programlisting>
+ </refsection>
- <warning>
- <para>
- The <literal>[mysqld]</literal> section name causes
- unpredictable results when used in conjunction with the
- Instance Manager. When using the Instance Manager, check
- that no section is named <literal>[mysqld]</literal>.
- </para>
- </warning>
+ <refsection id="instance-manager-security">
- <para>
- Each
<literal>[mysqld<replaceable>N</replaceable>]</literal>
- instance section specifies options given by Instance Manager
- to a server instance at startup. These are mainly common MySQL
- server options (see <xref linkend="server-options"/>). The
- following list describes additional options that are Instance
- Manager-specific:
- </para>
+ <title>Connecting to the MySQL Instance Manager and Creating User
Accounts</title>
- <itemizedlist>
-
- <listitem>
- <para>
- <literal>mysqld-path =
- <replaceable>path</replaceable></literal>
- </para>
-
- <para>
- The pathname of the <command>mysqld</command> server
- binary to use for the instance.
- </para>
- </listitem>
-
- <listitem>
- <para>
- <literal>shutdown-delay =
- <replaceable>seconds</replaceable></literal>
- </para>
-
- <para>
- The number of seconds Instance Manager should wait for the
- instance to shut down. The default value is 35 seconds.
- After the delay expires, Instance Manager assumes that the
- instance is hanging and attempts to terminate it. If you
- use <literal>InnoDB</literal> with large tables, you
- should increase this value.
- </para>
- </listitem>
-
- <listitem>
- <para>
- <literal>nonguarded</literal>
- </para>
-
- <para>
- This option disables Instance Manager monitoring
- functionality for the instance.
- </para>
- </listitem>
-
- </itemizedlist>
-
<para>
- Here are some sample instance sections:
+ The MySQL client-server protocol is used to communicate with
+ the MySQL Instance Manager. As such, you can connect to
+ Instance Manager using the standard <command>mysql</command>
+ client program, as well as the MySQL C API. Instance Manager
+ supports the version of the MySQL client-server protocol used
+ by the client tools and libraries distributed with MySQL 4.1
+ or later.
</para>
-<programlisting>
-[mysqld1]
-mysqld-path=/usr/local/mysql/libexec/mysqld
-socket=/tmp/mysql.sock
-port=3307
-server_id=1
-skip-stack-trace
-core-file
-skip-bdb
-log-bin
-log-error
-log=mylog
-log-slow-queries
-
-[mysqld2]
-nonguarded
-port=3308
-server_id=2
-mysqld-path= /home/cps/mysql/trees/mysql-¤t-series;/sql/mysqld
-socket = /tmp/mysql.sock5
-pid-file = /tmp/hostname.pid5
-datadir= /home/cps/mysql_data/data_dir1
-language=/home/cps/mysql/trees/mysql-¤t-series;/sql/share/english
-log-bin
-log=/tmp/fordel.log
-</programlisting>
-
</refsection>
<refsection id="instance-manager-commands">
Modified: trunk/refman-5.1/database-administration.xml
===================================================================
--- trunk/refman-5.1/database-administration.xml 2006-09-15 15:53:42 UTC (rev 3368)
+++ trunk/refman-5.1/database-administration.xml 2006-09-15 17:22:33 UTC (rev 3369)
Changed blocks: 3, Lines Added: 311, Lines Deleted: 312; 27689 bytes
@@ -13534,6 +13534,137 @@
</refsection>
+ <refsection id="instance-manager-configuration-files">
+
+ <title>MySQL Instance Manager Configuration Files</title>
+
+ <para>
+ Instance Manager uses the standard configuration file, unless
+ started with a <option>--defaults-file</option> option that
+ specifies a different file. On Unix, the standard file is
+ <filename>/etc/my.cnf</filename>. On Windows, the standard
+ file is <filename>my.ini</filename> in the directory where
+ Instance Manager is installed.
+ </para>
+
+ <para>
+ Instance Manager reads options for itself from the
+ <literal>[manager]</literal> section of the configuration
+ file, and options for server instances from
+ <literal>[mysqld<replaceable>N</replaceable>]</literal>
+ sections. The <literal>[manager]</literal> section contains
+ any of the options listed in
+ <xref linkend="instance-manager-command-options"/>, except for
+ those specified as having to be given as the first option on
+ the command line. Here is an example
+ <literal>[manager]</literal> section:
+ </para>
+
+<programlisting>
+# MySQL Instance Manager options section
+[manager]
+default-mysqld-path = /usr/local/mysql/libexec/mysqld
+socket=/tmp/manager.sock
+pid-file=/tmp/manager.pid
+password-file = /home/cps/.mysqlmanager.passwd
+monitoring-interval = 2
+port = 1999
+bind-address = 192.168.1.5
+</programlisting>
+
+ <warning>
+ <para>
+ The <literal>[mysqld]</literal> section name causes
+ unpredictable results when used in conjunction with the
+ Instance Manager. When using the Instance Manager, check
+ that no section is named <literal>[mysqld]</literal>.
+ </para>
+ </warning>
+
+ <para>
+ Each
<literal>[mysqld<replaceable>N</replaceable>]</literal>
+ instance section specifies options given by Instance Manager
+ to a server instance at startup. These are mainly common MySQL
+ server options (see <xref linkend="server-options"/>). The
+ following list describes additional options that are Instance
+ Manager-specific:
+ </para>
+
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ <literal>mysqld-path =
+ <replaceable>path</replaceable></literal>
+ </para>
+
+ <para>
+ The pathname of the <command>mysqld</command> server
+ binary to use for the instance.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>shutdown-delay =
+ <replaceable>seconds</replaceable></literal>
+ </para>
+
+ <para>
+ The number of seconds Instance Manager should wait for the
+ instance to shut down. The default value is 35 seconds.
+ After the delay expires, Instance Manager assumes that the
+ instance is hanging and attempts to terminate it. If you
+ use <literal>InnoDB</literal> with large tables, you
+ should increase this value.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>nonguarded</literal>
+ </para>
+
+ <para>
+ This option disables Instance Manager monitoring
+ functionality for the instance.
+ </para>
+ </listitem>
+
+ </itemizedlist>
+
+ <para>
+ Here are some sample instance sections:
+ </para>
+
+<programlisting>
+[mysqld1]
+mysqld-path=/usr/local/mysql/libexec/mysqld
+socket=/tmp/mysql.sock
+port=3307
+server_id=1
+skip-stack-trace
+core-file
+log-bin
+log-error
+log=mylog
+log-slow-queries
+
+[mysqld2]
+nonguarded
+port=3308
+server_id=2
+mysqld-path= /home/cps/mysql/trees/mysql-¤t-series;/sql/mysqld
+socket = /tmp/mysql.sock5
+pid-file = /tmp/hostname.pid5
+datadir= /home/cps/mysql_data/data_dir1
+language=/home/cps/mysql/trees/mysql-¤t-series;/sql/share/english
+log-bin
+log=/tmp/fordel.log
+</programlisting>
+
+ </refsection>
+
<refsection id="instance-manager-startup-process">
<title>Starting the MySQL Server with MySQL Instance Manager</title>
@@ -13646,78 +13777,64 @@
</refsection>
- <refsection id="instance-manager-security">
+ <refsection id="instance-manager-security-passwords">
- <title>Connecting to the MySQL Instance Manager and Creating User
Accounts</title>
+ <title>Instance Manager User and Password Management</title>
<para>
- The MySQL client-server protocol is used to communicate with
- the MySQL Instance Manager. As such, you can connect to
- Instance Manager using the standard <command>mysql</command>
- client program, as well as the MySQL C API. Instance Manager
- supports the version of the MySQL client-server protocol used
- by the client tools and libraries distributed with MySQL 4.1
- or later.
+ The Instance Manager stores its user information in a password
+ file. The default name of the password file is
+ <filename>/etc/mysqlmanager.passwd</filename>. To specify a
+ different location for the password file, use the
+ <option>--password-file</option> option.
</para>
- <refsection id="instance-manager-security-passwords">
-
- <title>Instance Manager User and Password Management</title>
-
+ <note>
<para>
- The Instance Manager stores its user information in a
- password file. The default name of the password file is
- <filename>/etc/mysqlmanager.passwd</filename>. To specify a
- different location for the password file, use the
- <option>--password-file</option> option.
+ The Instance Manager does not notice changes to the password
+ file. You must restart it after making password entry
+ changes.
</para>
+ </note>
- <note>
- <para>
- The Instance Manager does not notice changes to the
- password file. You must restart it after making password
- entry changes.
- </para>
- </note>
+ <para>
+ Password entries have the following format:
+ </para>
- <para>
- Password entries have the following format:
- </para>
-
<programlisting>
petr:*35110DC9B4D8140F5DE667E28C72DD2597B5C848
</programlisting>
- <para>
- Instance Manager accounts are associated with a username and
- password only. This differs from MySQL Server accounts,
- which also are associated with a hostname (see
- <xref linkend="user-names"/>). This means that a client can
- connect to Instance Manager with a given username from any
- host. To limit connections only from the local host, start
- Instance Manager with the
- <option>--bind-address=127.0.0.1</option> option so that it
- listens only to the local network interface. Clients can
- connect like this:
- </para>
+ <para>
+ Instance Manager accounts are associated with a username and
+ password only. This differs from MySQL Server accounts, which
+ also are associated with a hostname (see
+ <xref linkend="user-names"/>). This means that a client can
+ connect to Instance Manager with a given username from any
+ host. To limit connections only from the local host, start
+ Instance Manager with the
+ <option>--bind-address=127.0.0.1</option> option so that it
+ listens only to the local network interface. Clients can
+ connect like this:
+ </para>
<programlisting>
shell> <userinput>mysql -h 127.0.0.1 -P 2273</userinput>
</programlisting>
- <para>
- If the password file does not exist or contains no password
- entries, you cannot connect to the Instance Manager.
- </para>
+ <para>
+ If the password file does not exist or contains no password
+ entries, you cannot connect to the Instance Manager.
+ </para>
- <para>
- Before MySQL 5.1.12, the only option for creating password
- file entries is <option>--passwd</option>, which causes
- Instance Manager to prompt for username and password values
- and display the resulting entry. You can save the output in
- the <filename>/etc/mysqlmanager.passwd</filename> password
- file to store it. Here is an example:
- </para>
+ <para>
+ Before MySQL 5.1.12, the only option for creating password
+ file entries is <option>--passwd</option>, which causes
+ Instance Manager to prompt for username and password values
+ and display the resulting entry. You can save the output in
+ the <filename>/etc/mysqlmanager.passwd</filename> password
+ file to store it. Here is an example:
+ </para>
<programlisting>
shell> <userinput>mysqlmanager --passwd >>
/etc/mysqlmanager.passwd</userinput>
@@ -13727,334 +13844,216 @@
Re-type password: <userinput>mikepass</userinput>
</programlisting>
- <para>
- At the prompts, enter the username and password for the new
- Instance Manager user. You must enter the password twice. It
- does not echo to the screen, so double entry guards against
- entering a different password than you intend (if the two
- passwords do not match, no entry is generated).
- </para>
+ <para>
+ At the prompts, enter the username and password for the new
+ Instance Manager user. You must enter the password twice. It
+ does not echo to the screen, so double entry guards against
+ entering a different password than you intend (if the two
+ passwords do not match, no entry is generated).
+ </para>
- <para>
- The preceding command causes the following line to be added
- to <filename>/etc/mysqlmanager.passwd</filename>:
- </para>
+ <para>
+ The preceding command causes the following line to be added to
+ <filename>/etc/mysqlmanager.passwd</filename>:
+ </para>
<programlisting>
mike:*BBF1F551DD9DD96A01E66EC7DDC073911BAD17BA
</programlisting>
- <para>
- Beginning with MySQL 5.1.12, the <option>--passwd</option>
- option is renamed to <option>--print-password-line</option>
- and there are several other options for managing user
- accounts from the command line. For example, the
- <option>--username</option> and
<option>--password</option>
- options are available on the command line for specifying the
- username and password for an account entry. You can use them
- to generate an entry with no prompting like this (type the
- command on a single line):
- </para>
+ <para>
+ Beginning with MySQL 5.1.12, the <option>--passwd</option>
+ option is renamed to <option>--print-password-line</option>
+ and there are several other options for managing user accounts
+ from the command line. For example, the
+ <option>--username</option> and
<option>--password</option>
+ options are available on the command line for specifying the
+ username and password for an account entry. You can use them
+ to generate an entry with no prompting like this (type the
+ command on a single line):
+ </para>
<programlisting>
shell> <userinput>mysqlmanager --print-password-line</userinput>
<userinput>--username=mike --password=mikepass >>
/etc/mysqlmanager.passwd</userinput>
</programlisting>
- <para>
- If you omit the <option>--username</option> or
- <option>--password</option> option, Instance Manager prompts
- for the required values.
- </para>
+ <para>
+ If you omit the <option>--username</option> or
+ <option>--password</option> option, Instance Manager prompts
+ for the required values.
+ </para>
- <para>
- <option>--print-password-line</option> causes Instance
- Manager to send the resulting account entry to its output,
- which you can append to the password file. The following
- list describes other account-management options that cause
- Instance Manager to operate directly on the password file.
- (These options make Instance Manager scriptable for
- account-management purposes.) For these operations on the
- password file to succeed, the file must exist and it must be
- accessible by Instance Manager. If there is no password file
- yet, create it as an empty file and ensure that its
- ownership and access modes allow it to be read and written
- by Instance Manager. The default password file is used
- unless you specify a <option>--password-file</option>
- option.
- </para>
+ <para>
+ <option>--print-password-line</option> causes Instance Manager
+ to send the resulting account entry to its output, which you
+ can append to the password file. The following list describes
+ other account-management options that cause Instance Manager
+ to operate directly on the password file. (These options make
+ Instance Manager scriptable for account-management purposes.)
+ For these operations on the password file to succeed, the file
+ must exist and it must be accessible by Instance Manager. If
+ there is no password file yet, create it as an empty file and
+ ensure that its ownership and access modes allow it to be read
+ and written by Instance Manager. The default password file is
+ used unless you specify a <option>--password-file</option>
+ option.
+ </para>
- <para>
- To ensure consistent treatment of the password file, it
- should be owned by the system account that you use for
- running Instance Manager to manage server instances, and you
- should invoke it from that account when you use it to manage
- accounts in the password file.
- </para>
+ <para>
+ To ensure consistent treatment of the password file, it should
+ be owned by the system account that you use for running
+ Instance Manager to manage server instances, and you should
+ invoke it from that account when you use it to manage accounts
+ in the password file.
+ </para>
- <itemizedlist>
+ <itemizedlist>
- <listitem>
- <para>
- Create a new user:
- </para>
+ <listitem>
+ <para>
+ Create a new user:
+ </para>
<programlisting>
mysqlmanager --add-user --username=<replaceable>user_name</replaceable>
[--password=<replaceable>password</replaceable>]
</programlisting>
- <para>
- This command adds a new entry with the given username
- and password to the password file. The
- <option>--username</option> (or
<option>-u</option>)
- option is required. <command>mysqlmanager</command>
- prompts for the password it is is not given on the
- command line with the <option>--password</option> (or
- <option>-p</option> option. The command fails if the
- user already exists.
- </para>
- </listitem>
+ <para>
+ This command adds a new entry with the given username and
+ password to the password file. The
+ <option>--username</option> (or
<option>-u</option>)
+ option is required. <command>mysqlmanager</command>
+ prompts for the password it is is not given on the command
+ line with the <option>--password</option> (or
+ <option>-p</option> option. The command fails if the user
+ already exists.
+ </para>
+ </listitem>
- <listitem>
- <para>
- Drop an existing user:
- </para>
+ <listitem>
+ <para>
+ Drop an existing user:
+ </para>
<programlisting>
mysqlmanager --drop-user --username=<replaceable>user_name</replaceable>
</programlisting>
- <para>
- This command removes the entry with the given username
- from the password file. The username is required. The
- command fails if the user does not exist.
- </para>
- </listitem>
+ <para>
+ This command removes the entry with the given username
+ from the password file. The username is required. The
+ command fails if the user does not exist.
+ </para>
+ </listitem>
- <listitem>
- <para>
- Change the password for an existing user:
- </para>
+ <listitem>
+ <para>
+ Change the password for an existing user:
+ </para>
<programlisting>
mysqlmanager --edit-user --username=<replaceable>user_name</replaceable>
[--password=<replaceable>password</replaceable>]
</programlisting>
- <para>
- This command changes the given user's password in the
- password file. The username is required.
- <command>mysqlmanager</command> prompts for the password
- it is is not given on the command line. The command
- fails if the user does not exist.
- </para>
- </listitem>
+ <para>
+ This command changes the given user's password in the
+ password file. The username is required.
+ <command>mysqlmanager</command> prompts for the password
+ it is is not given on the command line. The command fails
+ if the user does not exist.
+ </para>
+ </listitem>
- <listitem>
- <para>
- List existing users:
- </para>
+ <listitem>
+ <para>
+ List existing users:
+ </para>
<programlisting>
mysqlmanager --list-users
</programlisting>
- <para>
- This command lists the usernames of the accounts in the
- password file.
- </para>
- </listitem>
+ <para>
+ This command lists the usernames of the accounts in the
+ password file.
+ </para>
+ </listitem>
- <listitem>
- <para>
- Check the password file:
- </para>
+ <listitem>
+ <para>
+ Check the password file:
+ </para>
<programlisting>
mysqlmanager --check-password-file
</programlisting>
- <para>
- This command performs a consistency and validity check
- of the password file. The command files if there is
- something wrong with the file.
- </para>
- </listitem>
+ <para>
+ This command performs a consistency and validity check of
+ the password file. The command files if there is something
+ wrong with the file.
+ </para>
+ </listitem>
- <listitem>
- <para>
- Empty the password file:
- </para>
+ <listitem>
+ <para>
+ Empty the password file:
+ </para>
<programlisting>
mysqlmanager --clean-password-file
</programlisting>
- <para>
- This command empties the password file, which has the
- effect of dropping all users listed in it.
- </para>
- </listitem>
+ <para>
+ This command empties the password file, which has the
+ effect of dropping all users listed in it.
+ </para>
+ </listitem>
- </itemizedlist>
+ </itemizedlist>
- </refsection>
-
- <refsection id="instance-manager-security-monitoring">
-
- <title>MySQL Server Accounts for Status Monitoring</title>
-
- <para>
- To monitor the status of a server instance, the MySQL
- Instance Manager attempts to connect to the MySQL server
- instance at regular intervals using the
- <literal>MySQL_Instance_Manager@localhost</literal> user
- account with a password of
- <literal>check_connection</literal>.
- </para>
-
- <para>
- You are <emphasis>not</emphasis> required to create a
- <literal>MySQL_Instance_M@localhost</literal> user account
- in order for the MySQL Instance Manager to monitor server
- status, as a login failure is sufficient to identify that
- the server is operational. However, if the account does not
- exist, failed connection attempts are logged by the server
- to its general query log (see <xref linkend="query-log"/>).
- </para>
-
- </refsection>
-
</refsection>
- <refsection id="instance-manager-configuration-files">
+ <refsection id="instance-manager-security-monitoring">
- <title>MySQL Instance Manager Configuration Files</title>
+ <title>MySQL Server Accounts for Status Monitoring</title>
<para>
- Instance Manager uses the standard configuration file, unless
- started with a <option>--defaults-file</option> option that
- specifies a different file. On Unix, the standard file is
- <filename>/etc/my.cnf</filename>. On Windows, the standard
- file is <filename>my.ini</filename> in the directory where
- Instance Manager is installed.
+ To monitor the status of a server instance, the MySQL Instance
+ Manager attempts to connect to the MySQL server instance at
+ regular intervals using the
+ <literal>MySQL_Instance_Manager@localhost</literal> user
+ account with a password of
+ <literal>check_connection</literal>.
</para>
<para>
- Instance Manager reads options for itself from the
- <literal>[manager]</literal> section of the configuration
- file, and options for server instances from
- <literal>[mysqld<replaceable>N</replaceable>]</literal>
- sections. The <literal>[manager]</literal> section contains
- any of the options listed in
- <xref linkend="instance-manager-command-options"/>, except for
- those specified as having to be given as the first option on
- the command line. Here is an example
- <literal>[manager]</literal> section:
+ You are <emphasis>not</emphasis> required to create a
+ <literal>MySQL_Instance_M@localhost</literal> user account in
+ order for the MySQL Instance Manager to monitor server status,
+ as a login failure is sufficient to identify that the server
+ is operational. However, if the account does not exist, failed
+ connection attempts are logged by the server to its general
+ query log (see <xref linkend="query-log"/>).
</para>
-<programlisting>
-# MySQL Instance Manager options section
-[manager]
-default-mysqld-path = /usr/local/mysql/libexec/mysqld
-socket=/tmp/manager.sock
-pid-file=/tmp/manager.pid
-password-file = /home/cps/.mysqlmanager.passwd
-monitoring-interval = 2
-port = 1999
-bind-address = 192.168.1.5
-</programlisting>
+ </refsection>
- <warning>
- <para>
- The <literal>[mysqld]</literal> section name causes
- unpredictable results when used in conjunction with the
- Instance Manager. When using the Instance Manager, check
- that no section is named <literal>[mysqld]</literal>.
- </para>
- </warning>
+ <refsection id="instance-manager-security">
- <para>
- Each
<literal>[mysqld<replaceable>N</replaceable>]</literal>
- instance section specifies options given by Instance Manager
- to a server instance at startup. These are mainly common MySQL
- server options (see <xref linkend="server-options"/>). The
- following list describes additional options that are Instance
- Manager-specific:
- </para>
+ <title>Connecting to the MySQL Instance Manager and Creating User
Accounts</title>
- <itemizedlist>
-
- <listitem>
- <para>
- <literal>mysqld-path =
- <replaceable>path</replaceable></literal>
- </para>
-
- <para>
- The pathname of the <command>mysqld</command> server
- binary to use for the instance.
- </para>
- </listitem>
-
- <listitem>
- <para>
- <literal>shutdown-delay =
- <replaceable>seconds</replaceable></literal>
- </para>
-
- <para>
- The number of seconds Instance Manager should wait for the
- instance to shut down. The default value is 35 seconds.
- After the delay expires, Instance Manager assumes that the
- instance is hanging and attempts to terminate it. If you
- use <literal>InnoDB</literal> with large tables, you
- should increase this value.
- </para>
- </listitem>
-
- <listitem>
- <para>
- <literal>nonguarded</literal>
- </para>
-
- <para>
- This option disables Instance Manager monitoring
- functionality for the instance.
- </para>
- </listitem>
-
- </itemizedlist>
-
<para>
- Here are some sample instance sections:
+ The MySQL client-server protocol is used to communicate with
+ the MySQL Instance Manager. As such, you can connect to
+ Instance Manager using the standard <command>mysql</command>
+ client program, as well as the MySQL C API. Instance Manager
+ supports the version of the MySQL client-server protocol used
+ by the client tools and libraries distributed with MySQL 4.1
+ or later.
</para>
-<programlisting>
-[mysqld1]
-mysqld-path=/usr/local/mysql/libexec/mysqld
-socket=/tmp/mysql.sock
-port=3307
-server_id=1
-skip-stack-trace
-core-file
-log-bin
-log-error
-log=mylog
-log-slow-queries
-
-[mysqld2]
-nonguarded
-port=3308
-server_id=2
-mysqld-path= /home/cps/mysql/trees/mysql-¤t-series;/sql/mysqld
-socket = /tmp/mysql.sock5
-pid-file = /tmp/hostname.pid5
-datadir= /home/cps/mysql_data/data_dir1
-language=/home/cps/mysql/trees/mysql-¤t-series;/sql/share/english
-log-bin
-log=/tmp/fordel.log
-</programlisting>
-
</refsection>
<refsection id="instance-manager-commands">
| Thread |
|---|
| • svn commit - mysqldoc@docsrva: r3369 - in trunk: refman-5.0 refman-5.1 | paul | 15 Sep |