Skip to content

Commit 6291442

Browse files
committed
Connection settings: update per review 2
1 parent f2df0e8 commit 6291442

File tree

2 files changed

+29
-27
lines changed

2 files changed

+29
-27
lines changed

doc/concepts/configuration/configuration_connections.rst

Lines changed: 17 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -3,20 +3,22 @@
33
Connections
44
===========
55

6-
Configuring connections is required for different purposes, for example:
7-
8-
- Communicating between cluster members.
9-
- Connecting to cluster members for administration using :ref:`tt <tt-cli>`.
10-
- Managing clusters using :ref:`Tarantool Cluster Manager <tcm>`.
11-
- Connecting to an instance using the :ref:`net.box <net_box-module>` module or :ref:`connectors <index-box_connectors>` for different languages.
12-
13-
To communicate to and between cluster instances, Tarantool uses a :ref:`binary protocol <box_protocol>` called iproto.
14-
The corresponding :ref:`iproto <configuration_reference_iproto>` section in :ref:`YAML configuration <configuration>` lets you configure various connection settings:
6+
To set up a Tarantool cluster, you need to enable communication between its instances, regardless of whether they running on one or different hosts.
7+
This requires :ref:`configuring <configuration>` connection settings that might include:
158

169
- One or several URIs used to listen for incoming requests.
17-
- An URI used advertise an instance to other cluster members.
10+
- An URI used to advertise an instance to other cluster members.
1811
- SSL settings used to secure connections.
1912

13+
Configuring connection settings is also required to enable communication of a Tarantool cluster to external systems.
14+
For example, this might be administering cluster members using :ref:`tt <tt-cli>`, managing clusters using :ref:`Tarantool Cluster Manager <tcm>`, or using :ref:`connectors <index-box_connectors>` for different languages.
15+
16+
This topic describes how to define connection settings in the :ref:`iproto <configuration_reference_iproto>` section of a YAML configuration.
17+
18+
.. NOTE::
19+
20+
iproto is a :ref:`binary protocol <box_protocol>` used to communicate between cluster instances and to communicate with external systems.
21+
2022

2123
.. _configuration_connections_listen_uri:
2224

