DOC-1800-fix-config-param-page, 3.7

tigergraph · Jun 23, 2023 · 88b1f6c · 88b1f6c
1 parent f1f358f
commit 88b1f6c
Showing 1 changed file with 52 additions and 49 deletions.
diff --git a/modules/reference/pages/configuration-parameters.adoc b/modules/reference/pages/configuration-parameters.adoc
@@ -1,16 +1,20 @@
 = Configuration parameters
 
-This page provides a compreshensive list of the parameters available for configuration with `gadmin config`.
+This page provides a comprehensive list of system configuration parameters.
+See xref:system-management:management-with-gadmin.adoc[] for how to use `gadmin config` to set configuration parameters.
 
-See xref:system-management:management-with-gadmin.adoc[] for how to set a parameter.
+The parameters are organized by TigerGraph internal component, listed here in alphabetical order: `Admin`, `Controller`, `Dict`, etc.
+
+In addition, the last table is for runtime environment variables. Each component may have a set of environment variables which are set by `xxx.BasicConfig.Env`. See `Admin.BasicConfig.Env` below for an example.
 
 == Admin
 
 [width="100%",cols="34%,33%,33%",options="header",]
 |===
 |Name |Description |Example
-|Admin.BasicConfig.Env |The runtime environment variables, separated by
-`;' |`LD_LIBRARY_PATH=$LD_LIBRARY_PATH;`
+
+|Admin.BasicConfig.Env | A list of `<environment variable>=<value>` pairs, separated by `;`
+|`LD_LIBRARY_PATH=$LD_LIBRARY_PATH;`
 
 |Admin.BasicConfig.LogConfig.LogFileMaxDurationDay |The maximum number
 of days to retain old log files based on the timestamp encoded in their
@@ -39,8 +43,7 @@ System.LogRoot) of log directory for Admin |`admin`
 [width="100%",cols="34%,33%,33%",options="header",]
 |===
 |Name |Description |Example
-|Controller.BasicConfig.Env |The runtime environment variables,
-separated by `;' |`nan`
+|Controller.BasicConfig.Env | A list of `<environment variable>=<value>` pairs, separated by `;` |`nan`
 
 |Controller.BasicConfig.LogConfig.LogFileMaxDurationDay |The maximum
 number of days to retain old log files based on the timestamp encoded in
@@ -93,8 +96,9 @@ controller |`5`
 [width="100%",cols="34%,33%,33%",options="header",]
 |===
 |Name |Description |Example
-|Dict.BasicConfig.Env |The runtime environment variables, separated by
-`;' |`LD_LIBRARY_PATH=$LD_LIBRARY_PATH;`
+
+|Dict.BasicConfig.Env | A list of `<environment variable>=<value>` pairs, separated by `;`
+|`LD_LIBRARY_PATH=$LD_LIBRARY_PATH;`
 
 |Dict.BasicConfig.LogConfig.LogFileMaxDurationDay |The maximum number of
 days to retain old log files based on the timestamp encoded in their
@@ -120,8 +124,9 @@ System.LogRoot) of log directory for Dict |`dict`
 [width="100%",cols="34%,33%,33%",options="header",]
 |===
 |Name |Description |Example
-|ETCD.BasicConfig.Env |The runtime environment variables, separated by
-`;' |`ETCD_UNSUPPORTED_ARCH=arm64`
+
+|ETCD.BasicConfig.Env | A list of `<environment variable>=<value>` pairs, separated by `;`
+|`ETCD_UNSUPPORTED_ARCH=arm64`
 
 |ETCD.BasicConfig.LogConfig.LogFileMaxDurationDay |The maximum number of
 days to retain old log files based on the timestamp encoded in their
@@ -176,8 +181,8 @@ snapshot to disk |`50000`
 [width="100%",cols="34%,33%,33%",options="header",]
 |===
 |Name |Description |Example
-|Executor.BasicConfig.Env |The runtime environment variables, separated
-by `;' |`nan`
+|Executor.BasicConfig.Env | A list of `<environment variable>=<value>` pairs, separated by `;`
+|`nan`
 
 |Executor.BasicConfig.LogConfig.LogFileMaxDurationDay |The maximum
 number of days to retain old log files based on the timestamp encoded in
@@ -221,8 +226,8 @@ file transfer |`10`
 [width="100%",cols="34%,33%,33%",options="header",]
 |===
 |Name |Description |Example
-|FileLoader.BasicConfig.Env |The runtime environment variables,
-separated by `;' |`nan`
+
+|FileLoader.BasicConfig.Env |A list of `<environment variable>=<value>` pairs, separated by `;` |`nan`
 
 |FileLoader.BasicConfig.LogConfig.LogFileMaxDurationDay |The maximum
 number of days to retain old log files based on the timestamp encoded in
