Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
Re ECFLOW-1986
  • Loading branch information
marcosbento committed Nov 14, 2024
1 parent 9948ab5 commit 5a4ebc1
Show file tree
Hide file tree
Showing 3 changed files with 27 additions and 8 deletions.
5 changes: 4 additions & 1 deletion docs/client_api/api/alter.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ alter
For change:
[ variable | clock_type | clock_gain | clock_date | clock_sync | event | meter | label |
trigger | complete | repeat | limit_max | limit_value | defstatus | late | time |
today, aviso, mirror ]
today | aviso | mirror ]
*NOTE* If the clock is changed, then the suite will need to be re-queued in order for
the change to take effect fully.
For add:
Expand All @@ -47,6 +47,9 @@ alter
* for mirror, "--listener '{ \"event\": \"mars\", \"request\": { \"class\": "od" } }'
--url http://aviso/ --schema /path/to/schema --polling 60"
For both aviso and mirror, the special value "reload" can be used to force reloading the configuration.
n.b. This is typically useful after updating variables used to configure these kind of attributes.
Usage:
ecflow_client --alter=add variable GLOBAL "value" / # add server variable
Expand Down
25 changes: 19 additions & 6 deletions docs/glossary.rst
Original file line number Diff line number Diff line change
Expand Up @@ -82,9 +82,15 @@
the user.

Each aviso attribute implies that a background thread is spawned whenever
the associated :term:`node` is (re)queued. This background thread is
responsible for polling the Aviso server, and periodically processing the
latest notifications.
the associated :term:`node` is (re)queued. This independent background thread,
responsible for polling the Aviso server and periodically processing the latest notifications,
uses the configuriguration available when the associated task is queued.

.. note::

If any variables provinding the configuration are updated, the Aviso configuration
can be reloaded (without unqueuing the Task) by issuing an Alter change command with
the value :code:`reload` to the relevant Aviso attribute.

The authentication credentials file is expected to be in JSON format, following the `ECMWF Web API <https://www.ecmwf.int/en/computing/software/ecmwf-web-api>`_:

Expand Down Expand Up @@ -1424,9 +1430,16 @@
(empty string), which effectively disables Authentication

Each mirror attribute implies that a background thread is spawned whenever
the ecFlow server is :term:`running<server states>`. This background thread is
responsible for polling the remote ecFlow server, and periodically
synchronise node status.
the ecFlow server is :term:`running<server states>` (i.e. when the server is shutdown or halted the
thread is terminated and the mirroring process is completely stopped).
This independent background thread, responsible for polling the remote ecFlow server and periodically
synchronise node status, uses the configuration available when the server is restarted.

.. note::

If any variables provinding the configuration are updated, the Mirror configuration can be
reloaded (without restarting the Server) by issuing an Alter change command with the value
:code:`reload` to the relevant attributes.

The authentication credentials file is expected to be in JSON, according to the following format:

Expand Down
5 changes: 4 additions & 1 deletion libs/base/src/ecflow/base/cts/user/AlterCmd.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -613,7 +613,7 @@ const char* AlterCmd::desc() {
" For change:\n"
" [ variable | clock_type | clock_gain | clock_date | clock_sync | event | meter | label |\n"
" trigger | complete | repeat | limit_max | limit_value | defstatus | late | time |\n"
" today, aviso, mirror ]\n"
" today | aviso | mirror ]\n"
" *NOTE* If the clock is changed, then the suite will need to be re-queued in order for\n"
" the change to take effect fully.\n"
" For add:\n"
Expand All @@ -640,6 +640,9 @@ const char* AlterCmd::desc() {
" * for mirror, \"--listener '{ \\\"event\\\": \\\"mars\\\", \\\"request\\\": { \\\"class\\\": \"od\" } }'\n"
" --url http://aviso/ --schema /path/to/schema --polling 60\"\n"
"\n"
"For both aviso and mirror, the special value \"reload\" can be used to force reloading the configuration.\n"
" n.b. This is typically useful after updating variables used to configure these kind of attributes.\n"
"\n"
"Usage:\n\n"
" ecflow_client --alter=add variable GLOBAL \"value\" / # add server variable\n"
" ecflow_client --alter=add variable FRED \"value\" /path/to/node # add node variable\n"
Expand Down

0 comments on commit 5a4ebc1

Please sign in to comment.