Skip to content

Commit b1b35c8

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

File tree

3 files changed

+119
-0
lines changed

3 files changed

+119
-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: 101 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2380,6 +2380,107 @@ 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+
- :ref:`process.coredump <configuration_reference_process_coredump>`
2393+
- :ref:`process.custom_proc_title <configuration_reference_process_custom_proc_title>`
2394+
- :ref:`process.pid_file <configuration_reference_process_pid_file>`
2395+
- :ref:`process.strip_core <configuration_reference_process_strip_core>`
2396+
- :ref:`process.username <configuration_reference_process_username>`
2397+
- :ref:`process.work_dir <configuration_reference_process_work_dir>`
2398+
2399+
.. _configuration_reference_process_background:
2400+
2401+
.. confval:: process.background
2402+
2403+
Run the server as a background task.
2404+
2405+
.. important::
2406+
2407+
Do not enable the background mode for applications intended to run by the
2408+
``tt`` utility. For more information, see the :ref:`tt-start` reference.
2409+
2410+
|
2411+
| Type: boolean
2412+
| Default: false
2413+
| Environment variable: TT_PROCESS_BACKGROUND
2414+
2415+
2416+
.. _configuration_reference_process_coredump:
2417+
2418+
.. confval:: process.coredump
2419+
2420+
2421+
|
2422+
| Type: boolean
2423+
| Default: false
2424+
| Environment variable: TT_PROCESS_COREDUMP
2425+
2426+
.. _configuration_reference_process_custom_proc_title:
2427+
2428+
.. confval:: process.custom_proc_title
2429+
2430+
Sets the name of the server's process title (what’s shown in the COMMAND column for
2431+
``ps -ef`` and ``top -c`` commands).
2432+
2433+
|
2434+
| Type: string
2435+
| Default: 'tarantool - {{ instance_name }}'
2436+
| Environment variable: TT_PROCESS_CUSTOM_PROC_TITLE
2437+
2438+
.. _configuration_reference_process_pid_file:
2439+
2440+
.. confval:: process.pid_file
2441+
2442+
Store the process id in this file.
2443+
2444+
|
2445+
| Type: string
2446+
| Default: 'var/run/{{ instance_name }}/tarantool.pid'
2447+
| Environment variable: TT_PROCESS_PID_FILE
2448+
2449+
.. _configuration_reference_process_strip_core:
2450+
2451+
.. confval:: process.strip_core
2452+
2453+
Whether coredump files should include memory allocated for tuples.
2454+
(This can be large if Tarantool runs under heavy load.)
2455+
Setting to ``true`` means "do not include".
2456+
2457+
|
2458+
| Type: boolean
2459+
| Default: true
2460+
| Environment variable: TT_PROCESS_STRIP_CORE
2461+
2462+
.. _configuration_reference_process_username:
2463+
2464+
.. confval:: process.username
2465+
2466+
The name of the system user to switch to after start.
2467+
2468+
|
2469+
| Type: string
2470+
| Default: box.NULL
2471+
| Environment variable: TT_PROCESS_USERNAME
2472+
2473+
.. _configuration_reference_process_work_dir:
2474+
2475+
.. confval:: process.work_dir
2476+
2477+
A directory where Tarantool working files are stored.
2478+
2479+
|
2480+
| Type: string
2481+
| Default: box.NULL
2482+
| Environment variable: TT_PROCESS_WORK_DIR
2483+
23832484
.. _configuration_reference_replication:
23842485

23852486
replication

doc/reference/tooling/tt_cli/start.rst

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,19 @@ 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+
.. important::
48+
49+
Do not switch the application to the background mode using the cluster configuration
50+
(``process.background: true`` in the YAML configuration) or application code (``box.cfg.background = true``).
51+
If you start such an application with ``tt start``, ``tt`` won't be able to check
52+
the application status or stop it using the corresponding commands.
53+
4154
Examples
4255
--------
4356

0 commit comments

Comments
 (0)