From 04da0e6c008cf1abc5eaa570c4fcdbc25a74c7ac Mon Sep 17 00:00:00 2001
From: lukken <lukken@astron.nl>
Date: Tue, 18 Oct 2022 13:12:16 +0000
Subject: [PATCH] L2SS-1026: Ensure requirements are clearly described
---
README.md | 13 +++++++++++--
1 file changed, 11 insertions(+), 2 deletions(-)
diff --git a/README.md b/README.md
index cb44d8f3a..240c4cd10 100644
--- a/README.md
+++ b/README.md
@@ -71,15 +71,24 @@ them down (`make stop <container>`).
Most notably, you will have web interfaces available at:
- http://localhost:8888 (Jupyter Notebook)
+ - http://localhost:5601 (ElasticSearch)
- http://localhost:3000 (Grafana).
+To create the appropriate indexes for ElasticSearch the following needs to be
+executed once while ElasticSearch is running:
+
+```sh
+cd docker-compose/elk
+curl -X POST http://localhost:5601/api/saved_objects/_import -H "kbn-xsrf: true" --form file=@kibana/default-objects.ndjson
+```
+
# Development
For development you will need several dependencies including:
```
git g++ gcc make docker docker-compose shellcheck graphviz python3-dev \
-python3-pip python3-tox libboost-python-dev libtango-cpp pkg-config
+python3-pip python3-tox libboost-python-dev libtango-cpp pkg-config
```
Of these docker-compose must be at least 2.0 and Python 3.7 or higher.
@@ -96,7 +105,7 @@ reserved. To do this please follow [semantic versioning](https://semver.org/).
Next change the version in the following places:
-1. The [VERSION](VERSION) file.
+1. The [VERSION](tangostationcontrol/VERSION) file.
2. In [test_writer_sst.py](tangostationcontrol/tangostationcontrol/integration_test/default/statistics/test_writer_sst.py)
for the `test_header_info` test.
3. Add a [Release note](#release-notes) for the given version.
--
GitLab