@@ -277,9 +282,9 @@ response |`8500`
 [width="100%",cols="34%,33%,33%",options="header",]
 |===
 |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=34; MALLOC_CONF=prof:true,prof_active:false`
+
+|GPE.BasicConfig.Env |A list of `<environment variable>=<value>` pairs, separated by `;`
+|`LD_PRELOAD=$LD_PRELOAD; LD_LIBRARY_PATH=$LD_LIBRARY_PATH; CPUPROFILE=/tmp/tg_cpu_profiler; CPUPROFILESIGNAL=34; MALLOC_CONF=prof:true,prof_active:false; ZMQ_KEEPALIVE=1`
 
 |GPE.BasicConfig.LogConfig.LogFileMaxDurationDay |The maximum number of
 days to retain old log files based on the timestamp encoded in their
@@ -371,8 +376,14 @@ bucket counts. |`5`
 [width="100%",cols="34%,33%,33%",options="header",]
 |===
 |Name |Description |Example
-|GSE.BasicConfig.Env |The runtime environment variables, separated by
-`;'
+
+|GSE.BasicConfig.Env | A list of `<environment variable>=<value>` pairs, separated by `;`
+
+Some of the environment variables:
+`MaxLicenseViolation`: max license violation times, default/max value: 3;
+`LicenseCheckInterval`: how often (in seconds) to check license violations, default/max value: 300;
+`UpdateGraphInterval`: how often (in seconds) to pull topology info from Zookeeper, default/max value: 300
+
 |`LD_PRELOAD=$LD_PRELOAD; LD_LIBRARY_PATH=$LD_LIBRARY_PATH; CPUPROFILE=/tmp/tg_cpu_profiler; CPUPROFILESIGNAL=34; MALLOC_CONF=prof:true,prof_active:false`
 
 |GSE.BasicConfig.LogConfig.LogFileMaxDurationDay |The maximum number of
@@ -413,8 +424,8 @@ responsive after the TTL. |`30`
 [width="100%",cols="34%,33%,33%",options="header",]
 |===
 |Name |Description |Example
-|GSQL.BasicConfig.Env |The runtime environment variables, separated by
-`;' |`CPATH=$CPATH; LD_LIBRARY_PATH=$LD_LIBRARY_PATH;`
+|GSQL.BasicConfig.Env |A list of `<environment variable>=<value>` pairs, 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`
@@ -471,7 +482,7 @@ gsql |`40`
 | `2`
 
 |GSQL.ManageCatalogTimeoutSec |GSQL connection timeout (second) to admin
-server when trying to |`nan`
+server when trying to download/upload/delete catalog. Default value: 20 | 20
 
 |GSQL.MaxAuthTokenLifeTimeSec |The maximum lifetime of auth token in
 seconds, 0 means unlimited |`0`
@@ -512,8 +523,8 @@ online |`300`
 [width="100%",cols="34%,33%,33%",options="header",]
 |===
 |Name |Description |Example
-|GUI.BasicConfig.Env |The runtime environment variables, separated by
-`;' |`nan`
+|GUI.BasicConfig.Env | A list of `<environment variable>=<value>` pairs, separated by `;`
+|`nan`
 
 |GUI.BasicConfig.LogConfig.LogFileMaxDurationDay |The maximum number of
 days to retain old log files based on the timestamp encoded in their
@@ -599,8 +610,8 @@ request timeout in milliseconds |`30000`
 [width="100%",cols="34%,33%,33%",options="header",]
 |===
 |Name |Description |Example
-|Informant.BasicConfig.Env |The runtime environment variables, separated
-by `;' |`nan`
+|Informant.BasicConfig.Env | A list of `<environment variable>=<value>` pairs, separated by `;
+|`nan`
 
 |Informant.BasicConfig.LogConfig.LogFileMaxDurationDay |The maximum
 number of days to retain old log files based on the timestamp encoded in
@@ -638,8 +649,8 @@ records to keep, set -1 for keeping forever |`30`
 [width="100%",cols="34%,33%,33%",options="header",]
 |===
 |Name |Description |Example
-|Kafka.BasicConfig.Env |The runtime environment variables, separated by
-`;' |`nan`
+|Kafka.BasicConfig.Env | A list of `<environment variable>=<value>` pairs, separated by `;`
+|`nan`
 
 |Kafka.BasicConfig.LogConfig.LogFileMaxSizeMB |The maximum size in
 megabytes of the log file before it gets rotated |`100`
@@ -694,8 +705,8 @@ eligible for deletion (gigabytes) |`40`
 [width="100%",cols="34%,33%,33%",options="header",]
 |===
 |Name |Description |Example
