Merge pull request #8224 from SUSE/wip-15212

rbdmap: add manpage

Reviewed-by: Boris Ranto <branto@redhat.com>
Reviewed-by: Josh Durgin <jdurgin@redhat.com>

ceph.spec.in

@@ -997,6 +997,7 @@ rm -rf $RPM_BUILD_ROOT
 %{_mandir}/man8/ceph.8*
 %{_mandir}/man8/rados.8*
 %{_mandir}/man8/rbd.8*
+%{_mandir}/man8/rbdmap.8*
 %{_mandir}/man8/rbd-replay.8*
 %{_mandir}/man8/rbd-replay-many.8*
 %{_mandir}/man8/rbd-replay-prep.8*

debian/ceph-common.install

@@ -25,6 +25,7 @@ usr/share/man/man8/ceph-post-file.8
 usr/share/man/man8/ceph.8
 usr/share/man/man8/rados.8
 usr/share/man/man8/rbd.8
+usr/share/man/man8/rbdmap.8
 usr/share/man/man8/rbd-replay*.8
 usr/share/ceph/known_hosts_drop.ceph.com
 usr/share/ceph/id_dsa_drop.ceph.com

doc/Makefile.am

@@ -33,4 +33,5 @@ EXTRA_DIST = \
 	man/8/rbd-replay-many.rst	\
 	man/8/rbd-replay-prep.rst	\
 	man/8/rbd-replay.rst	\
-	man/8/rbd.rst
+	man/8/rbd.rst           \
+	man/8/rbdmap.rst

doc/man/8/rbdmap.rst

@@ -0,0 +1,48 @@
+:orphan:
+
+=========================================
+ rbdmap -- map RBD devices at boot time
+=========================================
+
+.. program:: rbdmap
+
+Synopsis
+========
+
+| **rbdmap map**
+| **rbdmap unmap**
+
+
+Description
+===========
+
+**rbdmap** is a shell script that can be run manually by the system
+administrator at any time, or automatically at boot time by the init system
+(sysvinit, upstart, systemd). The script looks for an environment variable
+``RBDMAPFILE``, which defaults to ``/etc/ceph/rbdmap``. This file is
+expected to contain a list of RBD images and, possibly, parameters to be
+passed to the underlying ``rbd`` command. The syntax of
+``/etc/ceph/rbdmap`` is described in the comments at the top of that file.
+
+The script mounts devices after mapping, and unmounts them before
+unmapping.
+
+
+Options
+=======
+
+None
+
+
+Availability
+============
+
+**rbdmap** is part of Ceph, a massively scalable, open-source, distributed
+storage system. Please refer to the Ceph documentation at
+http://ceph.com/docs for more information.
+
+
+See also
+========
+
+:doc:`rbd <rbd>`\(8),