Configuration Parameters
This page lists the configuration parameters that are available for gadmin config.
To change a parameter, use the following command:
1
$ gadmin config set <parameter> <value>
Copied!
After updating a parameter, run gadmin config apply to apply the change and restart the corresponding services to make the change take effect.

Admin

Name
Description
Example
Admin.BasicConfig.Env
The runtime environment variables, separated by ';'
nan
Admin.BasicConfig.LogConfig.LogFileMaxDurationDay
The maximum number of days to retain old log files based on the timestamp encoded in their filename
90
Admin.BasicConfig.LogConfig.LogFileMaxSizeMB
The maximum size in megabytes of the log file before it gets rotated
100
Admin.BasicConfig.LogConfig.LogLevel
The log level("INFO","WARN","ERROR"), default is INFO
INFO
Admin.BasicConfig.LogConfig.LogRotationFileNumber
The maximum number of old log files to retain
100
Admin.BasicConfig.LogDirRelativePath
The relative path (to the System.LogRoot) of log directory for Admin
admin
Admin.BasicConfig.Nodes
The node list for Admin
[{"HostID":"m1","Partition":0,"Replica":1},{"HostID":"m2","Partition":0,"Replica":2}]
Admin.Port
The port for Admin
12471

Controller

Name
Description
Example
Controller.BasicConfig.Env
The runtime environment variables, separated by ';'
nan
Controller.BasicConfig.LogConfig.LogFileMaxDurationDay
The maximum number of days to retain old log files based on the timestamp encoded in their filename
90
Controller.BasicConfig.LogConfig.LogFileMaxSizeMB
The maximum size in megabytes of the log file before it gets rotated
100
Controller.BasicConfig.LogConfig.LogLevel
The log level("DEBUG","INFO","WARN","ERROR","PANIC","FATAL"), default is INFO
INFO
Controller.BasicConfig.LogConfig.LogRotationFileNumber
The maximum number of old log files to retain
100
Controller.BasicConfig.LogDirRelativePath
The relative path (to the System.LogRoot) of log directory for Controller
controller
Controller.BasicConfig.Nodes
The nodes to deploy Controller
[{"HostID":"m1","Partition":0,"Replica":1},{"HostID":"m2","Partition":0,"Replica":2}]
Controller.ConfigRepoRelativePath
The relative path (to the System.DataRoot) of config repo where the service config files are stored
configs
Controller.FileRepoRelativePath
The relative path (to the System.DataRoot) of the file repo for file management
files
Controller.FileRepoVersionNum
The maximum version of files to keep in the file repo
3
Controller.LeaderElectionHeartBeatIntervalMS
The maximum interval(milliseconds) at which each service should call controller leader election service to be considered alive.
6000
Controller.LeaderElectionHeartBeatMaxMiss
The maximum number of heartbeat can be missed before one service is considered dead by controller
5
Controller.Port
The serving grpc port for Controller
9188

Dict

Name
Description
Example
Dict.BasicConfig.Env
The runtime environment variables, separated by ';'
nan
Dict.BasicConfig.LogConfig.LogFileMaxDurationDay
The maximum number of days to retain old log files based on the timestamp encoded in their filename
90
Dict.BasicConfig.LogConfig.LogFileMaxSizeMB
The maximum size in megabytes of the log file before it gets rotated
100
Dict.BasicConfig.LogConfig.LogRotationFileNumber
The maximum number of old log files to retain
100
Dict.BasicConfig.LogDirRelativePath
The relative path (to the System.LogRoot) of log directory for Dict
dict
Dict.BasicConfig.Nodes
The node list for Dict
[{"HostID":"m1","Partition":0,"Replica":1},{"HostID":"m2","Partition":0,"Replica":2}]
Dict.Port
The port for Dict
17797

ETCD

Name
Description
Example
ETCD.BasicConfig.LogConfig.LogFileMaxDurationDay
The maximum number of days to retain old log files based on the timestamp encoded in their filename
90
ETCD.BasicConfig.LogConfig.LogFileMaxSizeMB
The maximum size in megabytes of the log file before it gets rotated
100
ETCD.BasicConfig.LogConfig.LogLevel
The log level("DEBUG","INFO","WARN","ERROR","PANIC","FATAL"), default is INFO
INFO
ETCD.BasicConfig.LogConfig.LogRotationFileNumber
The maximum number of old log files to retain
100
ETCD.BasicConfig.LogDirRelativePath
The relative path (to the System.LogRoot) of log directory for ETCD
etcd
ETCD.BasicConfig.Nodes
The node list for ETCD
[{"HostID":"m1","Partition":0,"Replica":1},{"HostID":"m2","Partition":0,"Replica":2}]
ETCD.ClientPort
The port of ETCD to listen for client traffic
20000
ETCD.DataRelativePath
The data dir of etcd under $DataRoot
etcd
ETCD.ElectionTimeoutMS
Time (in milliseconds) for an election to timeout
1000
ETCD.HeartbeatIntervalMS
Time (in milliseconds) of a heartbeat interval
100
ETCD.MaxRequestBytes
Maximum client request size in bytes the server will accept
52428800
ETCD.MaxSnapshots
Maximum number of snapshot files to retain (0 is unlimited)
5
ETCD.MaxTxnOps
Maximum number of operations permitted in a transaction
8192
ETCD.MaxWals
Maximum number of wal files to retain (0 is unlimited)
5
ETCD.PeerPort
The port of ETCD to listen for peer traffic
20001
ETCD.SnapshotCount
Number of committed transactions to trigger a snapshot to disk
50000

Executor

