From b35061a7e6af6f4b51ff0721006c7089ad41b3a0 Mon Sep 17 00:00:00 2001 From: Josh Durgin Date: Wed, 3 Feb 2016 23:41:58 -0800 Subject: [PATCH] man: stub manpage for rbd-mirror Signed-off-by: Josh Durgin --- doc/Makefile.am | 1 + doc/man/8/rbd-mirror.rst | 75 ++++++++++++++++++++++++++++++++++++++++ man/Makefile-client.am | 1 + 3 files changed, 77 insertions(+) create mode 100644 doc/man/8/rbd-mirror.rst diff --git a/doc/Makefile.am b/doc/Makefile.am index 4b15b9d2275..332b32345a9 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -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 \ diff --git a/doc/man/8/rbd-mirror.rst b/doc/man/8/rbd-mirror.rst new file mode 100644 index 00000000000..cda83474346 --- /dev/null +++ b/doc/man/8/rbd-mirror.rst @@ -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 `\(8) diff --git a/man/Makefile-client.am b/man/Makefile-client.am index f5e90638d5d..b03c9bf1fb3 100644 --- a/man/Makefile-client.am +++ b/man/Makefile-client.am @@ -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 \