From: Wido den Hollander Date: Mon, 26 Jun 2017 12:49:28 +0000 (+0200) Subject: doc: Mgr Dashboard docs update X-Git-Tag: v12.1.2~1^2~33^2 X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=0f15e4e76b061c91cdda5d130eb611a4739165c4;p=ceph.git doc: Mgr Dashboard docs update More instructions on how to deploy the dashboard using ceph-mgr Signed-off-by: Wido den Hollander --- diff --git a/doc/mgr/dashboard.rst b/doc/mgr/dashboard.rst index 7f837f26dbe4..b200e1349d69 100644 --- a/doc/mgr/dashboard.rst +++ b/doc/mgr/dashboard.rst @@ -11,5 +11,22 @@ configuration key facility. So we can configure them like:: ceph config-key put mgr/dashboard/$name/server_port $PORT where ``$name`` is the ID of the ceph-mgr who is hosting this dashboard web app. -If they are not configured, the web app will be bound to ``127.0.0.1:7000``. +These settings can also be configured cluster-wide and not manager specific, eg: + + ceph config-key put mgr/dashboard/server_addr $IP + ceph config-key put mgr/dashboard/server_port $PORT + +If the port is not configured, the web app will bind to port ``7000``. + +Setting the IP to ``::`` makes the dashboard bind to all available IPv4 and IPv6 +addresses. + +In addition, make sure that the *dashboard* module is enabled in the ceph.conf +configuration file: + + [mgr] + mgr_modules = dashboard + +Please note that the dashboard will *only* start on the manager which is active +at that moment. Query the Ceph cluster status to see which manager is active. diff --git a/src/pybind/mgr/dashboard/README.rst b/src/pybind/mgr/dashboard/README.rst index 1b0276632c2f..b52fea5dc548 100644 --- a/src/pybind/mgr/dashboard/README.rst +++ b/src/pybind/mgr/dashboard/README.rst @@ -33,6 +33,13 @@ Add this to your ceph.conf on nodes where you run ceph-mgr: If you use any other ceph-mgr modules, make sure they're in the list too. +An address where the dashboard will listen on needs to be configured as well, set this to ``::`` to listen on all +IPv4 and IPv6 addresses. + +:: + + ceph config-key put mgr/dashboard/server_addr :: + Restart the ceph-mgr daemon after modifying the setting to load the module. Accessing