]> git-server-git.apps.pok.os.sepia.ceph.com Git - ceph.git/commitdiff
doc/radosgw: improve DNS host name config in s3/commons.rst 66883/head
authorVille Ojamo <14869000+bluikko@users.noreply.github.com>
Mon, 12 Jan 2026 06:47:31 +0000 (13:47 +0700)
committerVille Ojamo <14869000+bluikko@users.noreply.github.com>
Tue, 13 Jan 2026 05:07:55 +0000 (12:07 +0700)
Clarify that not only virtual-host-based access is configured this way.
Use Monitor config database instead of ceph.conf and add link to it.
Fix typo. Use privileged prompt for CLI example command.
List that comma is the delimitor used in rgw_dns_name config.
Use double backticks consistently for literal strings.

Signed-off-by: Ville Ojamo <14869000+bluikko@users.noreply.github.com>
doc/radosgw/s3/commons.rst

index b53c0b34b87c02cb247de0ab3160324c2ce2808a..7b2b18a5c8a384d3e157624ad5c01cc5c6e2f58c 100644 (file)
@@ -14,7 +14,7 @@ Path-style requests identify the bucket as the top-level directory of the reques
        Host: cname.domain.com
 
 Most S3 clients default to virtual-hosted-style access, where the bucket name is instead
-indicated as part of the fully-qualified domain name::
+indicated as part of the fully-qualified domain name (FQDN)::
 
        GET / HTTP/1.1
        Host: mybucket.cname.domain.com
@@ -22,20 +22,23 @@ indicated as part of the fully-qualified domain name::
 Path-style access is deprecated by AWS. See the `Amazon S3 Path Deprecation
 Plan`_ for more information.
 
-To configure virtual hosted buckets, you can either set ``rgw_dns_name =
-cname.domain.com`` in ``ceph.conf`` or add ``cname.domain.com`` to the list of
-``hostnames`` in your zonegroup configuration. See :ref:`Ceph Object Gateway -
-Multisite Configuration <multisite>` for more on zonegroups.
+To configure the FQDN used for the Ceph Object Gateway, for both path-style and
+virtual-hosted-style access, you can either set :confval:`rgw_dns_name`
+to ``cname.domain.com`` in the Monitor configuration database or
+add ``cname.domain.com`` to the list of ``hostnames`` in your zonegroup
+configuration. See :ref:`ceph-conf-database` for more on configuration database
+and :ref:`Ceph Object Gateway - Multisite Configuration <multisite>` for more
+on zonegroups.
 
-Here is an example of a ``ceph config set`` comamnd that sets ``rgw_dns_name``
+Here is an example of a ``ceph config set`` command that sets :confval:`rgw_dns_name`
 to ``cname.domain.com``:
 
-.. prompt:: bash $
+.. prompt:: bash #
 
    ceph config set client.rgw.<ceph authx client for rgw> rgw_dns_name cname.domain.dom
 
-.. tip:: You can define multiple hostnames directly with the
-   :confval:`rgw_dns_name` parameter.
+.. tip:: You can define multiple hostnames delimited by commas directly with
+   the :confval:`rgw_dns_name` parameter.
 
 .. tip:: When SSL is enabled, the certificates must use a wildcard in the
    domain name in order to match the bucket subdomains.
@@ -44,7 +47,7 @@ to ``cname.domain.com``:
    name instead. Then you can use ``ceph config set client.rgw`` to set the DNS
    name for all instances.
    
-.. note:: The static website view for the `s3website` API must be served under
+.. note:: The static website view for the ``s3website`` API must be served under
    a different domain name. This is configured separately from
    :confval:`rgw_dns_name`, in :confval:`rgw_dns_s3website_name`.