]> git-server-git.apps.pok.os.sepia.ceph.com Git - ceph.git/commitdiff
doc: Document region hostnames settings.
authorRobin H. Johnson <robbat2@gentoo.org>
Wed, 15 Apr 2015 01:12:18 +0000 (18:12 -0700)
committerRobin H. Johnson <robbat2@gentoo.org>
Wed, 15 Apr 2015 01:12:18 +0000 (18:12 -0700)
The hostnames key in region settings was undocumented. Also includes how
the setting interacts with the ``rgw dns name`` configuration setting.

Signed-off-by: Robin H. Johnson <robbat2@gentoo.org>
doc/radosgw/config-ref.rst

index c78919cfa8e71ac95bf4a5783b774845c39dbab0..793deca16e95cb8b5d24a0842c6db8b06e0c1cba 100644 (file)
@@ -68,7 +68,7 @@ Ceph configuration file, the default value will be set automatically.
 
 ``rgw dns name``
 
-:Description: The DNS name of the served domain.
+:Description: The DNS name of the served domain. See also the ``hostnames`` setting within regions.
 :Type: String 
 :Default: None
        
@@ -373,6 +373,7 @@ The ``default`` region looks like this:
     "api_name": "",
     "is_master": "true",
     "endpoints": [],
+    "hostnames": [],
     "master_zone": "",
     "zones": [
       {"name": "default",
@@ -403,6 +404,10 @@ required settings:
    escape the forward slashes (``\/``). You may also specify a 
    port (``fqdn:port``) for each endpoint. Optional.
 
+#. ``hostnames``: A list of all the hostnames in the region. For example, 
+   you may use multiple domain names to refer to the same region. Optional.
+   The ``rgw dns name`` setting will automatically be included in this list.
+
 #. ``master_zone``: The master zone for the region. Optional. Uses the default
    zone if not specified. **note:** You can only have one master zone per 
    region.
@@ -464,6 +469,7 @@ JSON object is an example of a default region map.
             "api_name": "",
             "is_master": "true",
             "endpoints": [],
+            "hostnames": [],
             "master_zone": "",
             "zones": [
               { "name": "default",