Parameter
summary Port of the Saga server. Use -1 to disable HTTP
default 8080
name apiPort
type integer
Parameter
summary The HTTPS port to use
default 443
name secureApiPort
type integer
Parameter
summary Ip address the server will be listening for request
default 0.0.0.0
name host
Parameter
ipAddress
summary Server timeout for asynchronous requests.
default 30000
name serverTimeout
type double
Parameter
summary Disables HTTPS SSL certificate verification when doing HTTP requests to thirds (e.g. the Python-Bridge).
default false
name disableHTTPSSLVerification
type boolean
(ADDED on 1.3.4)
Parameter
summary Max payload size limit for requests. The value is in bytes, so the default is 1000000 bytes or 1MB.
default 1000000
name maxRequestPayloadSize
type double

CORS (added in 1.3.3)

Manages the security configuration regarding encrypted communication and authentication

Parameter
summary CORS configuration
name cors
type json
- Parameter
  summary List or origins to allow, if you want to allow all just add ["*"]
  default *
  name allow_origins
  type string array
- Parameter
  summary Allow credentials, values "true" or "false"
  default true
  name allow_credentials
- Parameter
  summary List or methods to allow, if you want to allow all just add ["*"]
  default *
  name allow_methods
  type string array
- Parameter
  summary List or headers to allow, if you want to allow all just add ["*"]
  default *
  name allow_headers
  type string array
- Parameter
  summary List or headers to expose in the response, if you want to expose all just add ["*"]
  default *
  name expose_headers
  type string array

Security

Manages the security configuration regarding encrypted communication and authentication

Parameter
summary Security configuration
name security
type json
- Parameter
  summary Enables or not the security
  default false
  name enable
  type boolean
- Parameter
  summary Indicates the encryption key used in all encryption/decryption process
  name encryptionKey
- Parameter
  summary Path to the file holding the encryption key. Recommended over encryptionKey
  name encryptionKeyFile
- Parameter
  summary Number of seconds of inactivity before expiring a session
  default 600
  name inactiveInterval
  type integer

Note
We recommend the use of encryptionKeyFile over the

...

encryptionKey directly in the configuration file. Never use both a the same time

...

Parameter

summary	User profiles definitions, an array of json objects, each one representing a user
name	users
type	json

...

Tip
For more details regarding Security on the Saga Server please see Security & Authentication

Parameter
summary
user accountnameusername
(server only)
Parameter
summary User password
name password
(server only)
Parameter
summary User roles
name roles
type string array
(not in use yet)

(server only)

Parameter

summary	SSL configuration
name	ssl
type	json

(server only)

Parameter
summary Enables and disables the use of the SSL
default false
name enable
type boolean
(server only)
Parameter
summary key store holding the certificate
name keyStore
(server only)
Parameter
summary Password of the key store
name keyStorePassword
(server only)

Export & Import (Server Only)

Manages the export functionality

...

Parameter
summary Configuration for the export functionality
name exportSettings
type json
- (server only)
  Parameter
  summary Maximum size in megabytes for each zip generated by the export
  name maxSize
  type integer
- (server only)
  Parameter
  summary Quantity of entries per file
  name batchSize
  type integer

...

Parameter
summary Locations for external libraries, the locations can be either folder paths or paths directly to the jars files
name libraryJars
type string array
Parameter
summary Indicates the class name of the external REST handler to use. If the class is in a non-standard package path, the whole path needs to be specified
name restHandlers
type string array
(server only)

Parameter

summary	Indicates the class name of the external REST UI handler to use. If the class is in a non-standard package path, the whole path needs to be specified
name	restHandlersuiHandlers
type	string array

(server only)

Parameter
summary Indicates the class name of the external Model to use. If the class is in a non-standard package path, the whole path needs to be specified
name models
type string array
(server only)

Server Proxys Configuration

...

(

...

Server Only)

...

Parameter
summary Configuration for the GTP3 proxy
name gpt3
(server only)
Parameter
summary Secret key for the OpenAI API
name key
Parameter
summary Host for the OpenAI API
name openAIHost
Parameter
summary OpenAI API version to use.
name openAIAPIVersion

