]> git.apps.os.sepia.ceph.com Git - ceph-ci.git/commitdiff
doc/cephadm/services: Clarify service discovery auth in monitoring.rst
authordudy <dudydev@proton.me>
Thu, 30 Oct 2025 19:57:37 +0000 (20:57 +0100)
committerdudy <dudydev@proton.me>
Fri, 31 Oct 2025 18:12:58 +0000 (19:12 +0100)
Signed-off-by: Dudy <dudythegoat@proton.me>
doc/cephadm/services/monitoring.rst

index e88c7fc7cfe16f3a29ef4c009ebf6d2235705835..63a91708fd67f4e9530c6541ac33c57d51c4d5d5 100644 (file)
@@ -103,6 +103,7 @@ few minutes until all components are fully operational. The updated secure confi
 #. Alertmanager: basic authentication is required to access the web portal and TLS is enabled for secure communication.
 #. Node Exporter: TLS is enabled for secure communication.
 #. Grafana: TLS is enabled and authentication is requiered to access the datasource information.
+#. Cephadm service discovery endpoint: basic authentication is required to access service discovery information, and TLS is enabled for secure communication.
 
 In this secure setup, users will need to setup authentication
 (username/password) for both Prometheus and Alertmanager. By default the
@@ -114,6 +115,32 @@ file, which enhances security. Additionally, Cephadm provides the commands
 ``orch prometheus get-credentials`` and ``orch alertmanager get-credentials`` to
 retrieve the current credentials.
 
+.. note::
+
+   The credentials used for the cephadm service discovery endpoint (the
+   endpoint that listens on ``https://<mgr-ip>:8765/sd/`` when security is
+   enabled) can be retrieved and updated using the following config-key
+   commands. For example, to retrieve the current credentials run:
+
+   .. prompt:: bash #
+
+     ceph config-key get mgr/cephadm/service_discovery/root/username
+     ceph config-key get mgr/cephadm/service_discovery/root/password
+
+   To update the credentials (username/password) for service discovery,
+   run:
+
+   .. prompt:: bash #
+
+     ceph config-key set mgr/cephadm/service_discovery/root/username <username>
+     ceph config-key set mgr/cephadm/service_discovery/root/password <password>
+
+   After changing these credentials, redeploy the Manager so the changes take effect.
+
+   .. prompt:: bash #
+
+     ceph orch redeploy mgr
+
 .. _cephadm-monitoring-centralized-logs:
 
 Centralized Logging in Ceph
@@ -417,8 +444,12 @@ Here's an example Prometheus job definition that uses the cephadm service discov
 
      - job_name: 'ceph-exporter'  
        http_sd_configs:  
-       - url: http://<mgr-ip>:8765/sd/prometheus/sd-config?service=ceph-exporter
-
+       - url: https://<mgr-ip>:8765/sd/prometheus/sd-config?service=ceph-exporter
+         basic_auth:  
+           username: '<username>'  
+           password: '<password>'  
+         tls_config:  
+           ca_file: '/path/to/ca.crt'  
 
 * To enable the dashboard's Prometheus-based alerting, see :ref:`dashboard-alerting`.