diff options
author | bazeltsev <bazeltsev@ydb.tech> | 2022-12-21 15:40:45 +0300 |
---|---|---|
committer | bazeltsev <bazeltsev@ydb.tech> | 2022-12-21 15:40:45 +0300 |
commit | 3944a91c66d9c840653678977c58bd5cc0fecfa8 (patch) | |
tree | 51ec16061658e1053aafc2ffc9e9467a0dc22584 | |
parent | 84ca810714ae4a9cb7c61bb07920b769c49ec31b (diff) | |
download | ydb-3944a91c66d9c840653678977c58bd5cc0fecfa8.tar.gz |
Improve format auth recipes Node.js
updated
updated
20 files changed, 18 insertions, 28 deletions
diff --git a/ydb/docs/_includes/nodejs/recipes/auth/access-token.md b/ydb/docs/_includes/nodejs/auth-access-token.md index b3dcf825a8..b3dcf825a8 100644 --- a/ydb/docs/_includes/nodejs/recipes/auth/access-token.md +++ b/ydb/docs/_includes/nodejs/auth-access-token.md diff --git a/ydb/docs/_includes/nodejs/recipes/auth/anonymous.md b/ydb/docs/_includes/nodejs/auth-anonymous.md index 2741bd3a6d..2741bd3a6d 100644 --- a/ydb/docs/_includes/nodejs/recipes/auth/anonymous.md +++ b/ydb/docs/_includes/nodejs/auth-anonymous.md diff --git a/ydb/docs/_includes/nodejs/recipes/auth/env.md b/ydb/docs/_includes/nodejs/auth-env.md index ef828d85eb..ef828d85eb 100644 --- a/ydb/docs/_includes/nodejs/recipes/auth/env.md +++ b/ydb/docs/_includes/nodejs/auth-env.md diff --git a/ydb/docs/_includes/nodejs/recipes/auth/metadata.md b/ydb/docs/_includes/nodejs/auth-metadata.md index 49ad89741b..49ad89741b 100644 --- a/ydb/docs/_includes/nodejs/recipes/auth/metadata.md +++ b/ydb/docs/_includes/nodejs/auth-metadata.md diff --git a/ydb/docs/_includes/nodejs/recipes/auth/service-account-data.md b/ydb/docs/_includes/nodejs/auth-sa-data.md index c9a75197ed..c9a75197ed 100644 --- a/ydb/docs/_includes/nodejs/recipes/auth/service-account-data.md +++ b/ydb/docs/_includes/nodejs/auth-sa-data.md diff --git a/ydb/docs/_includes/nodejs/recipes/auth/service-account-file.md b/ydb/docs/_includes/nodejs/auth-sa-file.md index 2531dd0365..2531dd0365 100644 --- a/ydb/docs/_includes/nodejs/recipes/auth/service-account-file.md +++ b/ydb/docs/_includes/nodejs/auth-sa-file.md diff --git a/ydb/docs/_includes/nodejs/recipes/auth/static.md b/ydb/docs/_includes/nodejs/auth-static.md index 932d2d2814..932d2d2814 100644 --- a/ydb/docs/_includes/nodejs/recipes/auth/static.md +++ b/ydb/docs/_includes/nodejs/auth-static.md diff --git a/ydb/docs/en/core/reference/ydb-sdk/recipes/auth-access-token.md b/ydb/docs/en/core/reference/ydb-sdk/recipes/auth-access-token.md index 5c5a17a375..f5caeadfc6 100644 --- a/ydb/docs/en/core/reference/ydb-sdk/recipes/auth-access-token.md +++ b/ydb/docs/en/core/reference/ydb-sdk/recipes/auth-access-token.md @@ -123,6 +123,6 @@ Below are examples of the code for authentication using a token in different {{ - Node.js - {% include [access-token](../../../../_includes/nodejs/recipes/auth/access-token.md) %} + {% include [auth-access-token](../../../../_includes/nodejs/auth-access-token.md) %} {% endlist %} diff --git a/ydb/docs/en/core/reference/ydb-sdk/recipes/auth-anonymous.md b/ydb/docs/en/core/reference/ydb-sdk/recipes/auth-anonymous.md index 677aa0422e..8767f93ad4 100644 --- a/ydb/docs/en/core/reference/ydb-sdk/recipes/auth-anonymous.md +++ b/ydb/docs/en/core/reference/ydb-sdk/recipes/auth-anonymous.md @@ -92,6 +92,6 @@ Below are examples of the code for anonymous authentication in different {{ ydb- - Node.js - {% include [anonymous](../../../../_includes/nodejs/recipes/auth/anonymous.md) %} + {% include [auth-anonymous](../../../../_includes/nodejs/auth-anonymous.md) %} {% endlist %} diff --git a/ydb/docs/en/core/reference/ydb-sdk/recipes/auth-env.md b/ydb/docs/en/core/reference/ydb-sdk/recipes/auth-env.md index 7e0b500490..4be2dac569 100644 --- a/ydb/docs/en/core/reference/ydb-sdk/recipes/auth-env.md +++ b/ydb/docs/en/core/reference/ydb-sdk/recipes/auth-env.md @@ -100,6 +100,6 @@ Below are examples of the code for authentication using environment variables in - Node.js - {% include [env](../../../../_includes/nodejs/recipes/auth/env.md) %} + {% include [auth-env](../../../../_includes/nodejs/auth-env.md) %} {% endlist %} diff --git a/ydb/docs/en/core/reference/ydb-sdk/recipes/auth-metadata.md b/ydb/docs/en/core/reference/ydb-sdk/recipes/auth-metadata.md index 93f16d6953..c40d699ed5 100644 --- a/ydb/docs/en/core/reference/ydb-sdk/recipes/auth-metadata.md +++ b/ydb/docs/en/core/reference/ydb-sdk/recipes/auth-metadata.md @@ -92,6 +92,6 @@ Below are examples of the code for authentication using environment variables in - Node.js - {% include [metadata](../../../../_includes/nodejs/recipes/auth/metadata.md) %} + {% include [auth-metadata](../../../../_includes/nodejs/auth-metadata.md) %} {% endlist %} diff --git a/ydb/docs/en/core/reference/ydb-sdk/recipes/auth-service-account.md b/ydb/docs/en/core/reference/ydb-sdk/recipes/auth-service-account.md index 9f1f40c065..1a9468ca8c 100644 --- a/ydb/docs/en/core/reference/ydb-sdk/recipes/auth-service-account.md +++ b/ydb/docs/en/core/reference/ydb-sdk/recipes/auth-service-account.md @@ -98,12 +98,12 @@ Below are examples of the code for authentication using a service account file i ### Load service account data from file - {% include [service-account-file](../../../../_includes/nodejs/recipes/auth/service-account-file.md) %} + {% include [auth-sa-file](../../../../_includes/nodejs/auth-sa-file.md) %} ### Load service account data from other source When you need to load service account data from the outside, for example, from the secrets vault, this method is suitable: - {% include [service-account-data](../../../../_includes/nodejs/recipes/auth/service-account-data.md) %} + {% include [service-account-data](../../../../_includes/nodejs/auth-sa-data.md) %} {% endlist %} diff --git a/ydb/docs/en/core/reference/ydb-sdk/recipes/auth-static.md b/ydb/docs/en/core/reference/ydb-sdk/recipes/auth-static.md index 3ba566a1fe..31b1a38024 100644 --- a/ydb/docs/en/core/reference/ydb-sdk/recipes/auth-static.md +++ b/ydb/docs/en/core/reference/ydb-sdk/recipes/auth-static.md @@ -63,6 +63,6 @@ Below are examples of the code for authentication based on a username and token - Node.js - {% include [static](../../../../_includes/nodejs/recipes/auth/static.md) %} + {% include [auth-static](../../../../_includes/nodejs/auth-static.md) %} {% endlist %} diff --git a/ydb/docs/ru/core/reference/ydb-sdk/_includes/auth.md b/ydb/docs/ru/core/reference/ydb-sdk/_includes/auth.md index 9f1f2224ad..e4418fa1f6 100644 --- a/ydb/docs/ru/core/reference/ydb-sdk/_includes/auth.md +++ b/ydb/docs/ru/core/reference/ydb-sdk/_includes/auth.md @@ -32,10 +32,10 @@ Режим | Пакет | Метод ----- | ----- | ---- Anonymous | [ydb-go-sdk/v3](https://github.com/ydb-platform/ydb-go-sdk/)| [ydb.WithAnonymousCredentials()](https://github.com/ydb-platform/ydb-go-examples/tree/master/auth/anonymous_credentials) - User+Password | [ydb-go-sdk/v3](https://github.com/ydb-platform/ydb-go-sdk/) | [ydb.WithStaticCredentials(user, password)](https://github.com/ydb-platform/ydb-go-examples/tree/master/auth/static_credentials) Access Token | [ydb-go-sdk/v3](https://github.com/ydb-platform/ydb-go-sdk/) | [ydb.WithAccessTokenCredentials(token)](https://github.com/ydb-platform/ydb-go-examples/tree/master/auth/access_token_credentials) Metadata | [ydb-go-yc](https://github.com/ydb-platform/ydb-go-yc/) | [yc.WithMetadataCredentials(ctx)](https://github.com/ydb-platform/ydb-go-examples/tree/master/auth/metadata_credentials) Service Account Key | [ydb-go-yc](https://github.com/ydb-platform/ydb-go-yc/) | [yc.WithServiceAccountKeyFileCredentials(key_file)](https://github.com/ydb-platform/ydb-go-examples/tree/master/auth/service_account_credentials) + Static Credentials | [ydb-go-sdk/v3](https://github.com/ydb-platform/ydb-go-sdk/) | [ydb.WithStaticCredentials(user, password)](https://github.com/ydb-platform/ydb-go-examples/tree/master/auth/static_credentials) Определяется по переменным окружения | [ydb-go-sdk-auth-environ](https://github.com/ydb-platform/ydb-go-sdk-auth-environ/) | [environ.WithEnvironCredentials(ctx)](https://github.com/ydb-platform/ydb-go-examples/tree/master/auth/environ) - Java @@ -50,19 +50,13 @@ - Node.js - ```js - import { AnonymousAuthService, TokenAuthService, - MetadataAuthService, getSACredentialsFromJson, - getCredentialsFromEnv } from 'ydb-sdk'; - ``` - Режим | Метод ----- | ----- Anonymous | [AnonymousAuthService()](https://github.com/ydb-platform/ydb-nodejs-sdk/tree/main/examples/auth/anonymous-credentials) Access Token | [TokenAuthService( accessToken, database )](https://github.com/ydb-platform/ydb-nodejs-sdk/tree/main/examples/auth/access-token-credentials) Metadata | [MetadataAuthService( database )](https://github.com/ydb-platform/ydb-nodejs-sdk/tree/main/examples/auth/metadata-credentials) Service Account Key | [getSACredentialsFromJson( saKeyFile )](https://github.com/ydb-platform/ydb-nodejs-sdk/tree/main/examples/auth/service-account-credentials) - User+Password | [StaticCredentialsAuthService( user, password, endpoint )](https://github.com/ydb-platform/ydb-nodejs-sdk/tree/main/examples/auth/static-credentials) + Static Credentials | [StaticCredentialsAuthService( user, password, endpoint )](https://github.com/ydb-platform/ydb-nodejs-sdk/tree/main/examples/auth/static-credentials) Определяется по переменным окружения | [getCredentialsFromEnv( entryPoint, database, logger )](https://github.com/ydb-platform/ydb-nodejs-sdk/tree/main/examples/auth/environ) - Rust diff --git a/ydb/docs/ru/core/reference/ydb-sdk/recipes/auth-access-token.md b/ydb/docs/ru/core/reference/ydb-sdk/recipes/auth-access-token.md index 76eb79eb78..42948fb674 100644 --- a/ydb/docs/ru/core/reference/ydb-sdk/recipes/auth-access-token.md +++ b/ydb/docs/ru/core/reference/ydb-sdk/recipes/auth-access-token.md @@ -118,6 +118,6 @@ - Node.js - {% include [access-token](../../../../_includes/nodejs/recipes/auth/access-token.md) %} + {% include [auth-access-token](../../../../_includes/nodejs/auth-access-token.md) %} {% endlist %} diff --git a/ydb/docs/ru/core/reference/ydb-sdk/recipes/auth-anonymous.md b/ydb/docs/ru/core/reference/ydb-sdk/recipes/auth-anonymous.md index c49297d323..b9bd734ca8 100644 --- a/ydb/docs/ru/core/reference/ydb-sdk/recipes/auth-anonymous.md +++ b/ydb/docs/ru/core/reference/ydb-sdk/recipes/auth-anonymous.md @@ -91,6 +91,6 @@ - Node.js - {% include [anonymous](../../../../_includes/nodejs/recipes/auth/anonymous.md) %} + {% include [auth-anonymous](../../../../_includes/nodejs/auth-anonymous.md) %} {% endlist %} diff --git a/ydb/docs/ru/core/reference/ydb-sdk/recipes/auth-env.md b/ydb/docs/ru/core/reference/ydb-sdk/recipes/auth-env.md index 68118e6785..03f014b6b9 100644 --- a/ydb/docs/ru/core/reference/ydb-sdk/recipes/auth-env.md +++ b/ydb/docs/ru/core/reference/ydb-sdk/recipes/auth-env.md @@ -99,6 +99,6 @@ - Node.js - {% include [env](../../../../_includes/nodejs/recipes/auth/env.md) %} + {% include [auth-env](../../../../_includes/nodejs/auth-env.md) %} {% endlist %} diff --git a/ydb/docs/ru/core/reference/ydb-sdk/recipes/auth-metadata.md b/ydb/docs/ru/core/reference/ydb-sdk/recipes/auth-metadata.md index d2f03990a6..34c247699c 100644 --- a/ydb/docs/ru/core/reference/ydb-sdk/recipes/auth-metadata.md +++ b/ydb/docs/ru/core/reference/ydb-sdk/recipes/auth-metadata.md @@ -92,6 +92,6 @@ - Node.js - {% include [metadata](../../../../_includes/nodejs/recipes/auth/metadata.md) %} + {% include [auth-metadata](../../../../_includes/nodejs/auth-metadata.md) %} {% endlist %} diff --git a/ydb/docs/ru/core/reference/ydb-sdk/recipes/auth-service-account.md b/ydb/docs/ru/core/reference/ydb-sdk/recipes/auth-service-account.md index 06ce170f9a..aaf73f5001 100644 --- a/ydb/docs/ru/core/reference/ydb-sdk/recipes/auth-service-account.md +++ b/ydb/docs/ru/core/reference/ydb-sdk/recipes/auth-service-account.md @@ -96,15 +96,12 @@ - Node.js - ### Загрузка данных сервисного аккаунта из файла + Загрузка данных сервисного аккаунта из файла: - {% include [service-account-file](../../../../_includes/nodejs/recipes/auth/service-account-file.md) %} + {% include [auth-sa-file](../../../../_includes/nodejs/auth-sa-file.md) %} - ### Загрузка данных сервисного аккаунта из стороннего источника - - В случае, когда необходимо подгрузить данные сервисного аккаунта извне, например, из хранилища секретов, подходит данный способ: - - {% include [service-account-data](../../../../_includes/nodejs/recipes/auth/service-account-data.md) %} + Загрузка данных сервисного аккаунта из стороннего источника (например, из хранилища секретов): + {% include [auth-sa-data](../../../../_includes/nodejs/auth-sa-data.md) %} {% endlist %} diff --git a/ydb/docs/ru/core/reference/ydb-sdk/recipes/auth-static.md b/ydb/docs/ru/core/reference/ydb-sdk/recipes/auth-static.md index 9124361798..ac4c726158 100644 --- a/ydb/docs/ru/core/reference/ydb-sdk/recipes/auth-static.md +++ b/ydb/docs/ru/core/reference/ydb-sdk/recipes/auth-static.md @@ -63,7 +63,6 @@ - Node.js - {% include [static](../../../../_includes/nodejs/recipes/auth/static.md) %} - + {% include [auth-static](../../../../_includes/nodejs/auth-static.md) %} {% endlist %} |