From 0a4556cd6eb24cbbc47056bfce4878eb761e2f6d Mon Sep 17 00:00:00 2001 From: Zac Dover Date: Mon, 26 May 2025 09:40:31 +1000 Subject: [PATCH] doc/mgr: edit orchestrator.rst Edit doc/mgr/orchestrator.rst. This is part of a project to separate out the twenty-five files that were committed to https://github.com/ceph/ceph/pull/62782. Signed-off-by: Zac Dover (cherry picked from commit 31ce3058fbc06709759e4c129a1af8678b257a6e) --- doc/mgr/orchestrator.rst | 36 ++++++++++++++++++------------------ 1 file changed, 18 insertions(+), 18 deletions(-) diff --git a/doc/mgr/orchestrator.rst b/doc/mgr/orchestrator.rst index 7cb6ddeecba69..c3fd5bee40527 100644 --- a/doc/mgr/orchestrator.rst +++ b/doc/mgr/orchestrator.rst @@ -54,7 +54,7 @@ Here is how the names relate: Status ====== -.. prompt:: bash $ +.. prompt:: bash # ceph orch status [--detail] @@ -108,12 +108,12 @@ following short list explains the meaning of the ``name`` parameter: Creating/growing/shrinking/removing services: -.. prompt:: bash $ +.. prompt:: bash # - ceph orch apply mds [--placement=] [--dry-run] - ceph orch apply rgw [--realm=] [--zone=] [--port=] [--ssl] [--placement=] [--dry-run] - ceph orch apply nfs [--namespace=] [--placement=] [--dry-run] - ceph orch rm [--force] + ceph orch apply mds [--placement=] [--dry-run] + ceph orch apply rgw [--realm=] [--zone=] [--port=] [--ssl] [--placement=] [--dry-run] + ceph orch apply nfs [--namespace=] [--placement=] [--dry-run] + ceph orch rm [--force] where ``placement`` is a :ref:`orchestrator-cli-placement-spec`. @@ -121,9 +121,9 @@ e.g., ``ceph orch apply mds myfs --placement="3 host1 host2 host3"`` Service Commands: -.. prompt:: bash $ +.. prompt:: bash # - ceph orch + ceph orch .. note:: These commands apply only to cephadm containerized daemons. @@ -160,35 +160,35 @@ Configuring the Orchestrator CLI Enable the orchestrator by using the ``set backend`` command to select the orchestrator module that will be used: -.. prompt:: bash $ +.. prompt:: bash # - ceph orch set backend + ceph orch set backend Example - Configuring the Orchestrator CLI ------------------------------------------ For example, to enable the Rook orchestrator module and use it with the CLI: -.. prompt:: bash $ +.. prompt:: bash # - ceph mgr module enable rook - ceph orch set backend rook + ceph mgr module enable rook + ceph orch set backend rook Confirm that the backend is properly configured: -.. prompt:: bash $ +.. prompt:: bash # - ceph orch status + ceph orch status Disable the Orchestrator ------------------------ To disable the orchestrator, use the empty string ``""``: -.. prompt:: bash $ +.. prompt:: bash # - ceph orch set backend "" - ceph mgr module disable rook + ceph orch set backend "" + ceph mgr module disable rook Current Implementation Status ============================= -- 2.39.5