Name
Description
Example
Executor.BasicConfig.Env
The runtime environment variables, separated by ';'
nan
Executor.BasicConfig.LogConfig.LogFileMaxDurationDay
The maximum number of days to retain old log files based on the timestamp encoded in their filename
90
Executor.BasicConfig.LogConfig.LogFileMaxSizeMB
The maximum size in megabytes of the log file before it gets rotated
100
Executor.BasicConfig.LogConfig.LogLevel
The log level("DEBUG","INFO","WARN","ERROR","PANIC","FATAL"), default is INFO
INFO
Executor.BasicConfig.LogConfig.LogRotationFileNumber
The maximum number of old log files to retain
100
Executor.BasicConfig.LogDirRelativePath
The relative path (to the System.LogRoot) of log directory for Executor
executor
Executor.BasicConfig.Nodes
The nodes to deploy Executors
[{"HostID":"m1","Partition":1,"Replica":0},{"HostID":"m2","Partition":2,"Replica":0}]
Executor.DataRelativePath
The data dir of executor under $DataRoot
executor
Executor.FileTransferPort
The port for Executor to do file transfer
9178
Executor.FileVersionNum
The maximum version of files to keep
10
Executor.Port
The serving port for Executor
9177
Executor.WatchDogIntervalMS
The process status check interval (ms)
1000

FileLoader

Name
Description
Example
FileLoader.BasicConfig.Env
The runtime environment variables, separated by ';'
nan
FileLoader.BasicConfig.LogConfig.LogFileMaxDurationDay
The maximum number of days to retain old log files based on the timestamp encoded in their filename
90
FileLoader.BasicConfig.LogConfig.LogFileMaxSizeMB
The maximum size in megabytes of the log file before it gets rotated
100
FileLoader.BasicConfig.LogConfig.LogLevel
The log level("OFF", "BRIEF", "DEBUG", "VERBOSE"), default is BRIEF
BRIEF
FileLoader.BasicConfig.LogConfig.LogRotationFileNumber
The maximum number of old log files to retain
100
FileLoader.BasicConfig.LogDirRelativePath
The relative path (to the System.LogRoot) of log directory for FileLoader
fileLoader
FileLoader.Factory.DefaultLoadingTimeoutSec
The default per request loading timeout (s) for FileLoader
600
FileLoader.Factory.DefaultQueryTimeoutSec
The default query timeout (s) for FileLoader
16
FileLoader.Factory.DynamicEndpointRelativePath
FileLoader's relative (to data root) path to store the dynamic endpoint
fileLoader/endpoint/
FileLoader.Factory.DynamicSchedulerRelativePath
FileLoader's relative (to data root) path to store the dynamic scheduler
fileLoader/scheduler/
FileLoader.Factory.EnableAuth
Enable authentication of FileLoader
false
FileLoader.Factory.HandlerCount
FileLoader's handler count
4
FileLoader.Factory.StatsIntervalSec
FileLoader's time interval to collect stats (e.g. QPS)
60
FileLoader.GPEResponseBasePort
The port of FileLoader to accept GPE response
8400
FileLoader.GSEResponseBasePort
The port of FileLoader to accept GSE response
8500
FileLoader.ReplicaNumber
The number of replica of fileloader per node
1

GPE

Name
Description
Example
GPE.BasicConfig.Env
The runtime environment variables, separated by ';'
LD_PRELOAD=$LD_PRELOAD; LD_LIBRARY_PATH=$LD_LIBRARY_PATH; CPUPROFILE=/tmp/tg_cpu_profiler; CPUPROFILESIGNAL=12; MALLOC_CONF=prof:true,prof_active:false
GPE.BasicConfig.LogConfig.LogFileMaxDurationDay
The maximum number of days to retain old log files based on the timestamp encoded in their filename
90
GPE.BasicConfig.LogConfig.LogFileMaxSizeMB
The maximum size in megabytes of the log file before it gets rotated
100
GPE.BasicConfig.LogConfig.LogLevel
The log level("OFF", "BRIEF", "DEBUG", "VERBOSE"), default is BRIEF
BRIEF
GPE.BasicConfig.LogConfig.LogRotationFileNumber
The maximum number of old log files to retain
100
GPE.BasicConfig.LogDirRelativePath
The relative path (to the System.LogRoot) of log directory for GPE
gpe
GPE.BasicConfig.Nodes
The node list for GPE
[{"HostID":"m1","Partition":1,"Replica":1},{"HostID":"m2","Partition":1,"Replica":2}]
GPE.Disk.CompressMethod
The compress method of GPE disk data
nan
GPE.Disk.DiskStoreRelativePath
The path(relative to temp root) to store GPE temporary disk data
gpe/disks
GPE.Disk.LoadThreadNumber
The number of threads to load from disk
1
GPE.Disk.SaveThreadNumber
The number of threads to save to disk
1
GPE.EdgeDataMemoryLimit
The memory limit of edge data
-1
GPE.GPE2GPEResponsePort
The GPE port for receiving response back from other GPEs
7501
GPE.GPERequestPort
The GPE port for receiving requests
7502
GPE.IdResponsePort
The GPE port for receiving id response from GSE
7500
GPE.Kafka.BatchMsgNumber
The number of messages to send in one batch when using async mode. The producer will wait until either this number of messages are ready to send or queue buffer max ms is reached.
64
GPE.Kafka.CompressCodec
This parameter allows you to specify the compression codec for all data generated by this producer. Valid values are none, gzip and snappy.
none
GPE.Kafka.FetchErrorBackoffTimeMS
How long to postpone the next fetch request for a topic+partition in case of a fetch error.
6
GPE.Kafka.FetchWaitMaxTimeMS
The maximum amount of time the server will block before answering the fetch request if there isn't sufficient data to immediately satisfy fetch min bytes.
10
GPE.Kafka.MsgMaxBytes
Maximum transmit message size.
10485760
GPE.Kafka.QueueBufferMaxMsgNumber
The maximum number of unsent messages that can be queued up the producer when using async mode before either the producer must be blocked or data must be dropped.
64
GPE.Kafka.QueueBufferMaxTimeMS
Maximum time to buffer data when using async mode.
1
GPE.Kafka.QueueMinMsgNumber
Minimum number of messages per topic+partition in the local consumer queue.
100000
GPE.Kafka.RequestRequiredAcks
This field indicates how many acknowledgements the leader broker must receive from ISR brokers before responding to the request.
1
GPE.MemoryLimitMB
The total topology memory limit GPE
0
GPE.NumberOfHashBucketInBit
The number of bits used to represent hash bucket counts.
5
GPE.RebuildThreadNumber
The number of rebuild threads for GPE
3
GPE.StopTimeoutMS
Stop GPE timeout
300000
GPE.VertexDataMemoryLimit
The memory limit of vertex data
-1

