| List: | Commits | « Previous MessageNext Message » | |
| From: | paul | Date: | September 22 2006 10:04pm |
| Subject: | svn commit - mysqldoc@docsrva: r3438 - in trunk: . refman-5.0 refman-5.1 | ||
| View as plain text | |||
Author: paul Date: 2006-09-22 22:04:49 +0200 (Fri, 22 Sep 2006) New Revision: 3438 Log: r13983@polar: paul | 2006-09-22 15:07:06 -0500 Instance Manager: General revisions. Modified: trunk/refman-5.0/database-administration.xml trunk/refman-5.1/database-administration.xml Property changes on: trunk ___________________________________________________________________ Name: svk:merge - 4767c598-dc10-0410-bea0-d01b485662eb:/mysqldoc-local/mysqldoc/trunk:13979 7d8d2c4e-af1d-0410-ab9f-b038ce55645b:/mysqldoc-local/mysqldoc:7902 b5ec3a16-e900-0410-9ad2-d183a3acac99:/mysqldoc-local/mysqldoc/trunk:14218 bf112a9c-6c03-0410-a055-ad865cd57414:/mysqldoc-local/mysqldoc/trunk:10466 + 4767c598-dc10-0410-bea0-d01b485662eb:/mysqldoc-local/mysqldoc/trunk:13983 7d8d2c4e-af1d-0410-ab9f-b038ce55645b:/mysqldoc-local/mysqldoc:7902 b5ec3a16-e900-0410-9ad2-d183a3acac99:/mysqldoc-local/mysqldoc/trunk:14218 bf112a9c-6c03-0410-a055-ad865cd57414:/mysqldoc-local/mysqldoc/trunk:10466 Modified: trunk/refman-5.0/database-administration.xml =================================================================== --- trunk/refman-5.0/database-administration.xml 2006-09-22 18:07:27 UTC (rev 3437) +++ trunk/refman-5.0/database-administration.xml 2006-09-22 20:04:49 UTC (rev 3438) Changed blocks: 17, Lines Added: 87, Lines Deleted: 47; 11762 bytes @@ -13082,17 +13082,20 @@ <listitem> <para> - A guarded instance is monitored by Instance Manager. - If the instance crashes, Instance Manager detects this - and restarts it. + When Instance Manager starts, it starts each guarded + instance. If the instance crashes, Instance Manager + detects this and restarts it. When Instance Manager + stops, it stops the instance. </para> </listitem> <listitem> <para> - A nonguarded instance is not monitored by Instance - Manager. If the instance crashes after being started, - Instance Manager does not restart it. + A nonguarded instance is not started when Instance + Manager starts or monitored by it. If the instance + crashes after being started, Instance Manager does not + restart it. When Instance Manager exits, it does not + stop the instance if it is running. </para> </listitem> @@ -13112,7 +13115,9 @@ configuring instances, so that the need to edit the configuration file manually is reduced or eliminated. </para> + </listitem> + <listitem> <para> Instance Manager provides remote instance management. That is, it runs on the host where you want to control MySQL @@ -13138,7 +13143,14 @@ The MySQL Instance Manager supports a number of command options. For a brief listing, invoke <command>mysqlmanager</command> with the - <option>--help</option> option. + <option>--help</option> option. Options may be given on the + command line or in the Instance Manager configuration file. On + Windows, the standard configuration file is + <filename>my.ini</filename> in the directory where Instance + Manager is installed. On Unix, the standard file is + <filename>/etc/my.cnf</filename>. To specify a different + configuration file, start Instance Manager with the + <option>--defaults-file</option> option. </para> <para> @@ -13602,8 +13614,10 @@ </para> <para> - On Windows, run Instance Manager in standalone mode. This - option was added in MySQL 5.0.13. + This option is used on Windows to run Instance Manager in + standalone mode. You should specify it when you start + Instance Manager from the command line. This option was + added in MySQL 5.0.13. </para> </listitem> @@ -13709,6 +13723,7 @@ Instance Manager reads options for itself from the <literal>[manager]</literal> section of the configuration file, and options for server instances from + <literal>[mysqld]</literal> or <literal>[mysqld<replaceable>N</replaceable>]</literal> sections. The <literal>[manager]</literal> section contains any of the options listed in @@ -13730,28 +13745,29 @@ 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> + Each <literal>[mysqld]</literal> or + <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"/>). In addition, a <literal>[mysqld<replaceable>N</replaceable>]</literal> - section can contain the following options, which are specific - to Instance Manager. These options are interpreted by Instance - Manager itself; it does not pass them to the server when it - attempts to start that server. + section can contain the options in the following list, which + are specific to Instance Manager. These options are + interpreted by Instance Manager itself; it does not pass them + to the server when it attempts to start that server. </para> + <warning> + <para> + The Instance Manager-specific options must not be used in a + <literal>[mysqld]</literal> section. If a server is started + without using Instance Manager, it will not recognize these + options and will fail to start properly. + </para> + </warning> + <itemizedlist> <listitem> @@ -13774,8 +13790,11 @@ <para> This option disables Instance Manager monitoring functionality for the server instance. By default, an - instance is guarded: Instance Manager monitors its status - and attempts to restart it if it fails. + instance is guarded: At Instance Manager start time, it + starts the instance. It also monitors the instance status + and attempts to restart it if it fails. At Instance + Manager exit time, it stops the instance. None of these + things happen for nonguarded instances. </para> </listitem> @@ -13835,6 +13854,16 @@ <title>Starting the MySQL Server with MySQL Instance Manager</title> <para> + This section discusses how Instance Manager starts server + instances when it starrts. However, before you start Instance + Manager, you should set up a password file for it. Otherwise, + you will not be able to connect to Instance Manager to control + it after it starts. For details about creating Instance + Manager accounts, see + <xref linkend="instance-manager-security-passwords"/>. + </para> + + <para> Normally, the <command>mysqld</command> MySQL database server is started with the <command>mysql.server</command> script, which usually resides in the <literal>/etc/init.d/</literal> @@ -13894,10 +13923,9 @@ <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>. + It is possible for a <literal>[mysqld]</literal> section to + exist, but you should avoid using it in conjunction with + Instance Manager. </para> </warning> @@ -13912,8 +13940,8 @@ option to let Instance Manager know where the <command>mysqld</command> binary resides. If there are multiple instances, it may also be necessary to set other - options, such as <literal>datadir</literal> and - <literal>port</literal> to ensure that each instance has a + options such as <literal>datadir</literal> and + <literal>port</literal>, to ensure that each instance has a different data directory and TCP/IP port number. <xref linkend="multiple-servers"/>, discusses the configuration values that must differ for each instance when @@ -13965,14 +13993,19 @@ <para> The Instance Manager stores its user information in a password - file. On Unix, the default file is - <filename>/etc/mysqlmanager.passwd</filename>. On Windows, the - default is <filename>mysqlmanager.passwd</filename> in the - directory where Instance Manager is installed. To specify a + file. On Windows, the default is + <filename>mysqlmanager.passwd</filename> in the directory + where Instance Manager is installed. On Unix, the default file + is <filename>/etc/mysqlmanager.passwd</filename>. To specify a different location for the password file, use the <option>--password-file</option> option. </para> + <para> + If the password file does not exist or contains no password + entries, you cannot connect to the Instance Manager. + </para> + <note> <para> Any Instance Manager process that is running to monitor @@ -13985,7 +14018,7 @@ <para> Entries in the password file have the following format, where the two fields are the account username and encrypted - password: + password, separated by a colon: </para> <programlisting> @@ -13993,9 +14026,9 @@ </programlisting> <para> - Password encryption is the same as that used by MySQL Server. - It is a one-way operation; no means are provided for - decrypting encrypted passwords. + Instance Manager password encryption is the same as that used + by MySQL Server. It is a one-way operation; no means are + provided for decrypting encrypted passwords. </para> <para> @@ -14007,7 +14040,7 @@ <listitem> <para> - MySQL Server accounts associated with a hostname, + MySQL Server accounts are associated with a hostname, username, and password (see <xref linkend="user-names"/>). </para> </listitem> @@ -14023,8 +14056,8 @@ <para> This means that a client can connect to Instance Manager with - a given username from any host. To limit connections to - clients that connect from the local host, start Instance + a given username from any host. To limit connections so that + clients can connect 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. Remote clients will not be able to connect. Local clients can @@ -14036,11 +14069,6 @@ </programlisting> <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 @@ -14190,6 +14218,18 @@ </para> </listitem> + <listitem> + <para> + If a <literal>[mysqld]</literal> instance section exists + in the configuration file, it must not contain any + Instance Manager-specific options (see + <xref linkend="instance-manager-configuration-files"/>). + Therefore, you must not add any of these options if you + change the configuration for an instance named + <literal>mysqld</literal>. + </para> + </listitem> + </itemizedlist> <para> Modified: trunk/refman-5.1/database-administration.xml =================================================================== --- trunk/refman-5.1/database-administration.xml 2006-09-22 18:07:27 UTC (rev 3437) +++ trunk/refman-5.1/database-administration.xml 2006-09-22 20:04:49 UTC (rev 3438) Changed blocks: 21, Lines Added: 102, Lines Deleted: 62; 14823 bytes @@ -561,13 +561,13 @@ in configuration files (Option file), server system variables (Server Var), and status variables (Status var) in one unified list, with notification of where each option/variable is - valid. If a server option set on the command line or in an option - file differs from the name of the corresponding server system - or status variable, the variable name is noted immediately - below the corresponding option. Please see the corresponding - sections for details on setting and using the options and - variables. Where appropriate, a direct link to further - information on the item as available. + valid. If a server option set on the command line or in an + option file differs from the name of the corresponding server + system or status variable, the variable name is noted + immediately below the corresponding option. Please see the + corresponding sections for details on setting and using the + options and variables. Where appropriate, a direct link to + further information on the item as available. </para> <note> @@ -12863,17 +12863,20 @@ <listitem> <para> - A guarded instance is monitored by Instance Manager. - If the instance crashes, Instance Manager detects this - and restarts it. + When Instance Manager starts, it starts each guarded + instance. If the instance crashes, Instance Manager + detects this and restarts it. When Instance Manager + stops, it stops the instance. </para> </listitem> <listitem> <para> - A nonguarded instance is not monitored by Instance - Manager. If the instance crashes after being started, - Instance Manager does not restart it. + A nonguarded instance is not started when Instance + Manager starts or monitored by it. If the instance + crashes after being started, Instance Manager does not + restart it. When Instance Manager exits, it does not + stop the instance if it is running. </para> </listitem> @@ -12893,7 +12896,9 @@ configuring instances, so that the need to edit the configuration file manually is reduced or eliminated. </para> + </listitem> + <listitem> <para> Instance Manager provides remote instance management. That is, it runs on the host where you want to control MySQL @@ -12919,7 +12924,14 @@ The MySQL Instance Manager supports a number of command options. For a brief listing, invoke <command>mysqlmanager</command> with the - <option>--help</option> option. + <option>--help</option> option. Options may be given on the + command line or in the Instance Manager configuration file. On + Windows, the standard configuration file is + <filename>my.ini</filename> in the directory where Instance + Manager is installed. On Unix, the standard file is + <filename>/etc/my.cnf</filename>. To specify a different + configuration file, start Instance Manager with the + <option>--defaults-file</option> option. </para> <para> @@ -13588,7 +13600,9 @@ </para> <para> - On Windows, run Instance Manager in standalone mode. + This option is used on Windows to run Instance Manager in + standalone mode. You should specify it when you start + Instance Manager from the command line. </para> </listitem> @@ -13714,6 +13728,7 @@ Instance Manager reads options for itself from the <literal>[manager]</literal> section of the configuration file, and options for server instances from + <literal>[mysqld]</literal> or <literal>[mysqld<replaceable>N</replaceable>]</literal> sections. The <literal>[manager]</literal> section contains any of the options listed in @@ -13735,28 +13750,29 @@ 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> + Each <literal>[mysqld]</literal> or + <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"/>). In addition, a <literal>[mysqld<replaceable>N</replaceable>]</literal> - section can contain the following options, which are specific - to Instance Manager. These options are interpreted by Instance - Manager itself; it does not pass them to the server when it - attempts to start that server. + section can contain the options in the following list, which + are specific to Instance Manager. These options are + interpreted by Instance Manager itself; it does not pass them + to the server when it attempts to start that server. </para> + <warning> + <para> + The Instance Manager-specific options must not be used in a + <literal>[mysqld]</literal> section. If a server is started + without using Instance Manager, it will not recognize these + options and will fail to start properly. + </para> + </warning> + <itemizedlist> <listitem> @@ -13779,8 +13795,11 @@ <para> This option disables Instance Manager monitoring functionality for the server instance. By default, an - instance is guarded: Instance Manager monitors its status - and attempts to restart it if it fails. + instance is guarded: At Instance Manager start time, it + starts the instance. It also monitors the instance status + and attempts to restart it if it fails. At Instance + Manager exit time, it stops the instance. None of these + things happen for nonguarded instances. </para> </listitem> @@ -13839,6 +13858,16 @@ <title>Starting the MySQL Server with MySQL Instance Manager</title> <para> + This section discusses how Instance Manager starts server + instances when it starrts. However, before you start Instance + Manager, you should set up a password file for it. Otherwise, + you will not be able to connect to Instance Manager to control + it after it starts. For details about creating Instance + Manager accounts, see + <xref linkend="instance-manager-security-passwords"/>. + </para> + + <para> Normally, the <command>mysqld</command> MySQL database server is started with the <command>mysql.server</command> script, which usually resides in the <literal>/etc/init.d/</literal> @@ -13885,10 +13914,9 @@ <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>. + It is possible for a <literal>[mysqld]</literal> section to + exist, but you should avoid using it in conjunction with + Instance Manager. </para> </warning> @@ -13903,8 +13931,8 @@ option to let Instance Manager know where the <command>mysqld</command> binary resides. If there are multiple instances, it may also be necessary to set other - options, such as <literal>datadir</literal> and - <literal>port</literal> to ensure that each instance has a + options such as <literal>datadir</literal> and + <literal>port</literal>, to ensure that each instance has a different data directory and TCP/IP port number. <xref linkend="multiple-servers"/>, discusses the configuration values that must differ for each instance when @@ -13956,14 +13984,19 @@ <para> The Instance Manager stores its user information in a password - file. On Unix, the default file is - <filename>/etc/mysqlmanager.passwd</filename>. On Windows, the - default is <filename>mysqlmanager.passwd</filename> in the - directory where Instance Manager is installed. To specify a + file. On Windows, the default is + <filename>mysqlmanager.passwd</filename> in the directory + where Instance Manager is installed. On Unix, the default file + is <filename>/etc/mysqlmanager.passwd</filename>. To specify a different location for the password file, use the <option>--password-file</option> option. </para> + <para> + If the password file does not exist or contains no password + entries, you cannot connect to the Instance Manager. + </para> + <note> <para> Any Instance Manager process that is running to monitor @@ -13976,7 +14009,7 @@ <para> Entries in the password file have the following format, where the two fields are the account username and encrypted - password: + password, separated by a colon: </para> <programlisting> @@ -13984,9 +14017,9 @@ </programlisting> <para> - Password encryption is the same as that used by MySQL Server. - It is a one-way operation; no means are provided for - decrypting encrypted passwords. + Instance Manager password encryption is the same as that used + by MySQL Server. It is a one-way operation; no means are + provided for decrypting encrypted passwords. </para> <para> @@ -13998,7 +14031,7 @@ <listitem> <para> - MySQL Server accounts associated with a hostname, + MySQL Server accounts are associated with a hostname, username, and password (see <xref linkend="user-names"/>). </para> </listitem> @@ -14014,8 +14047,8 @@ <para> This means that a client can connect to Instance Manager with - a given username from any host. To limit connections to - clients that connect from the local host, start Instance + a given username from any host. To limit connections so that + clients can connect 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. Remote clients will not be able to connect. Local clients can @@ -14027,11 +14060,6 @@ </programlisting> <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 @@ -14095,15 +14123,15 @@ 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. (The + For operations on the password file to succeed, the file must + exist and it must be accessible by Instance Manager. (The exception is <option>--clean-password-file</option>, which creates the file if it does not exist. Alternatively, if there - is no password file yet, manually 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. + is no password file, manually 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> @@ -14441,6 +14469,18 @@ </para> </listitem> + <listitem> + <para> + If a <literal>[mysqld]</literal> instance section exists + in the configuration file, it must not contain any + Instance Manager-specific options (see + <xref linkend="instance-manager-configuration-files"/>). + Therefore, you must not add any of these options if you + change the configuration for an instance named + <literal>mysqld</literal>. + </para> + </listitem> + </itemizedlist> <para> @@ -14454,7 +14494,7 @@ <para> <literal>CREATE INSTANCE <replaceable>instance_name</replaceable> - [<replaceable>option_name</replaceable>[=<replaceable>option_val</replaceable>], + [<replaceable>option_name</replaceable>[=<replaceable>option_value</replaceable>], ...]</literal> </para> @@ -14495,7 +14535,7 @@ </para> <programlisting> -mysql> <userinput>CREATE INSTANCE mysqld98 basedir=/var/mysql98;</userinput> +mysql> <userinput>CREATE INSTANCE mysqld98 basedir="/var/mysql98";</userinput> Query OK, 0 rows affected (0,00 sec) </programlisting>
| Thread | ||
|---|---|---|
| • svn commit - mysqldoc@docsrva: r3438 - in trunk: . refman-5.0 refman-5.1 | paul | 22 Sep |
© 1995-2008 MySQL AB, 2008-2009 Sun Microsystems, Inc.
Page generated in 0.842 sec. using MySQL 5.1.14-beta-log