projects / ceph.git / blame
| Commit | Line | Data |
|---|---|---|
| 7c673cae FG |
1 | :orphan: |
| 2 | ||
| 3 | =================================================== | |
| 4 | rbd-mirror -- Ceph daemon for mirroring RBD images | |
| 5 | =================================================== | |
| 6 | ||
| 7 | .. program:: rbd-mirror | |
| 8 | ||
| 9 | Synopsis | |
| 10 | ======== | |
| 11 | ||
| 12 | | **rbd-mirror** | |
| 13 | ||
| 14 | ||
| 15 | Description | |
| 16 | =========== | |
| 17 | ||
| 18 | :program:`rbd-mirror` is a daemon for asynchronous mirroring of RADOS | |
| 19 | block device (rbd) images among Ceph clusters. It replays changes to | |
| 20 | images in remote clusters in a local cluster, for disaster recovery. | |
| 21 | ||
| 22 | It connects to remote clusters via the RADOS protocol, relying on | |
| 23 | default search paths to find ceph.conf files, monitor addresses and | |
| 24 | authentication information for them, i.e. ``/etc/ceph/$cluster.conf``, | |
| 25 | ``/etc/ceph/$cluster.keyring``, and | |
| 26 | ``/etc/ceph/$cluster.$name.keyring``, where ``$cluster`` is the | |
| 27 | human-friendly name of the cluster, and ``$name`` is the rados user to | |
| 28 | connect as, e.g. ``client.rbd-mirror``. | |
| 29 | ||
| 30 | ||
| 31 | Options | |
| 32 | ======= | |
| 33 | ||
| 34 | .. option:: -c ceph.conf, --conf=ceph.conf | |
| 35 | ||
| 36 | Use ``ceph.conf`` configuration file instead of the default | |
| 37 | ``/etc/ceph/ceph.conf`` to determine monitor addresses during startup. | |
| 38 | ||
| 39 | .. option:: -m monaddress[:port] | |
| 40 | ||
| 41 | Connect to specified monitor (instead of looking through ``ceph.conf``). | |
| 42 | ||
| 43 | .. option:: -i ID, --id ID | |
| 44 | ||
| 45 | Set the ID portion of name for rbd-mirror | |
| 46 | ||
| 47 | .. option:: -n TYPE.ID, --name TYPE.ID | |
| 48 | ||
| 49 | Set the rados user name for the gateway (eg. client.rbd-mirror) | |
| 50 | ||
| 51 | .. option:: --cluster NAME | |
| 52 | ||
| 53 | Set the cluster name (default: ceph) | |
| 54 | ||
| 55 | .. option:: -d | |
| 56 | ||
| 57 | Run in foreground, log to stderr | |
| 58 | ||
| 59 | .. option:: -f | |
| 60 | ||
| 61 | Run in foreground, log to usual location | |
| 62 | ||
| 63 | ||
| 64 | Availability | |
| 65 | ============ | |
| 66 | ||
| 67 | :program:`rbd-mirror` is part of Ceph, a massively scalable, open-source, distributed | |
| 68 | storage system. Please refer to the Ceph documentation at http://ceph.com/docs for | |
| 69 | more information. | |
| 70 | ||
| 71 | ||
| 72 | See also | |
| 73 | ======== | |
| 74 | ||
| 75 | :doc:`rbd <rbd>`\(8) |