Recommendation System for EOSCF

The recommendation system component focuses on creating recommendations for a requested resource. So far, its data source is only the mongo of the RS.

Use cases that are being implemented: https://wiki.eoscfuture.eu/display/EOSCF/RS+Content-based+Use+Cases

V2 BREAKING

1. All the API urls have an added v1 eg. http://0.0.0.0:4559/similar_services/recommendation -> http://0.0.0.0:4559/v1/similar_services/recommendation
2. The recommendation responses have changed to match RecommendationSet

json { "panel_id": "similar_services", "recommendations": [ 12, 23, ... ], "explanations": [ "explanation1", "explanation2" ... ], "explanations_short": [ "explanation_short1", "explanation_short2" ... ], "score": [ 0.7, 0.6, ... ], "engine_version": "v1" }

Building and Running

Prerequisites:

1. Read access to RS Mongo (from Cyfronet)
2. Read/write access to our Internal Mongo (from Athena)
3. Read/write access to our internal Redis storage

Build and run:

1. Make sure that you have added the .env file in the project root
2. Run docker build -t rs-image . -f Dockerfile-rs
3. Run docker run -p <port>:4559 rs-image

The image can be deployed using docker-compose if the .env variables are set correctly.

Environment variables

The following variables should be set in the .env file

```shell

These variable are of our internal mongo which is used for logging recommendations

Should not be confused with the RS Mongo

CONTENTBASEDRSMONGOHOST=contentbasedrecsmongo # The hostname of the contentbasedrecs mongo CONTENTBASEDRSMONGOPORT=27017 # The port of the internal mongo CONTENTBASEDRSMONGODATABASE=contentbasedrecs # The name of the database we are using for internal storage CONTENTBASEDRSMONGOUSERNAME="admin" # The username of a user of the internal mongo deployed by compose CONTENTBASEDRSMONGO_PASSWORD="admin" # The password of a user of the internal mongo deployed by compose

RS Mongo (from Cyfronet)

RSMONGOHOST=localhost # The hostname of the external RS mongo RSMONGOPORT=27017 # The port of the external RS mongo RSMONGODATABASE=rsdump # The name of the RS database RSMONGOUSERNAME=dev # The username of a user of the external RS mongo RSMONGO_PASSWORD=dev # The password of a user of the external RS mongo

INTERNALREDISHOST=redis # The hostname of the internal redis deployed by compose INTERNALREDISPORT=6379 # The port of the internal redis deployed by compose INTERNALREDISPASSWORD=redis_pswd # The password of the internal redis deployed by compose

The private sdn key for sentry which we use for error logging

SENTRY_SDN=https://12345...

Cronitor is used to monitor the offline updating of our RS data structures

stored in redis

CRONITORAPIKEY=123aababdas...

Monitoring access token is used to obtain reliability status of services in the portal before recommending them

MONITORINGAPIACCESS_TOKEN=daad2dasd... ```