Update documentation

This commit is contained in:
Gennady Lipenkov 2020-07-09 17:43:11 +03:00
parent 22af3f2fd0
commit d83d2b0273
3 changed files with 61 additions and 8 deletions

View File

@ -29,10 +29,8 @@ type Config struct {
// List of paths to Yandex Object Storage where exported image will be uploaded. // List of paths to Yandex Object Storage where exported image will be uploaded.
// Please be aware that use of space char inside path not supported. // Please be aware that use of space char inside path not supported.
// Example value `[
// "s3://bucket-name/image-blob.qcow2",
// ]`
// Also this param support [build](/docs/templates/engine) template function. // Also this param support [build](/docs/templates/engine) template function.
// Check available template data for [Yandex](/docs/builders/yandex#build-template-data) builder.
Paths []string `mapstructure:"paths" required:"true"` Paths []string `mapstructure:"paths" required:"true"`
// The folder ID that will be used to launch a temporary instance. // The folder ID that will be used to launch a temporary instance.
// Alternatively you may set value by environment variable YC_FOLDER_ID. // Alternatively you may set value by environment variable YC_FOLDER_ID.
@ -231,8 +229,6 @@ func (p *PostProcessor) PostProcess(ctx context.Context, ui packer.Ui, artifact
state.Put("driver", driver) state.Put("driver", driver)
state.Put("sdk", driver.SDK()) state.Put("sdk", driver.SDK())
state.Put("ui", ui) state.Put("ui", ui)
// no used
gd := &builder.GeneratedData{State: state}
// Build the steps. // Build the steps.
steps := []multistep.Step{ steps := []multistep.Step{

View File

@ -73,3 +73,62 @@ can be configured for this builder.
### Optional: ### Optional:
@include 'builder/yandex/Config-not-required.mdx' @include 'builder/yandex/Config-not-required.mdx'
## Build template data
In configuration directives the following variables are available:
- `ImageID` - ID of the built image.
- `ImageName` - Name of the built image.
- `ImageFamily` - Family of the built image.
- `ImageDescription` - Description of the built image.
- `ImageFolderID` - Folder ID where the built image is stored.
- `SourceImageID` - The source image ID (for example `fd8fjtn3mj2kfe7h6f0r`) used to build the image.
- `SourceImageName` - The source image name (for example `ubuntu-1604-lts-1579200746`) used to build the image.
- `SourceImageDescription` - The source image description (for example `ubuntu 16.04 lts`).
- `SourceImageFamily` - The source image family (for example `ubuntu-1604-lts`).
- `SourceImageFolderID` - The folder ID where source image located (for example `standard-images`).
## Build Shared Information Variables
This builder generates data that are shared with provisioner and post-processor via build function of
[template engine](/docs/templates/engine) for JSON and [contextual variables](/docs/from-1.5/contextual-variables)
for HCL2.
The generated variables available for this builder see above
Usage example:
<Tabs>
<Tab heading="JSON">
```json
"post-processors": [
{
"type": "manifest",
"output": "manifest.json",
"strip_path": true,
"custom_data": {
"source_image_id": "{{ build `SourceImageID` }}"
}
}
]
```
</Tab>
<Tab heading="HCL2">
```hcl
post-processor "manifest" {
output = "manifest.json"
strip_path = true
custom_data = {
source_image_id = "${build.SourceImageID}"
}
}
```
</Tab>
</Tabs>

View File

@ -2,10 +2,8 @@
- `paths` ([]string) - List of paths to Yandex Object Storage where exported image will be uploaded. - `paths` ([]string) - List of paths to Yandex Object Storage where exported image will be uploaded.
Please be aware that use of space char inside path not supported. Please be aware that use of space char inside path not supported.
Example value `[
"s3://bucket-name/image-blob.qcow2",
]`
Also this param support [build](/docs/templates/engine) template function. Also this param support [build](/docs/templates/engine) template function.
Check available template data for [Yandex](/docs/builders/yandex#build-template-data) builder.
- `folder_id` (string) - The folder ID that will be used to launch a temporary instance. - `folder_id` (string) - The folder ID that will be used to launch a temporary instance.
Alternatively you may set value by environment variable YC_FOLDER_ID. Alternatively you may set value by environment variable YC_FOLDER_ID.