Skip to content

Commit fbfb80a

Browse files
committed
Add info about background for tt start
1 parent 739976c commit fbfb80a

File tree

3 files changed

+113
-0
lines changed

3 files changed

+113
-0
lines changed

doc/reference/configuration/cfg_basic.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,11 @@
2424
and :ref:`pid_file <cfg_basic-pid_file>` parameters must be non-null for
2525
this to work.
2626

27+
.. important::
28+
29+
Do not enable the background mode for applications intended to run by the
30+
``tt`` utility. For more information, see the :ref:`tt_start` reference.
31+
2732
|
2833
| Type: boolean
2934
| Default: false

doc/reference/configuration/configuration_reference.rst

Lines changed: 97 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2380,6 +2380,103 @@ The ``memtx`` section is used to configure parameters related to the :ref:`memtx
23802380
| Default: box.NULL
23812381
| Environment variable: TT_MEMTX_SORT_THREADS
23822382
2383+
.. _configuration_reference_process:
2384+
2385+
process
2386+
-------
2387+
2388+
The ``process`` defines configuration parameters of the Tarantool process in the system.
2389+
2390+
2391+
- :ref:`process.background <configuration_reference_process_background>`
2392+
2393+
.. _configuration_reference_process_background:
2394+
2395+
.. confval:: process.background
2396+
2397+
Run the server as a background task. The :ref:`log <cfg_logging-log>`
2398+
and :ref:`pid_file <cfg_basic-pid_file>` parameters must be non-null for
2399+
this to work.
2400+
2401+
.. important::
2402+
2403+
Do not enable the background mode for applications intended to run by the
2404+
``tt`` utility. For more information, see the :ref:`tt_start` reference.
2405+
2406+
|
2407+
| Type: boolean
2408+
| Default: false
2409+
| Environment variable: TT_PROCESS_BACKGROUND
2410+
2411+
2412+
.. _configuration_reference_process_coredump:
2413+
2414+
.. confval:: process.coredump
2415+
2416+
2417+
|
2418+
| Type: boolean
2419+
| Default: false
2420+
| Environment variable: TT_PROCESS_COREDUMP
2421+
2422+
.. _configuration_reference_process_custom_proc_title:
2423+
2424+
.. confval:: process.custom_proc_title
2425+
2426+
Sets the name of the server's process title (what’s shown in the COMMAND column for
2427+
``ps -ef`` and ``top -c`` commands).
2428+
2429+
|
2430+
| Type: string
2431+
| Default: 'tarantool - {{ instance_name }}'
2432+
| Environment variable: TT_PROCESS_CUSTOM_PROC_TITLE
2433+
2434+
.. _configuration_reference_process_pid_file:
2435+
2436+
.. confval:: process.pid_file
2437+
2438+
Store the process id in this file.
2439+
2440+
|
2441+
| Type: string
2442+
| Default: 'var/run/{{ instance_name }}/tarantool.pid'
2443+
| Environment variable: TT_PROCESS_PID_FILE
2444+
2445+
.. _configuration_reference_process_strip_core:
2446+
2447+
.. confval:: process.strip_core
2448+
2449+
Whether coredump files should include memory allocated for tuples.
2450+
(This can be large if Tarantool runs under heavy load.)
2451+
Setting to ``true`` means "do not include".
2452+
2453+
|
2454+
| Type: boolean
2455+
| Default: true
2456+
| Environment variable: TT_PROCESS_STRIP_CORE
2457+
2458+
.. _configuration_reference_process_username:
2459+
2460+
.. confval:: process.username
2461+
2462+
The name of the system user to switch to after start.
2463+
2464+
|
2465+
| Type: string
2466+
| Default: box.NULL
2467+
| Environment variable: TT_PROCESS_USERNAME
2468+
2469+
.. _configuration_reference_process_work_dir:
2470+
2471+
.. confval:: process.work_dir
2472+
2473+
A directory where Tarantool working files are be stored.
2474+
2475+
|
2476+
| Type: string
2477+
| Default: box.NULL
2478+
| Environment variable: TT_PROCESS_WORK_DIR
2479+
23832480
.. _configuration_reference_replication:
23842481

23852482
replication

doc/reference/tooling/tt_cli/start.rst

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,17 @@ For more information about Tarantool application layout, see :ref:`admin-instanc
3838
which is considered a legacy approach since Tarantool 3.0. For information
3939
about using ``tt`` with such applications, refer to the Tarantool 2.11 documentation.
4040

41+
Running in the background
42+
-------------------------
43+
44+
``tt start`` runs Tarantool applications in the background and uses its own watchdog
45+
process for status checks (:ref:`tt_status`) and application stopping (:ref:`tt_stop`)
46+
47+
Do not switch the application to the background mode using the cluster configuration
48+
(``process.background: true`` in the YAML configuration) or application code (``box.cfg.background = true``).
49+
If you start such an application with ``tt start``, ``tt`` won't be able to check
50+
the application status or stop it using the corresponding commands.
51+
4152
Examples
4253
--------
4354

0 commit comments

Comments
 (0)