ceph/doc/mgr/dashboard_plugins/motd.inc.rst

   1 .. _dashboard-motd:
   2
   3 Message of the day (MOTD)
   4 ^^^^^^^^^^^^^^^^^^^^^^^^^
   5
   6 Displays a configured `message of the day` at the top of the Ceph Dashboard.
   7
   8 The importance of a MOTD can be configured by its severity, which is
   9 `info`, `warning` or `danger`. The MOTD can expire after a given time,
  10 this means it will not be displayed in the UI anymore. Use the following
  11 syntax to specify the expiration time: `Ns|m|h|d|w` for seconds, minutes,
  12 hours, days and weeks. If the MOTD should expire after 2 hours, use `2h`
  13 or `5w` for 5 weeks. Use `0` to configure a MOTD that does not expire.
  14
  15 To configure a MOTD, run the following command:
  16
  17 .. prompt:: bash $
  18
  19    ceph dashboard motd set <severity:info|warning|danger> <expires> <message>
  20
  21 To show the configured MOTD:
  22
  23 .. prompt:: bash $
  24
  25    ceph dashboard motd get
  26
  27 To clear the configured MOTD run:
  28
  29 .. prompt:: bash $
  30
  31    ceph dashboard motd clear
  32
  33 A MOTD with a `info` or `warning` severity can be closed by the user. The
  34 `info` MOTD is not displayed anymore until the local storage cookies are
  35 cleared or a new MOTD with a different severity is displayed. A MOTD with
  36 a 'warning' severity will be displayed again in a new session.