Parcourir la source

Some more docs, more cleanup.

git-svn-id: svn://bind10.isc.org/svn/bind10/trunk@1480 e5f2f494-b856-4b98-b285-d166d9295462
Jeremy C. Reed il y a 15 ans
Parent
commit
98823855c9
1 fichiers modifiés avec 61 ajouts et 18 suppressions
  1. 61 18
      doc/userguide/userguide.xml

+ 61 - 18
doc/userguide/userguide.xml

@@ -511,13 +511,17 @@ $ <userinput>./configure</userinput></screen>
       The <command>msgq</command> and <command>b10-cfgmgr</command>
       The <command>msgq</command> and <command>b10-cfgmgr</command>
       services make up the core. The <command>msgq</command> daemon
       services make up the core. The <command>msgq</command> daemon
       provides the communication channel between every part of the system.
       provides the communication channel between every part of the system.
-      And <command>b10-cfgmgr</command> is always needed by every
+      The <command>b10-cfgmgr</command> daemon is always needed by every
       module, if only to send information about themselves somewhere,
       module, if only to send information about themselves somewhere,
       but more importantly to ask about their own settings, and
       but more importantly to ask about their own settings, and
       about other modules.
       about other modules.
+      The <command>bind10</command> master process will also startup
+      <command>b10-cmdctl</command> for admins to communicate with the
+      system, <command>b10-auth</command> for Authoritative DNS service,
+      and <command>b10-xfrin</command> for inbound DNS zone transfers.
+      (These are covered in upcoming chapters.)
     </para>
     </para>
 
 
-
     <sect1 id="start">
     <sect1 id="start">
       <title>Starting BIND 10</title>
       <title>Starting BIND 10</title>
       <para>
       <para>
@@ -530,6 +534,38 @@ $ <userinput>./configure</userinput></screen>
 
 
   </chapter>
   </chapter>
 
 
+  <chapter id="msgq">
+    <title>Command channel</title>
+
+      <para>
+        The BIND 10 components use the <command>msgq</command>
+        message routing daemon to intercommunicate.
+        This is called the <quote>Command Channel</quote>.
+        The members of the channel subscribe to listen to certain
+        messages and are programmed to handle received messages.
+	Example messages include shutdown, get configurations, and set
+	configurations.
+      </para>
+
+      <note><simpara>
+        This Command Channel is not used for DNS message passing.
+      </simpara></note>
+
+      <para>
+        Administrators do not communicate directly with the
+        <command>msgq</command> daemon. The only configuration is
+        to choose the port number it listens on.
+        By default, BIND 10 uses port 9912 for the
+        <command>msgq</command> service.
+        It listens on 127.0.0.1.
+      </para>
+
+<!-- TODO: upcoming plans:
+Unix domain sockets
+-->
+
+  </chapter>
+
   <chapter id="cfgmgr">
   <chapter id="cfgmgr">
     <title>Configuration manager</title>
     <title>Configuration manager</title>
 
 
@@ -580,13 +616,6 @@ $ <userinput>./configure</userinput></screen>
 	<command>b10-cmdctl</command>).
 	<command>b10-cmdctl</command>).
       </para>
       </para>
 
 
-<!-- TODO: show examples, test this -->
-
-<!--
-, so an admin can simply run bindctl,
-do config show, and it shows all modules; config show >module> shows all
-options for that module
--->
 
 
 <!--
 <!--
 
 
@@ -615,6 +644,16 @@ configuration for configuration manager itself. And perhaps we might
 change the messaging protocol, but an admin should never see any of that
 change the messaging protocol, but an admin should never see any of that
 -->
 -->
 
 
+     <para>
+     </para>
+
+<!-- TODO: show examples, test this -->
+<!--
+, so an admin can simply run bindctl,
+do config show, and it shows all modules; config show >module> shows all
+options for that module
+-->
+
   </chapter>
   </chapter>
 
 
   <chapter id="cmdctl">
   <chapter id="cmdctl">
@@ -655,13 +694,22 @@ change the messaging protocol, but an admin should never see any of that
     </para>
     </para>
 
 
     <note><para>
     <note><para>
-      The HTTPS server is configured to require a PEM certificate from
-      the client.
-      The BIND 10 installation provides a PEM bundle that matches
+      The HTTPS server doesn't support a certificate request from a
+      client (at this time).
+<!-- TODO: maybe allow request from server side -->
+      The <command>b10-cmdctl</command> daemon does not provide a
+      public service. If any client wants to control BIND 10, then
+      a certificate needs to be first recieved from the BIND 10
+      administrator.
+      The BIND 10 installation provides a sample PEM bundle that matches
       the sample key and certificate.
       the sample key and certificate.
     </para></note>
     </para></note>
 <!-- TODO: cross-ref -->
 <!-- TODO: cross-ref -->
-<!-- TODO: why is this required? -->
+
+<!-- TODO
+openssl req -new -x509 -keyout server.pem -out server.pem -days 365 -nodes
+but that is a single file, maybethis should go back to that format?
+-->
 
 
 <!--
 <!--
     <para>
     <para>
@@ -685,11 +733,6 @@ change the messaging protocol, but an admin should never see any of that
       <quote>bind10</quote>.)
       <quote>bind10</quote>.)
     </para>
     </para>
 
 
-<!-- TODO
-openssl req -new -x509 -keyout server.pem -out server.pem -days 365 -nodes
-but that is a single file, maybethis should go back to that format?
--->
-
     <para>
     <para>
       The administrator may create a user account with the
       The administrator may create a user account with the
       <command>b10-cmdctl-usermgr</command> tool.
       <command>b10-cmdctl-usermgr</command> tool.