Skip to content

Commit

Permalink
Docs and release notes
Browse files Browse the repository at this point in the history
  • Loading branch information
maxrussell committed Jun 6, 2024
1 parent 095dbe5 commit 8b5e2d5
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 3 deletions.
10 changes: 10 additions & 0 deletions docs/release-notes/cluster-message.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
:orphan:

**New Features**

- WebUI Cluster Message: Add a feature where administrators can set a message to be displayed on all pages
of the WebUI. This message is set in the CLI like ``det master cluster-message set -m "Your message"``
with optional flags for start time (for scheduling messages to display in the future) and end time
(for clearing messages automatically once the end has been reached). The message can be cleared
at any time with ``det master cluster-message clear``. Only one message can be active at a time,
so setting a new message clears any previous message.
14 changes: 11 additions & 3 deletions docs/tools/webui-if.rst
Original file line number Diff line number Diff line change
Expand Up @@ -186,13 +186,13 @@ header of every page in the WebUI for the configured duration. Commands include

Prepare the maintenance message using the CLI command, `det master cluster-message set`.

- For example, the following command creates a maintenance message with a start and end date:
- For example, the following command creates a maintenance message with a start and end date (which must be expressed in UTC):

.. code:: bash
det master cluster-message set --message "Scheduled maintenance on Dec 1st from 10pm CST to 11pm CST." --start "2024-12-01-22:00:00 CST" --end "2024-12-01-23:00:00 CST"
det master cluster-message set --message "Scheduled maintenance on Dec 1st from 10pm CST to 11pm CST." --start "2024-12-02-04:00:00Z" --end "2024-12-02-05:00:00Z"
- Instead of using a start and end date, you could also set a duration:
- You can also express the end date as a duration:

.. code:: bash
Expand All @@ -205,3 +205,11 @@ Verify the message with the following command:
.. code:: bash
det master cluster-message get
**Clear the Message**

Clear the message with the following command:

.. code:: bash
det master cluster-message clear

0 comments on commit 8b5e2d5

Please sign in to comment.