Merge pull request ceph#60412 from ShwetaBhosale1/fix_issue_68605_modify_structure_of_default_images

cephadm: Modify the structure of the default container images

Reviewed-by: Adam King <[email protected]>
Reviewed-by: John Mulligan <[email protected]>
Reviewed-by: Redouane Kachach <[email protected]>

Author: adk3798

doc/cephadm/services/mgmt-gateway.rst

@@ -183,7 +183,7 @@ The `mgmt-gateway` service internally makes use of nginx reverse proxy. The foll
 
 ::
 
-    DEFAULT_NGINX_IMAGE = 'quay.io/ceph/nginx:1.26.1'
+    mgr/cephadm/container_image_nginx = 'quay.io/ceph/nginx:sclorg-nginx-126'
 
 Admins can specify the image to be used by changing the `container_image_nginx` cephadm module option. If there were already
 running daemon(s) you must redeploy the daemon(s) in order to have them actually use the new image.

doc/cephadm/services/monitoring.rst

@@ -173,24 +173,22 @@ the [ceph-users] mailing list in April of 2024. The thread can be viewed here:
 ``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:
+To see the default container images, run below command:
 
 .. prompt:: bash #
 
-   grep -E "DEFAULT*IMAGE" /var/lib/ceph/{FSID}/cephadm.{DIGEST}
+   cephadm list-images
 
-::
-
-   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``.
+``/src/python-common/ceph/cephadm/images.py``.
+
+
+.. autoclass:: ceph.cephadm.images.DefaultImages
+   :members:
+   :undoc-members:
+   :exclude-members: desc, image_ref, key
+
 
 Using custom images
 ~~~~~~~~~~~~~~~~~~~

doc/man/8/cephadm.rst

@@ -13,7 +13,7 @@ Synopsis
 |               [--log-dir LOG_DIR] [--logrotate-dir LOGROTATE_DIR]
 |               [--unit-dir UNIT_DIR] [--verbose] [--timeout TIMEOUT]
 |               [--retry RETRY] [--no-container-init]
-|               {version,pull,inspect-image,ls,list-networks,adopt,rm-daemon,rm-cluster,run,shell,enter,ceph-volume,unit,logs,bootstrap,deploy,check-host,prepare-host,add-repo,rm-repo,install}
+|               {version,pull,inspect-image,ls,list-networks,adopt,rm-daemon,rm-cluster,run,shell,enter,ceph-volume,unit,logs,bootstrap,deploy,check-host,prepare-host,add-repo,rm-repo,install,list-images}
 |               ...
 
 
@@ -104,6 +104,8 @@ Synopsis
 |                                [--registry-password REGISTRY_PASSWORD]
 |                                [--registry-json REGISTRY_JSON] [--fsid FSID]
 
+| **cephadm** **list-images**
+
 
 
 Description
@@ -527,6 +529,12 @@ Arguments:
 * [--name NAME, -n NAME]  daemon name (type.id)
 
 
+list-images
+-----------
+
+List the default container images for all services in ini format. The output can be modified with custom images and passed to --config flag during bootstrap.
+
+
 Availability
 ============
 

src/cephadm/cephadmlib/container_types.py

@@ -9,7 +9,7 @@
 
 from .call_wrappers import call, call_throws, CallVerbosity
 from .constants import DEFAULT_TIMEOUT
-import ceph.cephadm.images as default_images
+from ceph.cephadm.images import DefaultImages
 from .container_engines import Docker, Podman
 from .context import CephadmContext
 from .daemon_identity import DaemonIdentity, DaemonSubIdentity
