summaryrefslogtreecommitdiffstats
path: root/doc/mgr/dashboard_plugins/motd.inc.rst
blob: 0f9cc199a9737dc09937c89009aae2ca84319632 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
.. _dashboard-motd:

Message of the day (MOTD)
^^^^^^^^^^^^^^^^^^^^^^^^^

Displays a configured `message of the day` at the top of the Ceph Dashboard.

The importance of a MOTD can be configured by its severity, which is
`info`, `warning` or `danger`. The MOTD can expire after a given time,
this means it will not be displayed in the UI anymore. Use the following
syntax to specify the expiration time: `Ns|m|h|d|w` for seconds, minutes,
hours, days and weeks. If the MOTD should expire after 2 hours, use `2h`
or `5w` for 5 weeks. Use `0` to configure a MOTD that does not expire.

To configure a MOTD, run the following command:

.. prompt:: bash $

   ceph dashboard motd set <severity:info|warning|danger> <expires> <message>

To show the configured MOTD:

.. prompt:: bash $

   ceph dashboard motd get

To clear the configured MOTD run:

.. prompt:: bash $

   ceph dashboard motd clear

A MOTD with a `info` or `warning` severity can be closed by the user. The
`info` MOTD is not displayed anymore until the local storage cookies are
cleared or a new MOTD with a different severity is displayed. A MOTD with
a 'warning' severity will be displayed again in a new session.