Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
24 commits
Select commit Hold shift + click to select a range
b839b98
Fix gh-893 feedback: Submodule box.info
Sep 13, 2019
9bb06d3
update for Fix gh-893
Sep 13, 2019
0f27e9f
Partial Fix gh-869 Сonfusing wording in box.backup page
Sep 16, 2019
7c5404c
Partial Fix gh-869 Сonfusing wording in box.backup page
Sep 16, 2019
11806f9
Fix gh-876 document reaction on error in replication configuration ch…
Sep 17, 2019
e612a06
Update gh-868 Tarantool dependency list was changed
Sep 18, 2019
fba422f
Fix gh-915 feedback: Building from source
Sep 19, 2019
70c908f
Fix gh-902 feedback: Сборка из исходных файлов
Sep 30, 2019
bb6cd02
Fix gh-920 feedback: Module vshard
Sep 30, 2019
0b1c153
Fix gh-922 feedback: Module vshard
Sep 30, 2019
1e6f234
Fixes after review
Oct 21, 2019
afe3a32
Fix gh-893 feedback: Submodule box.info
Sep 13, 2019
de2e649
update for Fix gh-893
Sep 13, 2019
2ade3c4
Partial Fix gh-869 Сonfusing wording in box.backup page
Sep 16, 2019
ae3746a
Partial Fix gh-869 Сonfusing wording in box.backup page
Sep 16, 2019
d8b4193
Fix gh-876 document reaction on error in replication configuration ch…
Sep 17, 2019
b84b6a1
Update gh-868 Tarantool dependency list was changed
Sep 18, 2019
8112d9f
Fix gh-915 feedback: Building from source
Sep 19, 2019
d3dec34
Fix gh-902 feedback: Сборка из исходных файлов
Sep 30, 2019
36a4531
Fix gh-920 feedback: Module vshard
Sep 30, 2019
93184fa
Fix gh-922 feedback: Module vshard
Sep 30, 2019
99efa84
Fixes after review
Oct 21, 2019
16b7074
Merge branch 'feedback_minor' of https://github.com/tarantool/doc int…
Oct 29, 2019
7a5f52e
Fix gh-915 feedback: Building from source
Nov 10, 2019
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
7 changes: 3 additions & 4 deletions doc/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/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/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/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
18 changes: 13 additions & 5 deletions doc/dev_guide/building_from_source.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,8 @@ 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 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 +51,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 +62,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 +75,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 @@ -90,15 +92,15 @@ the preferences can differ. But strategically the steps are always the same.
$ xcode-select --install
$ xcode-select -switch /Applications/Xcode.app/Contents/Developer

* For FreeBSD (instructions below are for FreeBSD 10.1 release), say:
* For FreeBSD (instructions below are for FreeBSD 10.1+ release), say:

.. code-block:: console

$ pkg install -y sudo git cmake gmake gcc coreutils \
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 +147,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 +189,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
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/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