Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

rbdmap: add manpage #8224

Merged
merged 2 commits into from Mar 24, 2016
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
1 change: 1 addition & 0 deletions ceph.spec.in
Expand Up @@ -995,6 +995,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*
Expand Down
1 change: 1 addition & 0 deletions debian/ceph-common.install
Expand Up @@ -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
Expand Down
3 changes: 2 additions & 1 deletion doc/Makefile.am
Expand Up @@ -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
48 changes: 48 additions & 0 deletions doc/man/8/rbdmap.rst
@@ -0,0 +1,48 @@
:orphan:

=========================================
rbdmap -- map RBD devices at boot time
=========================================

.. program:: rbdmap

Synopsis
========

| **rbdmap map**
| **rbdmap unmap**

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We could use the basic usage info, here. I.e. rbdmap map | 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),