List:Commits« Previous MessageNext Message »
From:paul Date:September 16 2006 5:02pm
Subject:svn commit - mysqldoc@docsrva: r3382 - in trunk: refman-5.0 refman-5.1
View as plain text  
Author: paul
Date: 2006-09-16 17:02:17 +0200 (Sat, 16 Sep 2006)
New Revision: 3382

Log:
Instance Manager:
- Add list of general capabilities to intro
- Add list of command-execution principles to section that describes commands


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 23:38:41 UTC (rev 3381)
+++ trunk/refman-5.0/database-administration.xml	2006-09-16 15:02:17 UTC (rev 3382)
Changed blocks: 2, Lines Added: 112, Lines Deleted: 16; 5689 bytes

@@ -13028,13 +13028,73 @@
           more instances of MySQL Server. Because Instance Manager can
           manage multiple server instances, it can also be used in place
           of the <command>mysqld_multi</command> script. Instance
-          Manager runs on the host where you want to control MySQL
-          Server instances, but you can use it for remote management
-          because you can connect to it from a remote host to perform
-          instance-management operations. A more detailed description of
-          MySQL Instance Manager follows.
+          Manager offers these capabilities:
         </para>
 
+        <itemizedlist>
+
+          <listitem>
+            <para>
+              Instance Manager can start and stop instances, and report
+              on the status of instances.
+            </para>
+          </listitem>
+
+          <listitem>
+            <para>
+              Server instances can be treated as guarded or unguarded:
+            </para>
+
+            <itemizedlist>
+
+              <listitem>
+                <para>
+                  A guarded instance is monitored by Instance Manager.
+                  If the instance crashes, Instance Manager detects this
+                  and restarts it.
+                </para>
+              </listitem>
+
+              <listitem>
+                <para>
+                  A nonguarded instance is not monitored by Instance
+                  Manager. If the instance crases, Instance Manager will
+                  not know this and does not restart it.
+                </para>
+              </listitem>
+
+            </itemizedlist>
+
+            <para>
+              By default, instances are guarded. An instance can be
+              designated as nonguarded by including the
+              <option>nonguarded</option> option in the configuration
+              file.
+            </para>
+          </listitem>
+
+          <listitem>
+            <para>
+              Instance Manager provides an interactive interface for
+              configuring instances, so that the need to editing the
+              configuration file manually is reduced or eliminated.
+            </para>
+
+            <para>
+              Instance Manager provides remote instance management. That
+              is, it runs on the host where you want to control MySQL
+              Server instances, but you can connect to it from a remote
+              host to perform instance-management operations.
+            </para>
+          </listitem>
+
+        </itemizedlist>
+
+        <para>
+          The following sections describe MySQL Instance Manager
+          operation in more detail.
+        </para>
+
       </refsection>
 
       <refsection id="instance-manager-command-options">

@@ -13978,23 +14038,59 @@
 
         <para>
           After you connect to MySQL Instance Manager, you can issue
-          commands. The following list shows the commands that Instance
-          Manager accepts, with examples. For some of these commands,
-          Instance Manager reads or writes the configuration file. For
-          these commands to succeed, the configuration file must be
-          accessible to Instance Manager for read or write access. On
-          Unix, the standard configuration 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 specify a different
-          configuration file, start Instance Manager with the
-          <option>--defaults-file</option> option.
+          commands. The following general principles apply to Instance
+          Manager command execution:
         </para>
 
         <itemizedlist>
 
           <listitem>
             <para>
+              Commands that take an instance name fail if the name is
+              not a valid instance name.
+            </para>
+          </listitem>
+
+          <listitem>
+            <para>
+              Commands other than <literal>CREATE INSTANCE</literal>
+              that take an instance name fail if the instance does not
+              exist.
+            </para>
+          </listitem>
+
+          <listitem>
+            <para>
+              Instance Manager maintains information about instance
+              configuration in an internal (in-memory) cache. Initially,
+              this information comes from the configuration file. Some
+              commands may change the configuration of an instance. The
+              configuration file must be accessible and not malformed.
+            </para>
+          </listitem>
+
+          <listitem>
+            <para>
+              On Unix, the standard configuration 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 specify a different
+              configuration file, start Instance Manager with the
+              <option>--defaults-file</option> option.
+            </para>
+          </listitem>
+
+        </itemizedlist>
+
+        <para>
+          The following list describes the commands that Instance
+          Manager accepts, with examples.
+        </para>
+
+        <itemizedlist>
+
+          <listitem>
+            <para>
               <literal>START INSTANCE
               <replaceable>instance_name</replaceable></literal>
             </para>


Modified: trunk/refman-5.1/database-administration.xml
===================================================================
--- trunk/refman-5.1/database-administration.xml	2006-09-15 23:38:41 UTC (rev 3381)
+++ trunk/refman-5.1/database-administration.xml	2006-09-16 15:02:17 UTC (rev 3382)
Changed blocks: 2, Lines Added: 127, Lines Deleted: 16; 6503 bytes

