CEPH-CONF(8)

📦
version 20.2.4 · 20 versions
, in ubuntu stonking

💖 CEPH-CONF(8) — the girlies' guide to the ceph conf file tool 💖

okay bestie, welcome to ceph-conf, section 8 of the manual, and let me tell you she is that girl for poking at your ceph configuration file 🎀

✨ NAME ✨

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-conf key -s section1 ...
ceph-conf [-s section ] [-r] --lookup key
ceph-conf [-s section ] key

like, six whole ways to serve cromulence, no cap 💅

✨ DESCRIPTION ✨

so ceph-conf is a lil utility for getting information out of a ceph configuration file. fr fr. and like most Ceph programs, you tell her which Ceph configuration file to use with the -c flag. iconic.

⚠️ important bestie, read this twice ⚠️ unlike other ceph tools, ceph-conf will only read from config files (or return compiled-in default values) — she will not fetch config values from the monitor cluster. not even a little. 💀

because of that, it is recommended that ceph-conf only be used in legacy environments that are strictly config-file based. new deployments and tools should instead rely on either:

  • querying the monitor explicitly for configuration (e.g., ceph config get <daemon> <option>), or
  • use daemons themselves to fetch effective config options (e.g., ceph-osd -i 123 --show-config-value osd_data).

and the latter option is lowkey the main character because it has the advantages of drawing from compiled-in defaults (which occasionally vary between daemons), config files, and the monitor's config database — providing the exact value that that daemon would be using if it were started. periodt. 👑

✨ ACTIONS ✨

ceph-conf performs one of the following actions, bestie — pick your fighter:

  • -L, --list-all-sections — list all sections in the configuration file. all of them. every single one 🦋
  • -l, --list-sections prefix — list the sections with the given prefix. for example, --list-sections mon would list all sections beginning with mon. it's giving filtered feed ✨
  • --lookup key — 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. she's the default for a reason 🫶
  • -h, --help — print a summary of usage. the "help me help you" era 💜

✨ 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 be searched: [osd.0], [osd], [global]. 👑
  • --pid pid — override the $pid when expanding options. for example, if an option is configured like /var/log/$name.$pid.log, the $pid portion in its value will be substituted using the PID of ceph-conf instead of the PID of the process specified using the --name option. 🧚
  • -r, --resolve-search — search for the first file that exists and can be opened in the resulted comma delimited search list. 🔍
  • -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. first come, first served bestie 🌸

✨ EXAMPLES ✨

lowkey the fun part. here's how the girlies actually use her 💅

to find out what value osd 0 will use for the "osd data" option:

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:

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

to list all sections that begin with "osd":

ceph-conf -c foo.conf -l osd

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. 🗂️ she'll find them, don't worry.

✨ AVAILABILITY ✨

ceph-conf 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 ✨

ceph <>(8),

2010-2014, Inktank Storage, Inc. and contributors. Licensed under Creative Commons Attribution Share Alike 3.0 (CC-BY-SA-3.0)

and that's the whole vibe check bestie 🫶 this page came from dev, dated Oct 06, 2026, living at the bottom of the CEPH-CONF(8) page — go forth and configure responsibly, mwah 💖✨🎀

📦 where this page comes from