From: Zac Dover <zac.dover@proton.me>
Date: Tue, 30 Jul 2024 07:33:55 +0000 (+1000)
Subject: doc/cephadm: edit "Using Custom Images"
X-Git-Tag: v17.2.8~257^2
X-Git-Url: http://git.apps.os.sepia.ceph.com/?a=commitdiff_plain;h=cf3080795452d9ca93910026aca751808f96289a;p=ceph.git

doc/cephadm: edit "Using Custom Images"

Edit the section "Using Custom Images" in
doc/cephadm/services/monitoring.rst.

Co-authored-by: Anthony D'Atri <anthony.datri@gmail.com>
Signed-off-by: Zac Dover <zac.dover@proton.me>
(cherry picked from commit e99fc5c82fd698c222a489a1ebc26c8fcbca321d)
---

diff --git a/doc/cephadm/services/monitoring.rst b/doc/cephadm/services/monitoring.rst
index a4d1ee548724b..07f5643a5b04f 100644
--- a/doc/cephadm/services/monitoring.rst
+++ b/doc/cephadm/services/monitoring.rst
@@ -165,59 +165,61 @@ Using custom images
 ~~~~~~~~~~~~~~~~~~~
 
 It is possible to install or upgrade monitoring components based on other
-images.  To do so, the name of the image to be used needs to be stored in the
-configuration first.  The following configuration options are available.
+images. The ID of the image that you plan to use must be stored in the
+configuration. The following configuration options are available:
 
 - ``container_image_prometheus``
 - ``container_image_grafana``
 - ``container_image_alertmanager``
 - ``container_image_node_exporter``
 
-Custom images can be set with the ``ceph config`` command
-
-.. code-block:: bash
+Custom images can be set with the ``ceph config`` command. To set custom images, run a command of the following form:
+ 
+.. prompt:: bash #
 
-     ceph config set mgr mgr/cephadm/<option_name> <value>
+   ceph config set mgr mgr/cephadm/<option_name> <value>
 
-For example
+For example:
 
-.. code-block:: bash
+.. prompt:: bash #
 
-     ceph config set mgr mgr/cephadm/container_image_prometheus prom/prometheus:v1.4.1
+   ceph config set mgr mgr/cephadm/container_image_prometheus prom/prometheus:v1.4.1
 
-If there were already running monitoring stack daemon(s) of the type whose
-image you've changed, you must redeploy the daemon(s) in order to have them
-actually use the new image.
+If you were already running monitoring stack daemon(s) of the same image type
+that you changed, then you must redeploy the daemon(s) in order to make them
+use the new image.
 
-For example, if you had changed the prometheus image
+For example, if you changed the Prometheus image, you would have to run the
+following command in order to pick up the changes:
 
 .. prompt:: bash #
 
-     ceph orch redeploy prometheus
+   ceph orch redeploy prometheus
 
 
 .. note::
 
      By setting a custom image, the default value will be overridden (but not
-     overwritten).  The default value changes when updates become available.
-     By setting a custom image, you will not be able to update the component
-     you have set the custom image for automatically.  You will need to
-     manually update the configuration (image name and tag) to be able to
-     install updates.
+     overwritten). The default value will change when an update becomes
+     available. If you set a custom image, you will not be able automatically
+     to update the component you have modified with the custom image. You will
+     need to manually update the configuration (that includes the image name
+     and the tag) to be able to install updates.
 
-     If you choose to go with the recommendations instead, you can reset the
-     custom image you have set before.  After that, the default value will be
-     used again.  Use ``ceph config rm`` to reset the configuration option
+     If you choose to accept the recommendations, you can reset the custom
+     image that you have set before. If you do this, the default value will be
+     used again.  Use ``ceph config rm`` to reset the configuration option, in
+     a command of the following form:
 
-     .. code-block:: bash
+     .. prompt:: bash #
 
-          ceph config rm mgr mgr/cephadm/<option_name>
+        ceph config rm mgr mgr/cephadm/<option_name>
 
-     For example
+     For example:
 
-     .. code-block:: bash
+     .. prompt:: bash #
 
-          ceph config rm mgr mgr/cephadm/container_image_prometheus
+        ceph config rm mgr mgr/cephadm/container_image_prometheus
 
 See also :ref:`cephadm-airgap`.