ri-orchestration-app

== ri-orchestration-app image:https://img.shields.io/badge/License-EPL%202.0-blue.svg["EPL 2.0", link="https://www.eclipse.org/legal/epl-2.0/"]

This microservice was created as a result of the OpenReq project funded by the European Union Horizon 2020 Research and Innovation programme under grant agreement No 732463.

== Technical description
=== What does the microservice do
This microservice is responsible for the coordination of all microservices that belong to the domain of app store data. The main goal of this microservice is to define apps that should be continuously observed by OpenReq. In its current state, the microservice first initiates a recurring crawling, classification, and finally storing process of app reviews that mention a given account. To achieve this, this miroservice calls the following microservices of OpenReq:

- Crawler: link:https://github.com/OpenReqEU/https://github.com/OpenReqEU/ri-collection-explicit-feedback-google-play-page[ri-collection-explicit-feedback-google-play-page]

- Crawler: link:https://github.com/OpenReqEU/ri-collection-explicit-feedback-google-play-review[ri-collection-explicit-feedback-google-play-review]

- Storage: link:https://github.com/OpenReqEU/ri-storage-app[ri-storage-app]

- Classifier: link:https://github.com/OpenReqEU/ri-analytics-classification-google-play-review[ri-analytics-classification-google-play-review]

=== Which technologies are used
- Go (-> https://github.com/golang/go)
- Gorilla Mux (-> https://github.com/gorilla/mux)

=== How to install it
- setup and start the microservices: link:https://github.com/OpenReqEU/https://github.com/OpenReqEU/ri-collection-explicit-feedback-google-play-page[ri-collection-explicit-feedback-google-play-page]
, link:https://github.com/OpenReqEU/ri-collection-explicit-feedback-google-play-review[ri-collection-explicit-feedback-google-play-review], link:https://github.com/OpenReqEU/ri-storage-app[ri-storage-app], link:https://github.com/OpenReqEU/ri-analytics-classification-google-play-review[ri-analytics-classification-google-play-review]

- Define a shared base url of all the three previously mentioned microservices called  *BASE_URL*. BASE_URL will be used as an environment variable in the Docker run command (See following section).

- An SSL certificate must be mounted to the docker image during the run build (see the following example)

- A bearer token must be added as an environment variable called *BEARER_TOKEN*


Run the following commands to start the microservice:

. docker build -t orchestrator_app .

. docker run -v "<path_to>/ca_chain.crt:/go/src/app/ca_chain.crt" -e "BASE_URL=<BASE_URL_OF_THE_REQUIRED_MICROSERVICES>"  -e "BEARER_TOKEN=<token>" -p 9702:9702 orchestrator_app

=== How to use it (high-level description)
The API is documented by using Swagger2:

- link:http://217.172.12.199/registry/#/services/ri-orchestration-app[Rendered Documentation]

=== Notes for developers 
None.

=== Sources
None.

== How to contribute
See OpenReq project contribution link:https://github.com/OpenReqEU/OpenReq/blob/master/CONTRIBUTING.md[Guidlines]

== License
Free use of this software is granted under the terms of the EPL version 2 (EPL2.0).