@@ -108,9 +110,9 @@ An advertise URI (:ref:`iproto.advertise.* <configuration_reference_iproto_adver
108110
- ``iproto.advertise.sharding`` specifies how to advertise the instance to a router and rebalancer.
109111
- ``iproto.advertise.client`` accepts a URI used to advertise the instance to clients.
110112

111-
``iproto_advertise.<peer_or_sharding>`` might include the credentials required to connect to this instance, a URI used to listen for incoming requests, and SSL settings.
113+
``iproto.advertise.<peer_or_sharding>`` might include the credentials required to connect to this instance, a URI used to listen for incoming requests, and SSL settings.
112114

113-
If ``iproto_advertise.<peer_or_sharding>.uri`` is not specified explicitly, a :ref:`listen URI <configuration_connections_listen_uri>` of this instance is used.
115+
If ``iproto.advertise.<peer_or_sharding>.uri`` is not specified explicitly, a :ref:`listen URI <configuration_connections_listen_uri>` of this instance is used.
114116
In this case, you need at least to specify credentials for connecting to this instance.
115117

116118

@@ -141,7 +143,7 @@ In a sharded cluster, ``iproto.advertise.sharding`` specifies that a router and
141143
URI
142144
~~~
143145

144-
If required, you can specify an advertise URI explicitly by setting up the :ref:`iproto_advertise.\<peer_or_sharding\>.uri <configuration_reference_iproto_advertise.peer_sharding.uri>` option.
146+
If required, you can specify an advertise URI explicitly by setting up the :ref:`iproto.advertise.\<peer_or_sharding\>.uri <configuration_reference_iproto_advertise.peer_sharding.uri>` option.
145147
In the example below, ``iproto.listen`` includes two URIs that can be used to connect to ``instance001`` but only the second one is used to advertise this instance to other replica set peers:
146148

147149
.. literalinclude:: /code_snippets/snippets/replication/instances.enabled/advertise_peer/config.yaml
@@ -150,7 +152,7 @@ In the example below, ``iproto.listen`` includes two URIs that can be used to co
150152
:end-before: instance002:
151153
:dedent:
152154

153-
The ``iproto_advertise.<peer_or_sharding>.uri`` option can also accept an FQDN instead of an IP address:
155+
The ``iproto.advertise.<peer_or_sharding>.uri`` option can also accept an FQDN instead of an IP address:
154156

155157
.. code-block:: yaml
156158
@@ -237,7 +239,7 @@ SSL parameters for an advertise URI should be set only if this :ref:`advertise U
237239
Otherwise, SSL parameters of a listen URI are used and no additional configuration is required.
238240

239241
Configuring an advertise URI's SSL options depends on whether a trusted certificate authorities (CA) file is set or not.
240-
Without the CA file, you only need to set ``iproto_advertise.<peer_or_sharding>.params.transport`` to ``ssl`` as shown below:
242+
Without the CA file, you only need to set ``iproto.advertise.<peer_or_sharding>.params.transport`` to ``ssl`` as shown below:
241243

242244
.. code-block:: yaml
243245

doc/reference/configuration/configuration_reference.rst

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -564,8 +564,8 @@ iproto.advertise.*
564564

565565
.. confval:: iproto.advertise.peer
566566

567-
Settings used advertise the current instance to other cluster members.
568-
The format of these setting is described in :ref:`iproto_advertise.\<peer_or_sharding\>.* <configuration_reference_iproto_advertise.peer_sharding>`.
567+
Settings used to advertise the current instance to other cluster members.
568+
The format of these settings is described in :ref:`iproto.advertise.\<peer_or_sharding\>.* <configuration_reference_iproto_advertise.peer_sharding>`.
569569

570570
**Example**
571571

@@ -587,8 +587,8 @@ iproto.advertise.*
587587

588588
.. confval:: iproto.advertise.sharding
589589

590-
Settings used advertise the current instance to a router and rebalancer.
591-
The format of these setting is described in :ref:`iproto_advertise.\<peer_or_sharding\>.* <configuration_reference_iproto_advertise.peer_sharding>`.
590+
Settings used to advertise the current instance to a router and rebalancer.
591+
The format of these settings is described in :ref:`iproto.advertise.\<peer_or_sharding\>.* <configuration_reference_iproto_advertise.peer_sharding>`.
592592

593593
**Example**
594594

@@ -615,7 +615,7 @@ iproto.advertise.<peer_or_sharding>.*
615615

616616
.. _configuration_reference_iproto_advertise.peer_sharding.uri:
617617

618-
.. confval:: iproto_advertise.<peer_or_sharding>.uri
618+
.. confval:: iproto.advertise.<peer_or_sharding>.uri
619619

620620
(Optional) A URI used to advertise the current instance.
621621
By default, the URI defined in :ref:`iproto.listen <configuration_reference_iproto_listen>` is used to advertise the current instance.
@@ -631,7 +631,7 @@ iproto.advertise.<peer_or_sharding>.*
631631
632632
.. _configuration_reference_iproto_advertise.peer_sharding.login:
633633

634-
.. confval:: iproto_advertise.<peer_or_sharding>.login
634+
.. confval:: iproto.advertise.<peer_or_sharding>.login
635635

636636
(Optional) A username used to connect to the current instance.
637637
If a username is not set, the ``guest`` user is used.
@@ -643,7 +643,7 @@ iproto.advertise.<peer_or_sharding>.*
643643
644644
.. _configuration_reference_iproto_advertise.peer_sharding.password:
645645

646-
.. confval:: iproto_advertise.<peer_or_sharding>.password
646+
.. confval:: iproto.advertise.<peer_or_sharding>.password
647647

648648
(Optional) A password for the specified user.
649649
If a ``login`` is specified but a password is missing, it is taken from the user's :ref:`credentials <configuration_reference_credentials>`.
@@ -655,7 +655,7 @@ iproto.advertise.<peer_or_sharding>.*
655655
656656
.. _configuration_reference_iproto_advertise.peer_sharding.params:
657657

658-
.. confval:: iproto_advertise.<peer_or_sharding>.params
658+
.. confval:: iproto.advertise.<peer_or_sharding>.params
659659

660660
(Optional) URI parameters (:ref:`<uri>.params.* <configuration_reference_iproto_uri_params>`) required for connecting to the current instance.
661661

@@ -672,7 +672,7 @@ iproto.*
672672
An array of URIs used to listen for incoming requests.
673673
If required, you can enable SSL for specific URIs by providing additional parameters (:ref:`<uri>.params.* <configuration_reference_iproto_uri_params>`).
674674

675-
Note that a URI value can't contain parameters, a login, or password.
675+
Note that a URI value can't contain parameters, a login, or a password.
676676

677677
**Example**
678678

@@ -705,7 +705,7 @@ iproto.*
705705
starts processing pending requests immediately.
706706

707707
- On weaker systems, decrease ``net_msg_max``, and the overhead
708-
may decrease. Although this may take some time because the
708+
may decrease. However, this may take some time because the
709709
scheduler must wait until already-running requests finish.
710710

711711
When ``net_msg_max`` is reached,
@@ -779,8 +779,8 @@ iproto.*
779779

780780
URI parameters that can be used in the following options:
781781

782-
- :ref:`iproto_advertise.\<peer_or_sharding\>.params <configuration_reference_iproto_advertise.peer_sharding.params>`
783-
- :ref:`iproto.listen <configuration_reference_iproto_listen>`
782+
- :ref:`iproto.advertise.\<peer_or_sharding\>.params <configuration_reference_iproto_advertise.peer_sharding.params>`
783+
- :ref:`iproto.listen.\<uri\>.params <configuration_reference_iproto_listen>`
784784

785785
.. NOTE::
786786

0 commit comments

Comments
 (0)