Skip to content

Commit

Permalink
Add description of Auth file for Aviso and Mirror
Browse files Browse the repository at this point in the history
  • Loading branch information
marcosbento committed Oct 25, 2024
1 parent ad4fa4e commit 690e64c
Showing 1 changed file with 23 additions and 1 deletion.
24 changes: 23 additions & 1 deletion docs/glossary.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@

.. index::
single: Glossary

Expand Down Expand Up @@ -87,6 +86,18 @@
responsible for polling the Aviso server, and periodically processing the
latest notifications.

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>`_:

.. code-block:: json
{
"url" : "https://api.ecmwf.int/v1",
"key" : "<your-api-key>",
"email" : "<your-email>"
}
Only the fields :code:`url`, :code:`key`, and :code:`email` are required; any additional fields are ignored.

check point
The check point file is like the :term:`suite definition`, but includes all the state information.

Expand Down Expand Up @@ -1417,6 +1428,17 @@
responsible for polling the remote ecFlow server, and periodically
synchronise node status.

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

.. code-block:: json
{
"username" : "<your-username>",
"password" : "<your-password>",
}
Only the fields :code:`username`, and :code:`password` are required; any additional fields are ignored.

node
:term:`suite`, :term:`family` and :term:`task` form a hierarchy.
Where a :term:`suite` serves as the root of the hierarchy.
Expand Down

0 comments on commit 690e64c

Please sign in to comment.