From efeb47bd38a84ad1f825f26814a1f701d5cb525e Mon Sep 17 00:00:00 2001 From: "alban.espie-guillon" Date: Tue, 26 Jul 2022 13:13:47 +0200 Subject: [PATCH 1/6] Changed: Set default value for image tags variables --- app/share/decoder-eu/docker-compose.yaml | 48 ++++++++++++------------ 1 file changed, 24 insertions(+), 24 deletions(-) diff --git a/app/share/decoder-eu/docker-compose.yaml b/app/share/decoder-eu/docker-compose.yaml index 935b880..1da1a09 100644 --- a/app/share/decoder-eu/docker-compose.yaml +++ b/app/share/decoder-eu/docker-compose.yaml @@ -4,7 +4,7 @@ services: #### MongoDB #### mongodb: - image: gitlab.ow2.org:4567/decoder/pkm-api/mongodb:${MONGODB_IMAGE_TAG} + image: gitlab.ow2.org:4567/decoder/pkm-api/mongodb:${MONGODB_IMAGE_TAG:-master} restart: unless-stopped networks: pkmnet: @@ -20,7 +20,7 @@ services: #### PKM #### pkm: - image: gitlab.ow2.org:4567/decoder/pkm-api/pkm:${PKM_IMAGE_TAG} + image: gitlab.ow2.org:4567/decoder/pkm-api/pkm:${PKM_IMAGE_TAG:-master} restart: unless-stopped networks: pkmnet: @@ -36,7 +36,7 @@ services: #### Frama-C #### frama-c: - image: gitlab.ow2.org:4567/decoder/pkm-api/framac:${FRAMA_C_IMAGE_TAG} + image: gitlab.ow2.org:4567/decoder/pkm-api/framac:${FRAMA_C_IMAGE_TAG:-master} restart: unless-stopped networks: - pkmnet @@ -47,7 +47,7 @@ services: #### Frama-Clang #### frama-clang: - image: gitlab.ow2.org:4567/decoder/pkm-api/frama-clang:${FRAMA_CLANG_IMAGE_TAG} + image: gitlab.ow2.org:4567/decoder/pkm-api/frama-clang:${FRAMA_CLANG_IMAGE_TAG:-master} restart: unless-stopped networks: - pkmnet @@ -58,7 +58,7 @@ services: #### Javaparser #### javaparser: - image: gitlab.ow2.org:4567/decoder/javaparsertool/javaparser:${JAVAPARSER_IMAGE_TAG} + image: gitlab.ow2.org:4567/decoder/javaparsertool/javaparser:${JAVAPARSER_IMAGE_TAG:-master} restart: unless-stopped networks: - pkmnet @@ -67,7 +67,7 @@ services: #### Openjmlanalyzer #### openjmlanalyzer: - image: gitlab.ow2.org:4567/decoder/javaparsertool/openjmlanalyzer:${OPENJMLANALYZER_IMAGE_TAG} + image: gitlab.ow2.org:4567/decoder/javaparsertool/openjmlanalyzer:${OPENJMLANALYZER_IMAGE_TAG:-master} restart: unless-stopped networks: - pkmnet @@ -76,7 +76,7 @@ services: #### Classmodelxmi2jsontransformer #### classmodelxmi2jsontransformer: - image: gitlab.ow2.org:4567/decoder/javaparsertool/classmodelxmi2jsontransformer:${CLASSMODELXMI2JSONTRANSFORMER_IMAGE_TAG} + image: gitlab.ow2.org:4567/decoder/javaparsertool/classmodelxmi2jsontransformer:${CLASSMODELXMI2JSONTRANSFORMER_IMAGE_TAG:-master} restart: unless-stopped networks: - pkmnet @@ -85,7 +85,7 @@ services: #### Smmodelxmi2jsontransformer #### smmodelxmi2jsontransformer: - image: gitlab.ow2.org:4567/decoder/javaparsertool/smmodelxmi2jsontransformer:${SMMODELXMI2JSONTRANSFORMER_IMAGE_TAG} + image: gitlab.ow2.org:4567/decoder/javaparsertool/smmodelxmi2jsontransformer:${SMMODELXMI2JSONTRANSFORMER_IMAGE_TAG:-master} restart: unless-stopped networks: - pkmnet @@ -94,7 +94,7 @@ services: #### Process Engine #### processengine: - image: gitlab.ow2.org:4567/decoder/processengine:${PROCESSENGINE_IMAGE_TAG} + image: gitlab.ow2.org:4567/decoder/processengine:${PROCESSENGINE_IMAGE_TAG:-master} restart: unless-stopped networks: - pkmnet @@ -106,7 +106,7 @@ services: #### Jmlgen #### jmlgen: - image: gitlab.ow2.org:4567/decoder/jmlgen-openapi:${JMLGEN_IMAGE_TAG} + image: gitlab.ow2.org:4567/decoder/jmlgen-openapi:${JMLGEN_IMAGE_TAG:-master} restart: unless-stopped networks: - pkmnet @@ -115,7 +115,7 @@ services: #### SRL #### srl: - image: gitlab.ow2.org:4567/decoder/srl_tool:${SRL_IMAGE_TAG} + image: gitlab.ow2.org:4567/decoder/srl_tool:${SRL_IMAGE_TAG:-master} restart: unless-stopped environment: - SERVICE_PORT=701 @@ -129,7 +129,7 @@ services: #### TRACE_RECOVERY_TOOL #### trace_recovery: - image: gitlab.ow2.org:4567/decoder/trace_recovery_tool:${TRACE_RECOVERY_IMAGE_TAG} + image: gitlab.ow2.org:4567/decoder/trace_recovery_tool:${TRACE_RECOVERY_IMAGE_TAG:-master} restart: unless-stopped expose: - '80' @@ -148,7 +148,7 @@ services: - PKM_PORT=8080 - DEBUG=True bert: - image: gitlab.ow2.org:4567/decoder/trace_recovery_tool/bert:${TRACE_RECOVERY_IMAGE_TAG} + image: gitlab.ow2.org:4567/decoder/trace_recovery_tool/bert:${TRACE_RECOVERY_IMAGE_TAG:-master} expose: - '5555' - '5556' @@ -158,7 +158,7 @@ services: #### NER_TOOL #### ner: - image: gitlab.ow2.org:4567/decoder/ner_tool:${NER_IMAGE_TAG} + image: gitlab.ow2.org:4567/decoder/ner_tool:${NER_IMAGE_TAG:-master} restart: unless-stopped expose: - '80' @@ -174,13 +174,13 @@ services: depends_on: - lima lima: - image: gitlab.ow2.org:4567/decoder/ner_tool/lima:${NER_IMAGE_TAG} + image: gitlab.ow2.org:4567/decoder/ner_tool/lima:${NER_IMAGE_TAG:-master} networks: - limanet #### SEMPARSING_TOOL #### semanticparsing: - image: gitlab.ow2.org:4567/decoder/semparsing_tool:${SEMANTICPARSING_IMAGE_TAG} + image: gitlab.ow2.org:4567/decoder/semparsing_tool:${SEMANTICPARSING_IMAGE_TAG:-master} restart: unless-stopped expose: - '80' @@ -201,7 +201,7 @@ services: - semanticparsing_backend semanticparsing_backend: - image: gitlab.ow2.org:4567/decoder/semparsing_tool/parsing_backend:${SEMANTICPARSING_IMAGE_TAG} + image: gitlab.ow2.org:4567/decoder/semparsing_tool/parsing_backend:${SEMANTICPARSING_IMAGE_TAG:-master} restart: unless-stopped volumes: - ${SEMPARSING_TOOL_CONFIG_MODELS_DIR}:/app/models @@ -213,7 +213,7 @@ services: #### TESTAR #### testar: - image: gitlab.ow2.org:4567/decoder/testar_docker:${TESTAR_IMAGE_TAG} + image: gitlab.ow2.org:4567/decoder/testar_docker:${TESTAR_IMAGE_TAG:-master} restart: unless-stopped volumes: - /srv/appdata/decoder/testar_output:/testar/bin/output @@ -253,7 +253,7 @@ services: #### JUPYTER #### jupyter-hub: - image: gitlab.ow2.org:4567/decoder/jupyter-hub:${JUPYTER_HUB_IMAGE_TAG} + image: gitlab.ow2.org:4567/decoder/jupyter-hub:${JUPYTER_HUB_IMAGE_TAG:-master} restart: unless-stopped networks: - pkmnet @@ -263,7 +263,7 @@ services: #### FRONTEND #### frontend: - image: gitlab.ow2.org:4567/decoder/frontend:${FRONTEND_IMAGE_TAG} + image: gitlab.ow2.org:4567/decoder/frontend:${FRONTEND_IMAGE_TAG:-master} restart: unless-stopped ports: - "${UI_PORT}:80" @@ -274,7 +274,7 @@ services: #### Code Summarization #### code-summarization: - image: gitlab.ow2.org:4567/decoder/code_summarization-api:${CODE_SUMMARIZATION_IMAGE_TAG} + image: gitlab.ow2.org:4567/decoder/code_summarization-api:${CODE_SUMMARIZATION_IMAGE_TAG:-master} restart: unless-stopped expose: - '8083' @@ -285,7 +285,7 @@ services: #### Variable Misuse #### variable-misuse: - image: gitlab.ow2.org:4567/decoder/variable_misuse-api:${VARIABLE_MISUSE_IMAGE_TAG} + image: gitlab.ow2.org:4567/decoder/variable_misuse-api:${VARIABLE_MISUSE_IMAGE_TAG:-master} restart: unless-stopped expose: - '8084' @@ -296,7 +296,7 @@ services: #### ASFM #### asfm: - image: gitlab.ow2.org:4567/decoder/pkm-api/asfm:${ASFM_IMAGE_TAG} + image: gitlab.ow2.org:4567/decoder/pkm-api/asfm:${ASFM_IMAGE_TAG:-master} restart: unless-stopped expose: - '8086' @@ -307,7 +307,7 @@ services: #### Excavator ### excavator: - image: gitlab.ow2.org:4567/decoder/pkm-api/excavator:${EXCAVATOR_IMAGE_TAG} + image: gitlab.ow2.org:4567/decoder/pkm-api/excavator:${EXCAVATOR_IMAGE_TAG:-master} restart: unless-stopped expose: - '8087' -- GitLab From 9ce16aab225ff899c86b09af5c828b3b86164dbf Mon Sep 17 00:00:00 2001 From: "alban.espie-guillon" Date: Tue, 26 Jul 2022 14:59:20 +0200 Subject: [PATCH 2/6] Changed: Set default value for volumes variables --- app/share/decoder-eu/docker-compose.yaml | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/app/share/decoder-eu/docker-compose.yaml b/app/share/decoder-eu/docker-compose.yaml index 1da1a09..d0a18a7 100644 --- a/app/share/decoder-eu/docker-compose.yaml +++ b/app/share/decoder-eu/docker-compose.yaml @@ -266,7 +266,7 @@ services: image: gitlab.ow2.org:4567/decoder/frontend:${FRONTEND_IMAGE_TAG:-master} restart: unless-stopped ports: - - "${UI_PORT}:80" + - "${UI_PORT:-80}:80" networks: - pkmnet volumes: @@ -319,7 +319,7 @@ services: #### Common Stuff #### secrets: credentials.json: - file: ${MONGODB_CONFIG_DIR}/credentials.json + file: ${MONGODB_CONFIG_DIR:-mongodb-config}/credentials.json networks: pkmnet: @@ -337,29 +337,29 @@ volumes: driver: local driver_opts: type: none - device: ${PKM_CONFIG_DIR} + device: ${PKM_CONFIG_DIR:-pkm_config} o: bind,ro process_engine_config: driver: local driver_opts: type: none - device: ${PROCESS_ENGINE_CONFIG_DIR} + device: ${PROCESS_ENGINE_CONFIG_DIR:-process_engine} o: bind,ro mongodb_data: driver: local driver_opts: type: none - device: ${MONGODB_DATA_DIR} + device: ${MONGODB_DATA_DIR:-mongodb-data} o: bind,rw mongodb_log: driver: local driver_opts: type: none - device: ${MONGODB_LOG_DIR} + device: ${MONGODB_LOG_DIR:-mongodb-logs} o: bind,rw git_root: driver: local driver_opts: type: none - device: ${PKM_GIT_ROOT_DIR} + device: ${PKM_GIT_ROOT_DIR:-git_root} o: bind,rw -- GitLab From 3b65c34fc22368867f0155b3a64e55005f9c9560 Mon Sep 17 00:00:00 2001 From: "alban.espie-guillon" Date: Tue, 26 Jul 2022 20:23:45 +0200 Subject: [PATCH 3/6] Changed: Update volumes --- app/share/decoder-eu/docker-compose.yaml | 34 +++++++++++++++++------- 1 file changed, 24 insertions(+), 10 deletions(-) diff --git a/app/share/decoder-eu/docker-compose.yaml b/app/share/decoder-eu/docker-compose.yaml index d0a18a7..a73a630 100644 --- a/app/share/decoder-eu/docker-compose.yaml +++ b/app/share/decoder-eu/docker-compose.yaml @@ -16,7 +16,7 @@ services: - credentials.json volumes: - mongodb_data:/pkm-api/mongodb/data - - mongodb_log:/pkm-api/mongodb/log + - mongodb_logs:/pkm-api/mongodb/log #### PKM #### pkm: @@ -204,7 +204,7 @@ services: image: gitlab.ow2.org:4567/decoder/semparsing_tool/parsing_backend:${SEMANTICPARSING_IMAGE_TAG:-master} restart: unless-stopped volumes: - - ${SEMPARSING_TOOL_CONFIG_MODELS_DIR}:/app/models + - ${SEMPARSING_TOOL_CONFIG_MODELS_DIR:-semparsing-models}:/app/models expose: - '1028' networks: @@ -269,8 +269,9 @@ services: - "${UI_PORT:-80}:80" networks: - pkmnet - volumes: - - ${FRONTEND_CONFIG_DIR}/app.config.json:/var/www/app.config.json + # Only needed if you wish to manually edit app.config.json + #volumes: + # - ${FRONTEND_CONFIG_DIR}/app.config.json:/var/www/app.config.json #### Code Summarization #### code-summarization: @@ -319,7 +320,7 @@ services: #### Common Stuff #### secrets: credentials.json: - file: ${MONGODB_CONFIG_DIR:-mongodb-config}/credentials.json + file: ${MONGODB_CONFIG_DIR:-/srv/appdata/mongodb-secret}/credentials.json networks: pkmnet: @@ -332,32 +333,45 @@ networks: driver: bridge my-thai-star: driver: bridge + volumes: pkm_config: + name: pkm_config driver: local driver_opts: type: none - device: ${PKM_CONFIG_DIR:-pkm_config} + device: ${PKM_CONFIG_DIR:-/srv/appdata/pkm_config} o: bind,ro process_engine_config: + name: process_engine driver: local driver_opts: type: none - device: ${PROCESS_ENGINE_CONFIG_DIR:-process_engine} + device: ${PROCESS_ENGINE_CONFIG_DIR:-/srv/appdata/process_engine} o: bind,ro + semparsing_tool_models: + name: semparsing_tool + driver: local + driver_opts: + type: none + device: ${PROCESS_ENGINE_CONFIG_DIR:-/srv/appdata/semparsing_tool} + o: bind mongodb_data: + name: mongodb_data driver: local driver_opts: type: none - device: ${MONGODB_DATA_DIR:-mongodb-data} + device: ${MONGODB_DATA_DIR:-mongodb_data} o: bind,rw - mongodb_log: + mongodb_logs: + name: mongodb_logs driver: local driver_opts: type: none - device: ${MONGODB_LOG_DIR:-mongodb-logs} + device: ${MONGODB_LOG_DIR:-mongodb_logs} o: bind,rw git_root: + name: git_root driver: local driver_opts: type: none -- GitLab From f4e024a68c8f67d7ef75d1fba09eb7d9fa612167 Mon Sep 17 00:00:00 2001 From: "alban.espie-guillon" Date: Tue, 26 Jul 2022 20:25:26 +0200 Subject: [PATCH 4/6] Changed: Update volumes --- app/share/decoder-eu/docker-compose.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/app/share/decoder-eu/docker-compose.yaml b/app/share/decoder-eu/docker-compose.yaml index a73a630..8f0cb4a 100644 --- a/app/share/decoder-eu/docker-compose.yaml +++ b/app/share/decoder-eu/docker-compose.yaml @@ -361,19 +361,19 @@ volumes: driver: local driver_opts: type: none - device: ${MONGODB_DATA_DIR:-mongodb_data} + device: ${MONGODB_DATA_DIR:-/srv/appdata/mongodb_data} o: bind,rw mongodb_logs: name: mongodb_logs driver: local driver_opts: type: none - device: ${MONGODB_LOG_DIR:-mongodb_logs} + device: ${MONGODB_LOG_DIR:-/srv/appdata/mongodb_logs} o: bind,rw git_root: name: git_root driver: local driver_opts: type: none - device: ${PKM_GIT_ROOT_DIR:-git_root} + device: ${PKM_GIT_ROOT_DIR:-/srv/appdata/decoder/git_root} o: bind,rw -- GitLab From 21ddf159b2376e1b2ad4cd0c8daff4c871e75ee5 Mon Sep 17 00:00:00 2001 From: "alban.espie-guillon" Date: Thu, 28 Jul 2022 09:56:35 +0200 Subject: [PATCH 5/6] Fixed: semparsing_tool volume --- app/share/decoder-eu/docker-compose.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/app/share/decoder-eu/docker-compose.yaml b/app/share/decoder-eu/docker-compose.yaml index 8f0cb4a..a7874de 100644 --- a/app/share/decoder-eu/docker-compose.yaml +++ b/app/share/decoder-eu/docker-compose.yaml @@ -204,7 +204,7 @@ services: image: gitlab.ow2.org:4567/decoder/semparsing_tool/parsing_backend:${SEMANTICPARSING_IMAGE_TAG:-master} restart: unless-stopped volumes: - - ${SEMPARSING_TOOL_CONFIG_MODELS_DIR:-semparsing-models}:/app/models + - ${SEMPARSING_TOOL_CONFIG_MODELS_DIR:-semparsing_tool}:/app/models expose: - '1028' networks: @@ -349,7 +349,7 @@ volumes: type: none device: ${PROCESS_ENGINE_CONFIG_DIR:-/srv/appdata/process_engine} o: bind,ro - semparsing_tool_models: + semparsing_tool: name: semparsing_tool driver: local driver_opts: -- GitLab From 324be0703c9cb52f661b781be8d8afce3daec9da Mon Sep 17 00:00:00 2001 From: "alban.espie-guillon" Date: Thu, 28 Jul 2022 10:20:53 +0200 Subject: [PATCH 6/6] Changed: Update README.md --- README.md | 36 ++++++++++++++++++------------------ 1 file changed, 18 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index c13818b..74e6c85 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ DECODER platform deployment using docker-compose Introduction ------------ -This program provides a command line interface and a control center for managing the services (download, install, update, start, ...) of DECODER EU Project Tool-chain. +This program provides a command line interface and a control center for managing the services (download, install, update, start, ...) of DECODER EU Project Tool-chain, and will basically execute a [docker-compose file](https://gitlab.ow2.org/decoder/docker-deployment/-/blob/main/app/share/decoder-eu/docker-compose.yaml) with variable replacement and multiple checks. The docker-compose file can also be executed manually. Minimum Hardware Requirements ----------------------------- @@ -32,57 +32,57 @@ Command line interface ---------------------- Usage: decoder-eu [] [] - + This program provides a command line interface and a control center for managing the components (download, install, update, start, ...) of DECODER EU Project Tool-chain. When command list is empty and zenity (https://help.gnome.org/users/zenity/) is installed, it displays a control center, otherwise it displays this help. - + Options: --version Outputs version information and exit - + --help Display this help and exit - + --user-pref-dir Set the directory where the user's preferences are located (default: ~/.config/decoder-eu) - + --user-data-dir Set the directory where the user's data are located (default: ~/.local/share/decoder-eu) - + Commands: start Starts the DECODER EU Project Tool-chain services then opens the GUI in your default browser - + gui Opens the GUI in your default browser - + stop Stops the DECODER EU Project Tool-chain services' - + status Shows the status of the DECODER EU Project Tool-chain services - + shell Starts a shell with a preset environment - + reset Resets all data (but preserve your saved preferences) (default: in ~/.local/share/decoder-eu) - + select-tools Select the tools considered for start, install and update commands - + configure Edit configuration file (default: in ~/.config/decoder-eu/config) - + delete-prefs Delete your saved preferences (default: in ~/.config/decoder-eu) - + install Downloads, install, and preconfigure DECODER EU Project Tool-chain ready to use - + update Update DECODER EU Project Tool-chain (without altering your saved preferences) - + uninstall Uninstall DECODER EU Project Tool-chain (but preserve your saved preferences) -- GitLab