doc: add day-2 operations documentation

This commit is the first of a serie in order to describe all day-2 operations
that are possible via ceph-ansible using a set of playbook provided in
`infrastructure-playbooks` directory.

Fixes: #5061

Signed-off-by: Guillaume Abrioux <gabrioux@redhat.com>
(cherry picked from commit 7e800303e9)
pull/5306/head
Guillaume Abrioux 2020-04-21 09:50:27 +02:00
parent 34cf0e5301
commit 8c9be9c179
3 changed files with 77 additions and 0 deletions

View File

@ -0,0 +1,51 @@
Adding/Removing OSD(s) after a cluster is deployed is a common operation that should be straight-forward to achieve.
Adding osd(s)
-------------
Adding new OSD(s) on an existing host or adding a new OSD node can be achieved by running the main playbook with the ``--limit`` ansible option.
You basically need to update your host_vars/group_vars with the new hardware and/or the inventory host file with the new osd nodes being added.
The command used would be like following:
``ansible-playbook -vv -i <your-inventory> site-docker.yml --limit <node>``
example:
.. code-block:: shell
$ cat hosts
[mons]
mon-node-1
mon-node-2
mon-node-3
[mgrs]
mon-node-1
mon-node-2
mon-node-3
[osds]
osd-node-1
osd-node-2
osd-node-3
osd-node-99
$ ansible-playbook -vv -i hosts site-docker.yml --limit osd-node-99
Shrinking osd(s)
----------------
Shrinking OSDs can be done by using the shrink-osd.yml playbook provided in ``infrastructure-playbooks`` directory.
The variable ``osd_to_kill`` is a comma separated list of OSD IDs which must be passed to the playbook (passing it as an extra var is the easiest way).
The playbook will shrink all osds passed in ``osd_to_kill`` serially.
example:
.. code-block:: shell
$ ansible-playbook -vv -i hosts infrastructure-playbooks/shrink-osds.yml -e osd_to_kill=1,2,3

View File

@ -0,0 +1,15 @@
Purging the cluster
-------------------
ceph-ansible provides two playbooks in ``infrastructure-playbooks`` for purging a Ceph cluster: ``purge-cluster.yml`` and ``purge-docker-cluster.yml``.
The names are pretty self-explanatory, ``purge-cluster.yml`` is intended to purge a non-containerized cluster whereas ``purge-docker-cluster.yml`` is to purge a containerized cluster.
example:
.. code-block:: shell
$ ansible-playbook -vv -i hosts infrastructure-playbooks/purge-docker-cluster.yml
.. note::
These playbooks aren't intended to be run with the ``--limit`` option.

View File

@ -271,6 +271,17 @@ by setting the ``osd_scenario`` configuration option.
osds/scenarios
Day-2 Operations
----------------
ceph-ansible provides a set of playbook in ``infrastructure-playbooks`` directory in order to perform some basic day-2 operations.
.. toctree::
:maxdepth: 1
day-2/osds
day-2/purge
Contribution
============