Skip to content

Commit

Permalink
Add EAGLE to startup guide
Browse files Browse the repository at this point in the history
  • Loading branch information
awicenec committed Oct 6, 2021
1 parent fcb3397 commit 5ffbf97
Showing 1 changed file with 27 additions and 9 deletions.
36 changes: 27 additions & 9 deletions docs/running.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,35 @@

Startup and Shutdown Guide
==========================
The translator and the engine are separate services and can be installed and run independently. (NOTE: The EAGLE visual graph editor is covered in its own `documentation <https://eagle-dlg.readthedocs.io>`_).
The translator and the engine are separate services and can be installed and run independently.

Depending on how you are intending to run the system startup and shutdown is slightly different.

For the impatient: Single node |daliuge|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
As a developer the following two commands will start both the translator and the engine, including a DIM and a NM::

cd daliuge-translator ; ./run_translator dev ; cd ..
cd daliuge-engine ; ./run_engine dev ; cd ..

This is the quickest way to start deploying workflows. Obviously this is limited to a single computer, but certainly useful for testing out the system and developing new components. You can use EAGLE on the URL: https:/eagle.icrar.org and point the EAGLE configuration for the translator to http://localhost:8084.

For the independent: Build and run EAGLE
----------------------------------------
If necessary it is also possible to start the EAGLE locally in addition as well. This requires to clone and build the EAGLE repo into a directory separate from the |daliuge| repo::

git clone https://github.com/ICRAR/EAGLE
cd EAGLE
./build_eagle dep

To start EAGLE::

./run_eagle dep dep

This will start the EAGLE docker image built in the previous step and try to open a browser tab.

(NOTE: The usage of the EAGLE visual graph editor is covered in its own `documentation <https://eagle-dlg.readthedocs.io>`_).

Starting the docker containers
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
We are providing convenience scripts to start the docker containers built according to the :ref:`installation`. Depending whether you want to run the development (dev) or the deployment (dep) version of the image there exist different startup options. Starting the translator::
Expand Down Expand Up @@ -50,13 +75,6 @@ which returns something like::

In this example there is just a Node Manager running with process ID 18.

Single node |daliuge|
^^^^^^^^^^^^^^^^^^^^^
As a developer the following two commands will start both the translator and the engine, including a DIM and a NM and will then allow to start deploying workflows::

cd daliuge-translator ; ./run_translator dev ; cd ..
cd daliuge-engine ; ./run_engine dev ; cd ..

Starting and stopping using CLI
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
If |daliuge| had been installed in a virtual environment of the host system it is possible to start the daemon from the command line and then use the same curl commands as above to start the required managers::
Expand Down Expand Up @@ -107,7 +125,7 @@ More details about the usage of the CLI can be found in the :ref:`cli` chapter.

Zeroconf
^^^^^^^^
The Master Manager also opens a zeroconf service, which allows the Node Managers to register and deregister and thus the MM is always up to date with the node available in the cluster. NOTE: This mechanism is currently not implemented for the DIMs, i.e. a DIM does not register with the MM automatically. Since it is not possible to guess which NM should belong to which DIM, the NMs also do not register with a DIM. When starting the development version of the image the single NM is automatically assigned to the DIM on localhost.
The Master Manager also opens a zeroconf service, which allows the Node Managers to register and deregister and thus the MM is always up to date with the node available in the cluster. NOTE: This mechanism is currently not implemented for the DIMs, i.e. a DIM does not register with the MM automatically. Since it is not possible to guess which NM should belong to which DIM, the NMs also do not register with a DIM. For convenience and as an exception to this rule, when starting the development version of the daliuge-engine image, the single NM is automatically assigned to the DIM on localhost.

.. [1] The daemon process is listening on port 9000 by default.

0 comments on commit 5ffbf97

Please sign in to comment.