You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: doc/concepts/configuration/configuration_connections.rst
+17-15Lines changed: 17 additions & 15 deletions
Original file line number
Diff line number
Diff line change
@@ -3,20 +3,22 @@
3
3
Connections
4
4
===========
5
5
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:
15
8
16
9
- 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.
18
11
- SSL settings used to secure connections.
19
12
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
+
20
22
21
23
.. _configuration_connections_listen_uri:
22
24
@@ -108,9 +110,9 @@ An advertise URI (:ref:`iproto.advertise.* <configuration_reference_iproto_adver
108
110
- ``iproto.advertise.sharding`` specifies how to advertise the instance to a router and rebalancer.
109
111
- ``iproto.advertise.client`` accepts a URI used to advertise the instance to clients.
110
112
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.
112
114
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.
114
116
In this case, you need at least to specify credentials for connecting to this instance.
115
117
116
118
@@ -141,7 +143,7 @@ In a sharded cluster, ``iproto.advertise.sharding`` specifies that a router and
141
143
URI
142
144
~~~
143
145
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.
145
147
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:
(Optional) URI parameters (:ref:`<uri>.params.* <configuration_reference_iproto_uri_params>`) required for connecting to the current instance.
661
661
@@ -672,7 +672,7 @@ iproto.*
672
672
An array of URIs used to listen for incoming requests.
673
673
If required, you can enable SSL for specific URIs by providing additional parameters (:ref:`<uri>.params.* <configuration_reference_iproto_uri_params>`).
674
674
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.
676
676
677
677
**Example**
678
678
@@ -705,7 +705,7 @@ iproto.*
705
705
starts processing pending requests immediately.
706
706
707
707
- 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
709
709
scheduler must wait until already-running requests finish.
710
710
711
711
When ``net_msg_max`` is reached,
@@ -779,8 +779,8 @@ iproto.*
779
779
780
780
URI parameters that can be used in the following options:
0 commit comments