Update doc

This commit is contained in:
Gennady Lipenkov 2020-07-09 00:24:53 +03:00
parent dd1ffe831a
commit e5a4155378
3 changed files with 4 additions and 10 deletions

View File

@ -31,18 +31,15 @@ type Config struct {
common.PackerConfig `mapstructure:",squash"` common.PackerConfig `mapstructure:",squash"`
// The folder ID that will be used to store imported Image. // The folder ID that will be used to store imported Image.
// Alternatively you may set value by environment variable YC_FOLDER_ID.
FolderID string `mapstructure:"folder_id" required:"true"` FolderID string `mapstructure:"folder_id" required:"true"`
// Service Account ID with proper permission to use Storage service // Service Account ID with proper permission to use Storage service
// for operations 'upload' and 'delete' object to `bucket` // for operations 'upload' and 'delete' object to `bucket`
ServiceAccountID string `mapstructure:"service_account_id" required:"true"` ServiceAccountID string `mapstructure:"service_account_id" required:"true"`
// OAuth token to use to authenticate to Yandex.Cloud. Alternatively you may set // OAuth token to use to authenticate to Yandex.Cloud.
// value by environment variable YC_TOKEN.
Token string `mapstructure:"token" required:"false"` Token string `mapstructure:"token" required:"false"`
// Path to file with Service Account key in json format. This // Path to file with Service Account key in json format. This
// is an alternative method to authenticate to Yandex.Cloud. Alternatively you may set environment variable // is an alternative method to authenticate to Yandex.Cloud.
// YC_SERVICE_ACCOUNT_KEY_FILE.
ServiceAccountKeyFile string `mapstructure:"service_account_key_file" required:"false"` ServiceAccountKeyFile string `mapstructure:"service_account_key_file" required:"false"`
// The name of the bucket where the qcow2 file will be copied to for import. // The name of the bucket where the qcow2 file will be copied to for import.

View File

@ -1,11 +1,9 @@
<!-- Code generated from the comments of the Config struct in post-processor/yandex-import/post-processor.go; DO NOT EDIT MANUALLY --> <!-- Code generated from the comments of the Config struct in post-processor/yandex-import/post-processor.go; DO NOT EDIT MANUALLY -->
- `token` (string) - OAuth token to use to authenticate to Yandex.Cloud. Alternatively you may set - `token` (string) - OAuth token to use to authenticate to Yandex.Cloud.
value by environment variable YC_TOKEN.
- `service_account_key_file` (string) - Path to file with Service Account key in json format. This - `service_account_key_file` (string) - Path to file with Service Account key in json format. This
is an alternative method to authenticate to Yandex.Cloud. Alternatively you may set environment variable is an alternative method to authenticate to Yandex.Cloud.
YC_SERVICE_ACCOUNT_KEY_FILE.
- `object_name` (string) - The name of the object key in - `object_name` (string) - The name of the object key in
`bucket` where the qcow2 file will be copied to import. This is a [template engine](/docs/templates/engine). `bucket` where the qcow2 file will be copied to import. This is a [template engine](/docs/templates/engine).

View File

@ -1,7 +1,6 @@
<!-- Code generated from the comments of the Config struct in post-processor/yandex-import/post-processor.go; DO NOT EDIT MANUALLY --> <!-- Code generated from the comments of the Config struct in post-processor/yandex-import/post-processor.go; DO NOT EDIT MANUALLY -->
- `folder_id` (string) - The folder ID that will be used to store imported Image. - `folder_id` (string) - The folder ID that will be used to store imported Image.
Alternatively you may set value by environment variable YC_FOLDER_ID.
- `service_account_id` (string) - Service Account ID with proper permission to use Storage service - `service_account_id` (string) - Service Account ID with proper permission to use Storage service
for operations 'upload' and 'delete' object to `bucket` for operations 'upload' and 'delete' object to `bucket`