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

update docs to show a use case for block device mappings

This commit is contained in:
Megan Marsh 2019-09-25 16:48:04 -07:00
parent e4e70f80ae
commit 72d393c95a
2 changed files with 30 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
builder/amazon/common/block_device.go
View File

@ -13,17 +13,27 @@ import (
)
// These will be attached when booting a new instance from your AMI. Your
// options here may vary depending on the type of VM you use. Example value:
// options here may vary depending on the type of VM you use.
//
// Example use case:
//
// The following mapping will tell Packer to encrypt the root volume of the
// build instance at launch using a specific non-default kms key:
//
// ``` json
// [{
// "device_name":"xvda",
// "delete_on_termination":true,
// "volume_type":"gp2"
// "launch_block_device_mappings": [{
// "device_name": "/dev/sda1",
// "encrypted": true,
// "kms_key_id": "1a2b3c4d-5e6f-1a2b-3c4d-5e6f1a2b3c4d"
// }]
// ```
//
// Documentation for Block Devices Mappings can be found here:
// https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-device-mapping-concepts.html
//
// These mappings give you control over either the volumes generated for the
// Packer build via `launch_block_device_mappings`, or the volumes that Packer will
// save with the artifact AMI via `ami_block_device_mappings`.
type BlockDevice struct {
// Indicates whether the EBS volume is deleted on instance termination.
// Default false. NOTE: If this value is not explicitly set to true and

20
website/source/partials/builder/amazon/common/_BlockDevice.html.md
View File

@ -1,13 +1,23 @@
<!-- Code generated from the comments of the BlockDevice struct in builder/amazon/common/block_device.go; DO NOT EDIT MANUALLY -->
These will be attached when booting a new instance from your AMI. Your
options here may vary depending on the type of VM you use. Example value:
options here may vary depending on the type of VM you use.
Example use case:
The following mapping will tell Packer to encrypt the root volume of the
build instance at launch using a specific non-default kms key:
``` json
[{
"device_name":"xvda",
"delete_on_termination":true,
"volume_type":"gp2"
"launch_block_device_mappings": [{
"device_name": "/dev/sda1",
"encrypted": true,
"kms_key_id": "1a2b3c4d-5e6f-1a2b-3c4d-5e6f1a2b3c4d"
}]
```
Documentation for Block Devices Mappings can be found here:
https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-device-mapping-concepts.html
These mappings give you control over either the volumes generated for the
Packer build via `launch_block_device_mappings`, or the volumes that Packer will
save with the artifact AMI via `ami_block_device_mappings`.