]> git.proxmox.com Git - ceph.git/blame - ceph/doc/man/8/ceph-mon.rst
update sources to v12.1.1
[ceph.git] / ceph / doc / man / 8 / ceph-mon.rst
CommitLineData
7c673cae
FG
1:orphan:
2
3=================================
4 ceph-mon -- ceph monitor daemon
5=================================
6
7.. program:: ceph-mon
8
9Synopsis
10========
11
12| **ceph-mon** -i *monid* [ --mon-data *mondatapath* ]
13
14
15Description
16===========
17
18**ceph-mon** is the cluster monitor daemon for the Ceph distributed
19file system. One or more instances of **ceph-mon** form a Paxos
20part-time parliament cluster that provides extremely reliable and
21durable storage of cluster membership, configuration, and state.
22
23The *mondatapath* refers to a directory on a local file system storing
24monitor data. It is normally specified via the ``mon data`` option in
25the configuration file.
26
27Options
28=======
29
30.. option:: -f, --foreground
31
32 Foreground: do not daemonize after startup (run in foreground). Do
33 not generate a pid file. Useful when run via :doc:`ceph-run <ceph-run>`\(8).
34
35.. option:: -d
36
37 Debug mode: like ``-f``, but also send all log output to stderr.
38
39.. option:: --setuser userorgid
40
41 Set uid after starting. If a username is specified, the user
42 record is looked up to get a uid and a gid, and the gid is also set
43 as well, unless --setgroup is also specified.
44
45.. option:: --setgroup grouporgid
46
47 Set gid after starting. If a group name is specified the group
48 record is looked up to get a gid.
49
50.. option:: -c ceph.conf, --conf=ceph.conf
51
52 Use *ceph.conf* configuration file instead of the default
53 ``/etc/ceph/ceph.conf`` to determine monitor addresses during
54 startup.
55
56.. option:: --mkfs
57
58 Initialize the ``mon data`` directory with seed information to form
59 and initial ceph file system or to join an existing monitor
60 cluster. Three pieces of information must be provided:
61
62 - The cluster fsid. This can come from a monmap (``--monmap <path>``) or
63 explicitly via ``--fsid <uuid>``.
64 - A list of monitors and their addresses. This list of monitors
65 can come from a monmap (``--monmap <path>``), the ``mon host``
66 configuration value (in *ceph.conf* or via ``-m
67 host1,host2,...``), or ``mon addr`` lines in *ceph.conf*. If this
68 monitor is to be part of the initial monitor quorum for a new
69 Ceph cluster, then it must be included in the initial list,
70 matching either the name or address of a monitor in the list.
71 When matching by address, either the ``public addr`` or ``public
72 subnet`` options may be used.
73 - The monitor secret key ``mon.``. This must be included in the
74 keyring provided via ``--keyring <path>``.
75
76.. option:: --keyring
77
78 Specify a keyring for use with ``--mkfs``.
79
80
81Availability
82============
83
84**ceph-mon** is part of Ceph, a massively scalable, open-source, distributed storage system. Please refer
85to the Ceph documentation at http://ceph.com/docs for more
86information.
87
88
89See also
90========
91
92:doc:`ceph <ceph>`\(8),
93:doc:`ceph-mds <ceph-mds>`\(8),
94:doc:`ceph-osd <ceph-osd>`\(8)