diff --git a/docs/source/index.rst b/docs/source/index.rst index 5e6c6564940391ea5171403a833a2f83ed015adc..57574bbf425b53a65a388b0f1647dc59b75047b0 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -10,6 +10,8 @@ Welcome to LOFAR2.0 Station Control's documentation! :maxdepth: 2 :caption: Contents: + usage/installation + Indices and tables diff --git a/docs/source/usage/installation.rst b/docs/source/usage/installation.rst new file mode 100644 index 0000000000000000000000000000000000000000..05c170540f3689fe1e6cda3f5109f3640f78967d --- /dev/null +++ b/docs/source/usage/installation.rst @@ -0,0 +1,70 @@ +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>`). + +Start up +----------- + +The start-up procedure is needed both after bootstrapping, and after a system reboot. Once per reboot, the host kernel needs to be configured:: + + make start elk-configure-host + +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. + +# 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 | | ++---------------------+--------------+----------------------+-------------------+ +