Update doc pages
This commit is contained in:
parent
409534738a
commit
32b77f3b80
|
@ -1,3 +1,4 @@
|
|||
//go:generate struct-markdown
|
||||
//go:generate mapstructure-to-hcl2 -type Config
|
||||
|
||||
package yandeximport
|
||||
|
|
|
@ -268,6 +268,7 @@ export default [
|
|||
'vsphere',
|
||||
'vsphere-template',
|
||||
'yandex-export',
|
||||
'yandex-import',
|
||||
],
|
||||
},
|
||||
'----------',
|
||||
|
|
|
@ -0,0 +1,23 @@
|
|||
<!-- 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
|
||||
value by environment variable YC_TOKEN.
|
||||
|
||||
- `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
|
||||
YC_SERVICE_ACCOUNT_KEY_FILE.
|
||||
|
||||
- `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).
|
||||
Therefore, you may use user variables and template functions in this field.
|
||||
|
||||
- `skip_clean` (bool) - Whether skip removing the qcow2 file uploaded to Storage
|
||||
after the import process has completed. Possible values are: `true` to
|
||||
leave it in the bucket, `false` to remove it. (Default: `false`).
|
||||
|
||||
- `image_description` (string) - The description of the image.
|
||||
|
||||
- `image_family` (string) - The family name of the imported image.
|
||||
|
||||
- `image_labels` (map[string]string) - Key/value pair labels to apply to the imported image.
|
||||
|
|
@ -0,0 +1,14 @@
|
|||
<!-- 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.
|
||||
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
|
||||
for operations 'upload' and 'delete' object to `bucket`
|
||||
|
||||
- `bucket` (string) - The name of the bucket where the qcow2 file will be copied to for import.
|
||||
This bucket must exist when the post-processor is run.
|
||||
|
||||
- `image_name` (string) - The name of the image, which contains 1-63 characters and only
|
||||
supports lowercase English characters, numbers and hyphen.
|
||||
|
Loading…
Reference in New Issue