From: Ville Ojamo <14869000+bluikko@users.noreply.github.com> Date: Fri, 9 Jan 2026 09:45:59 +0000 (+0700) Subject: doc/cephadm: small improvements continued X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=refs%2Fpull%2F66862%2Fhead;p=ceph.git doc/cephadm: small improvements continued Fix invalid section title and add a label for ref. Link to the new label instead of telling which section to read. Remove a sentence no longer relevant with config db. Remove stray spaces, add newlines per style, fix capitalization. Use privileged prompt when necessary. Signed-off-by: Ville Ojamo <14869000+bluikko@users.noreply.github.com> --- diff --git a/doc/cephadm/client-setup.rst b/doc/cephadm/client-setup.rst index 0f38773b12b..9ee1e92dcad 100644 --- a/doc/cephadm/client-setup.rst +++ b/doc/cephadm/client-setup.rst @@ -1,6 +1,7 @@ ======================= Basic Ceph Client Setup ======================= + Client hosts require basic configuration to interact with Ceph clusters. This section describes how to perform this configuration. @@ -10,10 +11,10 @@ Ceph clusters. This section describes how to perform this configuration. ``rados`` commands, as well as other commands including ``mount.ceph`` and ``rbd``. + Config File Setup ================= -Client hosts usually require smaller configuration files (here -sometimes called "config files") than do back-end cluster hosts. + To generate a minimal config file, log into a host that has been configured as a client or that is running a cluster daemon, then run the following command: @@ -26,14 +27,16 @@ This command generates a minimal config file that tells the client how to reach the Ceph Monitors. This file should usually be copied to ``/etc/ceph/ceph.conf`` on each client host. + Keyring Setup ============= + Most Ceph clusters run with authentication enabled. This means that the client needs keys in order to communicate with Ceph daemons. To generate a keyring file with credentials for ``client.fs``, log into an running cluster member and run the following command: -.. prompt:: bash $ +.. prompt:: bash # ceph auth get-or-create client.fs @@ -44,6 +47,5 @@ To gain a broader understanding of client keyring distribution and administratio you should read :ref:`client_keyrings_and_configs`. To see an example that explains how to distribute ``ceph.conf`` configuration -files to hosts that are tagged with the ``bare_config`` label, you should read -the subsection named "Distributing ceph.conf to hosts tagged with bare_config" -under the heading :ref:`etc_ceph_conf_distribution`. +files to hosts that are tagged with the ``bare_config`` label, you should +read :ref:`ceph_conf_distribution_label`. diff --git a/doc/cephadm/compatibility.rst b/doc/cephadm/compatibility.rst index 8dd301f1a22..7ec373a541e 100644 --- a/doc/cephadm/compatibility.rst +++ b/doc/cephadm/compatibility.rst @@ -34,12 +34,12 @@ This table shows which version pairs are expected to work or not work together: all Ceph versions, there are no known issues with using Podman version 3.0 or greater with Ceph Quincy and later releases. -.. warning:: +.. warning:: To use Podman with Ceph Pacific, you must use **a version of Podman that is 2.0.0 or higher**. However, **Podman version 2.2.1 does not work with Ceph Pacific**. - + "Kubic stable" is known to work with Ceph Pacific, but it must be run with a newer kernel. @@ -57,7 +57,7 @@ Cephadm support remains under development for the following features: - ceph-exporter deployment - stretch mode integration -- monitoring stack (moving towards prometheus service discover and providing TLS) +- monitoring stack (moving towards Prometheus service discovery and providing TLS) - RGW multisite deployment support (requires lots of manual steps currently) - cephadm agent diff --git a/doc/cephadm/operations.rst b/doc/cephadm/operations.rst index ad7cf880550..e592f5bcc76 100644 --- a/doc/cephadm/operations.rst +++ b/doc/cephadm/operations.rst @@ -694,9 +694,10 @@ without client keyrings, run the following command: ceph config set mgr mgr/cephadm/manage_etc_ceph_ceph_conf true +.. _ceph_conf_distribution_label: -Using Placement Specs to Specify which Hosts Get Keyrings ---------------------------------------------------------- +Using Placement Specs to Specify which Hosts Get ``ceph.conf`` +-------------------------------------------------------------- By default, the configs are written to all hosts (i.e., those listed by ``ceph orch host ls``). To specify which hosts get a ``ceph.conf``, run a command of