@@ -12808,13 +12808,73 @@
           more instances of MySQL Server. Because Instance Manager can
           manage multiple server instances, it can also be used in place
           of the <command>mysqld_multi</command> script. Instance
-          Manager runs on the host where you want to control MySQL
-          Server instances, but you can use it for remote management
-          because you can connect to it from a remote host to perform
-          instance-management operations. A more detailed description of
-          MySQL Instance Manager follows.
+          Manager offers these capabilities:
         </para>
 
+        <itemizedlist>
+
+          <listitem>
+            <para>
+              Instance Manager can start and stop instances, and report
+              on the status of instances.
+            </para>
+          </listitem>
+
+          <listitem>
+            <para>
+              Server instances can be treated as guarded or unguarded:
+            </para>
+
+            <itemizedlist>
+
+              <listitem>
+                <para>
+                  A guarded instance is monitored by Instance Manager.
+                  If the instance crashes, Instance Manager detects this
+                  and restarts it.
+                </para>
+              </listitem>
+
+              <listitem>
+                <para>
+                  A nonguarded instance is not monitored by Instance
+                  Manager. If the instance crases, Instance Manager will
+                  not know this and does not restart it.
+                </para>
+              </listitem>
+
+            </itemizedlist>
+
+            <para>
+              By default, instances are guarded. An instance can be
+              designated as nonguarded by including the
+              <option>nonguarded</option> option in the configuration
+              file.
+            </para>
+          </listitem>
+
+          <listitem>
+            <para>
+              Instance Manager provides an interactive interface for
+              configuring instances, so that the need to editing the
+              configuration file manually is reduced or eliminated.
+            </para>
+
+            <para>
+              Instance Manager provides remote instance management. That
+              is, it runs on the host where you want to control MySQL
+              Server instances, but you can connect to it from a remote
+              host to perform instance-management operations.
+            </para>
+          </listitem>
+
+        </itemizedlist>
+
+        <para>
+          The following sections describe MySQL Instance Manager
+          operation in more detail.
+        </para>
+
       </refsection>
 
       <refsection id="instance-manager-command-options">

@@ -14200,23 +14260,74 @@
 
         <para>
           After you connect to MySQL Instance Manager, you can issue
-          commands. The following list shows the commands that Instance
-          Manager accepts, with examples. For some of these commands,
-          Instance Manager reads or writes the configuration file. For
-          these commands to succeed, the configuration file must be
-          accessible to Instance Manager for read or write access. On
-          Unix, the standard configuration 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 specify a different
-          configuration file, start Instance Manager with the
-          <option>--defaults-file</option> option.
+          commands. The following general principles apply to Instance
+          Manager command execution:
         </para>
 
         <itemizedlist>
 
           <listitem>
             <para>
+              Commands that take an instance name fail if the name is
+              not a valid instance name.
+            </para>
+          </listitem>
+
+          <listitem>
+            <para>
+              Commands other than <literal>CREATE INSTANCE</literal>
+              that take an instance name fail if the instance does not
+              exist.
+            </para>
+          </listitem>
+
+          <listitem>
+            <para>
+              As of MySQL 5.1.12, commands for an instance require that
+              the instance be in an appropriate state. You can cannot
+              configure or start an instance that is not offline. You
+              cannot start an instance that is online.
+            </para>
+          </listitem>
+
+          <listitem>
+            <para>
+              Instance Manager maintains information about instance
+              configuration in an internal (in-memory) cache. Initially,
+              this information comes from the configuration file. Some
+              commands may change the configuration of an instance. As
+              of MySQL 5.1.12, these commands change both the in-memory
+              cache and the server instance section recorded in the
+              configuration file to maintain consistency between them.
+              For this to occur, the instance must be offline and the
+              configuration file must be accessible and not malformed.
+              If the configuration file cannot be updated, the command
+              fails and the cache remains unchanged.
+            </para>
+          </listitem>
+
+          <listitem>
+            <para>
+              On Unix, the standard configuration 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 specify a different
+              configuration file, start Instance Manager with the
+              <option>--defaults-file</option> option.
+            </para>
+          </listitem>
+
+        </itemizedlist>
+
+        <para>
+          The following list describes the commands that Instance
+          Manager accepts, with examples.
+        </para>
+
+        <itemizedlist>
+
+          <listitem>
+            <para>
               <literal>CREATE INSTANCE
               <replaceable>instance_name</replaceable>
              
[<replaceable>opt_name</replaceable>[=<replaceable>opt_val</replaceable>],


Thread
svn commit - mysqldoc@docsrva: r3382 - in trunk: refman-5.0 refman-5.1paul16 Sep