Updates root_volume_size documentation

It didn't indicate its unit of size (GB), the default value was not
indicated, the fact that it ignores the user-given size when it is
smaller than the source AMI's snapshot size, and the fact that the
value is required when `from_scratch` is `true` all needed to be added.
This commit is contained in:
Arthur Burkart 2016-10-27 00:20:45 -04:00
parent d3e3889559
commit 3eaa8a2dc3
1 changed files with 4 additions and 2 deletions

View File

@ -164,8 +164,10 @@ each category, the available configuration keys are alphabetized.
mount and copy steps. The device and mount path are provided by mount and copy steps. The device and mount path are provided by
`{{.Device}}` and `{{.MountPath}}`. `{{.Device}}` and `{{.MountPath}}`.
- `root_volume_size` (integer) - The size of the root volume for the chroot - `root_volume_size` (integer) - The size of the root volume in GB for the
environment, and the resulting AMI chroot environment and the resulting AMI. Default size is the snapshot size
of the `source_ami` unless `from_scratch` is `true`, in which case
this field must be defined.
- `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 `ami_regions` configuration option. Defaults to false. validation of the `ami_regions` configuration option. Defaults to false.