Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • Parameter
    summaryPort of the Saga server. Use -1 to disable HTTP
    default8080
    nameapiPort
    typeinteger
  • Parameter
    summaryThe HTTPS port to use
    default443
    namesecureApiPort
    typeinteger
  • Parameter
    summaryIp address the server will be listening for request
    default0.0.0.0
    namehost
  • Parameter
    summaryServer timeout for asynchronous requests.
    default30000
    nameserverTimeout
    typedouble
  • Parameter
    summaryDisables HTTPS SSL certificate verification when doing HTTP requests to thirds (e.g. the Python-Bridge).
    defaultfalse
    namedisableHTTPSSLVerification
    typeboolean
     (ADDED on 1.3.4)
  • Parameter
    summaryMax payload size limit for requests. The value is in bytes, so the default is 1000000 bytes or 1MB.
    default1000000
    namemaxRequestPayloadSize
    typedouble

CORS (added in 1.3.3)

Manages the security configuration regarding encrypted communication and authentication

  • Parameter
    summaryCORS configuration
    namecors
    typejson

    • Parameter
      summaryList or origins to allow, if you want to allow all just add ["*"]
      default*
      nameallow_origins
      typestring array
    • Parameter
      summaryAllow credentials, values "true" or "false"
      defaulttrue
      nameallow_credentials
    • Parameter
      summaryList or methods to allow, if you want to allow all just add ["*"]
      default*
      nameallow_methods
      typestring array
    • Parameter
      summaryList or headers to allow, if you want to allow all just add ["*"]
      default*
      nameallow_headers
      typestring array
    • Parameter
      summaryList or headers to expose in the response, if you want to expose all just add ["*"]
      default*
      nameexpose_headers
      typestring array

Security 

Manages the security configuration regarding encrypted communication and authentication

...

  • Parameter
    summaryProvider configurations
    nameproviders
    typejson
    • Parameter
      summaryProvider name
      namename
    • Parameter
      summaryType of provider, the type is the name segment of the class name (e.g. TheName is the type for TheNameProvider class)
      nametype

      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
    summaryLogging Provider configurations
    namelogging_provider
    typejson
    (ADDED on 1.3.4)

    Code Block
    languagejs
    titleLogging_provider Example Configuration
    collapsetrue
    "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
    summaryTag manager configuration
    nametagManager
    typejson
    • Parameter
      summaryName of the resource to use for the tags. The value should be form by "<provider_name>:<source_name>"
      defaultsaga-provider:saga_tags
      nameresource
  • Parameter
    summaryPipeline manager configuration
    namepipelineManager
    typejson
    • Parameter
      summaryName of the resource to use for the pipelines. The value should be form by "<provider_name>:<source_name>"
      defaultsaga-provider:saga_pipelines
      nameresource

...

Code Block
languagejs
themeRDark
{
  "config": {
    "apiPort": 8080,
    "secureApiPort": 443,
    "host": "0.0.0.0",
    "securityallow-domains": "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": ["*"],
 "username     "expose_headers": ["admin*",]
    },
    "passwordsecurity": "password"{
      "enable": false,
        "rolesencryptionKeyFile" : "admin"./bin/saga.ek",
      }]
"inactiveInterval": 600,
       }"defaultRole": "admin",
      "libraryJarsusers": [{
        "username": "./libadmin",
    ],
    "tagManagerpassword": {
"notpassword",
        "resourceroles": "saga-provider:saga_tagsadmin"
      }],
      "type": "none",

      "pipelineManageropenid": {
        "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": [],
    "gpt3providers": [
      {
        "keyname": "encrypted:7E7nI0+ofh//r1bFvTQCnY7DQlG6Kh4aA1TQlh44/NoxR0DDzHaeZdBXqYAguEXc"filesystem-provider",
    }     "type": "FileSystem",
        "providersbaseDir": ["./config"
      },
      {
        "name": "filesystemsaga-provider",
        "type": "Elastic",
        "nodeUrls": ["http://localhost:9200"],
        "timestamp": "FileSystem"updatedAt",
        "indexName": "saga",
        "baseDirencryptionKeyFile" : "./config"
/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",
      "timestampindexName": "updatedAtsaga",
      "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"
    ]}
  }
}