@@ -665,14 +665,8 @@ def enable_shared_namespaces(
 
 def get_mgr_images() -> dict:
     """Return dict of default mgr images"""
-    mgr_prefix = 'mgr/cephadm/container_image_'
-    mgr_images = {}
-    images = vars(default_images)
-    for key, value in images.items():
-        if key.startswith('DEFAULT_') and key.endswith('_IMAGE'):
-            # flake8 and black disagree about spaces around ":" hence the noqa comment
-            suffix = key[
-                len('DEFAULT_') : -len('_IMAGE')  # noqa: E203
-            ].lower()
-            mgr_images[mgr_prefix + suffix] = value
+    mgr_prefix = 'mgr/cephadm/'
+    mgr_images = {
+        f'{mgr_prefix}{image.key}': image.image_ref for image in DefaultImages
+    }
     return mgr_images

src/cephadm/cephadmlib/daemons/ingress.py

@@ -2,10 +2,7 @@
 
 from typing import Dict, List, Optional, Tuple, Union
 
-from ceph.cephadm.images import (
-    DEFAULT_HAPROXY_IMAGE,
-    DEFAULT_KEEPALIVED_IMAGE,
-)
+from ceph.cephadm.images import DefaultImages
 from ..constants import (
     DATA_DIR_MODE,
 )
@@ -27,7 +24,7 @@ class HAproxy(ContainerDaemonForm):
 
     daemon_type = 'haproxy'
     required_files = ['haproxy.cfg']
-    default_image = DEFAULT_HAPROXY_IMAGE
+    default_image = DefaultImages.HAPROXY.image_ref
 
     @classmethod
     def for_daemon_type(cls, daemon_type: str) -> bool:
@@ -155,7 +152,7 @@ class Keepalived(ContainerDaemonForm):
 
     daemon_type = 'keepalived'
     required_files = ['keepalived.conf']
-    default_image = DEFAULT_KEEPALIVED_IMAGE
+    default_image = DefaultImages.KEEPALIVED.image_ref
 
     @classmethod
     def for_daemon_type(cls, daemon_type: str) -> bool:

src/cephadm/cephadmlib/daemons/mgmt_gateway.py

@@ -11,7 +11,7 @@
 from ..daemon_form import register as register_daemon_form
 from ..daemon_identity import DaemonIdentity
 from ..deployment_utils import to_deployment_container
-from ceph.cephadm.images import DEFAULT_NGINX_IMAGE
+from ceph.cephadm.images import DefaultImages
 from ..data_utils import dict_get, is_fsid
 from ..file_utils import populate_files, makedirs, recursive_chown
 from ..exceptions import Error
@@ -32,7 +32,7 @@ class MgmtGateway(ContainerDaemonForm):
         'nginx_internal.key',
     ]
 
-    default_image = DEFAULT_NGINX_IMAGE
+    default_image = DefaultImages.NGINX.image_ref
 
     @classmethod
     def for_daemon_type(cls, daemon_type: str) -> bool:
@@ -44,7 +44,7 @@ def __init__(
         fsid: str,
         daemon_id: str,
         config_json: Dict,
-        image: str = DEFAULT_NGINX_IMAGE,
+        image: str = DefaultImages.NGINX.image_ref,
     ):
         self.ctx = ctx
         self.fsid = fsid

src/cephadm/cephadmlib/daemons/monitoring.py

@@ -3,14 +3,7 @@
 from typing import Dict, List, Tuple
 
 from ..call_wrappers import call, CallVerbosity
