Allow docker volume binds

hitier
2 parents e0554e86 5e936526
Showing 6 changed files with 50 additions and 2 deletions Show diff stats
CHANGELOG.md
Dockerfile
README.md
VERSION.txt
compose.override.yaml-dist
docker-compose.yml -> compose.yaml
@@ -27,6 +27,10 @@ or major refactoring improvments.
 ### Changed
 ### New
+## [2.0.0-alpha.4] - 2023-11-04 - Docker volume binds
+### New
+Allow to bind local files and dirs to container
+
 ## [2.0.0-alpha.3] - 2023-11-03 - Display Input plot
 ### New
 Show input data along with targets charts
@@ -13,7 +13,7 @@ RUN pip install --upgrade pip &amp;&amp;\
 # Build the whole stuff
 COPY . .
-run cp config.yml-dist config.yml
+COPY config.yml-dist config.yml
 # Allow running outside compose
 CMD flask --app heliopropa:application run --host=0.0.0.0
@@ -20,6 +20,34 @@ It also gathers NetCDF data from AMDA, and serves it as CSV to the plotter.
     docker compose build
     docker compose up
+## Docker compose configuration
+
+docker stack mainly consists in two files:
+
+- `Dockerfile` for the container building
+- `compose.yaml` for the volumes configuration and links with nginx service and gunicorn 
+
+### Volumes configuration and `compose.override.yaml`
+
+You may want to understand where data is stored:
+
+The web application saves `*.csv` files in the `./cache/` directory, which happens to be a docker volume named `helio_cache`
+
+The speasy library holds a cache dir located at `container:/root/.cache/speasy/Cache/` which is also mounted as a volume: `speasy_cache`
+
+Two configuration files are also used:
+
+- `./config.yml` for the web app
+- `${HOME}/.config/speasy/config.ini` for the speasy library
+
+
+You can use the `compose.override.yaml` file to make dynamic links between your local files and the container.
+That way you can live edit the config files, and also use already loaded cache directories.
+
+    cp compose.override.yaml-dist compose.override.yaml
+    ${EDITOR} compose.override.yaml # make sure its ok, comment what you dont need
+    docker compose up -d
+
 ## Develop
 ### Configuration
-v2.0.0-alpha.3
+v2.0.0-alpha.4
@@ -0,0 +1,14 @@
+# overriding compose configuration file
+# dynamically links files and directories from host to container
+
+services:
+  web:
+    volumes:
+      # local csv files cache used for the running container
+      - ./cache:/cache:rw
+      # local site configuration file used for the running container
+      - ./config.yml:/config.yml
+      # local speasy configuration file used for the running container
+      - ${HOME}/.config/speasy/config.ini:/root/.config/speasy/config.ini
+      # local speasy cache dir file used for the running container
+      - ${HOME}/.cache/speasy/Cache:/root/.cache/speasy/Cache:rw
@@ -8,6 +8,7 @@ services:
     command: gunicorn --bind 0.0.0.0:5000 heliopropa:application
     volumes:
       - helio_cache:/cache:rw
+      - speasy_cache:/root/.cache/speasy/Cache:rw
     expose:
       - 5000
   nginx:
@@ -21,3 +22,4 @@ services:
 volumes:
   helio_cache:
+  speasy_cache: