Commit 20245978 authored by Paschalis Korosoglou's avatar Paschalis Korosoglou
Browse files

Added documentation on messages generation and removal

parent 8912d738
# Messages on the central service
## Description
This guide describes how to publish a message on the [Central service]( of the service. This guide is intended to be used only by the administrators of the central service VM.
The administrator of the central service must first login the machine using ssh and become the `root` user. From the command line provide the following command
$ cd /var/www/okeanos-LoD/central_service/app/frontend
to navigate to the appropriate folder. In order to publish (or remove) a message from the central service web interface the python script `` (located in the aforementioned folder) may be used.
The following command prints out the help message related to this script:
$ python --help
usage: [-h] [--action {set,remove}] [--title TITLE]
[--message MESSAGE]
[--type {danger,warning,info,success}]
Admin Message
optional arguments:
-h, --help show this help message and exit
--action {set,remove}
set or remove an admin message (default: set)
--title TITLE title of the admin message (used only with set action,
--message MESSAGE admin message (used only with set action,
--type {danger,warning,info,success}
the type of the message (used only with set action,
In order to add a new message to the central web interface the `set` action should be used. The `--title` and `--message` arguments accept text as their arguments. Based on the the message itself (its contents) an appropriate `--type` should be used alongside (`info` for blue background, `success` for green, `warning` for orange and `danger` for red).
The following command will generate a "Lorem Ipsum" message on the central web interface
as it is shown also on the screenshot picture below.
$ python --action set \
--title "Lorem Ipsum" \
--message "Lorem Ipsum is ..." \
--type danger
To remove the message the `remove` action should be used (without any further arguments), like so:
$ python --action remove
\ No newline at end of file
......@@ -39,9 +39,10 @@ pages:
- 'Lamdba Instances API calls': 'central-api/'
- 'Lamdba Applications API calls': 'central-api/'
- Images:
- Service VM: 'vm-images/'
- Lambda nodes: 'vm-images/'
- Administration:
- Service VM image: 'admin/'
- Lambda nodes images: 'admin/'
- Service Messages: 'admin/'
- 'License': 'about/'
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment