Skip to content

Commit 7842958

Browse files
patiencedaurpatiencedaur
authored
Add environment variable names for documented configuration options (#2876)
* Add env var names for documented cfg options Resolves #2722 * Remove wrong information about not running box.cfg{} Resolves #1012 * Update translation Sources: * List of dynamic parameters: https://github.com/tarantool/tarantool/blob/47fbd24a848bd7ccf6235434f9e6619d1fb2dc06/src/box/lua/load_cfg.lua#L312-L369 * List of default values: https://github.com/tarantool/tarantool/blob/47fbd24a848bd7ccf6235434f9e6619d1fb2dc06/src/box/lua/load_cfg.lua#L38-L132
1 parent 078d355 commit 7842958

File tree

11 files changed

+95
-44
lines changed

11 files changed

+95
-44
lines changed

‎doc/reference/configuration/cfg_basic.rst

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@
2525

2626
| Type: boolean
2727
| Default: false
28+
| Environment variable: TT_BACKGROUND
2829
| Dynamic: no
2930
3031
.. _cfg_basic-custom_proc_title:
@@ -54,6 +55,7 @@
5455
5556
| Type: string
5657
| Default: null
58+
| Environment variable: TT_CUSTOM_PROC_TITLE
5759
| Dynamic: yes
5860
5961
.. _cfg_basic-listen:
@@ -86,6 +88,7 @@
8688

8789
| Type: integer or string
8890
| Default: null
91+
| Environment variable: TT_LISTEN
8992
| Dynamic: yes
9093
9194
.. _cfg_basic-memtx_dir:
@@ -99,6 +102,7 @@
99102

100103
| Type: string
101104
| Default: "."
105+
| Environment variable: TT_MEMTX_DIR
102106
| Dynamic: no
103107
104108
.. _cfg_basic-pid_file:
@@ -111,6 +115,7 @@
111115

112116
| Type: string
113117
| Default: null
118+
| Environment variable: TT_PID_FILE
114119
| Dynamic: no
115120
116121
.. _cfg_basic-read_only:
@@ -129,6 +134,7 @@
129134

130135
| Type: boolean
131136
| Default: false
137+
| Environment variable: TT_READ_ONLY
132138
| Dynamic: yes
133139
134140
Setting ``read_only == true`` affects spaces differently depending on the
@@ -160,6 +166,7 @@
160166

161167
| Type: number
162168
| Default: 5242880
169+
| Environment variable: TT_SQL_CACHE_SIZE
163170
| Dynamic: yes
164171
165172
.. _cfg_basic-vinyl_dir:
@@ -173,6 +180,7 @@
173180

174181
| Type: string
175182
| Default: "."
183+
| Environment variable: TT_VINYL_DIR
176184
| Dynamic: no
177185
178186
.. _cfg_basic-vinyl_timeout:
@@ -191,6 +199,7 @@
191199

192200
| Type: float
193201
| Default: 60
202+
| Environment variable: TT_VINYL_TIMEOUT
194203
| Dynamic: yes
195204
196205
.. _cfg_basic-username:
@@ -201,6 +210,7 @@
201210

202211
| Type: string
203212
| Default: null
213+
| Environment variable: TT_USERNAME
204214
| Dynamic: no
205215
206216
.. _cfg_basic-wal_dir:
@@ -216,6 +226,7 @@
216226

217227
| Type: string
218228
| Default: "."
229+
| Environment variable: TT_WAL_DIR
219230
| Dynamic: no
220231
221232
.. _cfg_basic-work_dir:
@@ -242,6 +253,7 @@
242253

243254
| Type: string
244255
| Default: null
256+
| Environment variable: TT_WORK_DIR
245257
| Dynamic: no
246258
247259

@@ -257,6 +269,7 @@
257269

258270
| Type: integer
259271
| Default: 4
272+
| Environment variable: TT_WORKER_POOL_THREADS
260273
| Dynamic: yes
261274
262275
.. _cfg_basic-strip_core:
@@ -270,6 +283,7 @@
270283

271284
| Type: boolean
272285
| Default: true
286+
| Environment variable: TT_STRIP_CORE
273287
| Dynamic: no
274288
275289
.. _cfg_basic-memtx_use_mvcc_engine:
@@ -281,4 +295,5 @@
281295

282296
| Type: boolean
283297
| Default: false
298+
| Environment variable: TT_MEMTX_USE_MVCC_ENGINE
284299
| Dynamic: no

‎doc/reference/configuration/cfg_binary_logging_snapshots.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@
2121

2222
| Type: boolean
2323
| Default: false
24+
| Environment variable: TT_FORCE_RECOVERY
2425
| Dynamic: no
2526
2627
.. _cfg_binary_logging_snapshots-wal_max_size:
@@ -34,6 +35,7 @@
3435

3536
| Type: integer
3637
| Default: 268435456 (256 * 1024 * 1024) bytes
38+
| Environment variable: TT_WAL_MAX_SIZE
3739
| Dynamic: no
3840
3941
.. _cfg_binary_logging_snapshots-snap_io_rate_limit:
@@ -53,6 +55,7 @@
5355

5456
| Type: float
5557
| Default: null
58+
| Environment variable: TT_SNAP_IO_RATE_LIMIT
5659
| Dynamic: **yes**
5760
5861
.. _cfg_binary_logging_snapshots-wal_mode:
@@ -70,6 +73,7 @@
7073

7174
| Type: string
7275
| Default: "write"
76+
| Environment variable: TT_WAL_MODE
7377
| Dynamic: no
7478
7579
.. _cfg_binary_logging_snapshots-wal_dir_rescan_delay:
@@ -83,4 +87,5 @@
8387

8488
| Type: float
8589
| Default: 2
90+
| Environment variable: TT_WAL_DIR_RESCAN_DELAY
8691
| Dynamic: no

‎doc/reference/configuration/cfg_hot_standby.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,4 +47,5 @@
4747

4848
| Type: boolean
4949
| Default: false
50+
| Environment variable: TT_HOT_STANDBY
5051
| Dynamic: no

‎doc/reference/configuration/cfg_logging.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@
2828

2929
| Type: integer
3030
| Default: 5
31+
| Environment variable: TT_LOG_LEVEL
3132
| Dynamic: **yes**
3233
3334
Warning: prior to Tarantool 1.7.5 there were only six levels and ``DEBUG`` was
@@ -111,6 +112,7 @@
111112

112113
| Type: string
113114
| Default: null
115+
| Environment variable: TT_LOG
114116
| Dynamic: no
115117
116118
.. _cfg_logging-log_nonblock:
@@ -136,6 +138,7 @@
136138

137139
| Type: boolean
138140
| Default: nil
141+
| Environment variable: TT_LOG_NONBLOCK
139142
| Dynamic: no
140143
141144
.. _cfg_logging-too_long_threshold:
@@ -149,6 +152,7 @@
149152

150153
| Type: float
151154
| Default: 0.5
155+
| Environment variable: TT_TOO_LONG_THRESHOLD
152156
| Dynamic: **yes**
153157
154158
.. _cfg_logging-log_format:
@@ -192,6 +196,7 @@
192196

193197
| Type: string
194198
| Default: 'plain'
199+
| Environment variable: TT_LOG_FORMAT
195200
| Dynamic: **yes**
196201
197202
.. _cfg_logging-logging_example:
@@ -294,6 +299,7 @@ adjust or turn off this feature.
294299

295300
| Type: boolean
296301
| Default: true
302+
| Environment variable: TT_FEEDBACK_ENABLED
297303
| Dynamic: **yes**
298304
299305
.. _cfg_logging-feedback_host:
@@ -305,6 +311,7 @@ adjust or turn off this feature.
305311

306312
| Type: string
307313
| Default: ``https://feedback.tarantool.io``
314+
| Environment variable: TT_FEEDBACK_HOST
308315
| Dynamic: **yes**
309316
310317
.. _cfg_logging-feedback_interval:
@@ -315,4 +322,5 @@ adjust or turn off this feature.
315322

316323
| Type: float
317324
| Default: 3600
325+
| Environment variable: TT_FEEDBACK_INTERVAL
318326
| Dynamic: **yes**

‎doc/reference/configuration/cfg_networking.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@
1515

1616
| Type: float
1717
| Default: null
18+
| Environment variable: TT_IO_COLLECT_INTERVAL
1819
| Dynamic: **yes**
1920
2021
.. _cfg_networking-net_msg_max:
@@ -51,6 +52,7 @@
5152

5253
| Type: integer
5354
| Default: 768
55+
| Environment variable: TT_NET_MSG_MAX
5456
| Dynamic: **yes**
5557
5658
.. _cfg_networking-readahead:
@@ -69,6 +71,7 @@
6971

7072
| Type: integer
7173
| Default: 16320
74+
| Environment variable: TT_READAHEAD
7275
| Dynamic: **yes**
7376
7477
.. _cfg_networking-iproto_threads:
@@ -87,4 +90,5 @@
8790

8891
| Type: integer
8992
| Default: 1
93+
| Environment variable: TT_IPROTO_THREADS
9094
| Dynamic: no

‎doc/reference/configuration/cfg_replication.rst

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,7 @@
5454

5555
| Type: string
5656
| Default: null
57+
| Environment variable: TT_REPLICATION
5758
| Dynamic: **yes**
5859
5960
.. _cfg_replication-replication_anon:
@@ -197,6 +198,11 @@
197198
instance must replicate from some read-write instance,
198199
otherwise it cannot be added to the ``_cluster`` table.
199200

201+
| Type: boolean
202+
| Default: false
203+
| Environment variable: TT_REPLICATION_ANON
204+
| Dynamic: **yes**
205+
200206
.. _cfg_replication-replication_connect_timeout:
201207

202208
.. confval:: replication_connect_timeout
@@ -213,6 +219,7 @@
213219

214220
| Type: float
215221
| Default: 30
222+
| Environment variable: TT_REPLICATION_CONNECT_TIMEOUT
216223
| Dynamic: **yes**
217224
218225
.. _cfg_replication-replication_connect_quorum:
@@ -242,6 +249,7 @@
242249
243250
| Type: integer
244251
| Default: null
252+
| Environment variable: TT_REPLICATION_CONNECT_QUORUM
245253
| Dynamic: **yes**
246254
247255
.. _cfg_replication-replication_skip_conflict:
@@ -265,6 +273,7 @@
265273
266274
| Type: boolean
267275
| Default: false
276+
| Environment variable: TT_REPLICATION_SKIP_CONFLICT
268277
| Dynamic: **yes**
269278
270279

@@ -295,6 +304,7 @@
295304

296305
| Type: float
297306
| Default: 10
307+
| Environment variable: TT_REPLICATION_SYNC_LAG
298308
| Dynamic: **yes**
299309
300310
.. _cfg_replication-replication_sync_timeout:
@@ -313,6 +323,7 @@
313323

314324
| Type: float
315325
| Default: 300
326+
| Environment variable: TT_REPLICATION_SYNC_TIMEOUT
316327
| Dynamic: **yes**
317328
318329
.. _cfg_replication-replication_timeout:
@@ -331,6 +342,7 @@
331342

332343
| Type: integer
333344
| Default: 1
345+
| Environment variable: TT_REPLICATION_TIMEOUT
334346
| Dynamic: **yes**
335347
336348
.. _cfg_replication-replicaset_uuid:
@@ -380,6 +392,7 @@
380392
381393
| Type: string
382394
| Default: null
395+
| Environment variable: TT_REPLICASET_UUID
383396
| Dynamic: no
384397
385398
.. _cfg_replication-instance_uuid:
@@ -424,6 +437,7 @@
424437

425438
| Type: number
426439
| Default: 1
440+
| Environment variable: TT_INSTANCE_UUID
427441
| Dynamic: **yes**
428442
429443
.. _cfg_replication-replication_synchro_timeout:
@@ -441,6 +455,7 @@
441455

442456
| Type: number
443457
| Default: 5
458+
| Environment variable: TT_REPLICATION_SYNCHRO_TIMEOUT
444459
| Dynamic: **yes**
445460
446461
.. _cfg_replication-election_mode:
@@ -477,6 +492,7 @@
477492

478493
| Type: string
479494
| Default: 'off'
495+
| Environment variable: TT_ELECTION_MODE
480496
| Dynamic: **yes**
481497
482498
.. _cfg_replication-election_timeout:
@@ -507,4 +523,5 @@
507523

508524
| Type: number
509525
| Default: 5
526+
| Environment variable: TT_ELECTION_TIMEOUT
510527
| Dynamic: **yes**

‎doc/reference/configuration/cfg_snapshot_daemon.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,7 @@ The checkpoint daemon and the Tarantool garbage collector will not delete a file
6969

7070
| Type: integer
7171
| Default: 3600 (one hour)
72+
| Environment variable: TT_CHECKPOINT_INTERVAL
7273
| Dynamic: yes
7374
7475
.. _cfg_checkpoint_daemon-checkpoint_count:
@@ -98,6 +99,7 @@ The checkpoint daemon and the Tarantool garbage collector will not delete a file
9899

99100
| Type: integer
100101
| Default: 2
102+
| Environment variable: TT_CHECKPOINT_COUNT
101103
| Dynamic: yes
102104
103105
.. _cfg_checkpoint_daemon-checkpoint_wal_threshold:
@@ -130,4 +132,5 @@ The checkpoint daemon and the Tarantool garbage collector will not delete a file
130132

131133
| Type: integer
132134
| Default: 10^18 (a large number so in effect there is no limit by default)
135+
| Environment variable: TT_CHECKPOINT_WAL_THRESHOLD
133136
| Dynamic: yes

0 commit comments

Comments
 (0)