@@ -12,10 +12,29 @@ inside the ``instances_enabled`` directory specified in the :ref:`tt configurati
12
12
For detailed instructions on preparing and running Tarantool applications, see
13
13
:ref: `admin-instance-environment-overview ` and :ref: `admin-start_stop_instance `.
14
14
15
- When called without arguments, starts all enabled applications in the current environment.
16
-
17
15
See also: :ref: `tt-stop `, :ref: `tt-restart `, :ref: `tt-status `.
18
16
17
+ To start all instances of the application stored in the ``app `` directory inside
18
+ ``instances_enabled `` in accordance with its ``instances.yml ``:
19
+
20
+ .. code-block :: console
21
+
22
+ $ tt start app
23
+
24
+ To start the ``router `` instance of the ``app `` application:
25
+
26
+ .. code-block :: console
27
+
28
+ $ tt start app:router
29
+
30
+ When called without arguments, starts all enabled applications in the current environment:
31
+
32
+ .. code-block :: console
33
+
34
+ $ tt start
35
+
36
+ .. _tt-start-app-layout :
37
+
19
38
Application layout
20
39
------------------
21
40
@@ -38,6 +57,8 @@ For more information about Tarantool application layout, see :ref:`admin-instanc
38
57
which is considered a legacy approach since Tarantool 3.0. For information
39
58
about using ``tt `` with such applications, refer to the Tarantool 2.11 documentation.
40
59
60
+ .. _tt-start-background :
61
+
41
62
Running in the background
42
63
-------------------------
43
64
@@ -52,19 +73,61 @@ process for status checks (:ref:`tt status <tt-status>`) and application stoppin
52
73
If you start such an application with ``tt start ``, ``tt `` won't be able to check
53
74
the application status or stop it using the corresponding commands.
54
75
55
- Examples
56
- --------
76
+ .. _tt-start-integrity-check :
77
+
78
+ Integrity check
79
+ ---------------
80
+
81
+ .. admonition :: Enterprise Edition
82
+ :class: fact
83
+
84
+ The integrity check functionality is supported by the `Enterprise Edition <https://www.tarantool.io/compare/ >`_ only.
85
+
86
+ ``tt start `` can perform initial and periodical integrity checks of the environment,
87
+ application, and centralized configuration.
88
+
89
+ To enable integrity checks of environment and application files, you need to pack
90
+ the application using ``tt pack `` with the ``--with-integrity-check `` option.
91
+ This option generates and signs checksums of executables and configuration files in the current ``tt ``
92
+ environment. Learn more in :ref: `tt-pack-integrity-check `.
93
+
94
+ To enable integrity check of the configuration at the centralized storage,
95
+ publish the configuration to this storage using ``tt cluster publish `` with the ``--with-integrity-check `` option.
96
+ This option generates and signs configuration checksums and saves them to the storage.
97
+ Learn more in :ref: `tt-cluster-publish-integrity `.
98
+
99
+ To perform the integrity checks when running the application, start it with the
100
+ ``--integrity-check `` :ref: `global option <tt-global-options >`.
101
+ Its argument must be a public key matching the private key that was used for
102
+ generating checksums.
103
+
104
+ .. code-block :: console
105
+
106
+ $ tt --integrity-check public.pem start myapp
107
+
108
+ After such a call, ``tt `` checks the environment, application, and configuration integrity
109
+ using the checksums and starts the application in case of the success. Then, integrity
110
+ checks are performed periodically while the application is running. By default,
111
+ they are performed once every 24 hours. You can adjust the integrity check period
112
+ by adding the ``--integrity-check-period `` option:
113
+
114
+ .. code-block :: console
115
+
116
+ $ tt --integrity-check public.pem start myapp --integrity-check-period 60
57
117
58
- * Start instances of the application stored in the `` app `` directory inside
59
- `` instances_enabled `` in accordance with its `` instances.yml ``:
118
+ Additionally, Tarantool checks the integrity of the modules that the application uses
119
+ at the load time, that is, when `` require('module') `` is called.
60
120
61
- .. code-block :: console
121
+ If an integrity check fails, `` tt `` stops the application.
62
122
63
- $ tt start app
123
+ .. _ tt- start-options :
64
124
65
- * Start the ``router `` instance of the ``app `` application:
125
+ Options
126
+ -------
66
127
67
- .. code-block :: console
128
+ .. option :: --integrity-check-interval NUMBER
68
129
69
- $ tt start app:router
130
+ Integrity check interval in seconds. Default: 86400 (24 hours).
131
+ Set this option to ``0 `` to disable periodic checks.
70
132
133
+ See also: :ref: `tt-start-integrity-check `
0 commit comments