Versions Compared

Key

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

Saga

...

Configuration

The Saga configuration can be use for the core library only or with the server, all the features available for the core library will work in the server, but the features for the server 

Server Access

  • (server only) 
    Parameter
    summaryPort of the Saga server
    default8080
    nameapiPort
    typeinteger
  • (server only) 
    Parameter
    summaryIp address the server will be listening for request
    default0.0.0.0
    nameipAddress

Security 

  • Parameter
    Parameter
    summarySecurity configuration
    namesecurity
    typejson

    • Parameter
      summaryIndicates the encryption key used in all encryption/decryption process
      nameencryptionKey
    • Parameter
      summaryPath to the file holding the encryption key. Recommended over encryptionKey
      nameencryptionKeyFile

      Note

      We recommend the use of encryptionKeyFile over the encriptionKey directly in the configuration file. Never use both a the same time

    • (server only) 
      Parameter
      summaryUser profiles definitions, an array of json objects, each one representing a user
      nameusers
      typejson
      • (server only) 
        Parameter
        summaryuser account
        nameusername
      • (server only) 
        Parameter
        summaryUser password
        namepassword
      • (server only) 
        Parameter
        summaryUser roles
        name
    libraryJars
      • roles
        typestring array
         (not yes in use)
  • (server only) 
    Parameter
    summarySSL configuration
    nametagManagerssl
    typejson
    • (server only) 
      Parameter
      summaryEnables and disables the use of the SSL
      defaultfalse
      nameenable
      typeboolean
    • (server only) 
      Parameter
      summarykey store holding the certificate
      namekeyStore
    • (server only) 
      Parameter
      summaryPassword of the key store
      nameresourcekeyStorePassword

Export & Import

  • (server only) parameter
    Parameter
    summaryConfiguration for the export functionality
    namepipelineManagerexportSettings
    typejson
    • (server only) 
      Parameter
      summaryMaximum size in megabytes for each zip generated by the export
      namemaxSize
      typeinteger
    • (server only) 
      Parameter
      summaryQuantity of entries per file
      namebatchSize
      typeinteger

External Libraries & Classes

  • Parameter
    summaryLocations for external libraries, the locations can be either folder paths or paths directly to the jars files
    namelibraryJars
    typestring array
  • (server only) 
    Parameter
    summaryIndicates 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
    namerestHandlers
    typestring array
  • (server only) 
    Parameter
    summaryIndicates 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
    typestring array
  • (server only) 
    Parameter
    summaryConfiguration for the GTP3 proxy
    namegpt3
    • (server only) 
      Parameter
      summarySecret key for the OpenAI API
      namekey

Providers & Resources

  • Parameter
    resource
    Parameter
    summaryProvider configurations
    nameproviders
    typejson
    • Parameter
      namename
    • Parameter
      nametype
  • 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
    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
  • Parameter
    namesolutions
    typejson


Code Block
languagejs
themeRDark
{
  "config": {
    "apiPort": 8080,
    "ipAddress": "0.0.0.0",
    "security": {
      "enable": false,
      "encryptionKey": "SDFW$%GW$S%S#",
      "encryptionKeyFile": "./bin/saga.ek",
      "users": [{
        "username": "admin",
        "password": "password",
        "roles": "admin"
      }]
    },
    "libraryJars": [
      "./lib"
    ],
    "tagManager": {
      "resource": "saga-provider:saga_tags"
    },
    "pipelineManager": {
      "resource": "saga-provider:saga_pipelines"
    },
    "providersdatasetFolder": ["./datasets",
     "ssl": {
        "nameenable": "filesystem-provider"false,
        "typekeyStore": "FileSystem./bin/saga.jks",
        "baseDirkeyStorePassword": "./configencrypted:NxepNROIgJ27pYpmKEw30llscPA8zCUpbQW676E7H8Nwo9DMABKQsIYF3fcSxQGG"
      },
    "exportSettings" : {
        "namemaxSize" : "saga-provider"40,
        "typebatchSize" : "Elastic",5000
    },
    "schemerestHandlers": "http"[],
    "models": [],
    "hostnameuiHandlers": "localhost"[],
        "portgpt3": 9200,{
        "timestampkey": "updatedAt",encrypted:7E7nI0+ofh//r1bFvTQCnY7DQlG6Kh4aA1TQlh44/NoxR0DDzHaeZdBXqYAguEXc"
    },
    "excludeproviders": [
      {
        "name": "updatedAtfilesystem-provider",
        "type":  "createdAtFileSystem",
        ]

"baseDir": "./config"
      }
    ],
    "solutions": [
      {
        "displayname": "Sagasaga-provider",
        "elasticSearchtype": {"Elastic",
          "scheme": "http",
          "hostname": "localhost",
          "port": 9200,
          "indexNametimestamp": "sagaupdatedAt",
          "timeoutexclude": 30,[
          "delayupdatedAt": 5,
          "retriescreatedAt": 3
        }]
      }
    ]
  }
}

Saga Server Configuration

...

Parameter
default8080
nameapiPort
typeinteger

...

Parameter
nameipAddress
Parameter
namesecurity
typejson
  • Parameter
    nameusers
    typejson
    • Parameter
      nameusername
    • Parameter
      namepassword
    • Parameter
      nameroles
      typestring array

...

Parameter
namedatasetFolder

...

Parameter
namessl
  • Parameter
    defaultfalse
    nameenable
    typeboolean
  • Parameter
    namekeyStore
  • Parameter
    namekeyStorePassword

...

Parameter
nameexportSettings
typejson
  • Parameter
    namemaxSize
    typeinteger
  • Parameter
    namebatchSize
    typeinteger

...

Parameter
namerestHandlers
typestring array

...

Parameter
namemodels
typestring array

...

Parameter
nameuiHandlers
typestring array

...

Parameter
namegpt3
  • Parameter
    namekey
Code Block
languagejs
themeRDark
{
  "config": {
    "apiPort": 8080,
    "ipAddress": "0.0.0.0",

    "security": {
      "enable": false,
,
    "solutions": [
      {
        "display": "Saga",
        "userselasticSearch": [{
          "usernamescheme": "adminhttp",
          "passwordhostname": "passwordlocalhost",
          "rolesport": "admin"9200,
      }]
    },
    "datasetFolderindexName": "./datasetssaga",
    "ssl": {
      "enabletimeout": false30,
      "keyStore": "./bin/saga.jks",
      "keyStorePassworddelay": "encrypted:NxepNROIgJ27pYpmKEw30llscPA8zCUpbQW676E7H8Nwo9DMABKQsIYF3fcSxQGG"
    }5,
    "exportSettings" : {
      "maxSizeretries" : 40,3
      "batchSize" : 5000}
      },
    "restHandlers": [],
  }
}


Saga Server Configuration


Code Block
languagejs
themeRDark
{
  "modelsconfig": [],{
    "uiHandlers": [],

    "gpt3security": {
      "key": "encrypted:7E7nI0+ofh//r1bFvTQCnY7DQlG6Kh4aA1TQlh44/NoxR0DDzHaeZdBXqYAguEXc"
    },
    }
  }
}