Providers & Resources

Parameter

summary	Provider configurations
name	providers
type	json

Each provider has it own configuration, which will not be review in this section

Parameter
summary Provider name
name name

Parameter

summary	Type of provider, the type is the name segment of the class name (e.g. TheName is the type for TheNameProvider class)
name	type

Info
As explained in the Resources page, a resource provides access to a specific set of resources from a particular storage technology. In order for the Saga to use these providers, we need to specify them in the config file under the providers field. The declaration of each Resource Provider depends of the resource per se; the details of each one can be find here.

Parameter

summary	Logging Provider configurations
name	logging_provider
type	json

(ADDED on 1.3.4)

Code Block

language	js
title	Logging_provider Example Configuration
collapse	true

"logging_provider": {
      "name": "saga-logging-provider",
      "type": "Elastic",
      "nodeUrls": ["http://localhost:9200"],
      "timestamp": "updatedAt",
      "indexName": "saga",
      "encryptionKeyFile" : "./bin/saga.ek",
      "authentication": "none",
      "caFilePath": "",
      "trustAllSSL": false,
      "timeout": 90,
      "delay": 5,
      "retries": 3,
      "exclude": [ ]
    }

Parameter
summary Tag manager configuration
name tagManager
type json
- Parameter
  summary Name of the resource to use for the tags. The value should be form by "<provider_name>:<source_name>"
  default saga-provider:saga_tags
  name resource

Parameter

summary	Pipeline manager configuration
name	pipelineManager
type	json

Parameter
summary Name of the resource to use for the pipelines. The value should be form by "<provider_name>:<source_name>"
default saga-provider:saga_pipelines
name resource

(server only)

Parameter

summary	Connections for the server user interface (one at the moment ¯\_(ツ)_/¯ ). Use to manage the patterns, tags, and pretty much every single stored element in elasticsearch
name	solutions
type	json

Parameter

summary	Elasticsearch configuration
name	elasticSearch
type	json

Parameter
summary Protocol to use for the connection
default http
name schema
Parameter
summary Hostname of the Elasticsearch server
default localhost
name hostname
Parameter
summary Elasticsearch port
default 9200
name port
type integer
Parameter
summary This will be the prefix for all the indexes created for this Saga solution
default saga
name indexName
Parameter
summary Timeout in seconds for all the connections use by the user interface
default 30
name timeout
type integer
Parameter
summary Time in seconds to wait before a retry of a failed connection
default 5
name delay

Parameter

summary

Number of times to retry a failed connection

default

3

name

retries

type

integer

Connecting Saga to an Elasticsearch on HTTPS

In addition to change the schema in the 'nodeUrls' parameter in the solutions and providers sections in the config file from 'http' to 'https', you also need to add the Elasticsearch CA certificate to the java keystore using the keytool command.

Something like this:

keytool -importcert -alias elastic_ca -cacerts -storepass changeit -file /tmp/es_ca.crt -noprompt

Saga Core & Server Configuration

...

Code Block

language	js
theme	RDark