GSE

Name
Description
Example
GSE.BasicConfig.Env
The runtime environment variables, separated by ';'
LD_PRELOAD=$LD_PRELOAD; LD_LIBRARY_PATH=$LD_LIBRARY_PATH; CPUPROFILE=/tmp/tg_cpu_profiler; CPUPROFILESIGNAL=12; MALLOC_CONF=prof:true,prof_active:false
GSE.BasicConfig.LogConfig.LogFileMaxDurationDay
The maximum number of days to retain old log files based on the timestamp encoded in their filename
90
GSE.BasicConfig.LogConfig.LogFileMaxSizeMB
The maximum size in megabytes of the log file before it gets rotated
100
GSE.BasicConfig.LogConfig.LogLevel
The log level("OFF", "BRIEF", "DEBUG", "VERBOSE"), default is BRIEF
BRIEF
GSE.BasicConfig.LogConfig.LogRotationFileNumber
The maximum number of old log files to retain
100
GSE.BasicConfig.LogDirRelativePath
The relative path (to the System.LogRoot) of log directory for GSE
gse
GSE.BasicConfig.Nodes
The node list for GSE
[{"HostID":"m1","Partition":1,"Replica":1},{"HostID":"m2","Partition":1,"Replica":2}]
GSE.IdRequestPort
The id request serving port of GSE
6500
GSE.JournalTopicPrefix
Kafka Topic prefix of GSE journal storage/replication
GSE_journal_
GSE.LeaderElectionHeartbeatIntervalMS
Time (in milliseconds) of the GSE heartbeat interval
60000
GSE.LeaderElectionTTLSec
The time-to-live of a GSE election participant.A GSE will be kicked out of election if one GSE is not responsive after the TTL.
30
GSE.RLSPort
The serving port of GSE RLS
8900
GSE.StopTimeoutMS
Stop GSE timeout
300000

GSQL

Name
Description
Example
GSQL.BasicConfig.Env
The runtime environment variables, separated by ';'
CPATH=$CPATH; LD_LIBRARY_PATH=$LD_LIBRARY_PATH;
GSQL.BasicConfig.LogConfig.LogFileMaxSizeMB
The maximum size in megabytes of the log file before it gets rotated
100
GSQL.BasicConfig.LogConfig.LogLevel
GSQL log level: ERROR, INFO, DEBUG
DEBUG
GSQL.BasicConfig.LogConfig.LogRotationFileNumber
The maximum number of old log files to retain
100
GSQL.BasicConfig.LogDirRelativePath
The relative path (to the System.LogRoot) of log directory for GSQL
gsql
GSQL.BasicConfig.Nodes
The node list for GSQL
[{"HostID":"m1","Partition":0,"Replica":1},{"HostID":"m2","Partition":0,"Replica":2}]
GSQL.CatalogBackupFileMaxDurationDay
The maximum number of days for catalog backup files to retain
30
GSQL.CatalogBackupFileMaxNumber
The maximum number of catalog backup files to retain
20
GSQL.DataRelativePath
The data dir of gsql under $DataRoot
gsql
GSQL.EnableStringCompress
Enable string compress
false
GSQL.FileOutputPolicy
The policy to control file outputs in GSQL queries
["/"]
GSQL.GithubBranch
The working branch in provided repository. Will use 'master' as the default branch
nan
GSQL.GithubPath
The path to the directory in the github that has TokenBank.cpp, ExprFunctions.hpp, ExprUtil.hpp, e.g. sample_code/src
nan
GSQL.GithubRepository
The repository name, e.g. tigergraph/ecosys
nan
GSQL.GithubUrl
The url that is used for github enterprise, e.g. https://api.github.com
nan
GSQL.GithubUserAcessToken
The credential for github. Set it to 'anonymous' for public access, or empty to not use github
nan
GSQL.GrpcMessageMaxSizeMB
The maximum size of grpc message request of gsql
40
GSQL.ManageCatalogTimeoutSec
GSQL connection timeout (second) to admin server when trying to
nan
GSQL.MaxAuthTokenLifeTimeSec
The maximum lifetime of auth token in seconds, 0 means unlimited
0
GSQL.OutputTokenBufferSize
The buffer size for output token from GSQL
16000000
GSQL.Port
The server port for GSQL
8123
GSQL.QueryResponseMaxSizeByte
Maximum response size in byte
33554432
GSQL.RESTPPRefreshTimeoutSec
Refresh time in Seconds of Restpp
60
GSQL.SchemaIndexFileNumber
File number
10
GSQL.TokenCleaner.GraceTimeSec
The grace time (in seconds) for expired tokens to exist without being cleaned
0
GSQL.TokenCleaner.IntervalTimeSec
The running interval of TokenCleaner in seconds
10800
GSQL.UserInfoLimit.TokenSizeLimit
The max number of tokens allowed
60000
GSQL.UserInfoLimit.UserCatalogFileMaxSizeByte
The file size limit for user metadata in byte
2097152
GSQL.UserInfoLimit.UserSizeLimit
The max number of users allowed
12000
GSQL.WaitServiceOnlineTimeoutSec
Timeout to wait for all services online
20

GUI

