Project

General

Profile

Actions

Bug #48280

open

The list of keyring, etc options in "Configuring Ceph" is misleading

Added by John Mulligan over 3 years ago.

Status:
New
Priority:
Normal
Assignee:
-
Category:
documentation
Target version:
-
% Done:

0%

Source:
Tags:
Backport:
Regression:
No
Severity:
4 - irritation
Reviewed:
Affected Versions:
ceph-qa-suite:
Pull request ID:
Crash signature (v1):
Crash signature (v2):

Description

https://docs.ceph.com/en/latest/rados/configuration/ceph-conf/#bootstrap-options

Under "Configuring Ceph" -> "Bootstrap options" there is an item that currently reads:
"""
keyring, keyfile, and/or key, which can be used to specify the authentication credential to use to authenticate with the monitor. Note that in most cases the default keyring location is in the data directory specified above.
"""

On my server I generated a config according to https://docs.ceph.com/en/latest/cephadm/client-setup/
This uses `ceph config generate-minimal-conf` to output a simple minimal config, but one that doesn't reference any auth params.
Since I am setting up ceph for experimentation and testing I didn't want to set up a global config file or put anything in /etc. On my test client I used `ceph -c $MYCEPHCONF status` but this (somewhat unexpectedly) failed due to lack of auth keys.

Based on the https://docs.ceph.com/en/latest/rados/configuration/ceph-conf/#bootstrap-options page I saw that I could add either "keyring, keyfile, and/or key" not being an expert in ceph auth, I naively saw them as aliases (at least the first two). I put in a path like `keyfile = /my/home/file` not realizing that the file format for keyring and keyfile differ and getting only the extremely terse `[errno 22] error connecting to the cluster` even after raising the debug levels in the conf file.

After spending two hours or so debugging I found enough links that hinted at the difference and then finally discovering:
https://docs.ceph.com/en/latest/rados/configuration/auth-config-ref/#keys
which clearly spells out the difference.

My request is to:
a) Have the above paragraph/bullet item link to https://docs.ceph.com/en/latest/rados/configuration/auth-config-ref/
and
b) Tweak the wording of the bullet to make these seem less like synonyms. Possible suggestion:
"""
keyring, keyfile, and/or key, which are three different methods that can be used to specify an authentication credential to use to authenticate with the monitor.
"""

No data to display

Actions

Also available in: Atom PDF