Skip to content

Commit 2dde692

Browse files
committed
Connection settings: update reference
1 parent 6634542 commit 2dde692

File tree

1 file changed

+13
-34
lines changed

1 file changed

+13
-34
lines changed

doc/reference/configuration/configuration_reference.rst

Lines changed: 13 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -501,7 +501,9 @@ The ``database`` section defines database-specific configuration parameters, suc
501501
iproto
502502
------
503503

504-
The ``iproto`` section is used to configure parameters related to communicating to and between cluster instances.
504+
The ``iproto`` section is used to configure parameters related to :ref:`communicating to and between cluster instances <configuration_connections>` topic.
505+
506+
Learn more about communication to and between Tarantool instances from the
505507

506508
.. NOTE::
507509

@@ -564,9 +566,8 @@ iproto.advertise.*
564566

565567
.. confval:: iproto.advertise.peer
566568

567-
A URI used to advertise the current instance to other cluster members.
568-
569-
The ``iproto.advertise.peer`` option accepts a URI in the format described in :ref:`iproto_advertise.\<peer_or_sharding\>.* <configuration_reference_iproto_advertise.peer_sharding>`.
569+
Settings used advertise the current instance to other cluster members.
570+
The format of these setting is described in :ref:`iproto_advertise.\<peer_or_sharding\>.* <configuration_reference_iproto_advertise.peer_sharding>`.
570571

571572
**Example**
572573

@@ -588,9 +589,8 @@ iproto.advertise.*
588589

589590
.. confval:: iproto.advertise.sharding
590591

591-
An advertise URI used by a router and rebalancer.
592-
593-
The ``iproto.advertise.sharding`` option accepts a URI in the format described in :ref:`iproto_advertise.\<peer_or_sharding\>.* <configuration_reference_iproto_advertise.peer_sharding>`.
592+
Settings used advertise the current instance to a router and rebalancer.
593+
The format of these setting is described in :ref:`iproto_advertise.\<peer_or_sharding\>.* <configuration_reference_iproto_advertise.peer_sharding>`.
594594

595595
**Example**
596596

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

677-
These URIs are used for different purposes, for example:
678-
679-
- Communicating between replica set peers or cluster members. See also: :ref:`iproto.advertise.* <configuration_reference_iproto_advertise>`.
680-
- Remote administration using :ref:`tt connect <tt-connect>`.
681-
- Connecting to an instance using the :ref:`net.box <net_box-module>` module.
682-
- Connecting to an instance using :ref:`connectors <index-box_connectors>` for different languages.
683-
684-
To grant the specified privileges for connecting to an instance, use the :ref:`credentials <configuration_reference_credentials>` configuration section.
685-
686677
**Example**
687678

688679
In the example below, ``iproto.listen`` is set explicitly for each instance in a cluster:
@@ -799,15 +790,8 @@ URI parameters that can be used in the following options:
799790

800791
.. confval:: <uri>.params.transport
801792

802-
Allows you to enable traffic encryption for client-server communications over :ref:`binary connections <box_protocol-iproto_protocol>`:
803-
804-
- A server is a Tarantool instance.
805-
- A client might be one of the following:
806-
807-
- Another Tarantool instance from this cluster. This means that one instance might act as the server that accepts connections from other instances and the client that connects to other instances.
808-
- A remote administrative console (:ref:`tt connect <tt-connect>`).
809-
- A :ref:`net.box <net_box-module>` connector.
810-
- :ref:`Connectors <index-box_connectors>` provided for different languages.
793+
Allows you to enable :ref:`traffic encryption <configuration_connections_ssl>` for client-server communications over binary connections.
794+
In a Tarantool cluster, one instance might act as the server that accepts connections from other instances and the client that connects to other instances.
811795

812796
``<uri>.params.transport`` accepts one of the following values:
813797

@@ -816,23 +800,18 @@ URI parameters that can be used in the following options:
816800

817801
**Example**
818802

819-
The example below demonstrates how to enable traffic encryption for connections between replica set peers.
803+
The example below demonstrates how to enable traffic encryption by using a self-signed server certificate.
820804
The following parameters are specified for each instance:
821805

822-
- ``ssl_ca_file``: a path to a trusted certificate authorities (CA) file.
823806
- ``ssl_cert_file``: a path to an SSL certificate file.
824807
- ``ssl_key_file``: a path to a private SSL key file.
825-
- ``ssl_password`` (``instance001``): a password for an encrypted private SSL key.
826-
- ``ssl_password_file`` (``instance002`` and ``instance003``): a text file containing passwords for encrypted SSL keys.
827-
- ``ssl_ciphers``: a colon-separated list of SSL cipher suites the connection can use.
828808

829-
.. literalinclude:: /code_snippets/snippets/replication/instances.enabled/ssl/config.yaml
809+
.. literalinclude:: /code_snippets/snippets/replication/instances.enabled/ssl_without_ca/config.yaml
830810
:language: yaml
831-
:start-at: groups:
832-
:end-before: app:
811+
:start-at: replicaset001:
833812
:dedent:
834813

835-
You can find the full example here: `ssl <https://github.com/tarantool/doc/tree/latest/doc/code_snippets/snippets/replication/instances.enabled/ssl>`_.
814+
You can find the full example here: `ssl_without_ca <https://github.com/tarantool/doc/tree/latest/doc/code_snippets/snippets/replication/instances.enabled/ssl_without_ca>`_.
836815

837816
|
838817
| Type: string

0 commit comments

Comments
 (0)