add more doc

This commit is contained in:
Roman Mingazeev 2020-10-23 18:01:52 +03:00
parent 09add100f2
commit 75befba67e
3 changed files with 7 additions and 3 deletions

View file

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

View file

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

View file

@ -1,4 +1,6 @@
<!-- Code generated from the comments of the AccessConfig struct in builder/yandex/access_config.go; DO NOT EDIT MANUALLY -->
- `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`.