highlights possible values instead of quoting them

Hello!

I updated a few values in this page to be highlighted instead of "quoted". I think this is in line with other values already existing on this page and should make the whole more consistent.

Happy to discuss if this needs changes!

This is a clean(er) version of PR 4255
This commit is contained in:
Kerim Satirli 2016-12-06 21:54:16 +01:00 committed by GitHub
parent 06039b358d
commit 74ed95511c
1 changed files with 16 additions and 13 deletions

View File

@ -49,9 +49,9 @@ builder.
templates](/docs/templates/configuration-templates.html) for more info) templates](/docs/templates/configuration-templates.html) for more info)
- `instance_type` (string) - The EC2 instance type to use while building the - `instance_type` (string) - The EC2 instance type to use while building the
AMI, such as "m1.small". AMI, such as `m1.small`.
- `region` (string) - The name of the region, such as "us-east-1", in which to - `region` (string) - The name of the region, such as `us-east-1`, in which to
launch the EC2 instance to create the AMI. launch the EC2 instance to create the AMI.
- `secret_key` (string) - The secret key used to communicate with AWS. [Learn - `secret_key` (string) - The secret key used to communicate with AWS. [Learn
@ -73,7 +73,7 @@ builder.
every build. every build.
- `device_name` (string) - The device name exposed to the instance (for - `device_name` (string) - The device name exposed to the instance (for
example, "/dev/sdh" or "xvdh"). Required when specifying `volume_size`. example, `/dev/sdh` or `xvdh`). Required when specifying `volume_size`.
- `encrypted` (boolean) - Indicates whether to encrypt the volume or not - `encrypted` (boolean) - Indicates whether to encrypt the volume or not
@ -95,8 +95,8 @@ builder.
- `volume_size` (integer) - The size of the volume, in GiB. Required if not - `volume_size` (integer) - The size of the volume, in GiB. Required if not
specifying a `snapshot_id` specifying a `snapshot_id`
- `volume_type` (string) - The volume type. gp2 for General Purpose (SSD) - `volume_type` (string) - The volume type. `gp2` for General Purpose (SSD)
volumes, io1 for Provisioned IOPS (SSD) volumes, and standard for Magnetic volumes, `io1` for Provisioned IOPS (SSD) volumes, and `standard` for Magnetic
volumes volumes
- `ami_description` (string) - The description to set for the - `ami_description` (string) - The description to set for the
@ -105,7 +105,7 @@ builder.
- `ami_groups` (array of strings) - A list of groups that have access to - `ami_groups` (array of strings) - A list of groups that have access to
launch the resulting AMI(s). By default no groups have permission to launch launch the resulting AMI(s). By default no groups have permission to launch
the AMI. `all` will make the AMI publicly accessible. AWS currently doesn't the AMI. `all` will make the AMI publicly accessible. AWS currently doesn't
accept any value other than "all". accept any value other than `all`.
- `ami_product_codes` (array of strings) - A list of product codes to - `ami_product_codes` (array of strings) - A list of product codes to
associate with the AMI. By default no product codes are associated with associate with the AMI. By default no product codes are associated with
@ -121,7 +121,7 @@ builder.
- `ami_virtualization_type` (string) - The type of virtualization for the AMI - `ami_virtualization_type` (string) - The type of virtualization for the AMI
you are building. This option must match the supported virtualization you are building. This option must match the supported virtualization
type of `source_ami`. Can be "paravirtual" or "hvm". type of `source_ami`. Can be `paravirtual` or `hvm`.
- `associate_public_ip_address` (boolean) - If using a non-default VPC, public - `associate_public_ip_address` (boolean) - If using a non-default VPC, public
IP addresses are not provided by default. If this is toggled, your new IP addresses are not provided by default. If this is toggled, your new
@ -194,7 +194,7 @@ builder.
- `shutdown_behaviour` (string) - Automatically terminate instances on shutdown - `shutdown_behaviour` (string) - Automatically terminate instances on shutdown
incase packer exits ungracefully. Possible values are "stop" and "terminate", incase packer exits ungracefully. Possible values are "stop" and "terminate",
default is stop. default is `stop`.
- `skip_region_validation` (boolean) - Set to true if you want to skip - `skip_region_validation` (boolean) - Set to true if you want to skip
validation of the region configuration option. Default `false`. validation of the region configuration option. Default `false`.
@ -245,11 +245,11 @@ builder.
when the current spot price is less than the maximum price you specify. Spot when the current spot price is less than the maximum price you specify. Spot
price will be updated based on available spot instance capacity and current price will be updated based on available spot instance capacity and current
spot instance requests. It may save you some costs. You can set this to spot instance requests. It may save you some costs. You can set this to
"auto" for Packer to automatically discover the best spot price or to "0" `auto` for Packer to automatically discover the best spot price or to "0"
to use an on demand instance (default). to use an on demand instance (default).
- `spot_price_auto_product` (string) - Required if `spot_price` is set - `spot_price_auto_product` (string) - Required if `spot_price` is set
to "auto". This tells Packer what sort of AMI you're launching to find the to `auto`. This tells Packer what sort of AMI you're launching to find the
best spot price. This must be one of: `Linux/UNIX`, `SUSE Linux`, `Windows`, best spot price. This must be one of: `Linux/UNIX`, `SUSE Linux`, `Windows`,
`Linux/UNIX (Amazon VPC)`, `SUSE Linux (Amazon VPC)`, `Windows (Amazon VPC)` `Linux/UNIX (Amazon VPC)`, `SUSE Linux (Amazon VPC)`, `Windows (Amazon VPC)`
@ -273,7 +273,7 @@ builder.
IP if available. IP if available.
- `subnet_id` (string) - If using VPC, the ID of the subnet, such as - `subnet_id` (string) - If using VPC, the ID of the subnet, such as
"subnet-12345def", where Packer will launch the EC2 instance. This field is `subnet-12345def`, where Packer will launch the EC2 instance. This field is
required if you are using an non-default VPC. required if you are using an non-default VPC.
- `tags` (object of key/value strings) - Tags applied to the AMI and - `tags` (object of key/value strings) - Tags applied to the AMI and
@ -299,7 +299,11 @@ builder.
to be set. to be set.
- `windows_password_timeout` (string) - The timeout for waiting for a Windows - `windows_password_timeout` (string) - The timeout for waiting for a Windows
password for Windows instances. Defaults to 20 minutes. Example value: "10m" password for Windows instances. Defaults to 20 minutes. Example value: `10m`
- `shutdown_behaviour` (string) - Automatically terminate instances on shutdown
incase packer exits ungracefully. Possible values are `stop` and `terminate`,
## Basic Example ## Basic Example
@ -388,4 +392,3 @@ up all residual volumes that are not designated by the user to remain after
termination. If you need to preserve those source volumes, you can overwrite the termination. If you need to preserve those source volumes, you can overwrite the
termination setting by specifying `delete_on_termination=false` in the termination setting by specifying `delete_on_termination=false` in the
`launch_block_device_mappings` block for the device. `launch_block_device_mappings` block for the device.