Skip to content

UI: Announcement banner documentation #517

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added source/_static/images/ui-announcement-banner.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
58 changes: 57 additions & 1 deletion source/adminguide/ui.rst
Original file line number Diff line number Diff line change
Expand Up @@ -508,7 +508,62 @@ For displaying a custom HTML in the plugin, HTML file can be stored in the Cloud
|ui-custom-plugin.png|


Instance Image Selction Customisation
Announcement Banner
===================

Admin can configure an **announcement banner** in `config.json` to display alerts or messages to all users.
This banner is useful for communicating important notices such as performance issues, scheduled maintenance, or general announcements.
To enable and customize the banner, use the `announcementBanner` section in the config.json file.

This section supports the following properties:

**Configuration Example**

.. parsed-literal::

"announcementBanner": {
"enabled": true,
"showIcon": true,
"closable": true,
"persistDismissal": true,
"type": "warning",
"message": "<strong>Performance Notice:</strong> We're experiencing high load. Some operations may be slower than usual.",
"startDate": "2025-06-01T00:00:00Z",
"endDate": "2025-07-16T00:00:00Z"
}

**Banner Display Example**

Based on the configuration above, the following banner is shown in the user interface:

.. image:: /_static/images/ui-announcement-banner.png
:align: center
:alt: UI Announcement banner

--------

**Properties Description**

- **enabled**: Enables or disables the announcement banner (`true` or `false`).
- **showIcon**: Displays an icon alongside the message. The icon corresponds to the banner `type`.
- **closable**: Allows users to close the banner.
- **persistDismissal**: Remembers the user's dismissal of the banner, so it doesn't reappear.
- **type**: Specifies the type of banner. Supported values are:

- `info`
- `warning`
- `error`
- `success`

- **message**: The HTML-formatted content displayed in the banner.
- **startDate** / **endDate**: Define the visibility window for the banner using ISO 8601 format (`YYYY-MM-DDTHH:MM:SSZ`).

.. note::

The `message` property supports basic HTML, allowing styled content such as `<strong>` tags for emphasis.


Instance Image Selection Customisation
-------------------------------------

In the UI, there are several forms where the user needs to select an image (template/ISO) for an instance, such as deploying an instance, reinstalling an instance, creating a VNF appliance, etc. The image selection interface for these forms can be selected by the operator based on preference by specifying properties in the UI configuration file (config.json).
Expand All @@ -523,6 +578,7 @@ The *legacy* interface will display images based on templatefilter/isofilter, i.

|ui-legacy-image-selection.png|


Advanced UI Customisation
~~~~~~~~~~~~~~~~~~~~~~~~~

Expand Down