From 4b96d12d3472a4e1fe8ac5ca36348cfe1ace4a2f Mon Sep 17 00:00:00 2001 From: Pavel Semyonov Date: Wed, 8 Feb 2023 17:04:19 +0700 Subject: [PATCH 1/3] Update tt config parameters --- .../tooling/tt_cli/configuration.rst | 22 +++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/doc/reference/tooling/tt_cli/configuration.rst b/doc/reference/tooling/tt_cli/configuration.rst index 8bd66e236b..c4beb50806 100644 --- a/doc/reference/tooling/tt_cli/configuration.rst +++ b/doc/reference/tooling/tt_cli/configuration.rst @@ -25,10 +25,17 @@ The ``tt`` configuration file is a YAML file with the following content: instances_available: path/to/available/applications run_dir: path/to/run_dir log_dir: path/to/log_dir + bin_dir: path/to/bin_dir + inc_dir: path/to/inc_dir log_maxsize: num (MB) log_maxage: num (days) log_maxbackups: num restart_on_failure: bool + repo: + rocks: path/to/rocks + distfiles: path/to/install + ee: + credential_path: path/to/file templates: - path: path/to/app/templates1 - path: path/to/app/templates2 @@ -48,6 +55,9 @@ app section * ``run_dir``-- the directory for instance runtime artifacts, such as console sockets or PID files. * ``log_dir`` -- the directory where log files are stored. +* ``bin_dir`` -- the directory where binary files are stored. +* ``inc_dir`` -- the base directory for storing header files. They will + be placed in the ``include`` subdirectory inside the specified directory. * ``log_maxsize`` -- the maximum size of the log file before it gets rotated, in megabytes. Default: 100. * ``log_maxage`` -- the maximum age of log files in days. The age of a log @@ -64,6 +74,18 @@ app section * ``restart_on_failure`` -- restart the instance on failure: ``true`` or ``false``. Default: ``false``. +repo section +~~~~~~~~~~~~ + +* ``rocks`` -- the directory where rocks files are stored. +* ``distfiles`` -- the directory where installation files are stored. + +ee section +~~~~~~~~~~ + +* ``credential_path`` -- a path to the file file with credentials used for + downloading Tarantool Enterprise. + templates section ~~~~~~~~~~~~~~~~~ From e21937d6e8add657d25295be9838c87d73d3e249 Mon Sep 17 00:00:00 2001 From: Pavel Semyonov Date: Wed, 8 Feb 2023 18:41:32 +0700 Subject: [PATCH 2/3] Fix warnings --- doc/reference/tooling/tt_cli/build.rst | 2 +- doc/reference/tooling/tt_cli/clean.rst | 2 +- doc/reference/tooling/tt_cli/create.rst | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/doc/reference/tooling/tt_cli/build.rst b/doc/reference/tooling/tt_cli/build.rst index d8e0c880ea..40e5c321ed 100644 --- a/doc/reference/tooling/tt_cli/build.rst +++ b/doc/reference/tooling/tt_cli/build.rst @@ -1,7 +1,7 @@ .. _tt-build: Building an application -==================== +======================= .. code-block:: bash diff --git a/doc/reference/tooling/tt_cli/clean.rst b/doc/reference/tooling/tt_cli/clean.rst index cecc107381..e39b21f65f 100644 --- a/doc/reference/tooling/tt_cli/clean.rst +++ b/doc/reference/tooling/tt_cli/clean.rst @@ -1,4 +1,4 @@ -.. _tt-stop: +.. _tt-clean: Cleaning instance files ======================= diff --git a/doc/reference/tooling/tt_cli/create.rst b/doc/reference/tooling/tt_cli/create.rst index 4b1754edfb..c7e6d00b8b 100644 --- a/doc/reference/tooling/tt_cli/create.rst +++ b/doc/reference/tooling/tt_cli/create.rst @@ -1,7 +1,7 @@ .. _tt-create: Creating an application from a template -===================================== +======================================= .. code-block:: bash From 4d6420c69cb6c9a8ef0835d816b2a48e1d7ff49b Mon Sep 17 00:00:00 2001 From: Pavel Semyonov Date: Wed, 8 Feb 2023 19:15:41 +0700 Subject: [PATCH 3/3] Add new parameters and default values --- .../tooling/tt_cli/configuration.rst | 19 +++++++++++++++---- 1 file changed, 15 insertions(+), 4 deletions(-) diff --git a/doc/reference/tooling/tt_cli/configuration.rst b/doc/reference/tooling/tt_cli/configuration.rst index c4beb50806..a881f21886 100644 --- a/doc/reference/tooling/tt_cli/configuration.rst +++ b/doc/reference/tooling/tt_cli/configuration.rst @@ -27,6 +27,9 @@ The ``tt`` configuration file is a YAML file with the following content: log_dir: path/to/log_dir bin_dir: path/to/bin_dir inc_dir: path/to/inc_dir + wal_dir: path/to/wal_dir + vinyl_dir: path/to/vinyl_dir + memtx_dir: path/to/memtx_dir log_maxsize: num (MB) log_maxage: num (days) log_maxbackups: num @@ -43,7 +46,8 @@ The ``tt`` configuration file is a YAML file with the following content: modules section ~~~~~~~~~~~~~~~ -* ``directory`` -- the directory where :doc:`external modules ` are stored. +* ``directory`` -- the directory where :doc:`external modules ` + are stored. .. _tt-config_file_app: @@ -53,11 +57,18 @@ app section * ``instances_available`` -- the directory where :ref:`instances ` are stored. * ``run_dir``-- the directory for instance runtime artifacts, such as console - sockets or PID files. -* ``log_dir`` -- the directory where log files are stored. -* ``bin_dir`` -- the directory where binary files are stored. + sockets or PID files. Default: ``var/run``. +* ``log_dir`` -- the directory where log files are stored. Default: ``var/log``. +* ``bin_dir`` -- the directory where binary files are stored. Default: ``bin``. * ``inc_dir`` -- the base directory for storing header files. They will be placed in the ``include`` subdirectory inside the specified directory. + Default: ``include``. +* ``wal_dir`` -- the directory where write-ahead log (``.xlog``) files are stored. + Default: ``var/lib``. +* ``memtx_dir`` -- the directory where memtx stores snapshot (``.snap``) files. + Default: ``var/lib``. +* ``vinyl_dir`` -- the directory where vinyl files or subdirectories are stored. + Default: ``var/lib``. * ``log_maxsize`` -- the maximum size of the log file before it gets rotated, in megabytes. Default: 100. * ``log_maxage`` -- the maximum age of log files in days. The age of a log