RepoMirrors/ceph
1
0
Fork 0
mirror of https://github.com/ceph/ceph synced 2025-01-02 09:02:34 +00:00
Code Issues Packages Projects Releases Wiki Activity

doc/cephadm: edit "Using Custom Images"

Browse Source 
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>
This commit is contained in:
Zac Dover 2024-07-30 17:33:55 +10:00
parent 808ecbb54c
commit e99fc5c82f
1 changed files with 33 additions and 31 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

64
doc/cephadm/services/monitoring.rst
View File

@ -196,8 +196,8 @@ 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``
@ -213,51 +213,53 @@ configuration first. The following configuration options are available.
- ``container_image_jaeger_collector``
- ``container_image_jaeger_query``
Custom images can be set with the ``ceph config`` command
Custom images can be set with the ``ceph config`` command. To set custom images, run a command of the following form:
.. prompt:: bash #
.. code-block:: bash
ceph config set mgr mgr/cephadm/<option_name> <value>
ceph config set mgr mgr/cephadm/<option_name> <value>
For example
.. code-block:: bash
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.
For example, if you had changed the prometheus image
For example:
.. prompt:: bash #
ceph orch redeploy prometheus
ceph config set mgr mgr/cephadm/container_image_prometheus prom/prometheus:v1.4.1
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 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
.. 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`.