Skip to content

Minor docs bug-fixes #938

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.

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

Closed
wants to merge 11 commits into from
7 changes: 3 additions & 4 deletions doc/1.10/book/admin/backups.rst
Original file line number Diff line number Diff line change
Expand Up @@ -88,15 +88,14 @@ checkpoint.
To take a mixed backup:

1. Issue :ref:`box.backup.start() <admin-backups-backup_start>` on the
:ref:`administrative console <admin-security>`. This will suspend
garbage collection till the next ``box.backup.stop()`` and
will return a list of files to back up.
:ref:`administrative console <admin-security>`. This will return a list of
files to back up and suspend garbage collection for them till the next ``box.backup.stop()``.

2. Copy the files from the list to a safe location. This will include memtx
snapshot files, vinyl run and index files, at a state consistent with the
last checkpoint.

3. Issue ``box.backup.stop()`` so the garbage collector can continue.
3. Issue ``box.backup.stop()`` so the garbage collector can continue as usual.

.. _admin-backups-cont_remote_backup_memtx:

Expand Down
11 changes: 5 additions & 6 deletions doc/1.10/book/admin/disaster_recovery.rst
Original file line number Diff line number Diff line change
Expand Up @@ -113,13 +113,12 @@ The following steps are applicable only to data in memtx storage engine.
Your actions:

1. Put all nodes in :ref:`read-only mode <cfg_basic-read_only>` and disable
checkpointing with :ref:`box.backup.start() <admin-backups-backup_start>`.
Disabling the checkpointing is
necessary to prevent the Tarantool garbage collector from removing files
made with older checkpoints.
deletion of expired checkpoints with :ref:`box.backup.start() <admin-backups-backup_start>`.
This will prevent the Tarantool garbage collector from removing files
made with older checkpoints until :ref:`box.backup.stop() <admin-backups-backup_start>` is called.

2. Get the latest valid :ref:`.snap file <internals-snapshot>` and use ``tarantoolctl cat`` command to
calculate at which lsn the data loss occurred.
2. Get the latest valid :ref:`.snap file <internals-snapshot>` and
use ``tarantoolctl cat`` command to calculate at which lsn the data loss occurred.

