Skip to content

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

Merged
merged 2 commits into from
Jan 10, 2024
Merged

3.0 iproto uri params #3973

merged 2 commits into from
Jan 10, 2024

Conversation

andreyaksenov
Copy link
Contributor

@andreyaksenov andreyaksenov commented Dec 27, 2023

  1. Created a runnable sample with SSL enabled for all instances:

    The config from this sample is included to the <uri>.params.transport option description.

  2. 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.

  1. Updated some existing descriptions:

  2. Updated the net.box sample (includes code from the new SSL sample):

@andreyaksenov andreyaksenov linked an issue Dec 27, 2023 that may be closed by this pull request
@andreyaksenov andreyaksenov force-pushed the 3.0-iproto-uri-params branch 16 times, most recently from a7f4371 to d980733 Compare January 2, 2024 08:23
@andreyaksenov andreyaksenov force-pushed the 3.0-iproto-uri-params branch 8 times, most recently from 9e14ca9 to 332e7f6 Compare January 9, 2024 14:16
@andreyaksenov andreyaksenov requested a review from ImeevMA January 9, 2024 14:35
@andreyaksenov andreyaksenov force-pushed the 3.0-iproto-uri-params branch 4 times, most recently from 54ca263 to 576a8ef Compare January 9, 2024 15:24
Copy link

@ImeevMA ImeevMA left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

Copy link
Contributor

@p7nov p7nov left a 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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
(Optional) An URI used to advertise the current instance.
(Optional) A URI used to advertise the current instance.

Copy link
Contributor Author

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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
(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.

Copy link
Contributor Author

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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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``.
Copy link
Contributor

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?

@andreyaksenov andreyaksenov merged commit 8fee77b into latest Jan 10, 2024
@andreyaksenov andreyaksenov deleted the 3.0-iproto-uri-params branch January 10, 2024 11:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

new format of the iproto.* config options.
3 participants