Skip to content

Commit d5bfec9

Browse files
authored
Update tt config parameters (#3324)
Resolves #3322
1 parent aefd793 commit d5bfec9

File tree

4 files changed

+39
-6
lines changed

4 files changed

+39
-6
lines changed

doc/reference/tooling/tt_cli/build.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
.. _tt-build:
22

33
Building an application
4-
====================
4+
=======================
55

66
.. code-block:: bash
77

doc/reference/tooling/tt_cli/clean.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.. _tt-stop:
1+
.. _tt-clean:
22

33
Cleaning instance files
44
=======================

doc/reference/tooling/tt_cli/configuration.rst

Lines changed: 36 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,18 +25,29 @@ The ``tt`` configuration file is a YAML file with the following content:
2525
instances_available: path/to/available/applications
2626
run_dir: path/to/run_dir
2727
log_dir: path/to/log_dir
28+
bin_dir: path/to/bin_dir
29+
inc_dir: path/to/inc_dir
30+
wal_dir: path/to/wal_dir
31+
vinyl_dir: path/to/vinyl_dir
32+
memtx_dir: path/to/memtx_dir
2833
log_maxsize: num (MB)
2934
log_maxage: num (days)
3035
log_maxbackups: num
3136
restart_on_failure: bool
37+
repo:
38+
rocks: path/to/rocks
39+
distfiles: path/to/install
40+
ee:
41+
credential_path: path/to/file
3242
templates:
3343
- path: path/to/app/templates1
3444
- path: path/to/app/templates2
3545
3646
modules section
3747
~~~~~~~~~~~~~~~
3848

39-
* ``directory`` -- the directory where :doc:`external modules <external_modules>` are stored.
49+
* ``directory`` -- the directory where :doc:`external modules <external_modules>`
50+
are stored.
4051

4152
.. _tt-config_file_app:
4253

@@ -46,8 +57,18 @@ app section
4657
* ``instances_available`` -- the directory where :ref:`instances <admin-instance_file>`
4758
are stored.
4859
* ``run_dir``-- the directory for instance runtime artifacts, such as console
49-
sockets or PID files.
50-
* ``log_dir`` -- the directory where log files are stored.
60+
sockets or PID files. Default: ``var/run``.
61+
* ``log_dir`` -- the directory where log files are stored. Default: ``var/log``.
62+
* ``bin_dir`` -- the directory where binary files are stored. Default: ``bin``.
63+
* ``inc_dir`` -- the base directory for storing header files. They will
64+
be placed in the ``include`` subdirectory inside the specified directory.
65+
Default: ``include``.
66+
* ``wal_dir`` -- the directory where write-ahead log (``.xlog``) files are stored.
67+
Default: ``var/lib``.
68+
* ``memtx_dir`` -- the directory where memtx stores snapshot (``.snap``) files.
69+
Default: ``var/lib``.
70+
* ``vinyl_dir`` -- the directory where vinyl files or subdirectories are stored.
71+
Default: ``var/lib``.
5172
* ``log_maxsize`` -- the maximum size of the log file before it gets rotated,
5273
in megabytes. Default: 100.
5374
* ``log_maxage`` -- the maximum age of log files in days. The age of a log
@@ -64,6 +85,18 @@ app section
6485
* ``restart_on_failure`` -- restart the instance on failure: ``true`` or ``false``.
6586
Default: ``false``.
6687

88+
repo section
89+
~~~~~~~~~~~~
90+
91+
* ``rocks`` -- the directory where rocks files are stored.
92+
* ``distfiles`` -- the directory where installation files are stored.
93+
94+
ee section
95+
~~~~~~~~~~
96+
97+
* ``credential_path`` -- a path to the file file with credentials used for
98+
downloading Tarantool Enterprise.
99+
67100
templates section
68101
~~~~~~~~~~~~~~~~~
69102

doc/reference/tooling/tt_cli/create.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
.. _tt-create:
22

33
Creating an application from a template
4-
=====================================
4+
=======================================
55

66
.. code-block:: bash
77

0 commit comments

Comments
 (0)