From: John Wilkins Date: Tue, 26 Feb 2013 00:29:57 +0000 (-0800) Subject: doc: Added subnet example and verbiage to network settings. X-Git-Tag: v0.59~119 X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=9e6025b697ebf23f6c4bce5a268eb467cd72518c;p=ceph.git doc: Added subnet example and verbiage to network settings. fixes: #4049 Signed-off-by: John Wilkins --- diff --git a/doc/rados/configuration/general-config-ref.rst b/doc/rados/configuration/general-config-ref.rst index a70b7f776b22..4b541b240e44 100644 --- a/doc/rados/configuration/general-config-ref.rst +++ b/doc/rados/configuration/general-config-ref.rst @@ -6,7 +6,9 @@ .. deprecated:: 0.51 -:Description: Indicates the type of authentication used. Currently ``cephx`` only. If not specified, it defaults to ``none``. +:Description: Indicates the type of authentication used. Currently ``cephx`` + only. If not specified, it defaults to ``none``. + :Type: String :Required: No :Default: ``none`` @@ -16,7 +18,9 @@ .. versionadded:: 0.51 -:Description: Enables authentication for the cluster. Valid setting is ``cephx``. +:Description: Enables authentication for the cluster. + Valid setting is ``cephx``. + :Type: String :Required: No :Default: ``none`` @@ -26,7 +30,9 @@ .. versionadded:: 0.51 -:Description: Enables authentication for the service. Valid setting is ``cephx``. +:Description: Enables authentication for the service. + Valid setting is ``cephx``. + :Type: String :Required: No :Default: ``none`` @@ -37,7 +43,9 @@ .. versionadded:: 0.51 -:Description: Enables authentication for the client. Valid setting is ``cephx``. +:Description: Enables authentication for the client. + Valid setting is ``cephx``. + :Type: String :Required: No :Default: ``none`` @@ -61,7 +69,10 @@ ``mon host`` -:Description: A list of ``{hostname}:{port}`` entries that clients can use to connect to a Ceph monitor. If not set, Ceph searches ``[mon.*]`` sections. +:Description: A list of ``{hostname}:{port}`` entries that clients can use to + connect to a Ceph monitor. If not set, Ceph searches ``[mon.*]`` + sections. + :Type: String :Required: No :Default: N/A @@ -69,26 +80,37 @@ ``host`` -:Description: The hostname. Use this setting for specific daemon instances (e.g., ``[osd.0]``). +:Description: The hostname. Use this setting for specific daemon instances + (e.g., ``[osd.0]``). + :Type: String :Required: Yes, for daemon instances. :Default: ``localhost`` -.. tip:: Do not use ``localhost``. To get your host name, execute ``hostname -s`` on your command line and use the name of your host (to the first period, not the fully-qualified domain name). -.. important: You should not specify any value for ``host`` when using a third party deployment system that retrieves the host name for you. +.. tip:: Do not use ``localhost``. To get your host name, execute + ``hostname -s`` on your command line and use the name of your host + (to the first period, not the fully-qualified domain name). + +.. important:: You should not specify any value for ``host`` when using a third + party deployment system that retrieves the host name for you. ``public network`` -:Description: The IP address and netmask of the public (front-side) network (e.g., ``10.20.30.40/24``). Set in ``[global]``. -:Type: ``{ip-address}/{netmask}`` +:Description: The IP address and netmask of the public (front-side) network + (e.g., ``10.20.30.40/24``). Set in ``[global]``. You may specify + comma-delimited subnets. + +:Type: ``{ip-address}/{netmask} [, {ip-address}/{netmask}]`` :Required: No :Default: N/A ``public addr`` -:Description: The IP address for the public (front-side) network. Set for each daemon. +:Description: The IP address for the public (front-side) network. + Set for each daemon. + :Type: IP Address :Required: No :Default: N/A @@ -96,15 +118,20 @@ ``cluster network`` -:Description: The IP address and netmask of the cluster (back-side) network (e.g., ``10.20.30.41/24``). Set in ``[global]``. -:Type: ``{ip-address}/{netmask}`` +:Description: The IP address and netmask of the cluster (back-side) network + (e.g., ``10.20.30.41/24``). Set in ``[global]``. You may specify + comma-delimited subnets. + +:Type: ``{ip-address}/{netmask} [, {ip-address}/{netmask}]`` :Required: No :Default: N/A ``cluster addr`` -:Description: The IP address for the cluster (back-side) network. Set for each daemon. +:Description: The IP address for the cluster (back-side) network. + Set for each daemon. + :Type: Address :Required: No :Default: N/A @@ -112,7 +139,9 @@ ``admin socket`` -:Description: The socket for executing administrative commands irrespective of whether Ceph monitors have established a quorum. +:Description: The socket for executing administrative commands irrespective + of whether Ceph monitors have established a quorum. + :Type: String :Required: No :Default: ``/var/run/ceph/$cluster-$name.asok`` @@ -120,7 +149,9 @@ ``pid file`` -:Description: Each running Ceph daemon has a running process identifier (PID) file. +:Description: Each running Ceph daemon has a running + process identifier (PID) file. + :Type: String :Required: No :Default: N/A. The default path is ``/var/run/$cluster/$name.pid``. The PID file is generated upon start-up. @@ -128,7 +159,9 @@ ``chdir`` -:Description: The directory Ceph daemons change to once they are up and running. Default ``/`` directory recommended. +:Description: The directory Ceph daemons change to once they are + up and running. Default ``/`` directory recommended. + :Type: String :Required: No :Default: ``/`` @@ -136,13 +169,19 @@ ``max open files`` -:Description: If set, when the Ceph service starts, Ceph sets the ``max open fds`` at the OS level (i.e., the max # of file descriptors). It helps prevents OSDs from running out of file descriptors. +:Description: If set, when the Ceph service starts, Ceph sets the + ``max open fds`` at the OS level (i.e., the max # of file + descriptors). It helps prevents OSDs from running out of + file descriptors. + :Type: 64-bit Integer :Required: No :Default: ``0`` ``fatal signal handlers`` -:Description: If set, we will install signal handlers for SEGV, ABRT, BUS, ILL, FPE, XCPU, XFSZ, SYS signals to generate a useful log message +:Description: If set, we will install signal handlers for SEGV, ABRT, BUS, ILL, + FPE, XCPU, XFSZ, SYS signals to generate a useful log message + :Type: Boolean :Default: ``true``