-
Notifications
You must be signed in to change notification settings - Fork 43
3.0 iproto uri params #3973
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
3.0 iproto uri params #3973
Conversation
a7f4371
to
d980733
Compare
9e14ca9
to
332e7f6
Compare
54ca263
to
576a8ef
Compare
576a8ef
to
cbf9a78
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM!
cbf9a78
to
ede55c0
Compare
ede55c0
to
e1c677e
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM, just some minor comments.
@@ -619,7 +619,8 @@ iproto.advertise.<peer_or_sharding>.* | |||
|
|||
.. confval:: iproto_advertise.<peer_or_sharding>.uri | |||
|
|||
An URI used to advertise the current instance. | |||
(Optional) An URI used to advertise the current instance. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
(Optional) An URI used to advertise the current instance. | |
(Optional) A URI used to advertise the current instance. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks, also fixed in other places
@@ -634,7 +635,8 @@ iproto.advertise.<peer_or_sharding>.* | |||
|
|||
.. confval:: iproto_advertise.<peer_or_sharding>.login | |||
|
|||
A username that should be used to connect to the current instance. | |||
(Optional) A username that should be used to connect to the current instance. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
(Optional) A username that should be used to connect to the current instance. | |
(Optional) A username used for connecting to the current instance. |
Feel free to ignore this edit if it changes the meaning.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Changed to A username used to connect to the current instance.
A password for the specified user. | ||
If a password is missing, it is taken from :ref:`credentials <configuration_reference_credentials>` for the specified username. | ||
(Optional) A password for the specified user. | ||
If ``login`` is specified but a password is missing, it is taken from :ref:`credentials <configuration_reference_credentials>` for this user. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If ``login`` is specified but a password is missing, it is taken from :ref:`credentials <configuration_reference_credentials>` for this user. | |
If a ``login`` is specified but a password is missing, it is taken from the user's :ref:`credentials <configuration_reference_credentials>`. |
- ``ssl_cert_file``: a path to an SSL certificate file. | ||
- ``ssl_key_file``: a path to a private SSL key file. | ||
- ``ssl_password`` (``instance001``): a password for an encrypted private SSL key. | ||
For ``instance002`` and ``instance003``, passwords for encrypted SSL keys are provided in ``ssl_password_file``. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe make ssl_password_file
a separate list item for better visibility?
Created a runnable sample with SSL enabled for all instances:
The config from this sample is included to the
<uri>.params.transport
option description.Documented all options in
<uri>.params.*
:Options descriptions are taken from Traffic encryption with some cosmetic changes.
Note
The
Traffic encryption
section will be updated to the new config and moved to the Configuration section when working on the #3665 issue.Updated some existing descriptions:
iproto_advertise.<peer_or_sharding>.uri
: https://docs.d.tarantool.io/en/doc/3.0-iproto-uri-params/reference/configuration/configuration_reference/#iproto-advertise-peer-or-shardingiproto.listen
: https://docs.d.tarantool.io/en/doc/3.0-iproto-uri-params/reference/configuration/configuration_reference/#configuration-reference-iproto-miscUpdated the
net.box
sample (includes code from the new SSL sample):