summaryrefslogtreecommitdiffstats
path: root/doc/man/8/ceph-mon.rst
blob: 640c842d605af22ccc8f8ac8d31aac5071836dd8 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
:orphan:

=================================
 ceph-mon -- ceph monitor daemon
=================================

.. program:: ceph-mon

Synopsis
========

| **ceph-mon** -i *monid* [ --mon-data *mondatapath* ]


Description
===========

**ceph-mon** is the cluster monitor daemon for the Ceph distributed
file system. One or more instances of **ceph-mon** form a Paxos
part-time parliament cluster that provides extremely reliable and
durable storage of cluster membership, configuration, and state.

The *mondatapath* refers to a directory on a local file system storing
monitor data. It is normally specified via the ``mon data`` option in
the configuration file.

Options
=======

.. option:: -f, --foreground

   Foreground: do not daemonize after startup (run in foreground). Do
   not generate a pid file. Useful when run via :doc:`ceph-run <ceph-run>`\(8).

.. option:: -d

   Debug mode: like ``-f``, but also send all log output to stderr.

.. option:: --setuser userorgid

   Set uid after starting.  If a username is specified, the user
   record is looked up to get a uid and a gid, and the gid is also set
   as well, unless --setgroup is also specified.

.. option:: --setgroup grouporgid

   Set gid after starting.  If a group name is specified the group
   record is looked up to get a gid.

.. 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:: --mkfs

   Initialize the ``mon data`` directory with seed information to form
   and initial ceph file system or to join an existing monitor
   cluster.  Three pieces of information must be provided:

   - The cluster fsid.  This can come from a monmap (``--monmap <path>``) or
     explicitly via ``--fsid <uuid>``.
   - A list of monitors and their addresses.  This list of monitors
     can come from a monmap (``--monmap <path>``), the ``mon host``
     configuration value (in *ceph.conf* or via ``-m
     host1,host2,...``), or (for backward compatibility) the deprecated ``mon addr`` lines in *ceph.conf*.  If this
     monitor is to be part of the initial monitor quorum for a new
     Ceph cluster, then it must be included in the initial list,
     matching either the name or address of a monitor in the list.
     When matching by address, either the ``public addr`` or ``public
     subnet`` options may be used.
   - The monitor secret key ``mon.``.  This must be included in the
     keyring provided via ``--keyring <path>``.

.. option:: --keyring

   Specify a keyring for use with ``--mkfs``.

.. option:: --no-config-file

    Signal that we don't want to rely on a *ceph.conf*, either user provided
    or the default, to run the daemon.  This will entail providing all
    necessary options to the daemon as arguments.

Availability
============

**ceph-mon** is part of Ceph, a massively scalable, open-source, distributed storage system. Please refer
to the Ceph documentation at https://docs.ceph.com for more
information.


See also
========

:doc:`ceph <ceph>`\(8),
:doc:`ceph-mds <ceph-mds>`\(8),
:doc:`ceph-osd <ceph-osd>`\(8)