Skip to content

Commit 7755fcb

Browse files
committed
Finalize the new sections structure and the content
Part of #2066
1 parent f159ec8 commit 7755fcb

File tree

1 file changed

+25
-30
lines changed

1 file changed

+25
-30
lines changed

doc/reference/configuration/index.rst

Lines changed: 25 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -163,6 +163,8 @@ URI values can be set in a number of ways:
163163
}
164164
}
165165
166+
.. _index-uri-several-params:
167+
166168
Also, starting from version 2.10.0, it is possible to specify additional parameters for URIs.
167169
You can do this in different ways:
168170

@@ -302,13 +304,11 @@ particular parameter, for example, the listen address, say ``box.cfg.listen``.
302304

303305
.. _box-cfg-params-prior:
304306

305-
Configuration parameter sources / priority
306-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
307-
308-
[TBD]--title
307+
Methods of setting and priorities
308+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
309309

310310
Tarantool configuration parameters can be specified in different ways.
311-
[TBD] The priority of parameter sources is the following, from higher to lower:
311+
The priority of parameter sources is the following, from higher to lower:
312312

313313
* ``box.cfg{}`` call
314314
* :ref:`environment variables <box-cfg-params-env>`
@@ -317,48 +317,43 @@ Tarantool configuration parameters can be specified in different ways.
317317

318318
.. _box-cfg-params-env:
319319

320-
Configuration parameters via environment variables
321-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
322-
323-
[TBD]--1) title 2) intro
324-
325-
[TBD--do we need this?] As described before, you can specify configuration parameters via environment variables
326-
and then pass them to ``box.cfg{}`` by using the ``os.getenv()`` function (see the :ref:`example <index-init-example>`).
320+
Setting via environment variables
321+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
327322

328-
Starting from version :doc:`2.8.1 </release/2.8.1>`, you can specify such parameters [via environment variables] in much easier way.
323+
Starting from version :doc:`2.8.1 </release/2.8.1>`, you can specify configuration parameters via special environment variables.
324+
The name of a variable should have the following pattern: ``TT_<NAME>``,
325+
where ``<NAME>`` is the uppercase name of the corresponding :ref:`box.cfg parameter <box-cfg-params-ref>`.
329326

330-
[TBD] The name of a variable should have the following pattern: ``TT_<NAME>``,
331-
where ``<NAME>`` is the uppercase name of the corresponding ``box.cfg`` option.
332-
333-
[TBD]--maybe give an example with the value, and only for tt_listen.
334327
For example:
335328

336329
* ``TT_LISTEN``---corresponds to the ``box.cfg.listen`` option.
337-
* ``TT_REPLICATION``---corresponds to the ``box.cfg.replication`` option..
338-
339-
[TBD] On Tarantool start and the ``box.cfg{}`` call, the values of the ``TT_<NAME>`` environment variables will be set for the corresponding configuration parameters.
340-
[TBD] ?Note on priorities?
330+
* ``TT_REPLICATION``---corresponds to the ``box.cfg.replication`` option.
341331

342-
[TBD] Array values should be separated by comma without space:
332+
In case of an array value, separate the array elements by comma without space:
343333

344334
.. code-block:: console
345335
346-
export TT_REPLICATION="localhost:3301,localhost:3302" [TBD] кавычки
336+
export TT_REPLICATION="localhost:3301,localhost:3302"
347337
348-
[TBD] An empty variable (``TT_LISTEN=``) has the effect as an unset one [meaning that the corresponding configuration parameter won't be set when calling ``box.cfg{}``].
338+
If you need to pass :ref:`additional parameters for URI <index-uri-several-params>`, use the ``?`` and ``&`` delimiters:
349339

350340
.. code-block:: console
351341
352342
export TT_LISTEN="localhost:3301?param1=value1&param2=value2"
353343
354-
Parameters reference
355-
~~~~~~~~~~~~~~~~~~~~
344+
An empty variable (``TT_LISTEN=``) has the same effect as an unset one meaning that the corresponding configuration parameter won't be set when calling ``box.cfg{}``.
345+
346+
.. _box-cfg-params-ref:
347+
348+
Reference
349+
~~~~~~~~~
356350

357-
[TBD]--1) title 2) intro phrase and possibly local ToC
351+
The sections that follow describe all configuration parameters for basic operations, storage,
352+
binary logging and snapshots, replication, networking, logging, and feedback.
358353

359-
The sections that follow describe all parameters for basic operation, for storage,
360-
for binary logging and snapshots, for replication, for networking,
361-
for logging, and for feedback.
354+
.. contents::
355+
:local:
356+
:depth: 1
362357

363358
Basic parameters
364359
^^^^^^^^^^^^^^^^

0 commit comments

Comments
 (0)