Skip to content

Add notes for EE customers about ATE and centralized configuration storages #5275

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: latest
Choose a base branch
from
Open

Add notes for EE customers about ATE and centralized configuration storages #5275

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 19 additions & 1 deletion doc/platform/configuration/configuration_etcd.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -241,6 +241,9 @@ Configuring connection to a storage

To use a configuration from a centralized storage for your cluster, you need to provide connection settings in a local configuration file.

.. include:: /platform/configuration/configuration_etcd.rst
:start-after: ee_note_centralized_config_start
:end-before: ee_note_centralized_config_end

.. _centralized_configuration_storage_connect_tarantool:

Expand Down Expand Up @@ -291,15 +294,30 @@ You can find the full example here: `config_etcd <https://github.com/tarantool/d
Starting a cluster
------------------

.. ate_note_run_instances_start

.. note::

To run instances in production, it is recommended to use Ansible Tarantool Enterprise installer (ATE).
ATE is a set of Ansible playbooks that are used to deploy and maintain Tarantool Enterprise products.
`ATE documentation <https://www.tarantool.io/ru/devops/latest>`__ is available to users logged in on the Tarantool website.

.. ate_note_run_instances_end

The :ref:`tt <tt-cli>` utility is the recommended way to start Tarantool instances.
You can learn how to do this from the :ref:`Starting and stopping instances <admin-start_stop_instance>` section.

You can also use the ``tarantool`` command to :ref:`start a Tarantool instance <configuration_run_instance_tarantool>`.
In this case, you can eliminate creating a :ref:`local configuration <centralized_configuration_storage_connect>` and provide connection settings using the following :ref:`environment variables <configuration_environment_variable>`:
In this case, you can eliminate creating a :ref:`local configuration <centralized_configuration_storage_connect>` and
provide connection settings using the following :ref:`environment variables <configuration_environment_variable>`:

* Tarantool-based storage: ``TT_CONFIG_STORAGE_ENDPOINTS`` and ``TT_CONFIG_STORAGE_PREFIX``.
* etcd-based storage: ``TT_CONFIG_ETCD_ENDPOINTS`` and ``TT_CONFIG_ETCD_PREFIX``.

.. include:: /platform/configuration/configuration_etcd.rst
:start-after: ee_note_centralized_config_start
:end-before: ee_note_centralized_config_end

The example below shows how to provide etcd connection settings and start cluster instances using the ``tarantool`` command:

.. code-block:: console
Expand Down
4 changes: 4 additions & 0 deletions doc/tooling/tt_cli/start_stop_instance.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,10 @@
Starting and stopping instances
===============================

.. include:: /platform/configuration/configuration_etcd.rst
:start-after: ate_note_run_instances_start
:end-before: ate_note_run_instances_end

This section describes how to manage instances in a Tarantool cluster using the :ref:`tt <tt-cli>` utility.
A cluster can include multiple instances that run different code.
A typical example is a cluster application that includes router and storage instances.
Expand Down