From 3b39597d7641fc76951c821ca29562a63bb138fc Mon Sep 17 00:00:00 2001 From: Pavel Semyonov Date: Tue, 21 May 2024 12:52:17 +0700 Subject: [PATCH 1/6] Add tt pack DEB/RPM content description --- doc/reference/tooling/tt_cli/pack.rst | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/doc/reference/tooling/tt_cli/pack.rst b/doc/reference/tooling/tt_cli/pack.rst index 31aa2cdf6c..a7f0172138 100644 --- a/doc/reference/tooling/tt_cli/pack.rst +++ b/doc/reference/tooling/tt_cli/pack.rst @@ -13,13 +13,24 @@ Packaging the application - ``deb``: create a DEB package. - ``rpm``: create an RPM package. -The command below creates a DEB package for an application: +.. _tt-pack-example: + +Example: a DEB package +---------------------- + +The command below creates a DEB package with all applications from the current ``tt`` +environment: .. code-block:: console $ tt pack deb This command generates a ``.deb`` file whose name depends on the environment directory name and the operating system architecture, for example, ``test-env_0.1.0.0-1_x86_64.deb``. +The package contains the entire ``tt`` environment: +- The content of the application directories: source files, resources, dependencies. +- ``tt`` environment files: ``tarantool`` and ``tt`` executables, external modules, headers. +- ``.service`` unit files that allow running applications as ``systemd`` services (a separate file for each application). + You can also pass various :ref:`options ` to the ``tt pack`` command to adjust generation properties, for example, customize a bundle name, choose which artifacts should be included, specify the required application dependencies. From 63dc6763f696c106c089f797c8fa9e600d60cc0e Mon Sep 17 00:00:00 2001 From: Pavel Semyonov Date: Tue, 21 May 2024 13:06:42 +0700 Subject: [PATCH 2/6] Add tt pack DEB/RPM content description --- doc/book/admin/instance_config.rst | 3 +++ doc/reference/tooling/tt_cli/pack.rst | 9 ++++++--- 2 files changed, 9 insertions(+), 3 deletions(-) diff --git a/doc/book/admin/instance_config.rst b/doc/book/admin/instance_config.rst index 35bacc21a2..529f48271e 100644 --- a/doc/book/admin/instance_config.rst +++ b/doc/book/admin/instance_config.rst @@ -151,7 +151,10 @@ The application's layout looks similar to the one defined when :ref:`developing - ``tt.yaml``: a ``tt`` configuration file. +.. note:: + In the DEB/PRM packages generated by :ref:`tt-pack`, there are also ``.service`` + unit files for each packaged application. .. _admin-instances_to_run: diff --git a/doc/reference/tooling/tt_cli/pack.rst b/doc/reference/tooling/tt_cli/pack.rst index a7f0172138..d6f445297b 100644 --- a/doc/reference/tooling/tt_cli/pack.rst +++ b/doc/reference/tooling/tt_cli/pack.rst @@ -26,10 +26,13 @@ environment: $ tt pack deb This command generates a ``.deb`` file whose name depends on the environment directory name and the operating system architecture, for example, ``test-env_0.1.0.0-1_x86_64.deb``. -The package contains the entire ``tt`` environment: +The package contains the following files: + - The content of the application directories: source files, resources, dependencies. -- ``tt`` environment files: ``tarantool`` and ``tt`` executables, external modules, headers. -- ``.service`` unit files that allow running applications as ``systemd`` services (a separate file for each application). +- ``tt`` environment files: ``tarantool`` and ``tt`` executables, ``tt.yaml`` configuration files, + external modules, headers. +- ``.service`` unit files that allow running applications as ``systemd`` services + (a separate file for each application). You can also pass various :ref:`options ` to the ``tt pack`` command to adjust generation properties, for example, customize a bundle name, choose which artifacts should be included, specify the required application dependencies. From b690c7c62a79f096f43626847912dbb251696ab8 Mon Sep 17 00:00:00 2001 From: Pavel Semyonov Date: Tue, 21 May 2024 13:37:05 +0700 Subject: [PATCH 3/6] Add tt pack DEB/RPM content description --- doc/book/admin/instance_config.rst | 2 +- doc/reference/tooling/tt_cli/pack.rst | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/book/admin/instance_config.rst b/doc/book/admin/instance_config.rst index 529f48271e..3656617dd5 100644 --- a/doc/book/admin/instance_config.rst +++ b/doc/book/admin/instance_config.rst @@ -153,7 +153,7 @@ The application's layout looks similar to the one defined when :ref:`developing .. note:: - In the DEB/PRM packages generated by :ref:`tt-pack`, there are also ``.service`` + In DEB/PRM packages generated by :ref:`tt pack `, there are also ``.service`` unit files for each packaged application. .. _admin-instances_to_run: diff --git a/doc/reference/tooling/tt_cli/pack.rst b/doc/reference/tooling/tt_cli/pack.rst index d6f445297b..2c40ec7f09 100644 --- a/doc/reference/tooling/tt_cli/pack.rst +++ b/doc/reference/tooling/tt_cli/pack.rst @@ -29,7 +29,7 @@ This command generates a ``.deb`` file whose name depends on the environment dir The package contains the following files: - The content of the application directories: source files, resources, dependencies. -- ``tt`` environment files: ``tarantool`` and ``tt`` executables, ``tt.yaml`` configuration files, +- ``tt`` environment files: ``tarantool`` and ``tt`` executables, ``tt.yaml`` configuration file, external modules, headers. - ``.service`` unit files that allow running applications as ``systemd`` services (a separate file for each application). From 81bb3b51fa90105699192f07769f811a08e718ab Mon Sep 17 00:00:00 2001 From: Pavel Semyonov Date: Tue, 21 May 2024 16:51:04 +0700 Subject: [PATCH 4/6] Update doc/reference/tooling/tt_cli/pack.rst Co-authored-by: Andrey Aksenov <38073144+andreyaksenov@users.noreply.github.com> --- doc/reference/tooling/tt_cli/pack.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/reference/tooling/tt_cli/pack.rst b/doc/reference/tooling/tt_cli/pack.rst index 2c40ec7f09..e199128b57 100644 --- a/doc/reference/tooling/tt_cli/pack.rst +++ b/doc/reference/tooling/tt_cli/pack.rst @@ -21,9 +21,9 @@ Example: a DEB package The command below creates a DEB package with all applications from the current ``tt`` environment: - .. code-block:: console +.. code-block:: console - $ tt pack deb + $ tt pack deb This command generates a ``.deb`` file whose name depends on the environment directory name and the operating system architecture, for example, ``test-env_0.1.0.0-1_x86_64.deb``. The package contains the following files: From e801e50ec1079aa0df51bbf56235db6d38a08732 Mon Sep 17 00:00:00 2001 From: Pavel Semyonov Date: Wed, 22 May 2024 12:58:57 +0700 Subject: [PATCH 5/6] Add info about tarantool user for systemd services --- doc/book/admin/instance_config.rst | 27 +++++++++++++++++++++++++-- 1 file changed, 25 insertions(+), 2 deletions(-) diff --git a/doc/book/admin/instance_config.rst b/doc/book/admin/instance_config.rst index 3656617dd5..3bca94d928 100644 --- a/doc/book/admin/instance_config.rst +++ b/doc/book/admin/instance_config.rst @@ -156,12 +156,18 @@ The application's layout looks similar to the one defined when :ref:`developing In DEB/PRM packages generated by :ref:`tt pack `, there are also ``.service`` unit files for each packaged application. +.. _admin-instance_config-deploy-app: + +Deploying the application +------------------------- + .. _admin-instances_to_run: Instances to run ~~~~~~~~~~~~~~~~ -One more difference for a deployed application is the content of the ``instances.yaml`` file that specifies instances to run in the current environment. +When deploying a distributed cluster application from a `.tar.gz` archive, you can +define instances to run on each machine by changing the content of the ``instances.yaml`` file. - On the developer's machine, this file might include all the instances defined in the cluster configuration. @@ -203,5 +209,22 @@ One more difference for a deployed application is the content of the ``instances storage-a-002: storage-b-002: - The :ref:`Starting and stopping instances ` section describes how to start and stop Tarantool instances. + +.. _admin-deploy-rpm-deb: + +DEB and RPM packages +~~~~~~~~~~~~~~~~~~~~ + +Tarantool applications installed from DEB and RPM packages built with :ref:`tt pack ` +can run as `systemd` services. They run on behalf of the ``tarantool`` system user. +It is created automatically during the package installation. + +By default, the application artifacts are placed in the following directories: + +- ``/var/lib/tarantool/sys_env`` -- application data +- ``/var/log/tarantool/sys_env`` -- logs +- ``/var/run/tarantool/sys_env`` -- runtime artifacts + +If you want to change these directories, make sure that the ``tarantool`` user +has enough permissions to the directories you use. \ No newline at end of file From 29d5bcfcca89bf785f3c8119d75b8ade93a88f66 Mon Sep 17 00:00:00 2001 From: Pavel Semyonov Date: Wed, 22 May 2024 13:25:56 +0700 Subject: [PATCH 6/6] fix --- doc/book/admin/instance_config.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/book/admin/instance_config.rst b/doc/book/admin/instance_config.rst index 3bca94d928..054f6e7d64 100644 --- a/doc/book/admin/instance_config.rst +++ b/doc/book/admin/instance_config.rst @@ -217,7 +217,7 @@ DEB and RPM packages ~~~~~~~~~~~~~~~~~~~~ Tarantool applications installed from DEB and RPM packages built with :ref:`tt pack ` -can run as `systemd` services. They run on behalf of the ``tarantool`` system user. +can run as ``systemd`` services. They run on behalf of the ``tarantool`` system user. It is created automatically during the package installation. By default, the application artifacts are placed in the following directories: @@ -227,4 +227,4 @@ By default, the application artifacts are placed in the following directories: - ``/var/run/tarantool/sys_env`` -- runtime artifacts If you want to change these directories, make sure that the ``tarantool`` user -has enough permissions to the directories you use. \ No newline at end of file +has enough permissions on the directories you use. \ No newline at end of file