iSharkFly-Docs
/
packer-cn
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Wrap values with backticks 

Signed-off-by: Gennady Lipenkov <xgen@yandex-team.ru>
This commit is contained in:
Gennady Lipenkov 2019-09-25 16:03:18 +03:00
parent 00e4e0c7a7
commit d070b4868a
4 changed files with 21 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
builder/yandex/config.go
View File

@ -45,9 +45,9 @@ type Config struct {
// The name of the disk, if unset the instance name // The name of the disk, if unset the instance name
// will be used. // will be used.
DiskName string `mapstructure:"disk_name" required:"false"` DiskName string `mapstructure:"disk_name" required:"false"`
// The size of the disk in GB. This defaults to 10, which is 10GB. // The size of the disk in GB. This defaults to `10`, which is 10GB.
DiskSizeGb int `mapstructure:"disk_size_gb" required:"false"` DiskSizeGb int `mapstructure:"disk_size_gb" required:"false"`
// Specify disk type for the launched instance. Defaults to network-hdd. // Specify disk type for the launched instance. Defaults to `network-hdd`.
DiskType string `mapstructure:"disk_type" required:"false"` DiskType string `mapstructure:"disk_type" required:"false"`
// The description of the resulting image. // The description of the resulting image.
ImageDescription string `mapstructure:"image_description" required:"false"` ImageDescription string `mapstructure:"image_description" required:"false"`
@ -57,7 +57,7 @@ type Config struct {
// apply to the created image. // apply to the created image.
ImageLabels map[string]string `mapstructure:"image_labels" required:"false"` ImageLabels map[string]string `mapstructure:"image_labels" required:"false"`
// The unique name of the resulting image. Defaults to // The unique name of the resulting image. Defaults to
// packer-{{timestamp}}. // `packer-{{timestamp}}`.
ImageName string `mapstructure:"image_name" required:"false"` ImageName string `mapstructure:"image_name" required:"false"`
// License IDs that indicate which licenses are attached to resulting image. // License IDs that indicate which licenses are attached to resulting image.
ImageProductIDs []string `mapstructure:"image_product_ids" required:"false"` ImageProductIDs []string `mapstructure:"image_product_ids" required:"false"`
@ -72,7 +72,7 @@ type Config struct {
// Key/value pair labels to apply to // Key/value pair labels to apply to
// the launched instance. // the launched instance.
Labels map[string]string `mapstructure:"labels" required:"false"` Labels map[string]string `mapstructure:"labels" required:"false"`
// Identifier of the hardware platform configuration for the instance. This defaults to standard-v1. // Identifier of the hardware platform configuration for the instance. This defaults to `standard-v1`.
PlatformID string `mapstructure:"platform_id" required:"false"` PlatformID string `mapstructure:"platform_id" required:"false"`
// The maximum number of times an API request is being executed // The maximum number of times an API request is being executed
MaxRetries int `mapstructure:"max_retries"` MaxRetries int `mapstructure:"max_retries"`
@ -86,7 +86,7 @@ type Config struct {
SerialLogFile string `mapstructure:"serial_log_file" required:"false"` SerialLogFile string `mapstructure:"serial_log_file" required:"false"`
// The source image family to create the new image // The source image family to create the new image
// from. You can also specify source_image_id instead. Just one of a source_image_id or // from. You can also specify source_image_id instead. Just one of a source_image_id or
// source_image_family must be specified. Example: ubuntu-1804-lts // source_image_family must be specified. Example: `ubuntu-1804-lts`
SourceImageFamily string `mapstructure:"source_image_family" required:"true"` SourceImageFamily string `mapstructure:"source_image_family" required:"true"`
// The ID of the folder containing the source image. // The ID of the folder containing the source image.
SourceImageFolderID string `mapstructure:"source_image_folder_id" required:"false"` SourceImageFolderID string `mapstructure:"source_image_folder_id" required:"false"`
@ -104,18 +104,19 @@ type Config struct {
// access. // access.
UseIPv4Nat bool `mapstructure:"use_ipv4_nat" required:"false"` UseIPv4Nat bool `mapstructure:"use_ipv4_nat" required:"false"`
// Set to true to enable IPv6 for the instance being // Set to true to enable IPv6 for the instance being
// created. This defaults to false, or not enabled. // created. This defaults to `false`, or not enabled.
// -> Note: Usage of IPv6 will be available in the future. //
// -> **Note**: Usage of IPv6 will be available in the future.
UseIPv6 bool `mapstructure:"use_ipv6" required:"false"` UseIPv6 bool `mapstructure:"use_ipv6" required:"false"`
// If true, use the instance's internal IP address // If true, use the instance's internal IP address
// instead of its external IP during building. // instead of its external IP during building.
UseInternalIP bool `mapstructure:"use_internal_ip" required:"false"` UseInternalIP bool `mapstructure:"use_internal_ip" required:"false"`
// The name of the zone to launch the instance. This defaults to ru-central1-a. // The name of the zone to launch the instance. This defaults to `ru-central1-a`.
Zone string `mapstructure:"zone" required:"false"` Zone string `mapstructure:"zone" required:"false"`
ctx interpolate.Context ctx interpolate.Context
// The time to wait for instance state changes. // The time to wait for instance state changes.
// Defaults to 5m. // Defaults to `5m`.
StateTimeout time.Duration `mapstructure:"state_timeout" required:"false"` StateTimeout time.Duration `mapstructure:"state_timeout" required:"false"`
} }

2
website/source/docs/builders/yandex.html.md
View File

@ -134,7 +134,7 @@ can be configured for this builder.
- `use_ipv6` (boolean) - Set to `true` to enable IPv6 for the instance being - `use_ipv6` (boolean) - Set to `true` to enable IPv6 for the instance being
created. This defaults to `false`, or not enabled. created. This defaults to `false`, or not enabled.
\~&gt; **Note:** Usage of IPv6 will be available in the future. \-&gt; **Note:** Usage of IPv6 will be available in the future.
- `source_image_folder_id` (string) - The ID of the folder containing the source image. - `source_image_folder_id` (string) - The ID of the folder containing the source image.

17
website/source/partials/builder/yandex/_Config-not-required.html.md
View File

@ -9,9 +9,9 @@
- `disk_name` (string) - The name of the disk, if unset the instance name - `disk_name` (string) - The name of the disk, if unset the instance name
will be used. will be used.
- `disk_size_gb` (int) - The size of the disk in GB. This defaults to 10, which is 10GB. - `disk_size_gb` (int) - The size of the disk in GB. This defaults to `10`, which is 10GB.
- `disk_type` (string) - Specify disk type for the launched instance. Defaults to network-hdd. - `disk_type` (string) - Specify disk type for the launched instance. Defaults to `network-hdd`.
- `image_description` (string) - The description of the resulting image. - `image_description` (string) - The description of the resulting image.
@ -21,7 +21,7 @@
apply to the created image. apply to the created image.
- `image_name` (string) - The unique name of the resulting image. Defaults to - `image_name` (string) - The unique name of the resulting image. Defaults to
packer-{{timestamp}}. `packer-{{timestamp}}`.
- `image_product_ids` ([]string) - License IDs that indicate which licenses are attached to resulting image. - `image_product_ids` ([]string) - License IDs that indicate which licenses are attached to resulting image.
@ -36,7 +36,7 @@
- `labels` (map[string]string) - Key/value pair labels to apply to - `labels` (map[string]string) - Key/value pair labels to apply to
the launched instance. the launched instance.
- `platform_id` (string) - Identifier of the hardware platform configuration for the instance. This defaults to standard-v1. - `platform_id` (string) - Identifier of the hardware platform configuration for the instance. This defaults to `standard-v1`.
- `max_retries` (int) - The maximum number of times an API request is being executed - `max_retries` (int) - The maximum number of times an API request is being executed
@ -64,14 +64,15 @@
access. access.
- `use_ipv6` (bool) - Set to true to enable IPv6 for the instance being - `use_ipv6` (bool) - Set to true to enable IPv6 for the instance being
created. This defaults to false, or not enabled. created. This defaults to `false`, or not enabled.
-> Note: Usage of IPv6 will be available in the future.
-> **Note**: Usage of IPv6 will be available in the future.
- `use_internal_ip` (bool) - If true, use the instance's internal IP address - `use_internal_ip` (bool) - If true, use the instance's internal IP address
instead of its external IP during building. instead of its external IP during building.
- `zone` (string) - The name of the zone to launch the instance. This defaults to ru-central1-a. - `zone` (string) - The name of the zone to launch the instance. This defaults to `ru-central1-a`.
- `state_timeout` (time.Duration) - The time to wait for instance state changes. - `state_timeout` (time.Duration) - The time to wait for instance state changes.
Defaults to 5m. Defaults to `5m`.

2
website/source/partials/builder/yandex/_Config-required.html.md
View File

@ -8,5 +8,5 @@
- `source_image_family` (string) - The source image family to create the new image - `source_image_family` (string) - The source image family to create the new image
from. You can also specify source_image_id instead. Just one of a source_image_id or from. You can also specify source_image_id instead. Just one of a source_image_id or
source_image_family must be specified. Example: ubuntu-1804-lts source_image_family must be specified. Example: `ubuntu-1804-lts`