← Back to branch summary

~ubuntu-branches/ubuntu/quantal/ceph/quantal

« back to all changes in this revision

Viewing changes to doc/man/8/monmaptool.rst

  • Committer: Package Import Robot
  • Author(s): James Page
  • Date: 2012-07-16 09:56:24 UTC
  • mfrom: (0.3.11)
  • mto: This revision was merged to the branch mainline in revision 17.
  • Revision ID: package-import@ubuntu.com-20120716095624-azr2w4hbhei1rxmx
Tags: upstream-0.48
Import upstream version 0.48

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/man/8/monmaptool.rst
 
1
==========================================================
 
2
 monmaptool -- ceph monitor cluster map manipulation tool
 
3
==========================================================
 
4
 
 
5
.. program:: monmaptool
 
6
 
 
7
Synopsis
 
8
========
 
9
 
 
10
| **monmaptool** *mapfilename* [ --clobber ] [ --print ] [ --create ]
 
11
  [ --add *ip*:*port* *...* ] [ --rm *ip*:*port* *...* ]
 
12
 
 
13
 
 
14
Description
 
15
===========
 
16
 
 
17
**monmaptool** is a utility to create, view, and modify a monitor
 
18
cluster map for the Ceph distributed file system. The monitor map
 
19
specifies the only fixed addresses in the Ceph distributed system.
 
20
All other daemons bind to arbitrary addresses and register themselves
 
21
with the monitors.
 
22
 
 
23
When creating a map with --create, a new monitor map with a new,
 
24
random UUID will be created. It should be followed by one or more
 
25
monitor addresses.
 
26
 
 
27
The default Ceph monitor port is 6789.
 
28
 
 
29
 
 
30
Options
 
31
=======
 
32
 
 
33
.. option:: --print
 
34
 
 
35
   will print a plaintext dump of the map, after any modifications are
 
36
   made.
 
37
 
 
38
.. option:: --clobber
 
39
 
 
40
   will allow monmaptool to overwrite mapfilename if changes are made.
 
41
 
 
42
.. option:: --create
 
43
 
 
44
   will create a new monitor map with a new UUID (and with it, a new,
 
45
   empty Ceph file system).
 
46
 
 
47
.. option:: --generate
 
48
 
 
49
   generate a new monmap based on the values on the command line or specified
 
50
   in the ceph configuration.  This is, in order of preference,
 
51
 
 
52
      #. ``--monmap filename`` to specify a monmap to load
 
53
      #. ``--mon-host 'host1,ip2'`` to specify a list of hosts or ip addresses
 
54
      #. ``[mon.foo]`` sections containing ``mon addr`` settings in the config
 
55
 
 
56
.. option:: --filter-initial-members
 
57
 
 
58
   filter the initial monmap by applying the ``mon initial members``
 
59
   setting.  Monitors not present in that list will be removed, and
 
60
   initial members not present in the map will be added with dummy
 
61
   addresses.
 
62
 
 
63
.. option:: --add name ip:port
 
64
 
 
65
   will add a monitor with the specified ip:port to the map.
 
66
 
 
67
.. option:: --rm name
 
68
 
 
69
    will remove the monitor with the specified ip:port from the map.
 
70
 
 
71
.. option:: --fsid uuid
 
72
 
 
73
    will set the fsid to the given uuid.  If not specified with --create, a random fsid will be generated.
 
74
 
 
75
 
 
76
Example
 
77
=======
 
78
 
 
79
To create a new map with three monitors (for a fresh Ceph file system)::
 
80
 
 
81
        monmaptool  --create  --add  mon.a 192.168.0.10:6789 --add mon.b 192.168.0.11:6789 \
 
82
          --add mon.c 192.168.0.12:6789 --clobber monmap
 
83
 
 
84
To display the contents of the map::
 
85
 
 
86
        monmaptool --print onmap
 
87
 
 
88
To replace one monitor::
 
89
 
 
90
        monmaptool --rm mon.a --add mon.a 192.168.0.9:6789 --clobber monmap
 
91
 
 
92
 
 
93
Availability
 
94
============
 
95
 
 
96
**monmaptool** is part of the Ceph distributed file system.  Please
 
97
refer to the Ceph wiki at http://ceph.newdream.net/wiki for more
 
98
information.
 
99
 
 
100
 
 
101
See also
 
102
========
 
103
 
 
104
:doc:`ceph <ceph>`\(8),
 
105
:doc:`crushtool <crushtool>`\(8),
 
106
:doc:`mkcephfs <mkcephfs>`\(8)