man: stub manpage for rbd-mirror

Signed-off-by: Josh Durgin <jdurgin@redhat.com>
This commit is contained in:
Josh Durgin 2016-02-03 23:41:58 -08:00
parent 3d263840f6
commit b35061a7e6
3 changed files with 77 additions and 0 deletions

View File

@ -27,6 +27,7 @@ EXTRA_DIST = \
man/8/radosgw.rst \
man/8/rados.rst \
man/8/rbd-fuse.rst \
man/8/rbd-mirror.rst \
man/8/rbd-nbd.rst \
man/8/rbd-replay-many.rst \
man/8/rbd-replay-prep.rst \

75
doc/man/8/rbd-mirror.rst Normal file
View File

@ -0,0 +1,75 @@
:orphan:
===================================================
rbd-mirror -- Ceph daemon for mirroring RBD images
===================================================
.. program:: rbd-mirror
Synopsis
========
| **rbd-mirror**
Description
===========
:program:`rbd-mirror` is a daemon for asynchronous mirroring of RADOS
block device (rbd) images among Ceph clusters. It replays changes to
images in remote clusters in a local cluster, for disaster recovery.
It connects to remote clusters via the RADOS protocol, relying on
default search paths to find ceph.conf files monitor addresses and
authentication information for them, i.e. ``/etc/ceph/$cluster.conf``,
``/etc/ceph/$cluster.keyring``, and
``/etc/ceph/$cluster.$name.keyring``, where ``$cluster`` is the
human-friendly name of the cluster, and ``$name`` is the rados user to
connect as, e.g. ``client.rbd-mirror``.
Options
=======
.. option:: -c ceph.conf, --conf=ceph.conf
Use ``ceph.conf`` configuration file instead of the default
``/etc/ceph/ceph.conf`` to determine monitor addresses during startup.
.. option:: -m monaddress[:port]
Connect to specified monitor (instead of looking through ``ceph.conf``).
.. option:: -i ID, --id ID
Set the ID portion of name for rbd-mirror
.. option:: -n TYPE.ID, --name TYPE.ID
Set the rados user name for the gateway (eg. client.rbd-mirror)
.. option:: --cluster NAME
Set the cluster name (default: ceph)
.. option:: -d
Run in foreground, log to stderr
.. option:: -f
Run in foreground, log to usual location
Availability
============
:program:`rbd-mirror` 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)

View File

@ -16,6 +16,7 @@ endif
if WITH_RBD
dist_man_MANS += \
ceph-rbdnamer.8 \
rbd-mirror.8 \
rbd-nbd.8 \
rbd-replay.8 \
rbd-replay-many.8 \