From 2b1eb405a5980a1680e036aba3e74ccc8257a24a Mon Sep 17 00:00:00 2001 From: Carmen Tawalika Date: Sat, 2 Sep 2023 13:38:48 +0200 Subject: [PATCH] enhance docker installation docs (#470) --- docker/README.md | 34 +++++++++++++++++++++++++++------- docker/docker-compose.yml | 5 ++++- docs/README.md | 6 +++++- docs/docs/installation.md | 24 ++++++++++++++++++++++++ 4 files changed, 60 insertions(+), 9 deletions(-) diff --git a/docker/README.md b/docker/README.md index f709490bc..810a08903 100644 --- a/docker/README.md +++ b/docker/README.md @@ -6,8 +6,8 @@ Requirements: docker and docker-compose To build and deploy actinia, run ``` -git clone https://github.com/mundialis/actinia_core.git -cd actinia_core +git clone https://github.com/actinia-org/actinia-core.git +cd actinia-core docker-compose -f docker/docker-compose.yml up ``` Now you have a running actinia instance locally! Check with @@ -21,6 +21,26 @@ curl http://127.0.0.1:8088/api/v3/version On startup, some GRASS GIS locations are created by default but they are still empty. How to get some geodata to start processing, see in [Testing GRASS GIS inside a container](#grass-gis) below. + + # How to fix common startup errors * if a redis db is running locally this will fail. Run and try again: @@ -37,11 +57,11 @@ sudo sysctl -w vm.max_map_count=262144 # Local dev-setup with docker -If desired, you can also directly start here without installing actinia first. You only need to have cloned and checked out the actinia_core repository. +If desired, you can also directly start here without installing actinia first. You only need to have cloned and checked out the actinia-core repository. -If you use [vscode](https://code.visualstudio.com/), open actinia_core as a workspace. This can be done by eg. typing `code $PATH_TO_MY_ACTINIA_CORE_CHECKOUT` in a terminal. Then press `F5` and after a few seconds, a browser window should be opened pointing to the version endpoint. For debugging tips, [read the docs](https://code.visualstudio.com/Docs/editor/debugging#_debug-actions). +If you use [vscode](https://code.visualstudio.com/), open actinia-core as a workspace. This can be done by eg. typing `code $PATH_TO_MY_ACTINIA_CORE_CHECKOUT` in a terminal. Then press `F5` and after a few seconds, a browser window should be opened pointing to the version endpoint. For debugging tips, [read the docs](https://code.visualstudio.com/Docs/editor/debugging#_debug-actions). -__If not stated otherwise, you need to be in folder `actinia_core/docker`__ +__If not stated otherwise, you need to be in folder `actinia-core/docker`__ To overwrite default config and uninstall actinia-core to use local source code, build a Dockerimage with the docker-compose-dev.yml file: ``` @@ -66,7 +86,7 @@ To test your local changes, you best use the Test Dockerimage: # changing directory is necessary to have the correct build context (cd .. && docker build -f docker/actinia-core-tests/Dockerfile -t actinia-test .) ``` -To dive deeper into testing + development, see the [test README](https://github.com/mundialis/actinia_core/blob/main/tests/README.md) +To dive deeper into testing + development, see the [test README](https://github.com/actinia-org/actinia-core/blob/main/tests/README.md) To lint your local changes, run ``` @@ -128,7 +148,7 @@ If you want to download the data not from inside the container but from your nor # Production and Cloud deployment -To run actinia_core in production systems, best with multiple actinia_core instances, find more detailed information in the dedicated [actinia-docker](https://github.com/mundialis/actinia-docker) repository. +To run actinia-core in production systems, best with multiple actinia-core instances, find more detailed information in the dedicated [actinia-docker](https://github.com/actinia-org/actinia-docker) repository. # Building the API documentation diff --git a/docker/docker-compose.yml b/docker/docker-compose.yml index 476a2bded..b3f6dac41 100644 --- a/docker/docker-compose.yml +++ b/docker/docker-compose.yml @@ -2,7 +2,10 @@ version: "3" services: actinia: - image: mundialis/actinia-core:4.9.1 + image: mundialis/actinia-core:4.10.0 + # build: + # context: .. + # dockerfile: docker/actinia-core-alpine/Dockerfile volumes: - ./actinia-core-data/grassdb:/actinia_core/grassdb:Z - ./actinia-core-data/userdata:/actinia_core/userdata diff --git a/docs/README.md b/docs/README.md index 716835ed3..854b08839 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,3 +1,7 @@ -## Deploy +## Local setup +* cd to actinia-core/docs folder +* run the command `mkdocs serve` + +## Deploy to https://actinia-org.github.io/actinia-core * cd to actinia_core/docs/ folder * run the command `mkdocs gh-deploy` diff --git a/docs/docs/installation.md b/docs/docs/installation.md index 885739466..e33f2c3cd 100644 --- a/docs/docs/installation.md +++ b/docs/docs/installation.md @@ -1,6 +1,30 @@ Installation ============ +Installation with docker +------------------------ + +Requirements: docker and docker-compose + +To build and deploy actinia, run + +``` +git clone https://github.com/mundialis/actinia-core.git +cd actinia-core +docker-compose -f docker/docker-compose.yml up +``` +Now you have a running actinia instance locally! Check with +``` +curl http://127.0.0.1:8088/api/v3/version +``` + +* For how to add data to this setup, how to run actinia locally with most recent GRASS GIS or how to fix common startup errors, see more details in [docker README](https://github.com/actinia-org/actinia-core/blob/main/docker/README.md). + + + +Local installation +------------------ + A local installation requires a full GRASS GIS installation. Make sure all requirements are fulfilled to compile GRASS GIS from the git repository.