Project

General

Profile

Actions

Documentation #61932

open

Clashing ceph.conf section name in doc/radosgw/admin vs doc/radosgw/config-ref

Added by Voja Molani 11 months ago.

Status:
New
Priority:
Normal
Assignee:
-
Target version:
-
% Done:

0%

Tags:
Backport:
Reviewed:
Affected Versions:
Pull request ID:

Description

Two different configuration section names exist in the documentation for rgw configuration:
  1. https://docs.ceph.com/en/latest/radosgw/admin/#usage - lists the ceph.conf section as: [client.rgw]
  2. https://docs.ceph.com/en/latest/radosgw/config-ref/#ceph-object-gateway-config-reference - lists the ceph.conf section as: [client.radosgw.{instance-name}]
This is confusing for the following reasons:
  1. Is it rgw or radosgw in the section name after client.?
  2. Does the section need an instance name or not? The latter URL (2) lists that section should be client/global to avoid specifying instance-name in section name. So is client.rgw a valid section name and the instance name is not actually needed?

Additional documentation referring to RGW ceph.conf section is for example https://docs.ceph.com/en/latest/man/8/radosgw/ which does list it as client.radosgw.instance. So it would seem the former listed URL (1) is wrong and the latter listed URL (2) section name is the correct one?

Would be happy to make a PR if someone could just clear this up in a comment...

No data to display

Actions

Also available in: Atom PDF