Skip to content

Commit

Permalink
Merge pull request ceph#46369 from rkachach/fix_issue_55357
Browse files Browse the repository at this point in the history
doc/cephadm: document the new per-fsid cephadm conf location

Reviewed-by: Adam King <[email protected]>
Reviewed-by: Anthony D'Atri <[email protected]>
  • Loading branch information
adk3798 authored Jun 22, 2022
2 parents d4d9594 + 443f93e commit 3c7431f
Show file tree
Hide file tree
Showing 3 changed files with 29 additions and 7 deletions.
4 changes: 3 additions & 1 deletion doc/cephadm/host-management.rst
Original file line number Diff line number Diff line change
Expand Up @@ -161,7 +161,9 @@ The following host labels have a special meaning to cephadm. All start with ``_
bootstrap was originally run), and the ``client.admin`` key is set to be distributed
to that host via the ``ceph orch client-keyring ...`` function. Adding this label
to additional hosts will normally cause cephadm to deploy config and keyring files
in ``/etc/ceph``.
in ``/etc/ceph``. Starting from versions 16.2.10 (Pacific) and 17.2.1 (Quincy) in
addition to the default location ``/etc/ceph/`` cephadm also stores config and keyring
files in the ``/var/lib/ceph/<fsid>/config`` directory.

Maintenance Mode
================
Expand Down
21 changes: 15 additions & 6 deletions doc/cephadm/operations.rst
Original file line number Diff line number Diff line change
Expand Up @@ -395,25 +395,34 @@ process is active within the cluster.*
CEPHADM_CHECK_KERNEL_VERSION
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The OS kernel version (maj.min) is checked for consistency across the hosts.
The kernel version of the majority of the hosts is used as the basis for
The kernel version of the majority of the hosts is used as the basis for
identifying anomalies.

.. _client_keyrings_and_configs:

Client keyrings and configs
===========================

Cephadm can distribute copies of the ``ceph.conf`` file and client keyring
files to hosts. It is usually a good idea to store a copy of the config and
``client.admin`` keyring on any host used to administer the cluster via the
CLI. By default, cephadm does this for any nodes that have the ``_admin``
label (which normally includes the bootstrap host).
files to hosts. Starting from versions 16.2.10 (Pacific) and 17.2.1 (Quincy),
in addition to the default location ``/etc/ceph/`` cephadm also stores config
and keyring files in the ``/var/lib/ceph/<fsid>/config`` directory. It is usually
a good idea to store a copy of the config and ``client.admin`` keyring on any host
used to administer the cluster via the CLI. By default, cephadm does this for any
nodes that have the ``_admin`` label (which normally includes the bootstrap host).

.. note:: Ceph daemons will still use files on ``/etc/ceph/``. The new configuration
location ``/var/lib/ceph/<fsid>/config`` is used by cephadm only. Having this config
directory under the fsid helps cephadm to load the configuration associated with
the cluster.


When a client keyring is placed under management, cephadm will:

- build a list of target hosts based on the specified placement spec (see
:ref:`orchestrator-cli-placement-spec`)
- store a copy of the ``/etc/ceph/ceph.conf`` file on the specified host(s)
- store a copy of the ``ceph.conf`` file at ``/var/lib/ceph/<fsid>/config/ceph.conf`` on the specified host(s)
- store a copy of the ``ceph.client.admin.keyring`` file at ``/var/lib/ceph/<fsid>/config/ceph.client.admin.keyring`` on the specified host(s)
- store a copy of the keyring file on the specified host(s)
- update the ``ceph.conf`` file as needed (e.g., due to a change in the cluster monitors)
- update the keyring file if the entity's key is changed (e.g., via ``ceph
Expand Down
11 changes: 11 additions & 0 deletions doc/man/8/cephadm.rst
Original file line number Diff line number Diff line change
Expand Up @@ -194,6 +194,17 @@ Arguments:
* [--skip-firewalld] Do not configure firewalld
* [--skip-pull] do not pull the latest image before adopting

Configuration:

When starting the shell, cephadm looks for configuration in the following order.
Only the first values found are used:

1. An explicit, user provided path to a config file (``-c/--config`` option)
2. Config file for daemon specified with ``--name`` parameter (``/var/lib/ceph/<fsid>/<daemon-name>/config``)
3. ``/var/lib/ceph/<fsid>/config/ceph.conf`` if it exists
4. The config file for a ``mon`` daemon (``/var/lib/ceph/<fsid>/mon.<mon-id>/config``) if it exists
5. Finally: fallback to the default file ``/etc/ceph/ceph.conf``


bootstrap
---------
Expand Down

0 comments on commit 3c7431f

Please sign in to comment.