From a7867c27cb1ea7a86f7f9d384c98fa63d4e02074 Mon Sep 17 00:00:00 2001 From: John Wilkins Date: Tue, 28 Aug 2012 13:25:44 -0700 Subject: [PATCH] doc: Completed and reviewed RGW config reference. Signed-off-by: John Wilkins --- doc/radosgw/config-ref.rst | 132 ++++++++++++++++++++++++------------- 1 file changed, 86 insertions(+), 46 deletions(-) diff --git a/doc/radosgw/config-ref.rst b/doc/radosgw/config-ref.rst index 694444d36732e..58c16b49c2675 100644 --- a/doc/radosgw/config-ref.rst +++ b/doc/radosgw/config-ref.rst @@ -2,157 +2,197 @@ RADOS Gateway Configuration Reference ======================================= -The following settings may added to the ``ceph.conf`` file. The settings may -contain default values. If you do not specify each setting in ``ceph.conf``, -the default value will be set automatically. +The following settings may added to the ``ceph.conf`` file under the +``[client.radosgw.gateway]`` section. The settings may contain default values. +If you do not specify each setting in ``ceph.conf``, the default value will be +set automatically. + ``rgw data`` -:Description: Sets the location of the data file for RADOS Gateway. +:Description: Sets the location of the data files for RADOS Gateway. +:Type: String :Default: ``/var/lib/ceph/radosgw/$cluster-$id`` + ``rgw cache enabled`` :Description: Whether the RADOS Gateway cache is enabled. +:Type: Boolean :Default: ``true`` + ``rgw cache lru size`` :Description: The number of entries in the RADOS Gateway cache. +:Type: Integer :Default: ``10000`` + ``rgw socket path`` :Description: The socket path for the domain socket. ``FastCgiExternalServer`` uses this socket. If you do not specify a socket path, RADOS Gateway will not run as an external server. The path you specify here must be the same as the path specified in the ``rgw.conf`` file. +:Type: String :Default: N/A -:Required: True -:Example: ``/var/run/ceph/rgw.sock`` + ``rgw dns name`` -:Description: The name of the DNS host. -:Default: Same as the host's DNS. +:Description: The DNS name of the served domain. +:Type: String +:Default: None + ``rgw swift url`` :Description: The URL for the RADOS Gateway Swift API. -:Default: Same as the ``host`` setting. +:Type: String +:Default: None + ``rgw swift url prefix`` :Description: The URL prefix for the Swift API. :Default: ``swift`` -:Example: http://swift.fqdn.com +:Example: http://fqdn.com/swift + ``rgw enforce swift acls`` :Description: Enforces the Swift Access Control List (ACL) settings. +:Type: Boolean :Default: ``true`` + ``rgw print continue`` :Description: Enable ``100-continue`` if it is operational. +:Type: Boolean :Default: ``true`` + ``rgw remote addr param`` -:Description: The remote address parameter. For example, a variable for the ``X-Forwarded-For`` address if a reverse proxy is operational. +:Description: The remote address parameter. For example, the HTTP field containing the remote address, or the ``X-Forwarded-For`` address if a reverse proxy is operational. + +:Type: String :Default: ``REMOTE_ADDR`` - + + ``rgw op thread timeout`` -:Description: The timeout in milliseconds for open threads. +:Description: The timeout in seconds for open threads. +:Type: Integer :Default: 600 + ``rgw op thread suicide timeout`` -:Description: -:Default: +:Description: The time ``timeout`` in seconds before a RADOS Gateway process dies. Disbled if set to ``0``. +:Type: Integer +:Default: ``0`` + ``rgw thread pool size`` -:Description: The size of the thread pool. +:Description: The size of the thread pool. +:Type: Integer :Default: 100 threads. - -``rgw maintenance tick interval`` - -:Description: -:Default: 10.0 -``rgw pools preallocate max`` -:Description: The maximum number of pool to pre-allocate to RADOS Gateway. -:Default: 100 +``rgw num control oids`` -``rgw pools preallocate threshold`` +:Description: The number of notification objects used for cache synchronization between different ``rgw`` instances. +:Type: Integer +:Default: ``8`` -:Description: The pool pre-allocation threshold. -:Default: 70 ``rgw log nonexistent bucket`` -:Description: Should RADOS GW log a request for a non-existent bucket? +:Description: Enables RADOS Gateway to log a request for a non-existent bucket. +:Type: Boolean :Default: ``false`` + ``rgw log object name`` -:Description: The logging format for an object name. // man date to see codes (a subset are supported) -:Default: "%Y-%m-%d-%H-%i-%n" +:Description: The logging format for an object name. See manpage :manpage:`date` for details about format specifiers. +:Type: Date +:Default: ``%Y-%m-%d-%H-%i-%n`` ``rgw log object name utc`` -:Description: +:Description: Whether a logged object name includes a UTC time. If ``false``, it uses the local time. +:Type: Boolean :Default: ``false`` ``rgw usage max shards`` -:Description: The maximum number of shards. -:Default: 32 +:Description: The maximum number of shards for usage logging. +:Type: Integer +:Default: ``32`` + ``rgw usage max user shards`` -:Description: The maximum number of shards per user. -:Default: 1 +:Description: The maximum number of shards used for a single user's usage logging. +:Type: Integer +:Default: ``1`` + ``rgw enable ops log`` -:Description: Enable logging for every RGW operation? +:Description: Enable logging for RGW operations. +:Type: Boolean :Default: ``true`` + ``rgw enable usage log`` -:Description: Log bandwidth usage? +:Description: Enable the usage log. +:Type: Boolean :Default: ``true`` + ``rgw usage log flush threshold`` -:Description: The threshold to flush pending log data. +:Description: The number of dirty merged entries in the usage log before flushing synchronously. +:Type: Integer :Default: 1024 ``rgw usage log tick interval`` -:Description: Flush pending log data every ``n`` seconds. -:Default: 30 +:Description: Flush pending usage log data every ``n`` seconds. +:Type: Integer +:Default: ``30`` + ``rgw intent log object name`` -:Description: The logging format for . // man date to see codes (a subset are supported) -:Default: "%Y-%m-%d-%i-%n" +:Description: The logging format for the intent log object name. See manpage :manpage:`date` for details about format specifiers. +:Type: Date +:Default: ``%Y-%m-%d-%i-%n`` + ``rgw intent log object name utc`` -:Description: Whether the intent log object name should use Coordinated Universal Time (UTC). +:Description: Whether the intent log object name includes a UTC time. If ``false``, it uses the local time. +:Type: Boolean :Default: ``false`` + ``rgw init timeout`` -:Description: The timeout threshold in seconds. -:Default: 30 +:Description: The number of seconds before RGW gives up on initialization. +:Type: Integer +:Default: ``30`` + ``rgw mime types file`` -:Description: The path and location of the MIME types. +:Description: The path and location of the MIME types. Used for Swift auto-detection of object types. +:Type: String :Default: ``/etc/mime.types`` -- 2.39.5