Update documentation of watcher and RAPI daemon
authorHelga Velroyen <helgav@google.com>
Thu, 2 Jul 2015 12:10:24 +0000 (14:10 +0200)
committerHelga Velroyen <helgav@google.com>
Fri, 3 Jul 2015 10:06:04 +0000 (12:06 +0200)
.. to reflect the relationship between the RAPI daemons'
-b option and the watchers --rapi-ip option.

Signed-off-by: Helga Velroyen <helgav@google.com>
Reviewed-by: Petr Pudlak <pudlak@google.com>

man/ganeti-rapi.rst
man/ganeti-watcher.rst

index da515cf..3cded7b 100644 (file)
@@ -9,7 +9,7 @@ ganeti-rapi - Ganeti remote API daemon
 Synopsis
 --------
 
-| **ganeti-rapi** [-d] [-f] [-p *PORT] [-b *ADDRESS*] [-i *INTERFACE*]
+| **ganeti-rapi** [-d] [-f] [-p *PORT*] [-b *ADDRESS*] [-i *INTERFACE*]
 | [\--no-ssl] [-K *SSL_KEY_FILE*] [-C *SSL_CERT_FILE*]
 | [\--require-authentication]
 
@@ -28,8 +28,11 @@ The daemon will listen to the "ganeti-rapi" TCP port, as listed in the
 system services database, or if not defined, to port 5080 by default.
 The port can be overridded by passing the ``-p`` option. The ``-b``
 option can be used to specify the address to bind to (defaults to
-``0.0.0.0``); alternatively, the ``-i`` option can be used to specify
-the interface to bind do.
+``0.0.0.0``). Note that if you specify the address, the watcher
+needs to be informed about it using its option ``--rapi-ip``, otherwise
+it will not be able to reach the RAPI interface and will attempt to
+restart it all the time. Alternatively to setting the IP with ``--b``,
+the ``-i`` option can be used to specify the interface to bind do.
 
 See the *Ganeti remote API* documentation for further information.
 
index 69925d7..ae4cb8d 100644 (file)
@@ -9,9 +9,8 @@ ganeti-watcher - Ganeti cluster watcher
 Synopsis
 --------
 
-**ganeti-watcher** [``--debug``]
-[``--job-age=``*age*]
-[``--ignore-pause``]
+**ganeti-watcher** [\--debug] [\--job-age=*age* ] [\--ignore-pause]
+[\--rapi-ip=*IP*]
 
 DESCRIPTION
 -----------
@@ -31,6 +30,11 @@ wants to run it just once.
 The ``--debug`` option will increase the verbosity of the watcher
 and also activate logging to the standard error.
 
+The ``--rapi-ip`` option needs to be set if the RAPI daemon was
+started with a particular IP (using the ``-b`` option). The two
+options need to be exactly the same to ensure that the watcher
+can reach the RAPI interface.
+
 Master operations
 ~~~~~~~~~~~~~~~~~