Skip to content

Commit f4574a8

Browse files
committed
Connection settings: update per review 2.1
1 parent 27a2e8b commit f4574a8

File tree

2 files changed

+11
-5
lines changed

2 files changed

+11
-5
lines changed

doc/concepts/configuration/configuration_connections.rst

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,11 @@ Connections
44
===========
55

66
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:
7+
This requires :ref:`configuring <configuration>` connection settings that include:
88

99
- One or several URIs used to listen for incoming requests.
10-
- An URI used to advertise an instance to other cluster members.
11-
- SSL settings used to secure connections.
10+
- An URI used to advertise an instance to other cluster members. This URI lets other cluster members know how to connect to the current Tarantool instance.
11+
- (Optional) SSL settings used to secure connections between instances.
1212

1313
Configuring connection settings is also required to enable communication of a Tarantool cluster to external systems.
1414
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.
@@ -74,14 +74,16 @@ In this case, this port is used for all IP addresses the server listens on.
7474
SSL parameters
7575
~~~~~~~~~~~~~~
7676

77-
In the Enterprise Edition, you can enable :ref:`traffic encryption <configuration_connections_ssl>` for a connection using the ``params`` section of the specified URI:
77+
In the Enterprise Edition, you can enable for a connection using the ``params`` section of the specified URI:
7878

7979
.. literalinclude:: /code_snippets/snippets/replication/instances.enabled/ssl_without_ca/config.yaml
8080
:language: yaml
8181
:start-at: instance001:
8282
:end-before: instance002:
8383
:dedent:
8484

85+
Learn more from :ref:`configuration_connections_ssl`.
86+
8587

8688
.. _configuration_connections_unix_socket:
8789

@@ -107,7 +109,7 @@ Advertise URI
107109
An advertise URI (:ref:`iproto.advertise.* <configuration_reference_iproto_advertise>`) lets other cluster members or clients know how to connect to the current Tarantool instance:
108110

109111
- ``iproto.advertise.peer`` specifies how to advertise the instance to other cluster members.
110-
- ``iproto.advertise.sharding`` specifies how to advertise the instance to a router and rebalancer.
112+
- ``iproto.advertise.sharding`` specifies how to advertise the instance to a :ref:`router <vshard-architecture-router>` and :ref:`rebalancer <vshard-rebalancer>`.
111113
- ``iproto.advertise.client`` accepts a URI used to advertise the instance to clients.
112114

113115
``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.

doc/reference/configuration/configuration_reference.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -590,6 +590,10 @@ iproto.advertise.*
590590
Settings used to advertise the current instance to a router and rebalancer.
591591
The format of these settings is described in :ref:`iproto.advertise.\<peer_or_sharding\>.* <configuration_reference_iproto_advertise.peer_sharding>`.
592592

593+
.. NOTE::
594+
595+
If ``iproto.advertise.sharding`` is not specified, advertise settings from :ref:`iproto.advertise.peer <configuration_reference_iproto_advertise_peer>` are used.
596+
593597
**Example**
594598

595599
In the example below, the following configuration options are specified:

0 commit comments

Comments
 (0)