Skip to content

Commit

Permalink
doc/cephadm: fix rgw realm and zone flags
Browse files Browse the repository at this point in the history
Signed-off-by: Daniel Pivonka <[email protected]>
  • Loading branch information
Daniel Pivonka committed Mar 26, 2021
1 parent f61ff08 commit 41a1df1
Show file tree
Hide file tree
Showing 4 changed files with 8 additions and 8 deletions.
2 changes: 1 addition & 1 deletion doc/cephadm/adoption.rst
Original file line number Diff line number Diff line change
Expand Up @@ -189,7 +189,7 @@ Adoption process

.. prompt:: bash #

ceph orch apply rgw <svc_id> [--rgw-realm=<realm>] [--rgw-zone=<zone>] [--port=<port>] [--ssl] [--placement=<placement>]
ceph orch apply rgw <svc_id> [--realm=<realm>] [--zone=<zone>] [--port=<port>] [--ssl] [--placement=<placement>]

where *<placement>* can be a simple daemon count, or a list of
specific hosts (see :ref:`orchestrator-cli-placement-spec`), and the
Expand Down
4 changes: 2 additions & 2 deletions doc/cephadm/rgw.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ To deploy a set of radosgw daemons, with an arbitrary service name

.. prompt:: bash #

ceph orch apply rgw *<name>* [--rgw-realm=*<realm-name>*] [--rgw-zone=*<zone-name>*] --placement="*<num-daemons>* [*<host1>* ...]"
ceph orch apply rgw *<name>* [--realm=*<realm-name>*] [--zone=*<zone-name>*] --placement="*<num-daemons>* [*<host1>* ...]"

Trivial setup
-------------
Expand Down Expand Up @@ -57,7 +57,7 @@ To deploy RGWs serving the multisite *myorg* realm and the *us-east-1* zone on

.. prompt:: bash #

ceph orch apply rgw east --rgw-realm=myorg --rgw-zone=us-east-1 --placement="2 myhost1 myhost2"
ceph orch apply rgw east --realm=myorg --zone=us-east-1 --placement="2 myhost1 myhost2"

Note that in a multisite situation, cephadm only deploys the daemons. It does not create
or update the realm or zone configurations. To create a new realm and zone, you need to do
Expand Down
2 changes: 1 addition & 1 deletion doc/mgr/orchestrator.rst
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ The ``name`` parameter is an identifier of the group of instances:
Creating/growing/shrinking/removing services::

ceph orch apply mds <fs_name> [--placement=<placement>] [--dry-run]
ceph orch apply rgw <name> [--rgw-realm=<realm>] [--rgw-zone=<zone>] [--port=<port>] [--ssl] [--placement=<placement>] [--dry-run]
ceph orch apply rgw <name> [--realm=<realm>] [--zone=<zone>] [--port=<port>] [--ssl] [--placement=<placement>] [--dry-run]
ceph orch apply nfs <name> <pool> [--namespace=<namespace>] [--placement=<placement>] [--dry-run]
ceph orch rm <service_name> [--force]

Expand Down
8 changes: 4 additions & 4 deletions src/pybind/mgr/orchestrator/module.py
Original file line number Diff line number Diff line change
Expand Up @@ -1061,8 +1061,8 @@ def _apply_mds(self,
@_cli_write_command('orch apply rgw')
def _apply_rgw(self,
svc_id: str,
realm_name: Optional[str] = None,
zone_name: Optional[str] = None,
realm: Optional[str] = None,
zone: Optional[str] = None,
port: Optional[int] = None,
ssl: bool = False,
placement: Optional[str] = None,
Expand All @@ -1076,8 +1076,8 @@ def _apply_rgw(self,

spec = RGWSpec(
service_id=svc_id,
rgw_realm=realm_name,
rgw_zone=zone_name,
rgw_realm=realm,
rgw_zone=zone,
rgw_frontend_port=port,
ssl=ssl,
placement=PlacementSpec.from_string(placement),
Expand Down

0 comments on commit 41a1df1

Please sign in to comment.