diff --git a/README.md b/README.md index 78523ff76c0ffa920a9f74f68631e2895b44eeb5..cc4e8af902bbb607ca28da3d77347a011e30e2bf 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,12 @@ # ATDB-LDV -### Apertif Task Database for LOFAR Data Valorization +## Apertif Task Database for LOFAR Data Valorization Test Environment: * https://sdc.astron.nl:5554/atdb/ * https://sdc.astron.nl:5554/atdb/admin/ -### Micro Services (in separate repo) +## Micro Services (in separate repo) * https://git.astron.nl/astron-sdc/ldv-services ### Confluence @@ -17,37 +17,37 @@ Workflow: This diagram roughly serves as the specs for adapting ATDB for LDV. * https://support.astron.nl/confluence/display/LDV/WORKFLOW -#### Overview Diagrams (under construction) +## Overview Diagrams (under construction) These diagrams are the core of the ATDB documentation. Currently they are still mostly the original ATDB diagrams. They will be adapted and kept in sync once the ATDB-LDV structure solifies a bit more. -Datamodel: +### Datamodel: * https://drive.google.com/file/d/1v5hMBQS0jT8DQJwySVISfRa1zF4o0fCQ/view?usp=sharing  -Workflow/Status Diagram: +### Workflow/Status Diagram: * https://drive.google.com/file/d/1BCrIwUfacOVqSN73VIIjUuBCXNYA67iK/view?usp=sharing  -Deployment Diagram: +### Deployment Diagram: * https://drive.google.com/file/d/1_j9Fp505pZTxcmzAEdgftdPkoIFrKfAX/view?usp=sharing  -### Manual deploy in Docker +## Manual deploy in Docker For the `master' branch there is a CI/CD pipeline in place which builds and deploys the backend at https://sdc.astron.nl:5554/atdb/ The deploy step requires pushing the 'play' button in the gitlab pipelines section. This is done to not have a mandatory deploy for every minor commmit. -#### initial +### initial > cd ~/my_docker > cd atdb-ldv > git clone https://git.astron.nl/astron-sdc/atdb-ldv.git -#### update: +### update: > export DOCKER_BUILD_DIR=$HOME/my_docker/atdb-ldv/atdb-ldv/atdb > export DOCKER_COMPOSE_DIR=$DOCKER_BUILD_DIR/docker @@ -64,20 +64,20 @@ This is how to do that manually for a persistent database in a Docker container. > docker exec -it atdb-ldv python manage.py makemigrations --settings atdb.settings.docker_sdc > docker exec -it atdb-ldv python manage.py migrate --settings atdb.settings.docker_sdc -### Postgres Database operations +## Postgres Database operations -#### dump a copy of the database +### dump a copy of the database > cd $HOME/shared > docker exec -it atdb-ldv-postgres pg_dump -U postgres -O atdbldv > atdb_ldv.sql -#### load a database (warning, this overwrites the database) +### load a database (warning, this overwrites the database) > docker exec -it atdb-ldv-postgres psql --command "drop database atdbldv" > docker exec -it atdb-ldv-postgres psql --command "create database atdbldv" > docker exec -it atdb-ldv-postgres psql -U postgres atdbldv -f /shared/atdb_ldv.sql > docker exec atdb-ldv-postgres psql --command "grant ALL ON DATABASE atdbldv TO dbadmin;" -### Original ATDB diagrams +## Original ATDB diagrams These diagrams can be used as inspiration and guidance to the original ATDB services, which can be harvested for functionality. 