Pre-requisites

1. Docker and docker-compose installed
   1. It can be Docker Desktop or just the Engine in a Linux/Unix environment (or in Windows with WSL, we have this guide on how to install Docker via WSL).
2. Download SAGA-Quickstart.zip
3. Have an Artifactory account (to be able to download the images from the docker repository).
   1. If you do not have access to Artifactory or do not remember your credentials, please contact the Support Team and they will help you out.

Saga Suite Installation (Saga-Server / ESUI / Python Bridge)

In order to run all elements of the SAGA Suite and Elasticsearch, the saga-quickstart.zip contains the files needed. So, the steps to run are the following:

1. Unzip the saga-quickstart.zip

2. Open a Command prompt (CMD/Powershell in Windows, sh/bash in Linux) and login to the docker artifactory repository

   Code Block
   docker login docker.repository.sca.accenture.com

   You will be prompted for your credentials (registered email and password).

   Info
   This step is only required the first time, once you have logged in, Docker will remember the credentials so you do not need to re-run this command.

   
   

   
   

3. Execute the quickstart script. 
   1. In windows, you can execute the bat file by clicking on it or inside a Command line.

   2. In linux, you may need first to give execution permissions before running the shell file.

      Code Block
      chmod +x saga-quickstart.sh

      
      

      
      

   3. Then you will be asked for what SAGA you want to start, because you can select one for vanilla SAGA and another with the Tensorflow model (it is a bigger image, so keep that in mind when running the script).

      
      

      Info
      There are two more options within the shell script, in case you need to execute the script using sudo permissions, this happens when docker is not configured properly and requires to use sudo each time a docker command is run.

4. Wait until all containers have started.
   1. Saga-Server will be deployed to the port 8080.
   2. ESUI to the port 3000.
   3. Python-Bridge to 5000.
   4. And Elasticsearch to 9200.

Saga Suite Uninstallation

When you are done with your work, you can remove everything by executing the uninstall scripts (bat in Windows, sh in Linux).

saga-cleanup.bat - Windows

saga-cleanup.sh - Linux

This cleanup script stops the docker containers running, deletes them after stopped and removes the network where they were running.

Single Official Images

Saga-Server

Now, if you only require the docker image of Saga-Server, then you do not need to download, run and mount the whole quickstart from above.

You can get pull the image from our official repository using:

docker pull docker.repository.sca.accenture.com/docker/saga-server:1.3.3-javacio17-base //OR
docker pull docker.repository.sca.accenture.com/docker/saga-server:1.3.3-tensor-javacio17-base

And from then you can configure it and use it as you need, however there are some things you need to know before pulling and running this docker image:

1. If it is your first time pulling the images, you will need to login with docker to our artifactory, otherwise, you will not be able to pull the image.

   Code Block
   docker login docker.repository.sca.accenture.com

   Then, as said before, you must enter your artifactory credentials.

