diff --git a/doc/reference/configuration/cfg_basic.rst b/doc/reference/configuration/cfg_basic.rst index 16ce77ef71..0113e5afc5 100644 --- a/doc/reference/configuration/cfg_basic.rst +++ b/doc/reference/configuration/cfg_basic.rst @@ -24,6 +24,11 @@ and :ref:`pid_file ` parameters must be non-null for this to work. + .. important:: + + Do not enable the background mode for applications intended to run by the + ``tt`` utility. For more information, see the :ref:`tt start ` reference. + | | Type: boolean | Default: false diff --git a/doc/reference/configuration/configuration_reference.rst b/doc/reference/configuration/configuration_reference.rst index 5508a5d293..bb5d54824a 100644 --- a/doc/reference/configuration/configuration_reference.rst +++ b/doc/reference/configuration/configuration_reference.rst @@ -2380,6 +2380,107 @@ The ``memtx`` section is used to configure parameters related to the :ref:`memtx | Default: box.NULL | Environment variable: TT_MEMTX_SORT_THREADS +.. _configuration_reference_process: + +process +------- + +The ``process`` defines configuration parameters of the Tarantool process in the system. + + +- :ref:`process.background ` +- :ref:`process.coredump ` +- :ref:`process.title ` +- :ref:`process.pid_file ` +- :ref:`process.strip_core ` +- :ref:`process.username ` +- :ref:`process.work_dir ` + +.. _configuration_reference_process_background: + +.. confval:: process.background + + Run the server as a background task. + + .. important:: + + Do not enable the background mode for applications intended to run by the + ``tt`` utility. For more information, see the :ref:`tt start ` reference. + + | + | Type: boolean + | Default: false + | Environment variable: TT_PROCESS_BACKGROUND + + +.. _configuration_reference_process_coredump: + +.. confval:: process.coredump + + + | + | Type: boolean + | Default: false + | Environment variable: TT_PROCESS_COREDUMP + +.. _configuration_reference_process_title: + +.. confval:: process.title + + Sets the name of the server's process title (what’s shown in the COMMAND column for + ``ps -ef`` and ``top -c`` commands). + + | + | Type: string + | Default: 'tarantool - {{ instance_name }}' + | Environment variable: TT_PROCESS_TITLE + +.. _configuration_reference_process_pid_file: + +.. confval:: process.pid_file + + Store the process id in this file. + + | + | Type: string + | Default: 'var/run/{{ instance_name }}/tarantool.pid' + | Environment variable: TT_PROCESS_PID_FILE + +.. _configuration_reference_process_strip_core: + +.. confval:: process.strip_core + + Whether coredump files should include memory allocated for tuples. + (This can be large if Tarantool runs under heavy load.) + Setting to ``true`` means "do not include". + + | + | Type: boolean + | Default: true + | Environment variable: TT_PROCESS_STRIP_CORE + +.. _configuration_reference_process_username: + +.. confval:: process.username + + The name of the system user to switch to after start. + + | + | Type: string + | Default: box.NULL + | Environment variable: TT_PROCESS_USERNAME + +.. _configuration_reference_process_work_dir: + +.. confval:: process.work_dir + + A directory where Tarantool working files are stored. + + | + | Type: string + | Default: box.NULL + | Environment variable: TT_PROCESS_WORK_DIR + .. _configuration_reference_replication: replication diff --git a/doc/reference/tooling/tt_cli/start.rst b/doc/reference/tooling/tt_cli/start.rst index d53be291e1..43d0c5c843 100644 --- a/doc/reference/tooling/tt_cli/start.rst +++ b/doc/reference/tooling/tt_cli/start.rst @@ -38,6 +38,20 @@ For more information about Tarantool application layout, see :ref:`admin-instanc which is considered a legacy approach since Tarantool 3.0. For information about using ``tt`` with such applications, refer to the Tarantool 2.11 documentation. +Running in the background +------------------------- + +``tt start`` runs Tarantool applications in the background and uses its own watchdog +process for status checks (:ref:`tt status `) and application stopping (:ref:`tt stop `). + +.. important:: + + Do not switch on the background mode using the cluster configuration + (``process.background: true`` in the YAML configuration) or code (``box.cfg.background = true``) + in applications that you run with ``tt``. + If you start such an application with ``tt start``, ``tt`` won't be able to check + the application status or stop it using the corresponding commands. + Examples --------