Skip to content
Snippets Groups Projects

updating documentation

Merged Nico Vermaas requested to merge dev-nico into master
2 files
+ 27
19
Compare changes
  • Side-by-side
  • Inline
Files
2
+ 26
18
# ATDB-LDV
## Apertif Task Database for LOFAR Data Valorization
### Test Environment on sdc.astron.nl:
main GUI:
* https://sdc.astron.nl:5554/atdb/
admin interface:
* https://sdc.astron.nl:5554/atdb/admin/
REST API
* workflows: http://localhost:8000/atdb/workflows/
* tasks: http://localhost:8000/atdb/tasks/
ATDB-LDV is the Django backend application for LDV.
It's main purpose is to hold the state of all the tasks that are in progress for LDV.
ATDB does not control the flow itself, that is handled by a cloud of micro services.
Communication is done through the REST API.
## Micro Services (in separate repo)
* https://git.astron.nl/astron-sdc/ldv-services
### Confluence
Confluence Page:
## Project Documentation (Confluence)
### Confluence Page:
* https://support.astron.nl/confluence/display/LDV/LOFAR+Data+Valorization+Home
Specifications:
### Specifications:
These diagrams roughly serves as the specifications for adapting ATDB for LDV.
* workflow: https://support.astron.nl/confluence/display/LDV/WORKFLOW
* datamodel: https://dbdiagram.io/d/5ffc5fb180d742080a35d560
@@ -37,6 +28,23 @@ These diagrams roughly serves as the specifications for adapting ATDB for LDV.
* https://drive.google.com/file/d/1BCrIwUfacOVqSN73VIIjUuBCXNYA67iK/view?usp=sharing
![](atdb/docs/ATDB-LDV%20Workflow%20Diagram.png)
### Test Environment on sdc-dev.astron.nl:
### main GUI:
* https://sdc.astron.nl:5554/atdb/
### admin interface:
* https://sdc.astron.nl:5554/atdb/admin/
### REST API
serializers:
* workflows: http://sdc.astron.nl:5554/atdb/workflows/
* tasks: http://sdc.astron.nl:5554/atdb/tasks/
get_size:
* https://sdc.astron.nl:5554/atdb/tasks/get_size
* https://sdc.astron.nl:5554/atdb/tasks/get_size?status__in=staged,processing,processed,validating,validated,ingesting,removing,removed
### Deployment Diagram:
* https://drive.google.com/file/d/1_j9Fp505pZTxcmzAEdgftdPkoIFrKfAX/view?usp=sharing
@@ -44,7 +52,7 @@ These diagrams roughly serves as the specifications for adapting ATDB for LDV.
![](atdb/docs/ATDB-LDV%20-%20Deployment%20Diagram.png)
## CI/CD (semi) automatic 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/
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.
Loading