From 3eaa8a2dc3c5ad56a727dfff714b9e9988bce9f2 Mon Sep 17 00:00:00 2001 From: Arthur Burkart Date: Thu, 27 Oct 2016 00:20:45 -0400 Subject: [PATCH] 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. --- website/source/docs/builders/amazon-chroot.html.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/website/source/docs/builders/amazon-chroot.html.md b/website/source/docs/builders/amazon-chroot.html.md index 163647334..799fdc01a 100644 --- a/website/source/docs/builders/amazon-chroot.html.md +++ b/website/source/docs/builders/amazon-chroot.html.md @@ -164,8 +164,10 @@ each category, the available configuration keys are alphabetized. mount and copy steps. The device and mount path are provided by `{{.Device}}` and `{{.MountPath}}`. -- `root_volume_size` (integer) - The size of the root volume for the chroot - environment, and the resulting AMI +- `root_volume_size` (integer) - The size of the root volume in GB for the + 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 validation of the `ami_regions` configuration option. Defaults to false.