Merge branch 'main' of git.rwth-aachen.de:polaris/entwicklung/deployment

LICENSE

+MIT License
+
+Copyright (c) 2023 Polaris / Entwicklung
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

analytics-engine/.env.sample

-DYNACONF_SQLALCHEMY_DATABASE_URI=postgresql://postgres:CHANGE_ME@database/analytics-engine
-DYNACONF_CELERY_BROKER_URL=redis://:CHANGE_ME@redis_db:6379/0
-DYNACONF_CELERY_RESULT_BACKEND=redis://:CHANGE_ME@redis_db:6379/1
-DYNACONF_ANALYTICS_BACKEND_URL=http://scheduler:5000
-DYNACONF_RIGHTS_ENGINE_BACKEND_URL=http://localhost:80/
-WEBSITE=analytics
-URL=$DEPLOYMENT_URL
+DYNACONF_SQLALCHEMY_DATABASE_URI=postgresql://postgres:CHANGE_ME@database/analytics-engine # the password should match with POSTGRES_PASSWORD
+DYNACONF_CELERY_BROKER_URL=redis://:CHANGE_ME@redis_db:6379/0 # the password should match with the REDIS_PASSWORD
+DYNACONF_CELERY_RESULT_BACKEND=redis://:CHANGE_ME@redis_db:6379/1 # the password should match with the REDIS_PASSWORD
+DYNACONF_ANALYTICS_BACKEND_URL=http://scheduler:5000 # no changes needed
+DYNACONF_RIGHTS_ENGINE_BACKEND_URL=http://localhost:80/ # url of the rights engine
+WEBSITE=analytics # traefik configuration 
+URL=$DEPLOYMENT_URL # traefik configuration
 REDIS_PASSWORD=CHANGE_ME 
 POSTGRES_USER=postgres
 POSTGRES_DATABASE=analytics-engine

analytics-engine/docker-compose.yml

@@ -20,7 +20,7 @@ services:
 
   scheduler:
     user: "${UID}:${GID}"
-    image: registry.git.rwth-aachen.de/polaris/analytics-engine/scheduler:latest
+    image: registry.git.rwth-aachen.de/polaris/entwicklung/analytics-engine/scheduler:latest
     restart: unless-stopped
     expose:
       - 8000
@@ -42,7 +42,7 @@ services:
 
   beat:
     user: "${UID}:${GID}"
-    image: registry.git.rwth-aachen.de/polaris/analytics-engine/scheduler:latest
+    image: registry.git.rwth-aachen.de/polaris/entwicklung/analytics-engine/scheduler:latest
     restart: unless-stopped
     entrypoint: celery
     command: -A scheduler.worker beat -l info --scheduler celery_sqlalchemy_scheduler.schedulers:DatabaseScheduler
@@ -57,7 +57,7 @@ services:
 
   worker:
     user: "${UID}:${GID}"
-    image: registry.git.rwth-aachen.de/polaris/analytics-engine/scheduler:latest
+    image: registry.git.rwth-aachen.de/polaris/entwicklung/analytics-engine/scheduler:latest
     restart: unless-stopped
     entrypoint: celery
     command: -A scheduler.worker worker -l info

rights-engine/.env.sample

-URL=localhost
+URL=localhost # url of the installation for traefik
 WEBSITE=polaris 
-DB_PASSWORD=CHANGE_ME
-DJANGO_DEVELOPMENT=false
+DB_PASSWORD=CHANGE_ME # this should be the same as DATABASE_PASSWORD
+DJANGO_DEVELOPMENT=false # production should be false
 DATABASE_NAME=polaris 
 DATABASE_USER=root
-DATABASE_PASSWORD=CHANGE_ME
+DATABASE_PASSWORD=CHANGE_ME # this should be the same as DB_PASSWORD
 DATABASE_HOST=database 
 DEBUG=False 