-from ceph.cephadm.images import (
-    DEFAULT_ALERTMANAGER_IMAGE,
-    DEFAULT_GRAFANA_IMAGE,
-    DEFAULT_LOKI_IMAGE,
-    DEFAULT_NODE_EXPORTER_IMAGE,
-    DEFAULT_PROMETHEUS_IMAGE,
-    DEFAULT_PROMTAIL_IMAGE,
-)
+from ceph.cephadm.images import DefaultImages
 from ..constants import (
     UID_NOBODY,
     GID_NOGROUP,
@@ -43,7 +36,7 @@ class Monitoring(ContainerDaemonForm):
 
     components = {
         'prometheus': {
-            'image': DEFAULT_PROMETHEUS_IMAGE,
+            'image': DefaultImages.PROMETHEUS.image_ref,
             'cpus': '2',
             'memory': '4GB',
             'args': [
@@ -55,7 +48,7 @@ class Monitoring(ContainerDaemonForm):
             ],
         },
         'loki': {
-            'image': DEFAULT_LOKI_IMAGE,
+            'image': DefaultImages.LOKI.image_ref,
             'cpus': '1',
             'memory': '1GB',
             'args': [
@@ -64,7 +57,7 @@ class Monitoring(ContainerDaemonForm):
             'config-json-files': ['loki.yml'],
         },
         'promtail': {
-            'image': DEFAULT_PROMTAIL_IMAGE,
+            'image': DefaultImages.PROMTAIL.image_ref,
             'cpus': '1',
             'memory': '1GB',
             'args': [
@@ -75,13 +68,13 @@ class Monitoring(ContainerDaemonForm):
             ],
         },
         'node-exporter': {
-            'image': DEFAULT_NODE_EXPORTER_IMAGE,
+            'image': DefaultImages.NODE_EXPORTER.image_ref,
             'cpus': '1',
             'memory': '1GB',
             'args': ['--no-collector.timex'],
         },
         'grafana': {
-            'image': DEFAULT_GRAFANA_IMAGE,
+            'image': DefaultImages.GRAFANA.image_ref,
             'cpus': '2',
             'memory': '4GB',
             'args': [],
@@ -93,7 +86,7 @@ class Monitoring(ContainerDaemonForm):
             ],
         },
         'alertmanager': {
-            'image': DEFAULT_ALERTMANAGER_IMAGE,
+            'image': DefaultImages.ALERTMANAGER.image_ref,
             'cpus': '2',
             'memory': '2GB',
             'args': [

src/cephadm/cephadmlib/daemons/nvmeof.py

@@ -8,7 +8,7 @@
 from ..context_getters import fetch_configs, get_config_and_keyring
 from ..daemon_form import register as register_daemon_form
 from ..daemon_identity import DaemonIdentity
-from ceph.cephadm.images import DEFAULT_NVMEOF_IMAGE
+from ceph.cephadm.images import DefaultImages
 from ..context import CephadmContext
 from ..data_utils import dict_get, is_fsid
 from ..deployment_utils import to_deployment_container
@@ -26,7 +26,7 @@ class CephNvmeof(ContainerDaemonForm):
 
     daemon_type = 'nvmeof'
     required_files = ['ceph-nvmeof.conf']
-    default_image = DEFAULT_NVMEOF_IMAGE
+    default_image = DefaultImages.NVMEOF.image_ref
 
     @classmethod
     def for_daemon_type(cls, daemon_type: str) -> bool:
@@ -38,7 +38,7 @@ def __init__(
         fsid: str,
         daemon_id: Union[int, str],
         config_json: Dict,
-        image: str = DEFAULT_NVMEOF_IMAGE,
+        image: str = DefaultImages.NVMEOF.image_ref,
     ) -> None:
         self.ctx = ctx
         self.fsid = fsid

src/cephadm/cephadmlib/daemons/oauth2_proxy.py

@@ -11,7 +11,7 @@
 from ..daemon_form import register as register_daemon_form
 from ..daemon_identity import DaemonIdentity
 from ..deployment_utils import to_deployment_container
-from ceph.cephadm.images import DEFAULT_OAUTH2_PROXY_IMAGE
+from ceph.cephadm.images import DefaultImages
 from ..constants import UID_NOBODY, GID_NOGROUP
 from ..data_utils import dict_get, is_fsid
 from ..file_utils import populate_files, makedirs, recursive_chown
@@ -25,7 +25,7 @@
 class OAuth2Proxy(ContainerDaemonForm):
     """Define the configs for the jaeger tracing containers"""
 
-    default_image = DEFAULT_OAUTH2_PROXY_IMAGE
+    default_image = DefaultImages.OAUTH2_PROXY.image_ref
     daemon_type = 'oauth2-proxy'
     required_files = [
         'oauth2-proxy.conf',
@@ -43,7 +43,7 @@ def __init__(
         fsid: str,
         daemon_id: str,
         config_json: Dict,
-        image: str = DEFAULT_OAUTH2_PROXY_IMAGE,
+        image: str = DefaultImages.OAUTH2_PROXY.image_ref,
     ):
         self.ctx = ctx
         self.fsid = fsid

src/cephadm/cephadmlib/daemons/smb.py

@@ -14,7 +14,7 @@
 from .. import deployment_utils
 from .. import file_utils
 from ..call_wrappers import call, CallVerbosity
-from ceph.cephadm.images import DEFAULT_SAMBA_IMAGE
+from ceph.cephadm.images import DefaultImages
 from ..container_daemon_form import ContainerDaemonForm, daemon_to_container
 from ..container_engines import Podman
 from ..container_types import (
@@ -368,7 +368,7 @@ class SMB(ContainerDaemonForm):
 
     daemon_type = 'smb'
     daemon_base = '/usr/sbin/smbd'
-    default_image = DEFAULT_SAMBA_IMAGE
+    default_image = DefaultImages.SAMBA.image_ref
 
     @classmethod
     def for_daemon_type(cls, daemon_type: str) -> bool: