diff --git a/README.md b/README.md index 354ddbf9b05959d06ca4ac911a529a636f909bd4..c54ed9f0e05a8145787fb43f26d6093803b7be8c 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,27 @@ # TANGO Docker containers +This project defines a set of Docker images and Docker compose files +that are useful for TANGO control system development. +See the documentation in the 'docs' folder for build and usage +instructions. + + +## Complete Archiver Implementation + [](https://developer.skatelescope.org/projects/ska-docker/en/latest/?badge=latest) -This project defines a set of Docker images and Docker compose files -that are useful for TANGO control system development. -See the documentation in the ``docs`` folder for build and usage -instructions. +Docker images such as tango-archiver, mariadb and hdb++ viewer are used for archiving various attributes and states of +tango devices. Containers like mariadb, databaseds, hdbpp-es, hdbpp-cm should be up and running. HDB++ is a historical +database used to store the archived attributes values. Here maria database with default schema of hdp++ is used to store +the archived values. +Hdbpp-es is event suscriber device is in charge of gathering the values from the Tango devices and storing them into the +database (mariadb). Hdbpp-cm is a configuration manager server. It configures the attributes to be archived and defines +which Event Subscriber is responsible for a set of Tango attributes to be archived. +Hdbpp-viewer shows the picturial representation of archived attributes, which are stored in maria database. + +# Important links + * [Link for Mariadb container](https://gitlab.com/ska-telescope/ska-docker/tree/story_AT1-422/docker/tango/mariadb_hdbpp) + * [Link for Tango-archiver container](https://gitlab.com/ska-telescope/ska-docker/tree/story_AT1-422/docker/tango/tango-archiver) + * [Link for Hdbpp-viewer container](https://gitlab.com/ska-telescope/ska-docker/tree/story_AT1-422/docker/tango/hdbpp_viewer) + * [Docker-compose yaml](https://gitlab.com/ska-telescope/ska-docker/blob/story_AT1-422/docker/tango/tango-archiver/docker-compose.yml) \ No newline at end of file diff --git a/docker/tango/mariadb_hdbpp/README.md b/docker/tango/mariadb_hdbpp/README.md index 7c36c7466dd9875d7797040e5a926de3b788e334..3ac3f85d9cadd9adacb96c6533c82dd30d6084d1 100644 --- a/docker/tango/mariadb_hdbpp/README.md +++ b/docker/tango/mariadb_hdbpp/README.md @@ -13,12 +13,12 @@ * tango-java ({DOCKER_REGISTRY_HOST}/${DOCKER_REGISTRY_USER}/tango-java:latest) * mariadb_hdbpp ({DOCKER_REGISTRY_HOST}/${DOCKER_REGISTRY_USER}/mariadb_hdbpp:latest) -# 4: Creating Mariadb docker containers +# 4: Creating mariadb docker containers Image '{DOCKER_REGISTRY_HOST}/${DOCKER_REGISTRY_USER}/mariadb_hdbpp' with tag:latest is used to create Mariadb container. MYSQL_DATABASE=hdbpp, MYSQL_USER=tango, MYSQL_PASSWORD=tango, TANGO_HOST=${TANGO_HOST} are the enviornments variables set at the time of mariadb container creation. archiverdb is the permenent volume required. -# 5: Running mariadb inside Docker containers +# 5: Running mariadb inside docker containers mariadb can run on dockers using following command inside the ./tango-archiver diff --git a/docker/tango/tango-archiver/README.md b/docker/tango/tango-archiver/README.md index 144657836029e39a3c9a1a46d74f07a95373bcd1..be6d5e6e85d87807f3e45563cff6fcb389b05665 100644 --- a/docker/tango/tango-archiver/README.md +++ b/docker/tango/tango-archiver/README.md @@ -1,4 +1,4 @@ -# Tango-archiver Docker Container +# Tango-archiver Docker Containers [](https://developer.skatelescope.org/projects/ska-docker/en/latest/?badge=latest) @@ -49,7 +49,7 @@ The data file, archiver-devices.json file runs in this container to configure al nexus.engageska-portugal.pt/ska-docker/tango-dsconfig:latest is used in this container. TANGO_HOST=${TANGO_HOST} is the eviornment variable set inside this container at the time of creation. -# 5: Running tango-archiver inside Docker containers +# 5: Running tango-archiver inside docker containers tango-archiver can run on dockers using following command inside the ./tango-archiver