Skip to content

Add environment variable names for documented configuration options #2876

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
May 17, 2022
Merged

Add environment variable names for documented configuration options #2876

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
00247aa
Add env var names for documented cfg options
patiencedaur May 17, 2022
b23b03b
Update translation
patiencedaur May 17, 2022
0c9b97d
Remove wrong information about not running box.cfg{}
patiencedaur May 17, 2022
7bf60d8
Update translation
patiencedaur May 17, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions doc/reference/configuration/cfg_basic.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@

| Type: boolean
| Default: false
| Environment variable: TT_BACKGROUND
| Dynamic: no

.. _cfg_basic-custom_proc_title:
Expand Down Expand Up @@ -54,6 +55,7 @@

| Type: string
| Default: null
| Environment variable: TT_CUSTOM_PROC_TITLE
| Dynamic: yes

.. _cfg_basic-listen:
Expand Down Expand Up @@ -86,6 +88,7 @@

| Type: integer or string
| Default: null
| Environment variable: TT_LISTEN
| Dynamic: yes

.. _cfg_basic-memtx_dir:
Expand All @@ -99,6 +102,7 @@

| Type: string
| Default: "."
| Environment variable: TT_MEMTX_DIR
| Dynamic: no

.. _cfg_basic-pid_file:
Expand All @@ -111,6 +115,7 @@

| Type: string
| Default: null
| Environment variable: TT_PID_FILE
| Dynamic: no

.. _cfg_basic-read_only:
Expand All @@ -129,6 +134,7 @@

| Type: boolean
| Default: false
| Environment variable: TT_READ_ONLY
| Dynamic: yes

Setting ``read_only == true`` affects spaces differently depending on the
Expand Down Expand Up @@ -160,6 +166,7 @@

| Type: number
| Default: 5242880
| Environment variable: TT_SQL_CACHE_SIZE
| Dynamic: yes

.. _cfg_basic-vinyl_dir:
Expand All @@ -173,6 +180,7 @@

| Type: string
| Default: "."
| Environment variable: TT_VINYL_DIR
| Dynamic: no

.. _cfg_basic-vinyl_timeout:
Expand All @@ -191,6 +199,7 @@

| Type: float
| Default: 60
| Environment variable: TT_VINYL_TIMEOUT
| Dynamic: yes

.. _cfg_basic-username:
Expand All @@ -201,6 +210,7 @@

| Type: string
| Default: null
| Environment variable: TT_USERNAME
| Dynamic: no

.. _cfg_basic-wal_dir:
Expand All @@ -216,6 +226,7 @@

| Type: string
| Default: "."
| Environment variable: TT_WAL_DIR
| Dynamic: no

.. _cfg_basic-work_dir:
Expand All @@ -242,6 +253,7 @@

| Type: string
| Default: null
| Environment variable: TT_WORK_DIR
| Dynamic: no


Expand All @@ -257,6 +269,7 @@

| Type: integer
| Default: 4
| Environment variable: TT_WORKER_POOL_THREADS
| Dynamic: yes

.. _cfg_basic-strip_core:
Expand All @@ -270,6 +283,7 @@

| Type: boolean
| Default: true
| Environment variable: TT_STRIP_CORE
| Dynamic: no

.. _cfg_basic-memtx_use_mvcc_engine:
Expand All @@ -281,4 +295,5 @@

| Type: boolean
| Default: false
| Environment variable: TT_MEMTX_USE_MVCC_ENGINE
| Dynamic: no
5 changes: 5 additions & 0 deletions doc/reference/configuration/cfg_binary_logging_snapshots.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@

| Type: boolean
| Default: false
| Environment variable: TT_FORCE_RECOVERY
| Dynamic: no

.. _cfg_binary_logging_snapshots-wal_max_size:
Expand All @@ -34,6 +35,7 @@

| Type: integer
| Default: 268435456 (256 * 1024 * 1024) bytes
| Environment variable: TT_WAL_MAX_SIZE
| Dynamic: no

