Welcome to the Getting Started, this is what you will achieve by follow the next steps:
Setup the environment.
Deploy Saga.
Run Saga.
Check it's working!.
Prerequisites
Elasticsearch 6.4.1 or above.
Java 11 or above.
This guide assumes you already have an stable Saga release such as 1.0 or above.
Step 1: Set up enviroment
Check Java 11 is installed on your machine by running on terminal (or system console):
$> java -version
Uncompress Saga in your prefered location. This is our recommended setup but you can pretty much handle the paths as you wish. This guide will refer to Saga's working directory as {SAGA_HOME}.
Saga uses Elasticsearch (6.4.1 or above) and you can get it here.
Deploy Elasticsearch (ES) under {SAGA_HOME} in something like {SAGA_HOME}/Elasticsearch-6.4.1.
Run ES by executing the binary on {SAGA_HOME}/Elasticsearch-6.4.1/bin.
Step 2: Deploy Saga
Once you have Saga in {SAGA_HOME} validate the following:
There is a {SAGA_HOME}/lib folder containing the following JARs:
saga-classification-trainer-stage-1.0.0-SNAPSHOT
saga-elastic-provider-1.0.0-SNAPSHOT
saga-name-trainer-stage-1.0.0-SNAPSHOT
Step 3: Configuring the environment
Saga Server Parser configuration files are specified in the Configure Pipelines & Resource Providers section. If you change any of those files in the saga-server-parser/src/main/resources folder, you need to rebuild the project or transfer the files to the directory specified in the saga-server-parser/startup.bat.
For the UI, you need to check the file in config/env/development.js. The display name, "Saga" in following snippet, is the name the UI will show for the project, but what it is important is the uri attribute from db, this is the database that Saga will be using. In the snippet, the database in use will be "SagaDB", change it according to your preference. If you loaded a Mongo database in step 2, you must change "SagaDB" to the name of the database you loaded. If you want to start a new database, just choose a proper name and the UI will create the database.
Before starting Saga, make sure Mongo is up and running. Try to run:
...> mongo
If the command does not run, run the following command from the MongoDB/Server/3.6/bin:
.../MongoDB/Server/3.6/bin> mongod
Then, you will need to run the Saga Server Parser and the Saga Server UI. The first to be run is the Saga Server UI, since it will create the database if it doesn't exist. Go to the Saga Server UI directory and run the startup.bat from a console:
.../saga-server-ui> startup.bat
And then do the same for the Saga Server Parser:
.../saga-server-parser> startup.bat
If you didn't change the port, you should be able to access saga at http://localhost:8080/