From 75befba67ee0e4981f80d4e31bf72df5676043b8 Mon Sep 17 00:00:00 2001 From: Roman Mingazeev Date: Fri, 23 Oct 2020 18:01:52 +0300 Subject: [PATCH] add more doc --- builder/yandex/access_config.go | 4 +++- website/pages/docs/builders/yandex.mdx | 2 +- .../pages/partials/builder/yandex/AccessConfig-required.mdx | 4 +++- 3 files changed, 7 insertions(+), 3 deletions(-) diff --git a/builder/yandex/access_config.go b/builder/yandex/access_config.go index 5caf6a518..89a150e05 100644 --- a/builder/yandex/access_config.go +++ b/builder/yandex/access_config.go @@ -22,7 +22,9 @@ type AccessConfig struct { // is an alternative method to authenticate to Yandex.Cloud. Alternatively you may set environment variable // `YC_SERVICE_ACCOUNT_KEY_FILE`. ServiceAccountKeyFile string `mapstructure:"service_account_key_file" required:"false"` - // OAuth token or IAM token to use to authenticate to Yandex.Cloud. Alternatively you may set + // [OAuth token](https://cloud.yandex.com/docs/iam/concepts/authorization/oauth-token) + // or [IAM token](https://cloud.yandex.com/docs/iam/concepts/authorization/iam-token) + // to use to authenticate to Yandex.Cloud. Alternatively you may set // value by environment variable `YC_TOKEN`. Token string `mapstructure:"token" required:"true"` // The maximum number of times an API request is being executed. diff --git a/website/pages/docs/builders/yandex.mdx b/website/pages/docs/builders/yandex.mdx index 70b6d80e7..d40a8c431 100644 --- a/website/pages/docs/builders/yandex.mdx +++ b/website/pages/docs/builders/yandex.mdx @@ -27,7 +27,7 @@ Builder can authenticate with Yandex.Cloud using one of the following methods: ### Authentication Using Token -To authenticate with an OAuth token only `token` config key is needed. +To authenticate with an OAuth token or IAM token only `token` config key is needed. Or use the `YC_TOKEN` environment variable with proper value. Token you could get [here](https://oauth.yandex.ru/authorize?response_type=token&client_id=1a6990aa636648e9b2ef855fa7bec2fb). Check [documentation](https://cloud.yandex.ru/docs/iam/operations/iam-token/create) about how to create IAM token. diff --git a/website/pages/partials/builder/yandex/AccessConfig-required.mdx b/website/pages/partials/builder/yandex/AccessConfig-required.mdx index 14f9b9c6a..80a11071d 100644 --- a/website/pages/partials/builder/yandex/AccessConfig-required.mdx +++ b/website/pages/partials/builder/yandex/AccessConfig-required.mdx @@ -1,4 +1,6 @@ -- `token` (string) - OAuth token or IAM token to use to authenticate to Yandex.Cloud. Alternatively you may set +- `token` (string) - [OAuth token](https://cloud.yandex.com/docs/iam/concepts/authorization/oauth-token) + or [IAM token](https://cloud.yandex.com/docs/iam/concepts/authorization/iam-token) + to use to authenticate to Yandex.Cloud. Alternatively you may set value by environment variable `YC_TOKEN`.