ceph/doc/mgr/orchestrator_cli.rst

.. _orchestrator-cli-module:

================
Orchestrator CLI
================

This module provides a command line interface (CLI) to orchestrator
modules (ceph-mgr modules which interface with external orchestation services)

Configuration
=============

You can select the orchestrator module to use with the ``set backend`` command:

::

    ceph orchestrator set backend <module>

For example, to enable the Rook orchestrator module and use it with the CLI:

::

    ceph mgr module enable orchestrator_cli
    ceph mgr module enable rook
    ceph orchestrator set backend rook


You can then check backend is properly configured:

::

    ceph orchestrator status


Usage
=====

Print a list of discovered devices, grouped by node and optionally
filtered to a particular node:

::

    orchestrator device ls [node]

Print a list of services known to the orchestrator. The list can be limited to
services on a particular host with the optional --host parameter and/or
services of a particular type via optional --type parameter
(mon, osd, mgr, mds, rgw):

::

    orchestrator service ls [--host=host] [--type=type]

Query the status of a particular service (mon, osd, mgr, mds, rgw).  For OSDs
the id is the numeric OSD ID, for MDS services it is the filesystem name:

::

    orchestrator service status <type> <id>

Create a service.  For an OSD, the "what" is <node>:<device>, where the
device naming should match what was reported in ``device ls``.  For an MDS
service, the "what" is the filesystem name:

::

    orchestrator service add <type> <what>