.. _cfg_binary_logging_snapshots-snap_io_rate_limit:
Expand All @@ -53,6 +55,7 @@

| Type: float
| Default: null
| Environment variable: TT_SNAP_IO_RATE_LIMIT
| Dynamic: **yes**

.. _cfg_binary_logging_snapshots-wal_mode:
Expand All @@ -70,6 +73,7 @@

| Type: string
| Default: "write"
| Environment variable: TT_WAL_MODE
| Dynamic: no

.. _cfg_binary_logging_snapshots-wal_dir_rescan_delay:
Expand All @@ -83,4 +87,5 @@

| Type: float
| Default: 2
| Environment variable: TT_WAL_DIR_RESCAN_DELAY
| Dynamic: no
1 change: 1 addition & 0 deletions doc/reference/configuration/cfg_hot_standby.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,4 +47,5 @@

| Type: boolean
| Default: false
| Environment variable: TT_HOT_STANDBY
| Dynamic: no
8 changes: 8 additions & 0 deletions doc/reference/configuration/cfg_logging.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@

| Type: integer
| Default: 5
| Environment variable: TT_LOG_LEVEL
| Dynamic: **yes**

Warning: prior to Tarantool 1.7.5 there were only six levels and ``DEBUG`` was
Expand Down Expand Up @@ -111,6 +112,7 @@

| Type: string
| Default: null
| Environment variable: TT_LOG
| Dynamic: no

.. _cfg_logging-log_nonblock:
Expand All @@ -136,6 +138,7 @@

| Type: boolean
| Default: nil
| Environment variable: TT_LOG_NONBLOCK
| Dynamic: no

.. _cfg_logging-too_long_threshold:
Expand All @@ -149,6 +152,7 @@

| Type: float
| Default: 0.5
| Environment variable: TT_TOO_LONG_THRESHOLD
| Dynamic: **yes**

.. _cfg_logging-log_format:
Expand Down Expand Up @@ -192,6 +196,7 @@

| Type: string
| Default: 'plain'
| Environment variable: TT_LOG_FORMAT
| Dynamic: **yes**

.. _cfg_logging-logging_example:
Expand Down Expand Up @@ -294,6 +299,7 @@ adjust or turn off this feature.

| Type: boolean
| Default: true
| Environment variable: TT_FEEDBACK_ENABLED
| Dynamic: **yes**

.. _cfg_logging-feedback_host:
Expand All @@ -305,6 +311,7 @@ adjust or turn off this feature.

| Type: string
| Default: ``https://feedback.tarantool.io``
| Environment variable: TT_FEEDBACK_HOST
| Dynamic: **yes**

.. _cfg_logging-feedback_interval:
Expand All @@ -315,4 +322,5 @@ adjust or turn off this feature.

| Type: float
| Default: 3600
| Environment variable: TT_FEEDBACK_INTERVAL
| Dynamic: **yes**
4 changes: 4 additions & 0 deletions doc/reference/configuration/cfg_networking.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@

| Type: float
| Default: null
| Environment variable: TT_IO_COLLECT_INTERVAL
| Dynamic: **yes**

.. _cfg_networking-net_msg_max:
Expand Down Expand Up @@ -51,6 +52,7 @@

| Type: integer
| Default: 768
| Environment variable: TT_NET_MSG_MAX
| Dynamic: **yes**

.. _cfg_networking-readahead:
Expand All @@ -69,6 +71,7 @@

| Type: integer
| Default: 16320
| Environment variable: TT_READAHEAD
| Dynamic: **yes**

.. _cfg_networking-iproto_threads:
Expand All @@ -87,4 +90,5 @@

| Type: integer
| Default: 1
| Environment variable: TT_IPROTO_THREADS
| Dynamic: no
17 changes: 17 additions & 0 deletions doc/reference/configuration/cfg_replication.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,7 @@

