Versions Compared

Key

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

...

  • 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
        nameroles
        typestring array
         (not yes in use yet)
  • (server only) 
    Parameter
    summarySSL configuration
    namessl
    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
      namekeyStorePassword

...

  • Parameter
    summaryProvider configurations
    nameproviders
    typejson

        Each provider has it own configuration, which will not be review in this section
    • 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
  • 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
  • (server only) 
    Parameter
    summaryConnections for the server user interface (one at the moment ¯\_(ツ)_/¯ ). Use to manage the patterns, tags, and pretty much every single stored element in elasticsearch
    namesolutions
    typejson


Saga Core & Server Configuration

Here you can see a sample configuration (not functional) 

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"
    },
    "datasetFolder": "./datasets",
    "ssl": {
      "enable": false,
      "keyStore": "./bin/saga.jks",
      "keyStorePassword": "encrypted:NxepNROIgJ27pYpmKEw30llscPA8zCUpbQW676E7H8Nwo9DMABKQsIYF3fcSxQGG"
    },
    "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",
        "scheme": "http",
        "hostname": "localhost",
        "port": 9200,
        "timestamp": "updatedAt",
        "exclude": [
          "updatedAt",
          "createdAt"
        ]
      }
    ],
    "solutions": [
      {
        "display": "Saga",
        "elasticSearch": {
          "scheme": "http",
          "hostname": "localhost",
          "port": 9200,
          "indexName": "saga",
          "timeout": 30,
          "delay": 5,
          "retries": 3
        }
      }
    ]
  }
}

Saga Server Configuration

Code Block
languagejs
themeRDark
{
  "config": {
    

    "security": {
      
    },
    
  }
}