-|KafkaConnect.BasicConfig.Env |The runtime environment variables,
-separated by `;' |`nan`
+
+|KafkaConnect.BasicConfig.Env |A list of `<environment variable>=<value>` pairs, separated by `;` |`nan`
 
 |KafkaConnect.BasicConfig.LogConfig.LogFileMaxSizeMB |The maximum size
 in megabytes of the log file before it gets rotated |`100`
@@ -737,8 +748,7 @@ attempting to retry a failed fetch request to a given topic partition
 [width="100%",cols="34%,33%,33%",options="header",]
 |===
 |Name |Description |Example
-|KafkaLoader.BasicConfig.Env |The runtime environment variables,
-separated by `;' |`nan`
+|KafkaLoader.BasicConfig.Env | A list of `<environment variable>=<value>` pairs, separated by `;` |`nan`
 
 |KafkaLoader.BasicConfig.LogConfig.LogFileMaxDurationDay |The maximum
 number of days to retain old log files based on the timestamp encoded in
@@ -793,8 +803,7 @@ node |`1`
 [width="100%",cols="34%,33%,33%",options="header",]
 |===
 |Name |Description |Example
-|KafkaStreamLL.BasicConfig.Env |The runtime environment variables,
-separated by `;' |`nan`
+|KafkaStreamLL.BasicConfig.Env | A list of `<environment variable>=<value>` pairs, separated by `;` |`nan`
 
 |KafkaStreamLL.BasicConfig.LogConfig.LogFileMaxSizeMB |The maximum size
 in megabytes of the log file before it gets rotated |`100`
@@ -882,8 +891,9 @@ the key from file) |`nan`
 [width="100%",cols="34%,33%,33%",options="header",]
 |===
 |Name |Description |Example
-|RESTPP.BasicConfig.Env |The runtime environment variables, separated by
-`;' |`LD_PRELOAD=$LD_PRELOAD; LD_LIBRARY_PATH=$LD_LIBRARY_PATH;`
+
+|RESTPP.BasicConfig.Env | A list of `<environment variable>=<value>` pairs, separated by `;`
+|`LD_PRELOAD=$LD_PRELOAD; LD_LIBRARY_PATH=$LD_LIBRARY_PATH; REPORT_FIRST_N_LINES=$REPORT_FIRST_N_LINES`
 
 |RESTPP.BasicConfig.LogConfig.LogFileMaxDurationDay |The maximum number
 of days to retain old log files based on the timestamp encoded in their
@@ -1195,8 +1205,8 @@ privatekey) |`tigergraph`
 [width="100%",cols="34%,33%,33%",options="header",]
 |===
 |Name |Description |Example
-|TS3.BasicConfig.Env |The runtime environment variables, separated by
-`;' |`nan`
+|TS3.BasicConfig.Env | A list of `<environment variable>=<value>` pairs, separated by `;`
+|`nan`
 
 |TS3.BasicConfig.LogConfig.LogFileMaxDurationDay |The maximum number of
 days to retain old log files based on the timestamp encoded in their
@@ -1237,8 +1247,8 @@ to keep, set -1 for keeping forever |`30`
 [width="100%",cols="34%,33%,33%",options="header",]
 |===
 |Name |Description |Example
-|TS3Server.BasicConfig.Env |The runtime environment variables, separated
-by `;' |`nan`
+|TS3Server.BasicConfig.Env | A list of `<environment variable>=<value>` pairs, separated by `;`
+|`nan`
 
 |TS3Server.BasicConfig.LogConfig.LogFileMaxDurationDay |The maximum
 number of days to retain old log files based on the timestamp encoded in
@@ -1271,7 +1281,7 @@ support one node)
 [width="100%",cols="34%,33%,33%",options="header",]
 |===
 |Name |Description |Example
-|ZK.BasicConfig.Env |The runtime environment variables, separated by `;'
+|ZK.BasicConfig.Env |  A list of `<environment variable>=<value>` pairs, separated by `;`
 |`ZK_SERVER_HEAP=4096;`
 
 |ZK.BasicConfig.LogConfig.LogFileMaxSizeMB |The maximum size in
@@ -1293,7 +1303,7 @@ System.LogRoot) of log directory for ZK |`zk`
 
 |ZK.ElectionPort |The port for Zookeeper to do leader election |`3888`
 
-|ZK.ForceSync |The force syncronize property of zookeeper |`false`
+|ZK.ForceSync |The force synchronize 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
@@ -1306,10 +1316,3 @@ as needed, if the amount of data managed by ZooKeeper is large |`30`
 |ZK.StartTimeoutMS |Start zookeeper timeout |`120000`
 |===
 
-== download/upload/delete catalog
-
-[cols=",,",options="header",]
-|===
-|Name |Description |Example
-|download/upload/delete catalog. Default value: 20 |nan |`nan`
-|===