ceph-conf – ceph conf file tool

Synopsis

ceph-conf -c conffile –list-all-sections

ceph-conf -c conffile -L

ceph-conf -c conffile -l prefix

ceph-confkey -s section1 …

ceph-conf [-s section ] [-r] –lookup key

ceph-conf [-s section ] key

Description

ceph-conf is a utility for getting information from a cephconfiguration file. As with most Ceph programs, you can specify whichCeph configuration file to use with the -c flag.

Note that unlike other ceph tools, ceph-conf will only read fromconfig files (or return compiled-in default values)–it will _not_fetch config values from the monitor cluster. For this reason it isrecommended that ceph-conf only be used in legacy environmentsthat are strictly config-file based. New deployments and tools shouldinstead rely on either querying the monitor explicitly forconfiguration (e.g., ceph config get <daemon> <option>) or usedaemons themselves to fetch effective config options (e.g.,ceph-osd -i 123 —show-config-value osd_data). The latter optionhas the advantages of drawing from compiled-in defaults (whichoccasionally vary between daemons), config files, and the monitor’sconfig database, providing the exact value that that daemon would beusing if it were started.

Actions

ceph-conf performs one of the following actions:

  • -L, —list-all-sections
  • list all sections in the configuration file.
  • -l, —list-sections prefix
  • list the sections with the given prefix. For example, —list-sections monwould list all sections beginning with mon.
  • —lookup key
  • search and print the specified configuration setting. Note: —lookup isthe default action. If no other actions are given on the command line, we willdefault to doing a lookup.
  • -h, —help
  • print a summary of usage.

Options

  • -c conffile
  • the Ceph configuration file.
  • —filter-key key
  • filter section list to only include sections with given key defined.
  • —filter-key-value key = value
  • filter section list to only include sections with given key/value pair.
  • —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 besearched: [osd.0], [osd], [global]
  • -r, —resolve-search
  • search for the first file that exists and can be opened in the resultedcomma delimited search list.
  • -s, —section
  • additional sections to search. These additional sections will be searchedbefore the sections that would normally be searched. As always, the firstmatching entry we find will be returned.

Examples

To find out what value osd 0 will use for the “osd data” option:

  1. ceph-conf -c foo.conf  --name osd.0 --lookup "osd data"

To find out what value will mds a use for the “log file” option:

  1. ceph-conf -c foo.conf  --name mds.a "log file"

To list all sections that begin with “osd”:

  1. ceph-conf -c foo.conf -l osd

To list all sections:

  1. ceph-conf -c foo.conf -L

To print the path of the “keyring” used by “client.0”:

  1. 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

ceph-conf is part of Ceph, a massively scalable, open-source, distributed storage system. Please referto the Ceph documentation at http://ceph.com/docs for moreinformation.

See also

ceph(8),