Skip to content

Сonfusing wording in box.backup page #869

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
artur-barsegyan opened this issue Aug 22, 2019 · 6 comments · Fixed by #883 or #964
Closed

Сonfusing wording in box.backup page #869

artur-barsegyan opened this issue Aug 22, 2019 · 6 comments · Fixed by #883 or #964
Assignees
Labels
bug Something isn't working need feedback [special status] On hold, awaiting feedback

Comments

@artur-barsegyan
Copy link
Contributor

artur-barsegyan commented Aug 22, 2019

box.backup.start() informs the server that some activities that might interfer with backup should be suspended – suspend checkpointing, suspend Tarantool garbage collection, and effectively enter read-only mode.

It doesn't mean that instance turned into read_only mode by it self. It means that Tarantool snapshot garbage collector will not remove any checkpoints.

It can also be noted that the creation of checkpoints in this case will occur by schedule.

@artur-barsegyan artur-barsegyan added the bug Something isn't working label Aug 22, 2019
@lenkis lenkis added the 1.10 label Aug 22, 2019
izmalk pushed a commit that referenced this issue Aug 23, 2019
Changed description as intended. Consider review.
@izmalk
Copy link
Contributor

izmalk commented Aug 23, 2019

Suggested fix in English - please review.
Also this issue might be mentioned in other parts of documentation: for example the very previous chapter has following text -
"Put all nodes in read-only mode and disable checkpointing with box.backup.start(). "
And in Russian -
"Переключите все узлы в режим только для чтения и отключите командой box.backup.start() создание контрольных точек."

@izmalk izmalk added the need feedback [special status] On hold, awaiting feedback label Aug 23, 2019
@artur-barsegyan
Copy link
Contributor Author

artur-barsegyan commented Aug 27, 2019

Reviewed – read comments.

Also this issue might be mentioned in other parts of documentation: for example the very previous chapter has following text -
"Put all nodes in read-only mode and disable checkpointing with box.backup.start(). "
And in Russian -
"Переключите все узлы в режим только для чтения и отключите командой box.backup.start() создание контрольных точек."

My point at this ticket is box.backup.start() doesn't put a node in read_only mode and doesn't disable checkpointing.

@izmalk
Copy link
Contributor

izmalk commented Aug 27, 2019

Reviewed – read comments.

Also this issue might be mentioned in other parts of documentation: for example the very previous chapter has following text -
"Put all nodes in read-only mode and disable checkpointing with box.backup.start(). "
And in Russian -
"Переключите все узлы в режим только для чтения и отключите командой box.backup.start() создание контрольных точек."

My point at this ticket is box.backup.start() doesn't put a node in read_only mode and doesn't disable checkpointing.

I understand that and agree with your point, but my quote was an example of the same problem in other part of the documentation. I am suggesting we use this ticket to check all documentation for the same issue.
But i feel like i need a permission to do that from @lenkis.

@artur-barsegyan
Copy link
Contributor Author

artur-barsegyan commented Aug 27, 2019 via email

izmalk pushed a commit that referenced this issue Aug 27, 2019
Changed wording after dicussion
izmalk pushed a commit that referenced this issue Sep 2, 2019
fixed 1 word
lenkis pushed a commit that referenced this issue Sep 2, 2019
Fix gh-825 feedback: Submodule box.index
Fix gh-857 feedback: Модель данных
Fix gh-856 feedback: Access control
Fix gh-853 feedback: Functions for transaction management
Fix gh-848 feedback: Submodule box.index
Fix gh-834 Использование бинарного пакета
Fix gh-867 feedback: Access control
Fix gh-866 feedback: Триггеры
Fix gh-865 feedback: Триггеры
Fix gh-864 feedback: Рекомендации по Lua-синтаксису
Fix gh-861 feedback: Модуль http
Fix gh-869 Сonfusing wording in box.backup page
Fix gh-860 vshard.router/storage.sync miss return value documentation
Fix gh-830 Improve documentation on fibers
Fix gh-850 Add more info about connectors
@lenkis lenkis reopened this Sep 2, 2019
@lenkis
Copy link
Contributor

lenkis commented Sep 2, 2019

@izmalk Please check all entries of read-only throughout the manual. Changes may be required.

@lenkis lenkis assigned v-izmalkov and unassigned izmalk Sep 6, 2019
v-izmalkov pushed a commit that referenced this issue Sep 16, 2019
Fixed description regarding garbage collection in backup.start()
v-izmalkov pushed a commit that referenced this issue Sep 16, 2019
Fixed backup.start() use description in disaster recovery.
Note the ref-link to box.backup.stop() is the same as the start().
@v-izmalkov
Copy link
Contributor

I searched doc.po for all box.backup.start() mentions and checked them - made 2 adjustments to clarify the documentations. Applied all changes to Russian version too.

v-izmalkov pushed a commit that referenced this issue Oct 29, 2019
Fixed description regarding garbage collection in backup.start()
v-izmalkov pushed a commit that referenced this issue Oct 29, 2019
Fixed backup.start() use description in disaster recovery.
Note the ref-link to box.backup.stop() is the same as the start().
lenkis pushed a commit that referenced this issue Nov 11, 2019
Fix gh-876 document reaction on error in replication configuration change
Upd gh-868 Tarantool dependency list was changed
Fix gh-869 Сonfusing wording in box.backup page
Fix gh-893 feedback: Submodule box.info
Fix gh-902 feedback: Сборка из исходных файлов
Fix gh-915 feedback: Building from source
Fix gh-920 feedback: Module vshard
Fix gh-922 feedback: Module vshard
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working need feedback [special status] On hold, awaiting feedback
Projects
None yet
4 participants