projects / ceph.git / blame
| Commit | Line | Data |
|---|---|---|
| 31f18b77 FG |
1 | dashboard plugin |
| 2 | ================ | |
| 3 | ||
| 4 | Dashboard plugin visualizes the statistics of the cluster using a web server | |
| 224ce89b WB |
5 | hosted by ``ceph-mgr``. |
| 6 | ||
| 7 | Enabling | |
| 8 | -------- | |
| 9 | ||
| 10 | The *dashboard* module is enabled with:: | |
| 11 | ||
| 12 | ceph mgr module enable dashboard | |
| 13 | ||
| 14 | Configuration | |
| 15 | ------------- | |
| 16 | ||
| 17 | Like most web applications, dashboard binds to a host name and port. | |
| 18 | By default, the ``ceph-mgr`` daemon hosting the dashboard (i.e., the | |
| 19 | currently active manager) will bind to port 7000 and any available | |
| 20 | IPv4 or IPv6 address on the host. | |
| 21 | ||
| 22 | Since each ``ceph-mgr`` hosts its own instance of dashboard, it may | |
| 23 | also be necessary to configure them separately. The hostname and port | |
| 24 | can be changed via the configuration key facility:: | |
| 31f18b77 | 25 | |
| c07f9fc5 FG |
26 | ceph config-key set mgr/dashboard/$name/server_addr $IP |
| 27 | ceph config-key set mgr/dashboard/$name/server_port $PORT | |
| 31f18b77 | 28 | |
| 224ce89b WB |
29 | where ``$name`` is the ID of the ceph-mgr who is hosting this |
| 30 | dashboard web app. | |
| 31 | ||
| 32 | These settings can also be configured cluster-wide and not manager | |
| 33 | specific. For example,:: | |
| 34 | ||
| c07f9fc5 FG |
35 | ceph config-key set mgr/dashboard/server_addr $IP |
| 36 | ceph config-key set mgr/dashboard/server_port $PORT | |
| 224ce89b WB |
37 | |
| 38 | If the port is not configured, the web app will bind to port ``7000``. | |
| 39 | If the address it not configured, the web app will bind to ``::``, | |
| 40 | which corresponds to all available IPv4 and IPv6 addresses. | |
| 41 | ||
| 3efd9988 FG |
42 | You can configure a prefix for all URLs:: |
| 43 | ||
| 44 | ceph config-key set mgr/dashboard/url_prefix $PREFIX | |
| 45 | ||
| 46 | so you can access the dashboard at ``http://$IP:$PORT/$PREFIX/``. | |
| 47 | ||
| 48 | ||
| 224ce89b WB |
49 | Load balancer |
| 50 | ------------- | |
| 31f18b77 | 51 | |
| 224ce89b WB |
52 | Please note that the dashboard will *only* start on the manager which |
| 53 | is active at that moment. Query the Ceph cluster status to see which | |
| 54 | manager is active (e.g., ``ceph mgr dump``). In order to make the | |
| 55 | dashboard available via a consistent URL regardless of which manager | |
| 56 | daemon is currently active, you may want to set up a load balancer | |
| 57 | front-end to direct traffic to whichever manager endpoint is | |
| 3efd9988 FG |
58 | available. If you use a reverse http proxy that forwards a subpath to |
| 59 | the dashboard, you need to configure ``url_prefix`` (see above). |