From: Sebastian Wagner <sewagner@redhat.com>
Date: Tue, 14 Dec 2021 12:09:35 +0000 (+0100)
Subject: mgr/cephadm: improve doc strings for ambigous config values
X-Git-Tag: v16.2.8~161^2~1
X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=69874dfa625ab0b3889744e9792bd95fa513c500;p=ceph.git

mgr/cephadm: improve doc strings for ambigous config values

Signed-off-by: Sebastian Wagner <sewagner@redhat.com>
(cherry picked from commit 391ddf15530d4063d68b03dce1da9999490930d6)
---

diff --git a/src/pybind/mgr/cephadm/module.py b/src/pybind/mgr/cephadm/module.py
index 0b7a3edd2f8e..4a1f89a8de35 100644
--- a/src/pybind/mgr/cephadm/module.py
+++ b/src/pybind/mgr/cephadm/module.py
@@ -302,19 +302,19 @@ class CephadmOrchestrator(orchestrator.Orchestrator, MgrModule,
             'registry_url',
             type='str',
             default=None,
-            desc='Custom repository url'
+            desc='Registry url for login purposes. This is not the default registry'
         ),
         Option(
             'registry_username',
             type='str',
             default=None,
-            desc='Custom repository username'
+            desc='Custom repository username. Only used for logging into a registry.'
         ),
         Option(
             'registry_password',
             type='str',
             default=None,
-            desc='Custom repository password'
+            desc='Custom repository password. Only used for logging into a registry.'
         ),
         ####
         Option(
@@ -339,7 +339,8 @@ class CephadmOrchestrator(orchestrator.Orchestrator, MgrModule,
             'default_registry',
             type='str',
             default='docker.io',
-            desc='Registry to which we should normalize unqualified image names',
+            desc='Search-registry to which we should normalize unqualified image names. '
+                 'This is not the default registry',
         ),
         Option(
             'max_count_per_host',