...

• Parameter
  summary Port of the Saga server default 8080 name apiPort type integer

• Parameter
  summary Ip address the server will be listening for request default 0.0.0.0 name ipAddresshost

Security 

Manages the security configuration regarding encrypted communication and authentication

...

• 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 UI handler to use. If the class is in a non-standard package path, the whole path needs to be specified name uiHandlers 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)

...

• Parameter
  summary Configuration for the GTP3 proxy name gpt3

  • 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

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

• 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

   (server only)

  • Parameter
    summary Elasticsearch configuration name elasticSearch type json

    ParametersummaryProtocol to use for the connectiondefault

    • http
      name	schema
      Parameter
      summary List of hostnames and ports to connect to name hostnamesAndPortsnodeUrls type string array

    • Parameter
      summary This will be the prefix for all the indexes created for this Saga solution. Prefix must not contain _ (underscore) character. default saga name indexName

    • Parameter
      summary Elasticsearch username name user
      Parameter
      This will enable authentication. default none name authentication summary Path to the file holding the password name password

    • 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
      Parameter
      summary Sets the maximum of elements to fetch with each request. The default is -1 indicating no limit is set default -1 name maxResults type integer

Connecting Saga to an Elasticsearch on HTTPS

...

{
  "config": {
    "apiPort": 8080,
    "ipAddresshost": "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",
        "schemenodeUrls": ["http://localhost:9200"],
        "hostnametimestamp": "localhostupdatedAt",
        "portauthentication": 9200,
        "timestamp": "updatedAt"none",
        "exclude": [
          "updatedAt",
          "createdAt"
        ]
      }
    ],
    "solutions": [
      {
        "display": "Saga",
        "elasticSearch": {
          "schemenodeUrls": ["http://localhost:9200"],
          "hostnamesAndPortsindexName": ["server1:9210", "server2:9220"]"saga",
          "indexNameauthentication": "saganone",
          "timeout": 30,
          "delay": 5,
          "retries": 3
        }
      }
    ]
  }
}