From: Zac Dover <zac.dover@proton.me>
Date: Sat, 4 May 2024 12:36:07 +0000 (+1000)
Subject: Merge pull request #57236 from zdover23/wip-doc-2024-05-02-cephadm-services-monitorin... 
X-Git-Tag: v18.2.5~679
X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=cebe73d607fdba2488732fca51c77e2b4837788b;p=ceph.git

Merge pull request #57236 from zdover23/wip-doc-2024-05-02-cephadm-services-monitoring-reef

reef: doc/cephadm: Reef default images procedure

Reviewed-by: Adam King <adking@redhat.com>
---

cebe73d607fdba2488732fca51c77e2b4837788b
diff --cc doc/cephadm/services/monitoring.rst
index b00c0ece0a4,90888999fed..a012751f26b
--- a/doc/cephadm/services/monitoring.rst
+++ b/doc/cephadm/services/monitoring.rst
@@@ -158,40 -158,73 +158,105 @@@ example spec file
        port: 4200
        protocol: http
  
+ .. _cephadm_default_images:
+ 
+ Default images
+ ~~~~~~~~~~~~~~
+ 
+ ``cephadm`` stores a local copy of the ``cephadm`` binary in
+ ``var/lib/ceph/{FSID}/cephadm.{DIGEST}``, where ``{DIGEST}`` is an alphanumeric
+ string representing the currently-running version of Ceph. In the Squid and
+ Reef releases of Ceph, this ``cephadm`` file is stored as a zip file and must
+ be unzipped before its contents can be examined.
+ 
+ This procedure explains how to generate a list of the default container images
+ used by ``cephadm``.
+ 
+ .. note:: This procedure applies only to the Reef and Squid releases of Ceph.
+    If you are using a different version of Ceph, you cannot use this procedure
+    to examine the list of default containers used by cephadm. Make sure that
+    you are reading the documentation for the release of Ceph that you have
+    installed.
+ 
+ #. To create a directory called ``cephadm_dir``, run the following command:
+ 
+    .. prompt:: bash #
+ 
+       mkdir cephadm_dir
+ 
+ #. To unzip ``/var/lib/ceph/{FSID}/cephadm.{DIGEST}`` in the directory
+    ``cephadm_dir``, run a command of the following form:
+ 
+    .. prompt:: bash #
+ 
+       unzip /var/lib/ceph/{FSID}/cephadm.{DIGEST} -d cephadm_dir > /dev/null
+ 
+    ::
+ 
+       warning [/var/lib/ceph/{FSID}/cephadm.{DIGEST}]:  14 extra bytes at
+       beginning or within zipfile
+       (attempting to process anyway)
+ 
+ 
+ #. To use ``egrep`` to search for the string ``_IMAGE =`` in the file
+    ``cephadm_dir/__main__.py``, run the following command: 
+ 
+    .. prompt:: bash #
+ 
+       egrep "_IMAGE =" cephadm_dir/__main__.py
+ 
+    ::
+ 
+       DEFAULT_IMAGE = 'quay.io/ceph/ceph:v18'
+       DEFAULT_PROMETHEUS_IMAGE = 'quay.io/prometheus/prometheus:v2.43.0'
+       DEFAULT_LOKI_IMAGE = 'docker.io/grafana/loki:2.4.0'
+       DEFAULT_PROMTAIL_IMAGE = 'docker.io/grafana/promtail:2.4.0'
+       DEFAULT_NODE_EXPORTER_IMAGE = 'quay.io/prometheus/node-exporter:v1.5.0'
+       DEFAULT_ALERT_MANAGER_IMAGE = 'quay.io/prometheus/alertmanager:v0.25.0'
+       DEFAULT_GRAFANA_IMAGE = 'quay.io/ceph/ceph-grafana:9.4.7'
+       DEFAULT_HAPROXY_IMAGE = 'quay.io/ceph/haproxy:2.3'
+       DEFAULT_KEEPALIVED_IMAGE = 'quay.io/ceph/keepalived:2.2.4'
+       DEFAULT_NVMEOF_IMAGE = 'quay.io/ceph/nvmeof:1.0.0'
+       DEFAULT_SNMP_GATEWAY_IMAGE = 'docker.io/maxwo/snmp-notifier:v1.2.1'
+       DEFAULT_ELASTICSEARCH_IMAGE = 'quay.io/omrizeneva/elasticsearch:6.8.23'
+       DEFAULT_JAEGER_COLLECTOR_IMAGE = 'quay.io/jaegertracing/jaeger-collector:1.29'
+       DEFAULT_JAEGER_AGENT_IMAGE = 'quay.io/jaegertracing/jaeger-agent:1.29'
+       DEFAULT_JAEGER_QUERY_IMAGE = 'quay.io/jaegertracing/jaeger-query:1.29'
+ 
  .. _cephadm_monitoring-images:
  
 +.. _cephadm_default_images:
 +
 +Default images
 +~~~~~~~~~~~~~~
 +
 +*The information in this section was developed by Eugen Block in a thread on
 +the [ceph-users] mailing list in April of 2024. The thread can be viewed here:
 +``https://lists.ceph.io/hyperkitty/list/ceph-users@ceph.io/thread/QGC66QIFBKRTPZAQMQEYFXOGZJ7RLWBN/``.*
 +
 +``cephadm`` stores a local copy of the ``cephadm`` binary in
 +``var/lib/ceph/{FSID}/cephadm.{DIGEST}``, where ``{DIGEST}`` is an alphanumeric
 +string representing the currently-running version of Ceph.
 +
 +To see the default container images, run a command of the following form:
 +
 +.. prompt:: bash #
 +
 +   grep -E "DEFAULT*IMAGE" /var/lib/ceph/{FSID}/cephadm.{DIGEST}
 +
 +::
 +
 +   DEFAULT_PROMETHEUS_IMAGE = 'quay.io/prometheus/prometheus:v2.51.0'
 +   DEFAULT_LOKI_IMAGE = 'docker.io/grafana/loki:2.9.5'    
 +   DEFAULT_PROMTAIL_IMAGE = 'docker.io/grafana/promtail:2.9.5'    
 +   DEFAULT_NODE_EXPORTER_IMAGE = 'quay.io/prometheus/node-exporter:v1.7.0'    
 +   DEFAULT_ALERT_MANAGER_IMAGE = 'quay.io/prometheus/alertmanager:v0.27.0'   
 +   DEFAULT_GRAFANA_IMAGE = 'quay.io/ceph/grafana:10.4.0'
 +
 +Default monitoring images are specified in
 +``/src/cephadm/cephadmlib/constants.py`` and in
 +``/src/pybind/mgr/cephadm/module.py``.
 +
  Using custom images
  ~~~~~~~~~~~~~~~~~~~