Configuration Parameters

This page lists the configuration parameters that are available for gadmin config.

To change a parameter, use the following command:

$ gadmin config set <parameter> <value>

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.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.RebuildThreadNumber	The number of rebuild threads for GPE	3
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;
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.RLSPort	The serving port of GSE RLS	8900

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.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.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	10
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.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.StartStopRequestTimeoutMS	The start/stop service default request timeout in milliseconds	300000

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.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.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.)	nan
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.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	uaTFLSuq563z0ru9n7A4yrNedwIvfcpL
System.Backup.CompressProcessNumber	The number of concurrent process for compression during backup	8
System.Backup.Local.Enable	Backup data to local path	false
System.Backup.Local.Path	The path to store the backup files	nan
System.Backup.S3.AWSAccessKeyID	The AWS access key ID for s3 bucket of backup	nan
System.Backup.S3.AWSSecretAccessKey	The secret access key for s3 bucket	nan
System.Backup.S3.BucketName	The S3 bucket name	nan
System.Backup.S3.Enable	Backup data to S3 path	false
System.Backup.TimeoutSec	The backup timeout in seconds	18000
System.CrossRegionReplication.Enabled	Enable Kafka Mirrormaker	false
System.CrossRegionReplication.GpeTopicPrefix	The prefix of GPE Kafka Topic, by default is empty.	nan
System.CrossRegionReplication.PrimaryKafkaIPs	Kafka mirrormaker primary cluster's IPs, separator by ','	nan
System.CrossRegionReplication.PrimaryKafkaPort	Kafka mirrormaker primary cluster's KafkaPort	30002
System.DataRoot	The root directory for data	/home/tigergraph/tigergraph/data
System.Event.EventInputTopic	Kafka topic name of event input queue	EventInputQueue
System.Event.EventOffsetFolderRelativePath	The relative path (to the System.DataRoot) of the folder to keep track of Kafka offsets for event input/output queue	offset
System.Event.EventOutputTopic	Kafka topic name of event output queue	EventOutputQueue
System.Expansion.TimeoutSec	The backup timeout in seconds	18000
System.HostList	The aliases and hostnames/IPs for nodes	[{"ID":"m1","Hostname":"192.168.1.1","Region":"r1"},{"ID":"m2","Hostname":"192.168.1.2","Region":"r2"}]
System.License	The license key for TigerGraph system	nan
System.LogRoot	The root directory for TigerGraph logs	/home/tigergraph/tigergraph/log
System.SSH.ConfigFileRelativePath	The relative path (to the System.DataRoot) of SSH config file	ssh/ssh_config
System.SSH.Port	SSH port	22
System.SSH.User.Password	OS User password (optional if using privatekey)	tigergraph
System.SSH.User.Privatekey	OS user private key path	nan
System.SSH.User.Username	OS Username for TigerGraph database	tigergraph
System.TempRoot	The temporary directory for TigerGraph applications	/tmp

TS3

Name	Description	Example
TS3.BasicConfig.Env	The runtime environment variables, separated by ';'	nan
TS3.BasicConfig.LogConfig.LogFileMaxDurationDay	The maximum number of days to retain old log files based on the timestamp encoded in their filename	90
TS3.BasicConfig.LogConfig.LogFileMaxSizeMB	The maximum size in megabytes of the log file before it gets rotated	100
TS3.BasicConfig.LogConfig.LogLevel	The log level("DEBUG","INFO","WARN","ERROR","PANIC","FATAL"), default is INFO	INFO
TS3.BasicConfig.LogConfig.LogRotationFileNumber	The maximum number of old log files to retain	100
TS3.BasicConfig.LogDirRelativePath	The relative path (to the System.LogRoot) of log directory for TS3	ts3
TS3.BasicConfig.Nodes	The node list for TS3	[{"HostID":"m1","Partition":1,"Replica":0},{"HostID":"m2","Partition":2,"Replica":0}]
TS3.BufferSize	The buffer size of TS3	10
TS3.DBRelativePath	The relative path (to the System.DataRoot) of TS3 database source folder	ts3/db
TS3.DbTrace	Enable tracing for db operations	false
TS3.Metrics	The metrics TS3 will be collecting	cpu,mem,diskspace,qps,servicestate,network,connection
TS3.RetentionPeriodDay	The period in days for local database records to keep, set -1 for keeping forever	30

TS3Server

Name	Description	Example
TS3Server.BasicConfig.Env	The runtime environment variables, separated by ';'	nan
TS3Server.BasicConfig.LogConfig.LogFileMaxDurationDay	The maximum number of days to retain old log files based on the timestamp encoded in their filename	90
TS3Server.BasicConfig.LogConfig.LogFileMaxSizeMB	The maximum size in megabytes of the log file before it gets rotated	100
TS3Server.BasicConfig.LogConfig.LogLevel	The log level("DEBUG","INFO","WARN","ERROR","PANIC","FATAL"), default is INFO	INFO
TS3Server.BasicConfig.LogConfig.LogRotationFileNumber	The maximum number of old log files to retain	100
TS3Server.BasicConfig.LogDirRelativePath	The relative path (to the System.LogRoot) of log directory for TS3Serer	ts3serv
TS3Server.BasicConfig.Nodes	The node list for TS3Server(Currently only support one node)	[{"HostID":"m1","Partition":0,"Replica":1},{"HostID":"m2","Partition":0,"Replica":2}]
TS3Server.GrpcPort	The grpc api port for TS3Server	19001
TS3Server.RestPort	The restful api port for TS3Server	19000

ZK

Name	Description	Example
ZK.BasicConfig.Env	The runtime environment variables, separated by ';'	ZK_SERVER_HEAP=4096;
ZK.BasicConfig.LogConfig.LogFileMaxSizeMB	The maximum size in megabytes of the log file before it gets rotated	100
ZK.BasicConfig.LogConfig.LogLevel	The log level for zk ("TRACE", "DEBUG", "INFO", "WARN", "ERROR", "FATAL" "OFF")	INFO
ZK.BasicConfig.LogConfig.LogRotationFileNumber	The maximum number of old log files to retain	100
ZK.BasicConfig.LogDirRelativePath	The relative path (to the System.LogRoot) of log directory for ZK	zk
ZK.BasicConfig.Nodes	The node list for Zookeeper	[{"HostID":"m1","Partition":0,"Replica":1},{"HostID":"m2","Partition":0,"Replica":2}]
ZK.DataRelativePath	The data dir of zookeeper under $DataRoot	zk
ZK.ElectionPort	The port for Zookeeper to do leader election	3888
ZK.ForceSync	The force syncronize property of zookeeper	false
ZK.InitLimit	The amount of time, in ticks(by default 2s for one tick), to allow followers to connect and sync to a leader. Increased this value as needed, if the amount of data managed by ZooKeeper is large	30
ZK.Port	The serving port for Zookeeper	19999
ZK.QuorumPort	The port for Zookeeper to do peer communication	2888