Skip to content

Add Static Credentials for Rust SDK to the docs #2824

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.

Sign up for GitHub

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 5 commits into from
Mar 18, 2024
Merged

Add Static Credentials for Rust SDK to the docs #2824

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
3913b5c
static credentials are implemented for Rust SDK
Mar 15, 2024
6f2485e
Merge branch 'ydb-platform:main' into main
uslon Mar 15, 2024
932fccf
refer to ydb-platform-owned repository
Mar 15, 2024
6f9f834
add |
Mar 15, 2024
1e55d3e
add examples
Mar 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions ydb/docs/en/core/reference/ydb-sdk/_includes/auth.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,7 @@ You can click any of the methods below to go to the source code of an example in
| Anonymous | ydb::StaticToken("") |
| Access Token | ydb::StaticToken(token) |
| Metadata | ydb::GCEMetadata, ydb::YandexMetadata |
| Static Credentials | [ydb::StaticCredentialsAuth](https://github.com/ydb-platform/ydb-rs-sdk/blob/master/ydb/examples/auth-static-credentials.rs) |
| Service Account Key | not supported |
| Determined by environment variables | not supported |
| Execution of an external command | ydb.CommandLineYcToken (for example, for authentication using a {{ yandex-cloud }} [IAM token]{% if lang == "ru"%}(https://cloud.yandex.ru/docs/iam/concepts/authorization/iam-token){% endif %}{% if lang == "en" %}(https://cloud.yandex.com/en/docs/iam/concepts/authorization/iam-token){% endif %} from the developer's computer ```ydb::CommandLineYcToken.from_cmd("yc iam create-token")```) |
Expand Down
6 changes: 3 additions & 3 deletions ydb/docs/en/core/reference/ydb-sdk/feature-parity.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
| Load balancing across all nodes of all local DCs | \+ | \+ | \+ | ? | \- | \- | \- |
| **Credentials providers** |
| Anonymous (default) | \+ | \+ | \+ | \+ | \+ | \+ | \+ | \+ |
| Static (user - password) | \+ | \+ | \+ | \+ | \- | \- | \- | \- |
| Static (user - password) | \+ | \+ | \+ | \+ | \- | \- | \+ | \- |
| Token: IAM, OAuth | \+ | \+ | \+ | \+ | \+ | \+ | \+ | \+ |
| Service account (Yandex.Cloud specific) | \+ | \+ | \+ | \+ | \+ | \+ | \- | \+ |
| Metadata (Yandex.Cloud specific) | \+ | \+ | \+ | \+ | \+ | \+ | \+ | \+ |
Expand Down Expand Up @@ -124,12 +124,12 @@
| in OpenTracing | \- | ? | \+ | \- | \- | \- | \- | \- |
| **Examples** |
| Auth |
| \* token | ? | ? | \+ | \+ | \+ | \+ | | \+ |
| \* token | ? | ? | \+ | \+ | \+ | \+ | \+ | \+ |
| \* anonymous | ? | ? | \+ | \+ | \+ | \+ | | \+ |
| \* environ | ? | ? | \+ | \+ | \+ | \- | | \+ |
| \* metadata | ? | ? | \+ | \+ | \+ | \+ | | \+ |
| \* service_account | ? | ? | \+ | \+ | \+ | \- | | \+ |
| \* static (username \+ password) | ? | ? | \+ | \+ | \+ | \+ | | \- |
| \* static (username \+ password) | ? | ? | \+ | \+ | \+ | \+ | \+ | \- |
| Basic (series) | \+ | ? | \+ | \+ | \+ | \+ | \+ | \+ |
| Bulk Upsert | \+/- | ? | \+ | \+ | \+ | \- | | \- |
| Containers (Struct,Variant,List,Tuple) | \- | ? | \+ | \- | \- | \- | | \- |
Expand Down
1 change: 1 addition & 0 deletions ydb/docs/ru/core/reference/ydb-sdk/_includes/auth.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,7 @@
Access Token | ydb::StaticToken(token)
Metadata | ydb::GCEMetadata, ydb::YandexMetadata
Service Account Key | не поддерживается
Static Credentials | [ydb::StaticCredentialsAuth](https://github.com/ydb-platform/ydb-rs-sdk/blob/master/ydb/examples/auth-static-credentials.rs)
Определяется по переменным окружения | не поддерживается
Выполнение внешней команды | ydb.CommandLineYcToken (например, для авторизации с помощью [IAM-токена]{% if lang == "ru"%}(https://cloud.yandex.ru/docs/iam/concepts/authorization/iam-token){% endif %}{% if lang == "en" %}(https://cloud.yandex.com/en/docs/iam/concepts/authorization/iam-token){% endif %} {{ yandex-cloud }} с компьютера разработчика ```ydb::CommandLineYcToken.from_cmd("yc iam create-token")```)

Expand Down
4 changes: 2 additions & 2 deletions ydb/docs/ru/core/reference/ydb-sdk/feature-parity.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
|Балансировка среди всех нод всех локального ДЦ|\+|\+|\+|?|\-|\-|\-||
|**Credentials providers**|||||||||
|Anonymous (по умолчанию)|\+|\+|\+|\+|\+|\+|\+|\+|
|Static (user - password)|\+|\+|\+|\+|\-|\-|\-|\+|
|Static (user - password)|\+|\+|\+|\+|\-|\-|\+|\+|
|Token: IAM, OAuth|\+|\+|\+|\+|\+|\+|\+|\+|
|Service account (Yandex.Cloud specific)|\+|\+|\+|\+|\+|\+|\-|\+|
|Metadata (Yandex.Cloud specific)|\+|\+|\+|\+|\+|\+|\+|\+|
Expand Down Expand Up @@ -130,7 +130,7 @@
|\* environ|?|?|\+|\+|\+|\-|\-|\+|
|\* metadata|?|?|\+|\+|\+|\+|\+|\+|
|\* service_account|?|?|\+|\+|\+|\-|\-|\+|
|\* static (username \+ password)|?|?|\+|\+|\+|\+|\-|\+|
|\* static (username \+ password)|?|?|\+|\+|\+|\+|\+|\+|
|Basic (series)|\+|?|\+|\+|\+|\+|\+|\+|
|Bulk Upsert|\+/-|?|\+|\+|\+|\-|\-|\+|
|Containers (Struct,Variant,List,Tuple)|\-|?|\+|\-|\-|\-|\+|\-|
Expand Down