3.0 config: replication reference #3834
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
andreyaksenov
force-pushed
the
3.0-config-replication
branch
2 times, most recently
from
d7605c0
to
7dbe024
Compare
andreyaksenov
force-pushed
the
3.0-config-etcd
branch
19 times, most recently
from
82bc916
to
c3e8597
Compare
andreyaksenov
force-pushed
the
3.0-config-etcd
branch
2 times, most recently
from
fdf8244
to
0c5d37c
Compare
This was
linked to
issues
Nov 10, 2023
andreyaksenov
force-pushed
the
3.0-config-etcd
branch
2 times, most recently
from
c24f5b0
to
bb1784e
Compare
andreyaksenov
force-pushed
the
3.0-config-replication
branch
from
7dbe024
to
69f3816
Compare
andreyaksenov
force-pushed
the
3.0-config-replication
branch
7 times, most recently
from
ec04aac
to
3c5da27
Compare
andreyaksenov
force-pushed
the
3.0-config-replication
branch
from
3c5da27
to
c587d83
Compare
Totktonada
approved these changes
Nov 21, 2023
andreyaksenov
force-pushed
the
3.0-config-replication
branch
from
c587d83
to
97a98f7
Compare
xuniq
reviewed
Nov 23, 2023
|
|
||
| # The maximum number of old log files to retain. | ||
| log_maxbackups: 10 | ||
| # Tarantoolctl artifacts layout compatibility: if set to true tt will not create application |
There was a problem hiding this comment.
Suggested change
| # Tarantoolctl artifacts layout compatibility: if set to true tt will not create application | |
| # Tarantoolctl artifacts layout compatibility: if set to true, tt will not create application |
same for
- doc/code_snippets/snippets/replication/tt.yaml
- doc/code_snippets/snippets/sharding/tt.yaml
There was a problem hiding this comment.
Unfortunately, cannot fix this as tt.yaml is generated automatically using tt init. So, this is a reminder that we need to cteate a process for reviewing user-facing texts written by the tt development team.
| restart_on_failure: false | ||
| app: | ||
| # Directory that stores various instance runtime | ||
| # artifacts like console socket, PID file, etc. |
There was a problem hiding this comment.
Suggested change
| # artifacts like console socket, PID file, etc. | |
| # artifacts such as console socket, PID file, etc. |
same for
- doc/code_snippets/snippets/replication/tt.yaml
- doc/code_snippets/snippets/sharding/tt.yaml
There was a problem hiding this comment.
The same as above
| database | ||
| -------- | ||
|
|
||
| The ``database`` section defines database-specific configuration parameters, such as an instance's read-write mode, transaction isolation level, and so on. |
There was a problem hiding this comment.
Suggested change
| The ``database`` section defines database-specific configuration parameters, such as an instance's read-write mode, transaction isolation level, and so on. | |
| The ``database`` section defines database-specific configuration parameters, such as an instance's read-write mode or transaction isolation level. |
| - ``rw``: an instance is in read-write mode. | ||
| - ``ro``: an instance is in read-only mode. | ||
|
|
||
| If this option is not specified explicitly, its default value depends on the number of instances in a replica set. For a single instance, the ``rw`` mode is used, while for multiple instances, the ``ro`` mode is used. |
There was a problem hiding this comment.
Suggestion: If not specified explicitly, the default value depends on the number of instances in a replica set.
There was a problem hiding this comment.
Much better, thanks
|
|
||
| .. confval:: database.txn_timeout | ||
|
|
||
| A timeout (in seconds) after which the transaction is rolled back. |
There was a problem hiding this comment.
Suggested change
| A timeout (in seconds) after which the transaction is rolled back. | |
| A timeout in seconds after which the transaction is rolled back. |
There was a problem hiding this comment.
If you don't mind, I'd keep units in round brackets to emphasise this information a bit.
|
|
||
| .. confval:: iproto.net_msg_max | ||
|
|
||
| To handle messages, Tarantool allocates fibers. |
| Tarantool restricts how many messages the fibers handle, | ||
| so that some pending requests are blocked. | ||
|
|
||
| - On powerful systems, increase ``net_msg_max`` and the scheduler |
There was a problem hiding this comment.
Suggested change
| - On powerful systems, increase ``net_msg_max`` and the scheduler | |
| - On powerful systems, increase ``net_msg_max``, and the scheduler |
| - On powerful systems, increase ``net_msg_max`` and the scheduler | ||
| starts processing pending requests immediately. | ||
|
|
||
| - On weaker systems, decrease ``net_msg_max`` and the overhead |
There was a problem hiding this comment.
Suggested change
| - On weaker systems, decrease ``net_msg_max`` and the overhead | |
| - On weaker systems, decrease ``net_msg_max``, and the overhead |
Comment on lines
674
to
675
| may decrease although this may take some time because the | ||
| scheduler must wait until already-running requests finish. |
There was a problem hiding this comment.
Consider splitting this long sentence in two separate sentences
Comment on lines
974
to
976
| * ``off`` | ||
|
|
||
| A node doesn't participate in the election activities. |
There was a problem hiding this comment.
Suggested change
| * ``off`` | |
| A node doesn't participate in the election activities. | |
| * ``off``: a node doesn't participate in the election activities. |
Same for other possible values below
xuniq
approved these changes
Nov 23, 2023
andreyaksenov
added a commit
that referenced
this pull request
Dec 6, 2023
Updated configuration reference with options related to replication.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds reference for configuration options related to replication. Here are a summary of all changes:
code_snippets/snippetsfolder contains runnable tt applications referenced in docs. In addition to exiting examples, this PR adds thebootstrap_leader,peers, andshardingsamples. These samples are included in a reference page in various places to demonstrate various features. Moreover, all these samples will be reused in other places in docs (tutorials, how-tos, etc.) for keeping consistency and making sure all the examples work fine.configandconfig.etcd, the following sections are added toConfiguration reference:replicasetsandinstancessections)Note that
replication.anonanddatabase.hot_standbyare not documented yet. Will create separate tickets for documenting these options (#3857 and #3858).Links to new configuration options in main docs are not updated yet. Most likely, this will be done in separate PRs when updating corresponding topics.