-LRS_HOST=http://learninglocker.digitallearning.gmbh:8080
-LRS_TOKEN=CHANGE_ME
-LRS_CONNECTION_STRING=mongodb://root:CHANGE_ME@127.0.0.1:27017
-LRS_MONGO_DB_NAME=lrs
-DATA_DISCLOSURE_EXPIRATION=30
-DATA_DISCLOSURE_LOCATION=/usr/src/app/backend/data_disclosure_zips
-EMAIL_HOST=
-EMAIL_PORT=
-EMAIL_HOST_USER=
-EMAIL_HOST_PASSWORD=
-REDIS_PASSWORD=CHANGE_ME
-CELERY_BROKER_URL=redis://:CHANGE_ME@redis:6379/0
-JWT_PUBLIC_KEY_PATH=backend/id_rsa.pub
-JWT_PRIVATE_KEY_PATH=backend/id_rsa
-IDP_SERVER=https://aai-test-v3.ruhr-uni-bochum.de
-IDP_ENABLED=false
-SP_HOST=polaris.digitallearning.gmbh
-ANONYMIZATION_HASH_PREFIX=anon
-ANONYMIZATION_DEFAULT_MINIMUM_COUNT=10
-
+LRS_HOST=http://sample.com:8080 # not needed, if you use mongodb
+LRS_TOKEN=CHANGE_ME # not needed, if you use mongodb
+LRS_CONNECTION_STRING=mongodb://root:CHANGE_ME@127.0.0.1:27017 # connection string to the mongodb
+LRS_MONGO_DB_NAME=lrs # no changes needed
+DATA_DISCLOSURE_EXPIRATION=30 # number of days the data disclosures are deleted
+DATA_DISCLOSURE_LOCATION=/usr/src/app/backend/data_disclosure_zips # folder of the data disclosures in the docker container, no changes needed
+EMAIL_HOST= # host for email notification account
+EMAIL_PORT= # port for email notification account
+EMAIL_HOST_USER= # username for email notification account
+EMAIL_HOST_PASSWORD= # password for email notification account
+REDIS_PASSWORD=CHANGE_ME # redis password
+CELERY_BROKER_URL=redis://:CHANGE_ME@redis:6379/0 # change redis connection string to match REDIS_PASSWORD
+JWT_PUBLIC_KEY_PATH=backend/id_rsa.pub # path for jwt public key; see documentation 
+JWT_PRIVATE_KEY_PATH=backend/id_rsa # path for the jwt private key; see documentation
+IDP_SERVER=https://aai-test-v3.ruhr-uni-bochum.de # shibboleth url
+IDP_ENABLED=false # login via shibboleth
+SP_HOST=polaris.digitallearning.gmbh # redirect back url of the shibboleth 
+PROVIDER_CONTEXTS_PULL_ENABLED=False # if you like to use the feature, that courses or structures are pulled from moodle, enable that option here
+PROVIDER_CONTEXTS_PULL_URL=https://example.com # url of moodle
+PROVIDER_CONTEXTS_PULL_TOKEN=CHANGE_ME # token of the moodle plugin 

rights-engine/docker-compose.yml

@@ -20,7 +20,7 @@ services:
       - internal
 
   rights-engine:
-    image: registry.git.rwth-aachen.de/polaris/rights-engine/rights-engine
+    image: registry.git.rwth-aachen.de/polaris/entwicklung/rights-engine/rights-engine:latest
     restart: unless-stopped
     expose:
       - 80
@@ -45,7 +45,7 @@ services:
       - "./data_disclosure_zips/:/usr/src/app/backend/data_disclosure_zips"
 
   beat:
-    image: registry.git.rwth-aachen.de/polaris/rights-engine/rights-engine
+    image: registry.git.rwth-aachen.de/polaris/entwicklung/rights-engine/rights-engine:latest
     restart: unless-stopped
     entrypoint: celery
     command: -A backend beat -l info
@@ -63,7 +63,7 @@ services:
       - "./id_rsa:/usr/src/app/backend/id_rsa"
 
   worker:
-    image: registry.git.rwth-aachen.de/polaris/rights-engine/rights-engine
+    image: registry.git.rwth-aachen.de/polaris/entwicklung/rights-engine/rights-engine:latest
     restart: unless-stopped
     entrypoint: celery
     command: -A backend worker --loglevel=debug

single-compose-with-moodle/docker-compose.yml

@@ -137,7 +137,7 @@ services:
       - "./configuration:/app/configuration"
 
   dashboard:
-    image: registry.git.rwth-aachen.de/polaris/dashboard-example/dashboard-example:latest
+    image: registry.git.rwth-aachen.de/polaris/entwicklung/dashboard-example/dashboard-example:latest
     restart: always
     ports:
       - 8005:80

single-compose/docker-compose.yml

@@ -137,7 +137,7 @@ services:
       - "./configuration:/app/configuration"
 
   dashboard:
-    image: registry.git.rwth-aachen.de/polaris/dashboard-example/dashboard-example:latest
+    image: registry.git.rwth-aachen.de/polaris/entwicklung/dashboard-example/dashboard-example:latest
     restart: always
     ports:
       - 8005:80