README.md 1.75 KB
Newer Older
Guillaume Mella's avatar
Guillaume Mella committed
1
2
# jmmc-jmdcui-docker

Guillaume Mella's avatar
Guillaume Mella committed
3
-> jmmc hey, it's a JMMC product !
Guillaume Mella's avatar
Guillaume Mella committed
4

Guillaume Mella's avatar
Guillaume Mella committed
5
-> jmdcui ok the project name may change
Guillaume Mella's avatar
Guillaume Mella committed
6

Guillaume Mella's avatar
Guillaume Mella committed
7
8
-> docker yes we try to avoid speaking on machines even virtual (trying to fly over orchestration with K8S initiative @ OSUG)

Guillaume Mella's avatar
Guillaume Mella committed
9
10

# Sprint project dedicated to setup a Web interface to feed collaborativelly the JMDC http://www.jmmc.fr/catalogue_jmdc.htm
Guillaume Mella's avatar
Guillaume Mella committed
11
 see issue #5
Guillaume Mella's avatar
Guillaume Mella committed
12
 
Guillaume Mella's avatar
Guillaume Mella committed
13
14
15
## Backlog of futur enhancements
### accept comment (stars) from any users
### add a specific form for a single record more user friendly
Guillaume Mella's avatar
Guillaume Mella committed
16
### provide a VO TAP compliant interface 
Guillaume Mella's avatar
Guillaume Mella committed
17

Guillaume Mella's avatar
Guillaume Mella committed
18
19
## Technical points

Guillaume Mella's avatar
Guillaume Mella committed
20
21
22
23
24
Some [discusion and try have been perform](#1) before coding. 
Our choice are:
- Content display with Datatable 
- Target name check performed with sesame basic url instead of https://astroquery.readthedocs.io/en/latest/simbad/simbad.html
- Framework is pyramid ( the same used by SSHADE / Philipe B. )
Guillaume Mella's avatar
Guillaume Mella committed
25

Guillaume Mella's avatar
Guillaume Mella committed
26
### Setup deployement uses docker
27

Guillaume Mella's avatar
Guillaume Mella committed
28
[First milestone aims to build and run prototyping container](#2)
Guillaume Mella's avatar
Guillaume Mella committed
29

Guillaume Mella's avatar
Guillaume Mella committed
30
31
32
The postgres DB is on top of existing container ready for VO TAP constraints (ready for VO interface identified in backlog).
Note: Some enhancement have been operated for dachs.sh

Guillaume Mella's avatar
Guillaume Mella committed
33
34


Guillaume Mella's avatar
Guillaume Mella committed
35
#### Quick collaboration diagram
36
37
38
39
40
41
```mermaid
graph TD

    webapp --> sgbd
    tapserver --> sgbd
    
Guillaume Mella's avatar
Guillaume Mella committed
42
    subgraph jmdc-ui container 
43
44
45
        webapp
    end
    
Guillaume Mella's avatar
Guillaume Mella committed
46
    subgraph jmdc-postgres container
47
48
49
        sgbd(Postgresql + PGShere)
    end
    
Guillaume Mella's avatar
Guillaume Mella committed
50
    subgraph TBD jmdc-tap container 
51
52
53
        tapserver
    end
```
Guillaume Mella's avatar
Guillaume Mella committed
54

55
56
57
58
59
60
61
62

#### How to release a new version ?

- source .env && git tag -a $IMAGE_TAG -m "v$IMAGE_TAG" && git push --tags



**Note:** try to follow our [docker guidelines](https://gricad-gitlab.univ-grenoble-alpes.fr/continuous-everything/dockerfile-for-prod) ( and maybe https://codefresh.io/containers/docker-anti-patterns/ )