RepoMirrors/ceph
1
0
Fork 0
mirror of https://github.com/ceph/ceph synced 2025-04-01 23:02:17 +00:00
Code Issues Packages Projects Releases Wiki Activity

doc: rework ceph-conf.8

Browse Source 
* sync it with the code
* reformat it like a proper man page

Signed-off-by: Kefu Chai <kchai@redhat.com>
This commit is contained in:
Kefu Chai 2015-04-21 14:57:18 +08:00
parent 89262abc53
commit a4627aabb7
1 changed files with 60 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

79
doc/man/8/ceph-conf.rst
View File

@ -13,7 +13,7 @@ Synopsis
| **ceph-conf** -c *conffile* -L
| **ceph-conf** -c *conffile* -l *prefix*
| **ceph-conf** *key* -s *section1* ...
| **ceph-conf** [-s *section* ] --lookup *key*
| **ceph-conf** [-s *section* ] [-r] --lookup *key*
| **ceph-conf** [-s *section* ] *key*
@ -28,30 +28,59 @@ Ceph configuration file to use with the ``-c`` flag.
Actions
=======
.. TODO format this like a proper man page
**ceph-conf** performs one of the following actions:
**ceph-conf** will perform one of the following actions:
.. option:: -L, --list-all-sections
--list-all-sections or -L prints out a list of all the section names in the configuration
file.
list all sections in the configuration file.
--list-sections or -l prints out a list of all the sections that begin
with a given prefix. For example, --list-sections mon would list all
sections beginning with mon.
.. option:: -l, --list-sections *prefix*
--lookup will search the configuration for a given value. By default, the sections that
are searched are determined by the Ceph name that we are using. The Ceph name defaults to
client.admin. It can be specified with --name.
list the sections with the given *prefix*. For example, ``--list-sections mon``
would list all sections beginning with ``mon``.
For example, if we specify --name osd.0, the following sections will be searched:
[osd.0], [osd], [global]
.. option:: --lookup *key*
You can specify additional sections to search with --section or -s. These additional
sections will be searched before the sections that would normally be searched. As always,
the first matching entry we find will be returned.
search and print the specified configuration setting. Note: ``--lookup`` is
the default action. If no other actions are given on the command line, we will
default to doing a lookup.
Note: --lookup is the default action. If no other actions are given on the command line,
we will default to doing a lookup.
.. option:: -h, --help
print a summary of usage.
Options
=======
.. option:: -c *conffile*
the Ceph configuration file.
.. option:: --filter-key *key*
filter section list to only include sections with given *key* defined.
.. option:: --filter-key-value *key* ``=`` *value*
filter section list to only include sections with given *key*/*value* pair.
.. option:: --name *type.id*
the Ceph name in which the sections are searched (default 'client.admin').
For example, if we specify ``--name osd.0``, the following sections will be
searched: [osd.0], [osd], [global]
.. option:: -r, --resolve-search
search for the first file that exists and can be opened in the resulted
comma delimited search list.
.. option:: -s, --section
additional sections to search. These additional sections will be searched
before the sections that would normally be searched. As always, the first
matching entry we find will be returned.
Examples
@ -65,7 +94,7 @@ To find out what value will mds a use for the "log file" option::
ceph-conf -c foo.conf --name mds.a "log file"
To list all sections that begin with osd::
To list all sections that begin with "osd"::
ceph-conf -c foo.conf -l osd
@ -73,6 +102,18 @@ To list all sections::
ceph-conf -c foo.conf -L
To print the path of the "keyring" used by "client.0"::
ceph-conf --name client.0 -r -l keyring
Files
=====
``/etc/ceph/$cluster.conf``, ``~/.ceph/$cluster.conf``, ``$cluster.conf``
the Ceph configuration files to use if not specified.
Availability
============