You are viewing an old version of this page. View the current version.
Compare with Current
View Page History
« Previous
Version 25
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. Use -1 to disable HTTP
-
secureApiPort ( type=integer
| default=443
| optional
)
- The HTTPS port to use
-
host ( type=string
| default=0.0.0.0
| optional
)
- Ip address the server will be listening for request
-
serverTimeout ( type=double
| default=30000
| optional
)
- Server timeout for asynchronous requests.
-
maxRequestPayloadSize ( type=double
| default=1000000
| optional
)
- Max payload size limit for requests. The value is in bytes, so the default is 1000000 bytes or 1MB.
CORS (added in 1.3.3)
Manages the security configuration regarding encrypted communication and authentication
-
cors ( type=json
| optional
)
- CORS configuration
-
allow_origins ( type=string array
| default=*
| optional
)
- List or origins to allow, if you want to allow all just add ["*"]
-
allow_credentials ( type=string
| default=true
| optional
)
- Allow credentials, values "true" or "false"
-
allow_methods ( type=string array
| default=*
| optional
)
- List or methods to allow, if you want to allow all just add ["*"]
-
allow_headers ( type=string array
| default=*
| optional
)
- List or headers to allow, if you want to allow all just add ["*"]
-
expose_headers ( type=string array
| default=*
| optional
)
- List or headers to expose in the response, if you want to expose all just add ["*"]
Security
Manages the security configuration regarding encrypted communication and authentication
-
security ( type=json
| optional
)
- Security configuration
-
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
-
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>"
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",
"serverTimeout": 30000
"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",
"caFilePath": "",
"exclude": []
}
]
}
}