]> git.apps.os.sepia.ceph.com Git - ceph.git/commitdiff
rbdmap: manpage
authorNathan Cutler <ncutler@suse.com>
Sat, 19 Mar 2016 20:41:10 +0000 (21:41 +0100)
committerNathan Cutler <ncutler@suse.com>
Sat, 19 Mar 2016 21:01:40 +0000 (22:01 +0100)
http://tracker.ceph.com/issues/15212 Fixes: #15212

Signed-off-by: Nathan Cutler <ncutler@suse.com>
doc/man/8/rbdmap.rst [new file with mode: 0644]

diff --git a/doc/man/8/rbdmap.rst b/doc/man/8/rbdmap.rst
new file mode 100644 (file)
index 0000000..6a54715
--- /dev/null
@@ -0,0 +1,43 @@
+:orphan:
+
+=========================================
+ rbdmap -- map RBD devices at boot time
+=========================================
+
+.. program:: rbdmap
+
+Synopsis
+========
+
+| **rbdmap**
+
+
+Description
+===========
+
+**rbdmap** is a shell script that is intended to be run at boot time
+by the init system (sysvinit, upstart, systemd). It looks for an
+environment variable ``RBDMAPFILE``, which defaults to
+``/etc/ceph/rbdmap``. This file is expected to contain a list of RBD
+devices to be mapped (via the ``rbd map`` command) and mounted at boot
+time.
+
+
+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),