2. In order to run this image you need to have an Elasticsearch running and set the config for SAGA to point to that Elasticsearch.
3. Now, this image has an entrypoint, which makes it executable from the start, so, when you run the image, it will try to override some configurations and start SAGA, so now, you do not need to enter the container and manually start the server.
4. This same entrypoint script accepts and overrides different environmental variables in order to configure SAGA server at runtime, these are the following:

   1. SAGA_CONFIG : this JSON-like string contains all the config to overwrite the default one that comes with the image. It must be a one liner string due to environmental limitations when using docker.
      For example:
      
      This is a fragment of the config for SAGA to run. 

      Code Block
      collapse true
      { "config": { "apiPort": 8080, "secureApiPort": 443, "host": "0.0.0.0", "allow-domains": "localhost", "serverTimeout": 30000, "maxRequestPayloadSize": 1000000, "cors": { "allow_origins": [ "http://localhost:8080", "https://localhost", "https://login.microsoftonline.com" ], "allow_credentials": "true", "allow_methods": ["*"], "allow_headers": ["*"], "expose_headers": ["*"] }, "security": { "enable": false, "encryptionKeyFile" : "./bin/saga.ek", "inactiveInterval": 600, "defaultRole": "admin", "users": [{ "username": "admin", "password": "notpassword", "roles": "admin" }], "type": "none", "openid": { "serverURL": "http://localhost:8080", "clientId": "clientId", "discoveryURI": "discoveryURI" } }, "ssl": { "enable": false, "keyStore": "./bin/saga.jks", "keyStorePassword": "encrypted:KCe8RrPQ8MV3po8NqHo0G7q7sa6T6yzf1JrTQ5VD0uty0elmrqRuybaAmrEHJ37d" }, "libraryJars": [ "./lib" ], "exportSettings" : { "maxSize" : 40, "batchSize" : 5000 }, "restHandlers": [], "models": [], "uiHandlers": [], "providers": [ { "name": "filesystem-provider", "type": "FileSystem", "baseDir": "./config" }, { "name": "saga-provider", "type": "Elastic", "nodeUrls": ["http://localhost:9200"], "timestamp": "updatedAt", "indexName": "saga", "encryptionKeyFile" : "./bin/saga.ek", "authentication": "none", "caFilePath": "", "timeout": 90, "delay": 5, "retries": 3, "exclude": [ ] } ], "gpt3": { "key": "", "openAIHost": "https://api.openai.com", "openAIAPIVersion": "v1" } } }

      And this is in the one-liner style that the SAGA_CONFIG environmental variable accepts:

      Code Block
      collapse true
      {"config":{"apiPort":8080,"secureApiPort":443,"host":"0.0.0.0","allow-domains":"localhost","serverTimeout":30000,"maxRequestPayloadSize":1000000,"cors":{"allow_origins":["http://localhost:8080","https://localhost","https://login.microsoftonline.com"],"allow_credentials":"true","allow_methods":["*"],"allow_headers":["*"],"expose_headers":["*"]},"security":{"enable":false,"encryptionKeyFile":"./bin/saga.ek","inactiveInterval":600,"defaultRole":"admin","users":[{"username":"admin","password":"notpassword","roles":"admin"}],"type":"none","openid":{"serverURL":"http://localhost:8080","clientId":"clientId","discoveryURI":"discoveryURI"}},"ssl":{"enable":false,"keyStore":"./bin/saga.jks","keyStorePassword":"encrypted:KCe8RrPQ8MV3po8NqHo0G7q7sa6T6yzf1JrTQ5VD0uty0elmrqRuybaAmrEHJ37d"},"libraryJars":["./lib"],"exportSettings":{"maxSize":40,"batchSize":5000},"restHandlers":[],"models":[],"uiHandlers":[],"providers":[{"name":"filesystem-provider","type":"FileSystem","baseDir":"./config"},{"name":"saga-provider","type":"Elastic","nodeUrls":["http://localhost:9200"],"timestamp":"updatedAt","indexName":"saga","encryptionKeyFile":"./bin/saga.ek","authentication":"none","caFilePath":"","timeout":90,"delay":5,"retries":3,"exclude":[]}],"gpt3":{"key":"","openAIHost":"https://api.openai.com","openAIAPIVersion":"v1"}}}

      Note
      This SAGA_CONFIG is temporal, we needed a way to configure environmental variables quickly. In the future, all the configurations will have their own environmental variable.

   2. JAVA_INITIAL_MEMORY : The amount of initial memory Saga will start with. Default is '6g'.
   3. JAVA_MAX_MEMORY : 'The amount of initial memory Saga will start with. Default is '10g'.
   4. JAVA_META_MEMORY : The amount of initial memory Saga will start with. Default is '512m'.

   5. JAVA_MAX_META_MEMORY : The amount of initial memory Saga will start with. Default is '1024m'.

      Info
      All these values can be marked as ‘g' for GB, ‘m' for MB and ‘k' for KB. So, '6g' is six gigabytes and '512m' are in megabytes. Also when assigning the values exclude the quotes as they are just to demonstrate they are strings.

   6. SAGA_ELASTIC_USERNAME: The username to use on the providers section to connect to Elastic/OpenSearch.

   7. SAGA_ELASTIC_PASSWORD: The password to use on the providers section when connecting to Elastic/Opensearch.

      Info
      These last two environmental variables are used together and they'll call the "SAGA-Secure" jar to encrypt the password and automatically change the values on the SAGA config file.

   8. SAGA_DISABLE_SSL_VERIFY: This will disable all SSL certificate verification on SAGA for all requests (HTTP/Direct to provider). (USE IT ONLY FOR DEVELOPMENT/STAGING)

   9. ELASTIC_CA_PATH: The custom certificate to connect to Elastic/OpenSearch via HTTPS.

   10. SAGA_CA_PATH: The password to use on the providers section when connecting to Elastic/Opensearch

       1. Info
          These last two environmental variables are used inside the docker entrypoint to import certificates to keystores. THEY NEED TO POINT TO AN EXISTING FILE INSIDE THE CONTAINER. So you can use a volume at the time of running the image or copy the certificates to build a custom image.

       
       
       

       
       

ESUI

As well as the SAGA image, you can download the Enterprise Search UI docker image and run it where you need it using:

docker pull docker.repository.sca.accenture.com/docker/esui:latest

Some of the basic configuration that can be do it via environmental variables are these:

• ESUI_PORT : The port where ESUI will start, defaults to 3000.
• ESUI_ELASTIC_URL : The location where the ElasticSearch is running, defaults to "http://localhost:9200".
• SAGA_URL : The location where SAGA server is running, defaults to "http://localhost:8080".

Python Bridge

For the Saga-Python-Bridge, the image can be downloaded using:

docker pull docker.repository.sca.accenture.com/docker/saga-python-bridge:1.3.3-ubuntu22.04cio-base

Related articles