Name
Description
Example
GUI.BasicConfig.Env
The runtime environment variables, separated by ';'
nan
GUI.BasicConfig.LogConfig.LogFileMaxDurationDay
The maximum number of days to retain old log files based on the timestamp encoded in their filename
90
GUI.BasicConfig.LogConfig.LogFileMaxSizeMB
The maximum size in megabytes of the log file before it gets rotated
100
GUI.BasicConfig.LogConfig.LogLevel
The log level("DEBUG","INFO","WARN","ERROR","PANIC","FATAL"), default is INFO
INFO
GUI.BasicConfig.LogConfig.LogRotationFileNumber
The maximum number of old log files to retain
100
GUI.BasicConfig.LogDirRelativePath
The relative path (to the System.LogRoot) of log directory for GUI
gui
GUI.BasicConfig.Nodes
The node list for GraphStudio
[{"HostID":"m1","Partition":0,"Replica":1},{"HostID":"m2","Partition":0,"Replica":2}]
GUI.ClientIdleTimeSec
The maximum idle time of client-side GraphStudio and AdminPortal before inactivity logout
604800
GUI.Cookie.DurationSec
GUI Cookie duration time in seconds
86400
GUI.Cookie.SameSite
Default mode: 1; Lax mode: 2; Strict mode: 3; None mode: 4
3
GUI.DataDirRelativePath
The relative path of gui data folder (to the System.DataRoot)
gui
GUI.EnableDarkTheme
The boolean value on whether or not GUI should enable dark theme
true
GUI.GraphStatCheckIntervalSec
The internval(in seconds) GraphStudio wait before checking the graph statistics
10
GUI.HTTPRequest.RetryMax
GUI http request max retry times
4
GUI.HTTPRequest.RetryWaitMaxSec
GUI HTTP request max retry waiting time in seconds
30
GUI.HTTPRequest.RetryWaitMinSec
GUI HTTP request minimum retry waiting time in seconds
1
GUI.HTTPRequest.TimeoutSec
GUI HTTP request timeout in seconds
300
GUI.Port
The serving port for GraphStudio Websocket communication
14242
GUI.RESTPPResponseMaxSizeBytes
The RESTPP response size limit bytes.
33554432
GUI.TempDirRelativePath
The relative path of gui temp folder (to the System.TempRoot)
gui
GUI.TempFileMaxDurationDay
GUI temp file max duration time in days
7

Gadmin

Name
Description
Example
Gadmin.StartServiceDefaultTimeoutMS
The start one service default timeout in milliseconds
30000
Gadmin.StartStopRequestTimeoutMS
The start/stop service default request timeout in milliseconds
600000
Gadmin.StopServiceDefaultTimeoutMS
The stop one service default request timeout in milliseconds
30000

Informant

Name
Description
Example
Informant.BasicConfig.Env
The runtime environment variables, separated by ';'
nan
Informant.BasicConfig.LogConfig.LogFileMaxDurationDay
The maximum number of days to retain old log files based on the timestamp encoded in their filename
90
Informant.BasicConfig.LogConfig.LogFileMaxSizeMB
The maximum size in megabytes of the log file before it gets rotated
100
Informant.BasicConfig.LogConfig.LogLevel
The log level("DEBUG","INFO","WARN","ERROR","PANIC","FATAL"), default is INFO
INFO
Informant.BasicConfig.LogConfig.LogRotationFileNumber
The maximum number of old log files to retain
100
Informant.BasicConfig.LogDirRelativePath
The relative path (to the System.LogRoot) of log directory for Informant
informant
Informant.BasicConfig.Nodes
The nodes to deploy Informant
[{"HostID":"m1","Partition":0,"Replica":1},{"HostID":"m2","Partition":0,"Replica":2}]
Informant.DBRelativePath
The relative path (to the System.DataRoot) of informant database source folder
informant/db
Informant.GrpcPort
The grpc server port for Informant
9166
Informant.RestPort
The restful server port for Informant
9167
Informant.RetentionPeriodDay
The period in days for local database records to keep, set -1 for keeping forever
30

Kafka

Name
Description
Example
Kafka.BasicConfig.Env
The runtime environment variables, separated by ';'
nan
Kafka.BasicConfig.LogConfig.LogFileMaxSizeMB
The maximum size in megabytes of the log file before it gets rotated
100
Kafka.BasicConfig.LogConfig.LogLevel
The log level for kafka ("TRACE", "DEBUG", "INFO", "WARN", "ERROR", "FATAL" "OFF")
INFO
Kafka.BasicConfig.LogConfig.LogRotationFileNumber
The maximum number of old log files to retain
100
Kafka.BasicConfig.LogDirRelativePath
The relative path (to the System.LogRoot) of log directory for Kafka
kafka
Kafka.BasicConfig.Nodes
The node list for Kafka
[{"HostID":"m1","Partition":0,"Replica":1},{"HostID":"m2","Partition":0,"Replica":2}]
Kafka.DataRelativePath
The data dir of kafka under $DataRoot
kafka
Kafka.IOThreads
The number of threads for Kafka IO
2
Kafka.LogFlushIntervalMS
The threshold of time for flushing log (ms)
10000
Kafka.LogFlushIntervalMessage
The threshold of message for flushing log
10000
Kafka.MessageMaxSizeMB
The maximum size of a message of Kafka to be produced (megabytes)
10
Kafka.MinInsyncReplicas
The minimal number of insync replicas that must acknowledge, when producer sets acks to 'all'
1
Kafka.NetworkThreads
The number of threads for Kafka Network
4
Kafka.Port
The serving port for Kafka
30002
Kafka.RetentionHours
The minimum age of a log file of Kafka to be eligible for deletion (hours)
168
Kafka.RetentionSizeGB
The minimum size of a log file of Kafka to be eligible for deletion (gigabytes)
40
Kafka.StartTimeoutMS
Start kafka timeout
300000
Kafka.TopicReplicaFactor
The default replica number for each topic
1

KafkaConnect

