You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 17 Next »

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

Control the server's basic communication configuration

  • apiPort ( type=integer | default=8080 | optional ) - Port of the Saga server
  • host ( type=string | default=0.0.0.0 | optional ) - Ip address the server will be listening for request

Security 

Manages the security configuration regarding encrypted communication and authentication

  • security ( type=json | optional ) - Security configuration
    • enable ( type=boolean | default=false | optional ) - Enables or not the security
    • encryptionKey ( type=string | optional ) - Indicates the encryption key used in all encryption/decryption process

    • encryptionKeyFile ( type=string | optional ) - Path to the file holding the encryption key. Recommended over encryptionKey

    • inactiveInterval ( type=integer | default=600 | optional ) - Number of seconds of inactivity before expiring a session



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


    • users ( type=json | optional ) - User profiles definitions, an array of json objects, each one representing a user (server only)
      • username ( type=string | optional ) - user account (server only)
      • password ( type=string | optional ) - User password (server only)
      • roles ( type=string array | optional ) - User roles (not in use yet) (server only)
  • ssl ( type=json | optional ) - SSL configuration (server only)
    • enable ( type=boolean | default=false | optional ) - Enables and disables the use of the SSL (server only)
    • keyStore ( type=string | optional ) - key store holding the certificate (server only)
    • keyStorePassword ( type=string | optional ) - Password of the key store (server only)

Export & Import (Server Only)

Manages the export functionality

  • exportSettings ( type=json | optional ) - Configuration for the export functionality
    • maxSize ( type=integer | optional ) - Maximum size in megabytes for each zip generated by the export
    • batchSize ( type=integer | optional ) - Quantity of entries per file

External Libraries & Classes

Defines the location of external libraries and classes 

  • libraryJars ( type=string array | optional ) - Locations for external libraries, the locations can be either folder paths or paths directly to the jars files
  • restHandlers ( type=string array | optional ) - 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 (server only)
  • uiHandlers ( type=string array | optional ) - 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 (server only)
  • models ( type=string array | optional ) - 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 (server only)

Server Proxys Configuration (Server Only)

  • gpt3 ( type=string | optional ) - Configuration for the GTP3 proxy
    • key ( type=string | optional ) - Secret key for the OpenAI API
    • openAIHost ( type=string | optional ) - Host for the OpenAI API
    • openAIAPIVersion ( type=string | optional ) - OpenAI API version to use.

Providers & Resources

  • providers ( type=json | optional ) - Provider configurations
    • name ( type=string | optional ) - Provider name

    • type ( type=string | optional ) - Type of provider, the type is the name segment of the class name (e.g. TheName is the type for TheNameProvider class)

      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.

  • tagManager ( type=json | optional ) - Tag manager configuration
    • resource ( type=string | default=saga-provider:saga_tags | optional ) - Name of the resource to use for the tags. The value should be form by "<provider_name>:<source_name>"
  • pipelineManager ( type=json | optional ) - Pipeline manager configuration
    • resource ( type=string | default=saga-provider:saga_pipelines | optional ) - Name of the resource to use for the pipelines. The value should be form by "<provider_name>:<source_name>"
  • solutions ( type=json | optional ) - 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 (server only)
    • elasticSearch ( type=json | optional ) - Elasticsearch configuration
      • nodeUrls ( type=string array | optional ) - List of hostnames and ports to connect to
      • indexName ( type=string | default=saga | optional ) - This will be the prefix for all the indexes created for this Saga solution. Prefix must not contain _ (underscore) character.
      • authentication ( type=string | default=none | optional ) - This will enable authentication.
      • timeout ( type=integer | default=30 | optional ) - Timeout in seconds for all the connections use by the user interface
      • delay ( type=string | default=5 | optional ) - Time in seconds to wait before a retry of a failed connection
      • retries ( type=integer | default=3 | optional ) - Number of times to retry a failed connection


Connecting Saga to an Elasticsearch on HTTPS

In addition to change the schema in the 'nodeUrls' parameter in the solutions and providers sections in the config file from 'http' to 'https',  you also need to add the Elasticsearch CA certificate to the java keystore using the keytool command.

Something like this:

keytool -importcert -alias elastic_ca -cacerts -storepass changeit -file /tmp/es_ca.crt -noprompt

Saga Core & Server Configuration

Here you can see a sample configuration (not functional) 

{
  "config": {
    "apiPort": 8080,
    "host": "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",
        "nodeUrls": ["http://localhost:9200"],
        "timestamp": "updatedAt",
        "authentication": "none",
        "exclude": [
          "updatedAt",
          "createdAt"
        ]
      }
    ],
    "solutions": [
      {
        "display": "Saga",
        "elasticSearch": {
          "nodeUrls": ["http://localhost:9200"],
          "indexName": "saga",
          "authentication": "none",
          "timeout": 30,
          "delay": 5,
          "retries": 3
        }
      }
    ]
  }
}
  • No labels