| Type: string
| Default: null
| Environment variable: TT_REPLICATION
| Dynamic: **yes**

.. _cfg_replication-replication_anon:
Expand Down Expand Up @@ -197,6 +198,11 @@
instance must replicate from some read-write instance,
otherwise it cannot be added to the ``_cluster`` table.

| Type: boolean
| Default: false
| Environment variable: TT_REPLICATION_ANON
| Dynamic: **yes**

.. _cfg_replication-replication_connect_timeout:

.. confval:: replication_connect_timeout
Expand All @@ -213,6 +219,7 @@

| Type: float
| Default: 30
| Environment variable: TT_REPLICATION_CONNECT_TIMEOUT
| Dynamic: **yes**

.. _cfg_replication-replication_connect_quorum:
Expand Down Expand Up @@ -242,6 +249,7 @@

| Type: integer
| Default: null
| Environment variable: TT_REPLICATION_CONNECT_QUORUM
| Dynamic: **yes**

.. _cfg_replication-replication_skip_conflict:
Expand All @@ -265,6 +273,7 @@

| Type: boolean
| Default: false
| Environment variable: TT_REPLICATION_SKIP_CONFLICT
| Dynamic: **yes**


Expand Down Expand Up @@ -295,6 +304,7 @@

| Type: float
| Default: 10
| Environment variable: TT_REPLICATION_SYNC_LAG
| Dynamic: **yes**

.. _cfg_replication-replication_sync_timeout:
Expand All @@ -313,6 +323,7 @@

| Type: float
| Default: 300
| Environment variable: TT_REPLICATION_SYNC_TIMEOUT
| Dynamic: **yes**

.. _cfg_replication-replication_timeout:
Expand All @@ -331,6 +342,7 @@

| Type: integer
| Default: 1
| Environment variable: TT_REPLICATION_TIMEOUT
| Dynamic: **yes**

.. _cfg_replication-replicaset_uuid:
Expand Down Expand Up @@ -380,6 +392,7 @@

| Type: string
| Default: null
| Environment variable: TT_REPLICASET_UUID
| Dynamic: no

.. _cfg_replication-instance_uuid:
Expand Down Expand Up @@ -424,6 +437,7 @@

| Type: number
| Default: 1
| Environment variable: TT_INSTANCE_UUID
| Dynamic: **yes**

.. _cfg_replication-replication_synchro_timeout:
Expand All @@ -441,6 +455,7 @@

| Type: number
| Default: 5
| Environment variable: TT_REPLICATION_SYNCHRO_TIMEOUT
| Dynamic: **yes**

.. _cfg_replication-election_mode:
Expand Down Expand Up @@ -477,6 +492,7 @@

| Type: string
| Default: 'off'
| Environment variable: TT_ELECTION_MODE
| Dynamic: **yes**

.. _cfg_replication-election_timeout:
Expand Down Expand Up @@ -507,4 +523,5 @@

| Type: number
| Default: 5
| Environment variable: TT_ELECTION_TIMEOUT
| Dynamic: **yes**
3 changes: 3 additions & 0 deletions doc/reference/configuration/cfg_snapshot_daemon.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,7 @@ The checkpoint daemon and the Tarantool garbage collector will not delete a file

| Type: integer
| Default: 3600 (one hour)
| Environment variable: TT_CHECKPOINT_INTERVAL
| Dynamic: yes

.. _cfg_checkpoint_daemon-checkpoint_count:
Expand Down Expand Up @@ -98,6 +99,7 @@ The checkpoint daemon and the Tarantool garbage collector will not delete a file

| Type: integer
| Default: 2
| Environment variable: TT_CHECKPOINT_COUNT
| Dynamic: yes

.. _cfg_checkpoint_daemon-checkpoint_wal_threshold:
Expand Down Expand Up @@ -130,4 +132,5 @@ The checkpoint daemon and the Tarantool garbage collector will not delete a file

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