Name
Description
Example
KafkaConnect.BasicConfig.Env
The runtime environment variables, separated by ';'
nan
KafkaConnect.BasicConfig.LogConfig.LogFileMaxSizeMB
The maximum size in megabytes of the log file before it gets rotated
100
KafkaConnect.BasicConfig.LogConfig.LogLevel
The log level for kafka connect ("TRACE", "DEBUG", "INFO", "WARN", "ERROR", "FATAL" "OFF")
INFO
KafkaConnect.BasicConfig.LogConfig.LogRotationFileNumber
The maximum number of old log files to retain
100
KafkaConnect.BasicConfig.LogDirRelativePath
The relative path (to the System.LogRoot) of log directory for Kafka connect
kafkaconn
KafkaConnect.BasicConfig.Nodes
The node list for Kafka connect
[{"HostID":"m1","Partition":0,"Replica":1},{"HostID":"m2","Partition":0,"Replica":2}]
KafkaConnect.MaxRequestSize
The max request size of kafka connect producer
1048576
KafkaConnect.OffsetFlushIntervalMS
The interval at which Kafka connect tasks' offsets are committed
10000
KafkaConnect.Port
The port used for kafka connect
30003
KafkaConnect.ReconnectBackoffMS
The amount of time to wait before attempting to reconnect to a given host
500
KafkaConnect.RetryBackoffMS
The amount of time to wait before attempting to retry a failed fetch request to a given topic partition
10000

KafkaLoader

Name
Description
Example
KafkaLoader.BasicConfig.Env
The runtime environment variables, separated by ';'
nan
KafkaLoader.BasicConfig.LogConfig.LogFileMaxDurationDay
The maximum number of days to retain old log files based on the timestamp encoded in their filename
90
KafkaLoader.BasicConfig.LogConfig.LogFileMaxSizeMB
The maximum size in megabytes of the log file before it gets rotated
100
KafkaLoader.BasicConfig.LogConfig.LogLevel
The log level("OFF", "BRIEF", "DEBUG", "VERBOSE"), default is BRIEF
BRIEF
KafkaLoader.BasicConfig.LogConfig.LogRotationFileNumber
The maximum number of old log files to retain
100
KafkaLoader.BasicConfig.LogDirRelativePath
The relative path (to the System.LogRoot) of log directory for KafkaLoader
kafkaLoader
KafkaLoader.Factory.DefaultLoadingTimeoutSec
The default per request loading timeout (s) for KafkaLoader
600
KafkaLoader.Factory.DefaultQueryTimeoutSec
The default query timeout (s) for KafkaLoader
16
KafkaLoader.Factory.DynamicEndpointRelativePath
KafkaLoader's relative (to data root) path to store the dynamic endpoint
kafkaLoader/endpoint/
KafkaLoader.Factory.DynamicSchedulerRelativePath
KafkaLoader's relative (to data root) path to store the dynamic scheduler
kafkaLoader/scheduler/
KafkaLoader.Factory.EnableAuth
Enable authentication of KafkaLoader
false
KafkaLoader.Factory.HandlerCount
KafkaLoader's handler count
4
KafkaLoader.Factory.StatsIntervalSec
KafkaLoader's time interval to collect stats (e.g. QPS)
60
KafkaLoader.GPEResponseBasePort
The port of KafkaLoader to accept GPE response
9400
KafkaLoader.GSEResponseBasePort
The port of KafkaLoader to accept GSE response
9500
KafkaLoader.ReplicaNumber
The number of replica of kafkaloader per node
1

KafkaStreamLL

Name
Description
Example
KafkaStreamLL.BasicConfig.Env
The runtime environment variables, separated by ';'
nan
KafkaStreamLL.BasicConfig.LogConfig.LogFileMaxSizeMB
The maximum size in megabytes of the log file before it gets rotated
100
KafkaStreamLL.BasicConfig.LogConfig.LogLevel
The log level for Kafka stream LoadingLog ("TRACE", "DEBUG", "INFO", "WARN", "ERROR", "FATAL" "OFF")
INFO
KafkaStreamLL.BasicConfig.LogConfig.LogRotationFileNumber
The maximum number of old log files to retain
100
KafkaStreamLL.BasicConfig.LogDirRelativePath
The relative path (to the System.LogRoot) of log directory for Kafka stream LoadingLog
kafkastrm-ll
KafkaStreamLL.BasicConfig.Nodes
The node list for Kafka stream LoadingLog
[{"HostID":"m1","Partition":1,"Replica":0},{"HostID":"m2","Partition":2,"Replica":0}]
KafkaStreamLL.Port
The port used for Kafka stream LoadingLog
30004
KafkaStreamLL.StateDirRelativePath
The relative folder path for Kafka stream LoadingLog state
kafkastrm-ll

Nginx

