ceph/doc/man/8/ceph-mds.rst
Jos Collin 3404d4c8ed
doc: mention MDS name and ID format in ceph-mds.rst
Signed-off-by: Jos Collin <jcollin@redhat.com>
2022-02-11 10:20:47 +05:30

88 lines
2.3 KiB
ReStructuredText

:orphan:
=========================================
ceph-mds -- ceph metadata server daemon
=========================================
.. program:: ceph-mds
Synopsis
========
| **ceph-mds** -i <*ID*> [flags]
Description
===========
**ceph-mds** is the metadata server daemon for the Ceph distributed file
system. One or more instances of ceph-mds collectively manage the file
system namespace, coordinating access to the shared OSD cluster.
Each ceph-mds daemon instance should have a unique name. The name is used
to identify daemon instances in the ceph.conf.
Once the daemon has started, the monitor cluster will normally assign
it a logical rank, or put it in a standby pool to take over for
another daemon that crashes. Some of the specified options can cause
other behaviors.
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:: -m monaddress[:port]
Connect to specified monitor (instead of looking through
``ceph.conf``).
.. option:: --id/-i ID
Set ID portion of the MDS name. The ID should not start with a numeric digit.
.. option:: --name/-n TYPE.ID
Set the MDS name of the format TYPE.ID. The TYPE is obviously 'mds'.
The ID should not start with a numeric digit.
Availability
============
**ceph-mds** 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-mon <ceph-mon>`\(8),
:doc:`ceph-osd <ceph-osd>`\(8)