Describe schema upgrading process (#1131)

Close #587
tarantool · Nov 20, 2020 · 87bb9f8 · 87bb9f8
1 parent 221cf6e
commit 87bb9f8
Show file tree

Hide file tree

Showing 3 changed files with 63 additions and 0 deletions.
diff --git a/rst/cartridge_admin.rst b/rst/cartridge_admin.rst
@@ -916,6 +916,22 @@ Potential issues
   error message to detect this replica set. Then fix the issue in the same way
   as for :ref:`UNREACHABLE_REPLICA <unreachable_replica>`.
 
+.. _cartridge-upgrading_schema:
+
+-------------------------------------------------------------------------------
+Upgrading schema
+-------------------------------------------------------------------------------
+
+When upgrading Tarantool to a newer version, please don't forget to:
+
+1. Stop the cluster
+2. Make sure that ``upgrade_schema`` :ref:`option <cartridge.cfg>` is enabled
+3. Start the cluster again
+
+This will automatically apply `box.schema.upgrade()
+<https://www.tarantool.io/en/doc/latest/book/admin/upgrades/#admin-upgrades>`_
+on the leader, according to the failover priority in the topology configuration.
+
 .. _cartridge-recovery:
 
 -------------------------------------------------------------------------------

diff --git a/rst/locale/cartridge_admin.pot b/rst/locale/cartridge_admin.pot
@@ -614,6 +614,24 @@ msgstr ""
 msgid "**Solution:** The replica set has an unreachable master and replica. Check the error message to detect this replica set. Then fix the issue in the same way as for :ref:`UNREACHABLE_REPLICA <unreachable_replica>`."
 msgstr ""
 
+msgid "Upgrading schema"
+msgstr ""
+
+msgid "When upgrading Tarantool to a newer version, please don't forget to:"
+msgstr ""
+
+msgid "Stop the cluster"
+msgstr ""
+
+msgid "Make sure that ``upgrade_schema`` :ref:`option <cartridge.cfg>` is enabled"
+msgstr ""
+
+msgid "Start the cluster again"
+msgstr ""
+
+msgid "This will automatically apply `box.schema.upgrade() <https://www.tarantool.io/en/doc/latest/book/admin/upgrades/#admin-upgrades>`_ on the leader, according to the failover priority in the topology configuration."
+msgstr ""
+
 msgid "Disaster recovery"
 msgstr ""
 
@@ -625,3 +643,4 @@ msgstr ""
 
 msgid "Please see the `backups section <https://www.tarantool.io/en/doc/latest/book/admin/backups/>`_ in the Tarantool manual."
 msgstr ""
+
diff --git a/rst/locale/ru/LC_MESSAGES/cartridge_admin.po b/rst/locale/ru/LC_MESSAGES/cartridge_admin.po
@@ -1195,6 +1195,34 @@ msgstr ""
 " описано в решении ошибки :ref:`UNREACHABLE_REPLICA "
 "<unreachable_replica>`."
 
+msgid "Upgrading schema"
+msgstr "Обновление схемы"
+
+msgid "When upgrading Tarantool to a newer version, please don't forget to:"
+msgstr ""
+"Во время перехода на более новую версию Tarantool, пожалуйста, не "
+"забудьте:"
+
+msgid "Stop the cluster"
+msgstr "Остановить кластер"
+
+msgid "Make sure that ``upgrade_schema`` :ref:`option <cartridge.cfg>` is enabled"
+msgstr "Убедиться, что включена :ref:`опция <cartridge.cfg>` ``upgrade_schema``"
+
+msgid "Start the cluster again"
+msgstr "Затем снова запустить кластер"
+
+msgid ""
+"This will automatically apply `box.schema.upgrade() "
+"<https://www.tarantool.io/en/doc/latest/book/admin/upgrades/#admin-"
+"upgrades>`_ on the leader, according to the failover priority in the "
+"topology configuration."
+msgstr ""
+"Это автоматически запустит `box.schema.upgrade() "
+"<https://www.tarantool.io/ru/doc/latest/book/admin/upgrades/#admin-"
+"upgrades>`_ на лидере в соответствии с приоритетом (failover priority) в "
+"настройках набора реплик."
+
 msgid "Disaster recovery"
 msgstr "Аварийное восстановление"