Name
Description
Example
Nginx.AllowedCIDRList
The whitelist of IPv4/IPv6 CIDR blocks to restrict the application access, separate in comma.
0.0.0.0/0, ::/0
Nginx.BasicConfig.LogConfig.LogFileMaxDurationDay
The maximum number of days to retain old log files based on the timestamp encoded in their filename
90
Nginx.BasicConfig.LogConfig.LogFileMaxSizeMB
The maximum size in megabytes of the log file before it gets rotated
100
Nginx.BasicConfig.LogConfig.LogRotationFileNumber
The maximum number of old log files to retain
100
Nginx.BasicConfig.LogDirRelativePath
The relative path (to the System.LogRoot) of log directory for Nginx
nginx
Nginx.BasicConfig.Nodes
The node list for Nginx
[{"HostID":"m1","Partition":0,"Replica":1},{"HostID":"m2","Partition":0,"Replica":2}]
Nginx.ClientMaxBodySize
The maximum request size for Nginx in MB
200
Nginx.ConfigTemplate
The template to generate nginx config. Please use @filepath to parse template from file. Check the default template first at https://docs.tigergraph.com.(Warning: Don't modify the reserved keywords(string like UPPER_CASE) in template.)
worker_processes __WORKER_PROCESSES__;\ndaemon off;\npid __NGINX_PID_PATH__;\n\nevents {\n worker_connections 10240;\n}\n\nhttp {\n\n server_tokens off;\n\n map $request_uri $request_uri_path {\n \~^(?P\u003cpath\u003e[^?]*)(\\?.*)?$\" $path;\n }\n\n log_format combined_no_query '$remote_addr - $remote_user [$time_local] '\n '\"$request_method $request_uri_path $server_protocol\" $status $body_bytes_sent '\n '\"$http_referer\" \"$http_user_agent\"';\n\n\t#Set allowed CIDR blocks\n__CIDR_LIST__\n types {\n text/html html htm shtml;\n text/css css;\n text/xml xml;\n image/gif gif;\n image/jpeg jpeg jpg;\n application/javascript js;\n application/atom+xml atom;\n application/rss+xml rss;\n\n text/mathml mml;\n text/plain txt;\n text/vnd.sun.j2me.app-descriptor jad;\n text/vnd.wap.wml wml;\n text/x-component htc;\n\n image/png png;\n image/svg+xml svg svgz;\n image/tiff tif tiff;\n image/vnd.wap.wbmp wbmp;\n image/webp webp;\n image/x-icon ico;\n image/x-jng jng;\n image/x-ms-bmp bmp;\n\n font/woff woff;\n font/woff2 woff2;\n\n application/java-archive jar war ear;\n application/json json;\n application/mac-binhex40 hqx;\n application/msword doc;\n application/pdf pdf;\n application/postscript ps eps ai;\n application/rtf rtf;\n application/vnd.apple.mpegurl m3u8;\n application/vnd.google-earth.kml+xml kml;\n application/vnd.google-earth.kmz kmz;\n application/vnd.ms-excel xls;\n application/vnd.ms-fontobject eot;\n application/vnd.ms-powerpoint ppt;\n application/vnd.oasis.opendocument.graphics odg;\n application/vnd.oasis.opendocument.presentation odp;\n application/vnd.oasis.opendocument.spreadsheet ods;\n application/vnd.oasis.opendocument.text odt;\n application/vnd.openxmlformats-officedocument.presentationml.presentation\n pptx;\n application/vnd.openxmlformats-officedocument.spreadsheetml.sheet\n xlsx;\n application/vnd.openxmlformats-officedocument.wordprocessingml.document\n docx;\n application/vnd.wap.wmlc wmlc;\n application/x-7z-compressed 7z;\n application/x-cocoa cco;\n application/x-java-archive-diff jardiff;\n application/x-java-jnlp-file jnlp;\n application/x-makeself run;\n application/x-perl pl pm;\n application/x-pilot prc pdb;\n application/x-rar-compressed rar;\n application/x-redhat-package-manager rpm;\n application/x-sea sea;\n application/x-shockwave-flash swf;\n application/x-stuffit sit;\n application/x-tcl tcl tk;\n application/x-x509-ca-cert der pem crt;\n application/x-xpinstall xpi;\n application/xhtml+xml xhtml;\n application/xspf+xml xspf;\n application/zip zip;\n\n application/octet-stream bin exe dll;\n application/octet-stream deb;\n application/octet-stream dmg;\n application/octet-stream iso img;\n application/octet-stream msi msp msm;\n\n audio/midi mid midi kar;\n audio/mpeg mp3;\n audio/ogg ogg;\n audio/x-m4a m4a;\n audio/x-realaudio ra;\n\n video/3gpp 3gpp 3gp;\n video/mp2t ts;\n video/mp4 mp4;\n video/mpeg mpeg mpg;\n video/quicktime mov;\n video/webm webm;\n video/x-flv flv;\n video/x-m4v m4v;\n video/x-mng mng;\n video/x-ms-asf asx asf;\n video/x-ms-wmv wmv;\n video/x-msvideo avi;\n }\n default_type application/octet-stream;\n client_max_body_size __MAX_BODY_SIZE__;\n\n access_log __NGINX_LOG_PER_RESTPP__ combined_no_query;\n error_log __NGINX_ERR_PER_RESTPP__;\n fastcgi_temp_path __TEMP_ROOT__;\n fastcgi_buffers 256 8k;\n\n ###### [BEGIN] customized headers ######\n __HEADER_CONFIG__\n ###### [END] customized headers ######\n\n\n keepalive_timeout 900s;\n\n upstream fastcgi_backend {\n server unix:__FASTCGI_PASS__;\n keepalive 128;\n }\n\n # Use upstream derivative for listing all gsql server \n # that could be used in requesttoken proxy_pass\n __ENABLE_RESTPP_AUTH__ upstream gsql_token_server {\n __ENABLE_RESTPP_AUTH__ __GSQL_TOKEN_SERVER_LIST__\n __ENABLE_RESTPP_AUTH__ }\n\n # Keep it for backward compatibility\n server {\n add_header Strict-Transport-Security \"max-age=63072000; includeSubdomains; preload\";\n ssl_protocols TLSv1.2;\n ssl_ciphers ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-CHACHA20-POLY1305:ECDHE-RSA-CHACHA20-POLY1305:DHE-RSA-AES128-GCM-SHA256:DHE-RSA-AES256-GCM-SHA384;\n ssl_prefer_server_ciphers on;\n listen __PORT_PER_RESTPP__ __GUI_CONNECTION_TYPE__;\n server_name localhost;\n\n fastcgi_read_timeout 72000s;\n fastcgi_send_timeout 72000s;\n\n __SSL_CERT_ATTR__ __SSL_CERT_PATH__; # if SSL is disabled, here should be '#'\n __SSL_KEY_ATTR__ __SSL_KEY_PATH__; # if SSL is disabled, here should be '#'\n\n\n location / {\n fastcgi_pass fastcgi_backend;\n fastcgi_keep_conn on;\n fastcgi_param REQUEST_METHOD $request_method;\n fastcgi_param CONTENT_TYPE $content_type;\n fastcgi_param CONTENT_LENGTH $content_length;\n fastcgi_param REQUEST_URI $request_uri;\n fastcgi_param GSQL_ASYNC $http_gsql_async;\n fastcgi_param GSQL_TIMEOUT $http_gsql_timeout;\n fastcgi_param GSQL_MEMLIMIT $http_gsql_memlimit;\n fastcgi_param RESPONSE_LIMIT $http_response_limit;\n }\n\n # To ensure the performance of RESTPP, this rule shouldn't be enabled\n # unless restpp.authentication is True.\n # And for performance consideration,\n #!!!!!!! DO NOT USE REGULAR EXPRESSION HERE !!!!!!!\n __ENABLE_RESTPP_AUTH__ location = /requesttoken {\n __ENABLE_RESTPP_AUTH__ proxy_ssl_verify __PROXY_SSL_VERIFY__;\n __ENABLE_RESTPP_AUTH__ proxy_set_header X-Real-IP $remote_addr;\n __ENABLE_RESTPP_AUTH__ proxy_pass __REQUEST_TOKEN_PROTOCOL__://gsql_token_server;\n __ENABLE_RESTPP_AUTH__ }\n }\n\n server {\n\t\tlisten __NGINX_SERVICES_PORT__ __GUI_CONNECTION_TYPE__;\n\n\t\t__SSL_CERT_ATTR__ __SSL_CERT_PATH__; # if SSL is disabled, here should be '#'\n\t\t__SSL_KEY_ATTR__ __SSL_KEY_PATH__; # if SSL is disabled, here should be '#'\n\n\t\tlocation / {\n\t\t\t# Set whether to enable compression\n\t\t\tgzip on;\n\t\t\tgzip_types\n\t\t\t\tapplication/javascript # works significantly with javascript files in GUI\n\t\t\t;\n\t\t\troot __GST_STATIC_FOLDER__;\n\t\t\ttry_files $uri $uri/ @backend;\n\t\t}\n\n\t\tlocation /assets/img/user-uploaded-icons/ {\n\t\t\talias __GUI_DATA_FOLDER__/user_icons/;\n\t\t\ttry_files $uri $uri/ = 404;\n\t\t}\n\n\t\tlocation /admin/ {\n\t\t\t# Set whether to enable compression\n\t\t\tgzip on;\n\t\t\tgzip_types\n\t\t\t\tapplication/javascript # works significantly with javascript files in GUI\n\t\t\t;\n\t\t\talias __ADMIN_PORTAL_STATIC_FOLDER__/;\n\t\t\ttry_files $uri $uri/ = 404;\n\t\t}\n\n\t\tlocation @backend {\n\t\t\tproxy_read_timeout 3600s;\n\t\t\tproxy_set_header X-Real-IP $remote_addr;\n\t\t\tproxy_pass http://localhost:__GUI_WEBSERVER_PORT__;\n\t\t}\n\n\t\tlocation ~ ^/ts3/(?\u003cts3_uri\u003e.*) {\n\t\t\tproxy_read_timeout 3600s;\n\t\t\trewrite ^/ts3/(.*) /$ts3_uri break;\n\t\t\tproxy_set_header X-Real-IP $remote_addr;\n\t\t\tproxy_pass http://localhost:__TS3_REST_PORT__;\n\t\t}\n\n\t\tlocation ~ ^/gsqlserver/(?\u003cgsql_uri\u003e.*) {\t\n\t\t\trewrite ^/gsqlserver/(.*) /$gsql_uri break;\n\t\t\tproxy_read_timeout 3600s;\n\t\t\tproxy_set_header X-Real-IP $remote_addr;\n\t\t\tproxy_pass http://localhost:__GSQL_SERVER_PORT__;\n\t\t\tproxy_http_version 1.1;\n\t\t}\n\n\t\t# This RESTPP endpoint shares the same security configuration\n\t\tfastcgi_read_timeout 72000s;\n\t\tfastcgi_send_timeout 72000s;\n\n\t\t__ENABLE_RESTPP_AUTH__ location ~ ^/restpp/(?\u003ctoken_uri\u003erequesttoken.*) {\n\t\t__ENABLE_RESTPP_AUTH__ rewrite ^/restpp/(.*) /$token_uri break;\n\t\t__ENABLE_RESTPP_AUTH__ proxy_ssl_verify __PROXY_SSL_VERIFY__;\n\t\t__ENABLE_RESTPP_AUTH__ proxy_set_header X-Real-IP $remote_addr;\n\t\t__ENABLE_RESTPP_AUTH__ proxy_pass __REQUEST_TOKEN_PROTOCOL__://gsql_token_server;\n\t\t__ENABLE_RESTPP_AUTH__ }\n\n\t\tlocation ~ ^/restpp/(.*) {\n\t\t\tfastcgi_pass fastcgi_backend;\n\t\t\tfastcgi_keep_conn on;\n\t\t\tfastcgi_param REQUEST_METHOD $request_method;\n\t\t\tfastcgi_param CONTENT_TYPE $content_type;\n\t\t\tfastcgi_param CONTENT_LENGTH $content_length;\n\t\t\tfastcgi_param REQUEST_URI $1?$query_string; # the url pattern matched above\n\t\t\tfastcgi_param GSQL_TIMEOUT $http_gsql_timeout;\n\t\t\tfastcgi_param GSQL_MEMLIMIT $http_gsql_memlimit;\n\t\t\tfastcgi_param RESPONSE_LIMIT $http_response_limit;\t \n\t\t}\n\t}\n}\n"
Nginx.Port
The serving port for Nginx
14240
Nginx.ResponseHeaders
The customized headers in HTTP Response
[{"FieldName":"X-Frame-Options","FieldValue":"SAMEORIGIN"}]
Nginx.SSL.Cert
Public certificate for SSL. (Could use @cert_file_path to parse the certificate from file)
nan
Nginx.SSL.Enable
Enable SSL connection for all HTTP requests
false
Nginx.SSL.Key
Private key for SSL. (Could use @key_file_path to parse the key from file)
nan
Nginx.WorkerProcessNumber
The number of worker processes for Nginx
4

RESTPP

Name
Description
Example
RESTPP.BasicConfig.Env
The runtime environment variables, separated by ';'
LD_PRELOAD=$LD_PRELOAD; LD_LIBRARY_PATH=$LD_LIBRARY_PATH;
RESTPP.BasicConfig.LogConfig.LogFileMaxDurationDay
The maximum number of days to retain old log files based on the timestamp encoded in their filename
90
RESTPP.BasicConfig.LogConfig.LogFileMaxSizeMB
The maximum size in megabytes of the log file before it gets rotated
100
RESTPP.BasicConfig.LogConfig.LogLevel
The log level("OFF", "BRIEF", "DEBUG", "VERBOSE"), default is BRIEF
BRIEF
RESTPP.BasicConfig.LogConfig.LogRotationFileNumber
The maximum number of old log files to retain
100
RESTPP.BasicConfig.LogDirRelativePath
The relative path (to the System.LogRoot) of log directory for RESTPP
restpp
RESTPP.BasicConfig.Nodes
The node list for RESTPP
[{"HostID":"m1","Partition":0,"Replica":1},{"HostID":"m2","Partition":0,"Replica":2}]
RESTPP.FCGISocketBackLogMaxCnt
RESTPP fcgi socket backlog max length which is the listen queue depth used in the listen() call.
36864
RESTPP.FCGISocketFileRelativePath
The relative path of FCGI socket for RESTPP-Nginx communitation under $TempRoot
rest/restpp-nginx.fcgi.sock
RESTPP.Factory.DefaultLoadingTimeoutSec
The default per request loading timeout (s) for RESTPP
600
RESTPP.Factory.DefaultQueryTimeoutSec
The default query timeout (s) for RESTPP
16
RESTPP.Factory.DynamicEndpointRelativePath
RESTPP's relative (to data root) path to store the dynamic endpoint
restpp/endpoint/
RESTPP.Factory.DynamicSchedulerRelativePath
RESTPP's relative (to data root) path to store the dynamic scheduler
restpp/scheduler/
RESTPP.Factory.EnableAuth
Enable authentication of RESTPP
false
RESTPP.Factory.HandlerCount
RESTPP's handler count
4
RESTPP.Factory.QueryMemoryLimitMB
The memory limit of query runs for container on disk. The default value is -1, meaning no limit
-1
RESTPP.Factory.StatsIntervalSec
RESTPP's time interval to collect stats (e.g. QPS)
60
RESTPP.GPEResponsePort
The port of RESTPP to accept GPE response
5400
RESTPP.GSEResponsePort
The port of RESTPP to accept GSE response
5500
RESTPP.HttpServer.Enable
Enable RESTPP's http server
false
RESTPP.HttpServer.Port
RESTPP's http server port
10000
RESTPP.HttpServer.WorkerNum
RESTPP's http server worker number
2
RESTPP.NginxPort
The port of RESTPP to accept upstream Nginx requests
9000

Security

Name
Description
Example
Security.LDAP.AdminDN
Configure the DN of LDAP user who has read access to the base DN specified above. Empty if everyone has read access to LDAP data: default empty
nan
Security.LDAP.AdminPassword
Configure the password of the admin DN specified above. Needed only when admin_dn is specified: default empty
secret
Security.LDAP.BaseDN
Configure LDAP search base DN, the root node to start the LDAP search for user authentication: must specify
nan
Security.LDAP.Enable
Enable LDAP authentication: default false
false
Security.LDAP.Hostname
Configure LDAP server hostname: default localhost
localhost
Security.LDAP.Port
Configure LDAP server port: default 389
389
Security.LDAP.SearchFilter
Configure LDAP search base DN, the root node to start the LDAP search for user authentication.
(objectClass=*)
Security.LDAP.Secure.Protocol
Enable SSL/StartTLS for LDAP connection [none/ssl/starttls]: default none
none
Security.LDAP.Secure.TrustAll
Configure to trust all LDAP servers (unsafe): default false
false
Security.LDAP.Secure.TruststoreFormat
Configure the truststore format [JKS/PKCS12]: default JKS
JKS
Security.LDAP.Secure.TruststorePassword
Configure the truststore password: default changeit
changeit
Security.LDAP.Secure.TruststorePath
Configure the truststore absolute path for the certificates used in SSL: default empty
nan
Security.LDAP.UsernameAttribute
Configure the username attribute name in LDAP server: default uid
uid
Security.SSO.SAML.AssertionSigned
Require Identity Provider to sign assertions: default true
true
Security.SSO.SAML.AuthnRequestSigned
Sign AuthnRequests before sending to Identity Provider: default true
true
Security.SSO.SAML.BuiltinUser
The builtin user for SAML
__GSQL__saml
Security.SSO.SAML.Enable
Enable SAML2-based SSO: default false
false
Security.SSO.SAML.IDP.EntityId
Identity Provider Entity ID: default http://idp.example.com
http://idp.example.com
Security.SSO.SAML.IDP.SSOUrl
Single Sign-On URL: default http://idp.example.com/sso/saml
http://idp.example.com/sso/saml
Security.SSO.SAML.IDP.X509Cert
Identity Provider's x509 Certificate filepath: default empty. You can use @/cert/file/path to pass the certificate from a file.
nan
Security.SSO.SAML.MetadataSigned
Sign Metadata: default true
true
Security.SSO.SAML.RequestedAuthnContext
Authentication context (comma separate multiple values)
nan
Security.SSO.SAML.ResponseSigned
Require Identity Provider to sign SAML responses: default true
true
Security.SSO.SAML.SP.Hostname
TigerGraph Service Provider URL: default http://127.0.0.1:14240
http://127.0.0.1:14240
Security.SSO.SAML.SP.PrivateKey
Content of the host machine's private key. Require PKCS#8 format (start with "BEGIN PRIVATE KEY"). You can use @/privatekey/file/path to pass the certificate from a file.
nan
Security.SSO.SAML.SP.X509Cert
Content of the x509 Certificate: default empty. You can use @/cert/file/path to pass the certificate from a file.
nan
Security.SSO.SAML.SignatureAlgorithm
Signiture algorithm [rsa-sha1/rsa-sha256/rsa-sha384/rsa-sha512]: default rsa-sha256
rsa-sha256

System

Name
Description
Example
System.AppRoot
The root directory for TigerGraph applications
/home/tigergraph/tigergraph/app
System.AuthToken
The authorization token for TigerGraph services