Merge pull request #195 from UtkarshBhatthere/dashboard

Update Ceph-Dashboard docs
canonical · Aug 25, 2023 · c3ee25b · c3ee25b
2 parents becddc7 + 2cb0efa
commit c3ee25b
Showing 1 changed file with 28 additions and 17 deletions.
diff --git a/docs/tutorial/enable_dashboard.rst b/docs/tutorial/enable_dashboard.rst
@@ -21,8 +21,27 @@ It can also generate a self signed certificate to quickly configure TLS.
 
     ceph dashboard create-self-signed-cert
 
+Configure SSL Key/Certificate pair
+----------------------------------
+
+Users may wish to configure their own set of SSL certificates for ceph-dashboard. This can be done simply using the ceph cli command:
+
+..  code-block:: none
+
+    ceph dashboard set-ssl-certificate -i server.pem 
+    SSL certificate updated
+    ceph dashboard set-ssl-certificate-key -i server.key
+    SSL certificate key updated
+
 For more details on SSL/TLS config visit `Ceph-Dashboard configuration <https://docs.ceph.com/en/quincy/mgr/dashboard/#configuration>`_.
 
+..  caution::
+
+    MicroCeph snap is a confined ceph application, therefore it does not have access to files at arbitrary locations on the host machine. Therefore, it is required to have the SSL certificate/key files at $HOMEDIR, since MicroCeph can read files located at the home directory. 
+
+Check active dashboard service URL
+----------------------------------
+
 Enabled ceph-mgr services can be queried as:
 
 ..  code-block:: none
@@ -33,30 +52,22 @@ Enabled ceph-mgr services can be queried as:
         "prometheus": "http://10.5.3.199:9283/"
     }
 
-Let's visit the service URL and see our dashboard.
+Creating Admin user
+-------------------
 
-.. figure:: assets/dashboard.jpeg
+..  code-block:: none
 
-  Ceph Dashboard WebUI
+    ceph dashboard ac-user-create <username> -i <file-containing-password> administrator
 
-Configure SSL Key/Certificate pair
-----------------------------------
+..  caution::
 
-Users may wish to configure their own set of SSL certificates for ceph-dashboard. This can be done simply using the ceph cli command:
+    Since MicroCeph can only acces external files located at $HOMEDIR, <file-containing-password> should also be located at the home directory.
 
-..  code-block:: none
+Let's visit the service URL and see our dashboard.
 
-    ceph dashboard set-ssl-certificate -i server.pem 
-    SSL certificate updated
-    ceph dashboard set-ssl-certificate-key -i server.key
-    SSL certificate key updated
-    ceph mgr services
-    {
-        "dashboard": "https://10.5.1.107:8443/"
-        "prometheus": "http://10.5.1.107:9283/"
-    }
+.. figure:: assets/dashboard.jpeg
 
-**Warning:** MicroCeph snap is a confined ceph application, therefore it does not have access to files at arbitrary locations on the host machine. Therefore, it is required to have the SSL certificate/key files at $HOMEDIR, since MicroCeph can read files located at the home directory. 
+  Ceph Dashboard WebUI
 
 Integration with Prometheus and Alertmanager
 --------------------------------------------