Page History

...

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
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

...

Parameter

summary	Provider configurations
name	providers
type	json

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

...

Code Block

language	js
theme	RDark

{
  "config": {
    "apiPort": 8080,
    "secureApiPort": 443,
    "host": "0.0.0.0",
    "allow-domains": "localhost",
	"serverTimeout": 30000,
	"disableHTTPSSLVerification": false,
     "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": "",
		"trustAllSSL": false,
           "timeout": 90,
        "delay": 5,
        "retries": 3,
        "exclude": [ ]
      }
    ],
 	"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": [ ]
    }
    "gpt3": {
      "key": "",
      "openAIHost": "https://api.openai.com",
      "openAIAPIVersion": "v1"
    }
  }
}

Page tree

Versions Compared

Old Version 26

New Version Current

Key