ceph/doc/mgr/dashboard_plugins/motd.inc.rst
Volker Theile f7f163e75c mgr/dashboard: Add configurable MOTD or wall notification
Fixes: https://tracker.ceph.com/issues/51408

Signed-off-by: Volker Theile <vtheile@suse.com>
2021-07-14 10:48:49 +02:00

31 lines
1.1 KiB
ReStructuredText

.. _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::
$ ceph dashboard motd set <severity:info|warning|danger> <expires> <message>
To show the configured MOTD::
$ ceph dashboard motd get
To clear the configured MOTD run::
$ 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.