3. Start a new instance (instance#1) and use ``tarantoolctl play`` command to
play to it the contents of .snap/.xlog files up to the calculated lsn.
Expand Down
8 changes: 5 additions & 3 deletions doc/1.10/book/box/box_info.rst
Original file line number Diff line number Diff line change
Expand Up @@ -182,9 +182,11 @@ variables.
Even if an instance is :ref:`removed <replication-remove_instances>`,
its values will still appear here.

* **replication.downstream.status** ``= disconnected`` is displayed if the
downstream instance disconnects from the upstream instance. Otherwise the
status is not reported.
* **replication.downstream.status** is the replication status for downstream
replications:

* ``stopped`` means that downstream replication has stopped.
* ``follow`` means that downstream replication is in progress.

.. function:: box.info()

Expand Down
18 changes: 15 additions & 3 deletions doc/1.10/book/replication/repl_add_instances.rst
Original file line number Diff line number Diff line change
Expand Up @@ -198,6 +198,16 @@ is less than or equal to the number of seconds specified in
If ``replication_sync_lag`` is unset (nil) or set to TIMEOUT_INFINITY, then
the replica skips the "sync" state and switches to "follow" immediately.

In order to leave orphan mode you need to sync with a sufficient number
(:ref:`replication_connect_quorum <cfg_replication-replication_connect_quorum>`) of
instances. To do so, you may either:

* Set :ref:`replication_connect_quorum <cfg_replication-replication_connect_quorum>`
to a lower value.
* Reset ``box.cfg.replication`` to exclude instances that cannot be reached
or synced with.
* Set ``box.cfg.replication`` to ``""`` (empty string).

The following situations are possible.

.. _replication-leader:
Expand All @@ -215,7 +225,7 @@ A replica is joining but no replica set exists yet.
:ref:`replication_connect_timeout <cfg_replication-replication_connect_timeout>`
is overridden.

3. Abort if not connected to all nodes in ``box.cfg.replication`` or
3. Abort and throw an error if not connected to all nodes in ``box.cfg.replication`` or
:ref:`replication_connect_quorum <cfg_replication-replication_connect_quorum>`.

4. This instance might be elected as the replica set 'leader'.
Expand Down Expand Up @@ -248,9 +258,11 @@ It is being called again in order to perform recovery.

2. Connect to at least
:ref:`replication_connect_quorum <cfg_replication-replication_connect_quorum>`
nodes.
nodes. If failed - set status to 'orphan'.
(Attempts to sync will continue in the background and when/if they succeed
then 'orphan' will be changed to 'connected'.)

3. Sync with all connected nodes, until the difference is not more than
3. If connected - sync with all connected nodes, until the difference is not more than
:ref:`replication_sync_lag <cfg_replication-replication_sync_lag>` seconds.

.. _replication-configuration_update:
Expand Down
17 changes: 13 additions & 4 deletions doc/1.10/dev_guide/building_from_source.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,9 @@ the preferences can differ. But strategically the steps are always the same.
* A program for managing the build process. |br| For all platforms, this is
``CMake`` version 2.8+.

* A build automation tool. |br| For all platforms, except FreeBSD this is
``BSD Make``, but for FreeBSD this is ``GNU Make``.

* `ReadLine <http://www.gnu.org/software/readline/>`_ library, any version
* `ncurses <https://www.gnu.org/software/ncurses/>`_ library, any version
* `OpenSSL <https://www.openssl.org>`_ library, version 1.0.1+
Expand Down Expand Up @@ -49,7 +52,7 @@ the preferences can differ. But strategically the steps are always the same.

.. code-block:: console

$ apt install -y build-essential cmake coreutils sed \
$ apt install -y build-essential cmake make coreutils sed \
autoconf automake libtool zlib1g-dev \
libreadline-dev libncurses5-dev libyaml-dev libssl-dev \
libunwind-dev libicu-dev \
Expand All @@ -60,7 +63,7 @@ the preferences can differ. But strategically the steps are always the same.

.. code-block:: console

$ yum install -y gcc gcc-c++ cmake coreutils sed \
$ yum install -y gcc gcc-c++ cmake make coreutils sed \
autoconf automake libtool zlib-devel \
readline-devel ncurses-devel libyaml-devel openssl-devel \
libunwind-devel libicu-devel \
Expand All @@ -73,7 +76,7 @@ the preferences can differ. But strategically the steps are always the same.

.. code-block:: console

$ brew install cmake autoconf binutils zlib \
$ brew install cmake make autoconf binutils zlib \
autoconf automake libtool \
readline ncurses libyaml openssl libunwind-headers icu4c \
&& pip install python-daemon \
Expand All @@ -98,7 +101,7 @@ the preferences can differ. But strategically the steps are always the same.
autoconf automake libtool \
readline ncurses libyaml openssl libunwind icu \
python27 py27-pip py27-setuptools py27-daemon \
py27-msgpack-python py27-yaml py27-argparse py27-six py27-gevent
py27-msgpack py27-yaml py27-argparse py27-six py27-gevent

If some Python modules are not available in a repository,
it is best to set up the modules by getting a tarball and
Expand Down Expand Up @@ -145,6 +148,7 @@ the preferences can differ. But strategically the steps are always the same.

.. code-block:: console

cd ~/tarantool
$ git submodule update --init --recursive

3. Use CMake to initiate the build.
Expand Down Expand Up @@ -186,6 +190,11 @@ the preferences can differ. But strategically the steps are always the same.

This creates the 'tarantool' executable in the ``src/`` directory.

.. NOTE::

If you encounter a ``curl`` or ``OpenSSL`` errors on this step try
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If you encounter curl or OpenSSL errors on this step, try
installing an openssl111 package of the specific 1.1.1d version.

installing ``openssl111`` package of the specific ``1.1.1d`` version.

Next, it's highly recommended to say ``make install`` to install Tarantool to
the ``/usr/local`` directory and keep your system clean. However, it is
possible to run the Tarantool executable without installation.
Expand Down
5 changes: 3 additions & 2 deletions doc/1.10/reference/reference_rock/vshard/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,8 @@ To acquire it, do a separate installation:
Quick start
-------------------------------------------------------------------------------

The ``vshard/example/`` directory includes a pre-configured development cluster
The ``example/`` directory of `the vshard git-repository <https://github.com/tarantool/vshard>`_
includes a pre-configured development cluster
of 1 ``router`` and 2 replica sets of 2 nodes (2 ``storages``) each, making 5
Tarantool instances in total:

Expand All @@ -85,7 +86,7 @@ Tarantool instances in total:

All instances are managed using the ``tarantoolctl`` utility which comes with Tarantool.

Change the directory to ``example/`` and use make to run the development cluster:
Change the directory to ``example/`` and use ``make`` to run the development cluster:

.. code-block:: console

Expand Down
43 changes: 22 additions & 21 deletions locale/ru/LC_MESSAGES/doc.po
Original file line number Diff line number Diff line change
Expand Up @@ -183,14 +183,14 @@ msgstr "Для создания смешанной резервной копии
#: ../doc/1.10/book/admin/backups.rst:124
msgid ""
"Issue :ref:`box.backup.start() <admin-backups-backup_start>` on the "
":ref:`administrative console <admin-security>`. This will suspend garbage"
" collection till the next ``box.backup.stop()`` and will return a list of"
" files to back up."
":ref:`administrative console <admin-security>`. This will
" return a list of files to back up and suspend garbage"
" collection for them till the next ``box.backup.stop()``."
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

... collection FOR them...

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is it matter for translation whether i change msgid in po files if they are generated as we discussed?

msgstr ""
"Выполните команду :ref:`box.backup.start() <admin-backups-backup_start>` "
"в :ref:`административной консоли <admin-security>`. Эта команда "
"приостановит сборку мусора до вызова ``box.backup.stop()`` и покажет "
"список файлов для резервирования."
"в :ref:`административной консоли <admin-security>`. Эта команда покажет "
"список файлов для резервного копирования и приостановит сборку мусора для этих"
"файлов до вызова ``box.backup.stop()``."

#: ../doc/1.10/book/admin/backups.rst:129
msgid ""
Expand All @@ -203,10 +203,10 @@ msgstr ""
"последней контрольной точке."

#: ../doc/1.10/book/admin/backups.rst:133
msgid "Issue ``box.backup.stop()`` so the garbage collector can continue."
msgid "Issue ``box.backup.stop()`` so the garbage collector can continue as usual."
msgstr ""
"Выполните команду ``box.backup.stop()``, чтобы сборщик мусора мог "
"продолжить работу."
"продолжить работу в обычном режиме."

#: ../doc/1.10/book/admin/backups.rst:139
msgid "Continuous remote backup (memtx)"
Expand Down Expand Up @@ -1105,17 +1105,16 @@ msgstr ""

#: ../doc/1.10/book/admin/disaster_recovery.rst:149
msgid ""
"Put all nodes in :ref:`read-only mode <cfg_basic-read_only>` and disable "
"checkpointing with :ref:`box.backup.start() <admin-backups-"
"backup_start>`. Disabling the checkpointing is necessary to prevent the "
"Tarantool garbage collector from removing files made with older "
"checkpoints."
"Put all nodes in :ref:`read-only mode <cfg_basic-read_only>` and disable"
"deletion of expired checkpoints with :ref:`box.backup.start() <admin-backups-backup_start>`."
"This will prevent the Tarantool garbage collector from removing files"
"made with older checkpoints until :ref:`box.backup.stop() <admin-backups-backup_start>`."
msgstr ""
"Переключите все узлы в :ref:`режим только для чтения <cfg_basic-"
"read_only>` и отключите командой :ref:`box.backup.start() <admin-backups-"
"backup_start>` создание контрольных точек. Последнее действие необходимо,"
"backup_start>` удаление устаревших контрольных точек. Последнее действие необходимо,"
" чтобы сборщик мусора автоматически не удалил более старые контрольные "
"точки."
"точки до тех пор, пока не будет вызвана команда :ref:`box.backup.stop() <admin-backups-backup_start>`."

#: ../doc/1.10/book/admin/disaster_recovery.rst:155
msgid ""
Expand Down Expand Up @@ -67341,12 +67340,14 @@ msgstr "Краткое руководство"

#: ../doc/1.10/reference/reference_rock/vshard/index.rst:110
msgid ""
"The ``vshard/example/`` directory includes a pre-configured development "
"cluster of 1 ``router`` and 2 replica sets of 2 nodes (2 ``storages``) "
"The ``example/`` directory of `the vshard git-repository <https://github.com/tarantool/vshard>`_"
"includes a pre-configured development cluster"
"of 1 ``router`` and 2 replica sets of 2 nodes (2 ``storages``) "
"each, making 5 Tarantool instances in total:"
msgstr ""
"В директории ``vshard/example/`` находится предварительно настроенный "
"кластер из 1 роутера и 2 наборов реплик из 2 узлов (2 хранилища) в "
"В директории ``example/`` `гит репозитория vshard <https://github.com/tarantool/vshard>`_ "
"находится предварительно настроенный "
"кластер из 1 роутера и 2 наборов реплик из 2 узлов (2 хранилищ) в "
"каждом, что составляет всего 5 экземпляров Tarantool'а в целом:"

#: ../doc/1.10/reference/reference_rock/vshard/index.rst:114
Expand Down Expand Up @@ -67395,10 +67396,10 @@ msgstr ""

#: ../doc/1.10/reference/reference_rock/vshard/index.rst:122
msgid ""
"Change the directory to ``example/`` and use make to run the development "
"Change the directory to ``example/`` and use ``make`` to run the development "
"cluster:"
msgstr ""
"Измените директорию ``example/`` и используйте команду make для запуска "
"Измените директорию ``example/`` и используйте команду ``make`` для запуска "
"кластера:"

#: ../doc/1.10/reference/reference_rock/vshard/index.rst:124
Expand Down