{
  "config": {
    "apiPort": 8080,
    "secureApiPort": 443,
    "ipAddresshost": "0.0.0.0",
    "allow-domains": "security"localhost",
	"serverTimeout": {
   30000,
	"disableHTTPSSLVerification": false,
    "maxRequestPayloadSize": 1000000,
    "enablecors": false,{
      "encryptionKeyallow_origins": "SDFW$%GW$S%S# [
        "http://localhost:8080",
        "encryptionKeyFile": "./bin/saga.ekhttps://localhost",
        "https://login.microsoftonline.com"
      ],
      "allow_credentials": "true",
      "usersallow_methods": [{"*"],
      "allow_headers": ["*"],
      "usernameexpose_headers": ["admin*",]
    },
    "passwordsecurity": "password",
  {
      "enable": false,
      "rolesencryptionKeyFile" : "admin"
./bin/saga.ek",
       }]
"inactiveInterval": 600,
      }"defaultRole": "admin",
      "libraryJarsusers": [{
        "./lib""username": "admin",
    ],
    "tagManagerpassword": {
"notpassword",
        "resourceroles": "saga-provider:saga_tagsadmin"
      }],
      "type": "pipelineManager"none",

      "openid": {
        "resourceserverURL": "saga-provider:saga_pipelines"http://localhost:8080",
    },
     "clientId": "clientId",
        "datasetFolderdiscoveryURI": "./datasets"discoveryURI"
      }
    },
    "ssl": {
      "enable": false,
      "keyStore": "./bin/saga.jks",
      "keyStorePassword": "encrypted:NxepNROIgJ27pYpmKEw30llscPA8zCUpbQW676E7H8Nwo9DMABKQsIYF3fcSxQGGKCe8RrPQ8MV3po8NqHo0G7q7sa6T6yzf1JrTQ5VD0uty0elmrqRuybaAmrEHJ37d"
    },
    "libraryJars": [
      "./lib"
    ],
    "exportSettings" : {
      "maxSize" : 40,
      "batchSize" : 5000
    },
    "restHandlers": [],
    "models": [],
    "uiHandlers": [],
    "gpt3": {
      "key": "encrypted:7E7nI0+ofh//r1bFvTQCnY7DQlG6Kh4aA1TQlh44/NoxR0DDzHaeZdBXqYAguEXc"
    },
    "providers": [
      {
        "name": "filesystem-provider",
        "type": "FileSystem",
        "baseDir": "./config"
      },
      {
        "name": "saga-provider",
        "type": "Elastic",
        "schemenodeUrls": ["http://localhost:9200"],
        "hostnametimestamp": "localhostupdatedAt",
        "portindexName": 9200"saga",
        "timestampencryptionKeyFile" : "updatedAt./bin/saga.ek",
        "excludeauthentication": ["none",
         "caFilePath": "updatedAt",
		"trustAllSSL": false,
        "timeout": 90,
        "createdAtdelay": 5,
         ]"retries": 3,
      }
  "exclude": [ ],
     "solutions": [}
    ],
 	"logging_provider": {
        "displayname": "Sagasaga-logging-provider",
        "elasticSearchtype": {
    "Elastic",
      "schemenodeUrls": ["http://localhost:9200"],
      "timestamp": "updatedAt",
      "hostnameindexName": "localhostsaga",
      "encryptionKeyFile" : "./bin/saga.ek",
      "portauthentication": 9200"none",
          "indexNamecaFilePath": "saga",
      "trustAllSSL": false,
      "timeout": 3090,
      "delay": 5,
      "delayretries": 53,
      "exclude": [ ]
    }
    "retriesgpt3": 3{
      "key": "",
    }  "openAIHost": "https://api.openai.com",
      }"openAIAPIVersion": "v1"
    ]}
  }
}

Page tree

Versions Compared

Old Version 6

New Version Current

Key

CORS (added in 1.3.3)

Security

Export & Import (Server Only)

Server Proxys Configuration

(

Server Only)

Parameter
summary Configuration for the GTP3 proxy
name gpt3
(server only)
Parameter
summary Secret key for the OpenAI API
name key
Parameter
summary Host for the OpenAI API
name openAIHost
Parameter
summary OpenAI API version to use.
name openAIAPIVersion

Providers & Resources

Connecting Saga to an Elasticsearch on HTTPS

Saga Core & Server Configuration

Page tree

Page History

Versions Compared

Old Version 6

New Version Current

Key

CORS (added in 1.3.3)

Security

Export & Import (Server Only)

Server Proxys Configuration

(

Server Only)

ParametersummaryConfiguration for the GTP3 proxynamegpt3(server only) ParametersummarySecret key for the OpenAI APInamekey ParametersummaryHost for the OpenAI APInameopenAIHost ParametersummaryOpenAI API version to use.nameopenAIAPIVersion

Providers & Resources

Connecting Saga to an Elasticsearch on HTTPS

Saga Core & Server Configuration

Parameter
summary Configuration for the GTP3 proxy
name gpt3
(server only)
Parameter
summary Secret key for the OpenAI API
name key
Parameter
summary Host for the OpenAI API
name openAIHost
Parameter
summary OpenAI API version to use.
name openAIAPIVersion