Skip to content
Snippets Groups Projects
Commit 3d936c78 authored by Jan David Mol's avatar Jan David Mol
Browse files

L2SS-434: Added station initialisation procedure

parent 79fe2fde
No related branches found
No related tags found
1 merge request!150L2SS-434: Add sphinx documentation content
...@@ -11,7 +11,7 @@ Welcome to LOFAR2.0 Station Control's documentation! ...@@ -11,7 +11,7 @@ Welcome to LOFAR2.0 Station Control's documentation!
:caption: Contents: :caption: Contents:
usage/installation usage/installation
usage/remote_interfaces
Indices and tables Indices and tables
......
...@@ -34,44 +34,38 @@ You should see the following state: ...@@ -34,44 +34,38 @@ You should see the following state:
If not, you can inspect why with `docker logs <container>`. Note that the containers will automatically be restarted on failure, and also if you reboot. Stop them explicitly to bring them down (`make stop <container>`). If not, you can inspect why with `docker logs <container>`. Note that the containers will automatically be restarted on failure, and also if you reboot. Stop them explicitly to bring them down (`make stop <container>`).
Start up Initialisation
----------- ----------------
The start-up procedure is needed both after bootstrapping, and after a system reboot. Once per reboot, the host kernel needs to be configured:: The following procedure describes how to initialise the system, which is required after installation and after a system reboot.
The docker containers will automatically restart after a system reboot. But the Linux kernel will lose its required custom settings required by our ELK stack. To reconfigure the kernel parameters, run::
make start elk-configure-host make start elk-configure-host
make restart elk
We can now initialise the station configuration, that is, start all the software devices to control the station hardware, and to initialise the hardware with the configured default settings. Go to http://localhost:8888, start a new *Station Control* notebook, and initiate the software boot sequence::
# reset our boot device
boot.off()
assert boot.state() == DevState.OFF
boot.initialise()
assert boot.state() == DevState.STANDBY
boot.on()
assert boot.state() == DevState.ON
# start and initialise the other devices
boot.initialise_station()
# wait for the devices to be initialised
import time
The software devices start in an OFF state, after bootstrap or reboot. To boot the devices, go to Jupyter (replace "localhost" with the hostname of your installation, if required): http://localhost:8888/notebooks/Home.ipynb . Then, in Grafana (http://localhost:3000), you should see the devices reaching the ON state. while boot.initialising_station_R:
print(f"Still initialising station. {boot.initialisation_progress_R}% complete. State: {boot.initialisation_status_R}")
# Remote Interfaces time.sleep(1)
The station provides the following interfaces accessible through your browser (assuming you run on `localhost`):
+---------------------+---------+----------------------+-------------------+
|Interface |Subsystem|URL |Default credentials|
+=====================+=========+======================+===================+
|Interactive scripting|Jupyter |http://localhost:8888 | |
+---------------------+---------+----------------------+-------------------+
|Monitoring |Grafana |http://localhost:3000 |admin/admin |
+---------------------+---------+----------------------+-------------------+
|Logs |Kibana |http://localhost:5601 | |
+---------------------+---------+----------------------+-------------------+
Futhermore, there are some low-level interfaces:
+---------------------+--------------+----------------------+-------------------+
|Interface |Subsystem |URL |Default credentials|
+=====================+==============+======================+===================+
|Tango API |Tango |http://localhost:10000| |
+---------------------+--------------+----------------------+-------------------+
|Timeseries Database |Prometheus |http://localhost:9090 | |
+---------------------+--------------+----------------------+-------------------+
|ReST API |tango-rest |http://localhost:8080 |tango-cs/tango |
+---------------------+--------------+----------------------+-------------------+
|Tango Database |MariaDB |http://localhost:3306 |tango/tango |
+---------------------+--------------+----------------------+-------------------+
|Archive Database |MariaDB |http://localhost:3307 |tango/tango |
+---------------------+--------------+----------------------+-------------------+
|Log Database |ElasticSearch |http://localhost:9200 | |
+---------------------+--------------+----------------------+-------------------+
# print conclusion
if boot.initialisation_progress_R == 100:
print("Done initialising station.")
else:
print(f"Failed to initialise station: {boot.initialisation_status_R}")
Installation
==================
You start with checking out the source code, f.e. the master branch, as well as the git submodules we use::
git clone https://git.astron.nl/lofar2.0/tango.git
cd tango
git submodule init
git submodule update
Next, we bootstrap the system. This will build our docker images, start key ones, and load the base configuration. This may take a while::
cd docker-compose
make bootstrap
If you lack access to LOFAR station hardware, load additional configurations to use the simulators instead::
for sim in ../CDB/\*-sim-config.json; do
../sbin/update_ConfigDb.sh ../CDB${sim}-config.json
done
Now we are ready to start the other containers::
make start
and make sure they are all up and running::
make status
You should see the following state:
- Containers `astor`, `hdbpp-viewer`, `jive`, `log-viewer` and `pogo` will have State `Exit 1`. These are containers that are interactive X11 tools, and not needed for now,
- Other containers have either State `Up` or `Exit 0`.
If not, you can inspect why with `docker logs <container>`. Note that the containers will automatically be restarted on failure, and also if you reboot. Stop them explicitly to bring them down (`make stop <container>`).
Initialisation
----------------
The following procedure describes how to initialise the system, which is required after installation and after a system reboot.
The docker containers will automatically restart after a system reboot. But the Linux kernel will lose its required custom settings required by our ELK stack. To reconfigure the kernel parameters, run::
make start elk-configure-host
make restart elk
We can now initialise the station configuration, that is, start all the software devices to control the station hardware, and to initialise the hardware with the configured default settings. Go to http://localhost:8888, start a new *Station Control* notebook, and initiate the software boot sequence::
# reset our boot device
boot.off()
assert boot.state() == DevState.OFF
boot.initialise()
assert boot.state() == DevState.STANDBY
boot.on()
assert boot.state() == DevState.ON
# start and initialise the other devices
boot.initialise_station()
# wait for the devices to be initialised
Remote Interfaces
======================
The station provides the following interfaces accessible through your browser (assuming you run on `localhost`):
+---------------------+---------+----------------------+-------------------+
|Interface |Subsystem|URL |Default credentials|
+=====================+=========+======================+===================+
|Interactive scripting|Jupyter |http://localhost:8888 | |
+---------------------+---------+----------------------+-------------------+
|Monitoring |Grafana |http://localhost:3000 |admin/admin |
+---------------------+---------+----------------------+-------------------+
|Logs |Kibana |http://localhost:5601 | |
+---------------------+---------+----------------------+-------------------+
Futhermore, there are some low-level interfaces:
+---------------------+--------------+----------------------+-------------------+
|Interface |Subsystem |URL |Default credentials|
+=====================+==============+======================+===================+
|Tango API |Tango |http://localhost:10000| |
+---------------------+--------------+----------------------+-------------------+
|Timeseries Database |Prometheus |http://localhost:9090 | |
+---------------------+--------------+----------------------+-------------------+
|ReST API |tango-rest |http://localhost:8080 |tango-cs/tango |
+---------------------+--------------+----------------------+-------------------+
|Tango Database |MariaDB |http://localhost:3306 |tango/tango |
+---------------------+--------------+----------------------+-------------------+
|Archive Database |MariaDB |http://localhost:3307 |tango/tango |
+---------------------+--------------+----------------------+-------------------+
|Log Database |ElasticSearch |http://localhost:9200 | |
+---------------------+--------------+----------------------+-------------------+
Jupyter: Interactive Scripting
------------------------------------
The station offers Juypyter notebooks On http://localhost:8888, which allow one to interact with the station, for example to set control points, access monitoring points, or to graph their values.
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment