add a table explaining what to expect with different ssh options for the amazon builders. Also convert builder docs to .erb to support partials

This commit is contained in:
Megan Marsh 2019-04-19 16:35:15 -07:00
parent a360516a64
commit 8c9f2f5e1c
6 changed files with 27 additions and 5 deletions

View File

@ -226,11 +226,11 @@ builder.
Unlimited - even for instances that would usually qualify for the
[AWS Free Tier](https://aws.amazon.com/free/).
- `encrypt_boot` (boolean) - Whether or not to encrypt the resulting AMI when
copying a provisioned instance to an AMI. By default, Packer will keep the
- `encrypt_boot` (boolean) - Whether or not to encrypt the resulting AMI when
copying a provisioned instance to an AMI. By default, Packer will keep the
encryption setting to what it was in the source image. Setting `false` will
result in an unencrypted image, and `true` will result in an encrypted one.
- `force_delete_snapshot` (boolean) - Force Packer to delete snapshots associated with
AMIs, which have been deregistered by `force_deregister`. Default `false`.
@ -726,3 +726,5 @@ be easily added to the provisioner section.
}
```
<%= partial "partials/builders/aws-ssh-differentiation-table" %>

View File

@ -215,8 +215,8 @@ builder.
Unlimited - even for instances that would usually qualify for the [AWS Free
Tier](https://aws.amazon.com/free/).
- `encrypt_boot` (boolean) - Whether or not to encrypt the resulting AMI when
copying a provisioned instance to an AMI. By default, Packer will keep the
- `encrypt_boot` (boolean) - Whether or not to encrypt the resulting AMI when
copying a provisioned instance to an AMI. By default, Packer will keep the
encryption setting to what it was in the source image. Setting `false` will
result in an unencrypted image, and `true` will result in an encrypted one.
@ -626,3 +626,6 @@ These source AMIs may include volumes that are not flagged to be destroyed on
termination of the instance building the new image. In addition to those
volumes created by this builder, any volumes inn the source AMI which are not
marked for deletion on termination will remain in your account.
<%= partial "partials/builders/aws-ssh-differentiation-table" %>

View File

@ -564,3 +564,6 @@ These source AMIs may include volumes that are not flagged to be destroyed on
termination of the instance building the new image. In addition to those
volumes created by this builder, any volumes inn the source AMI which are not
marked for deletion on termination will remain in your account.
<%= partial "partials/builders/aws-ssh-differentiation-table" %>

View File

@ -705,3 +705,6 @@ this:
```
You may wish to constrain the resource to a specific bucket.
<%= partial "partials/builders/aws-ssh-differentiation-table" %>

View File

@ -0,0 +1,11 @@
## Which SSH Options to use:
This chart breaks down Packer does if you set any of the below SSH options:
| ssh_password | ssh_private_key_file | ssh_keypair_name | temporary_key_pair_name | Packer will... |
| --- | --- | --- | --- | --- |
| X | - | - | - | ssh authenticating with username and given password |
| - | X | - | - | ssh authenticating with private key file |
| - | X | X | - | ssh authenticating with given private key file and "attaching" the keypair to the instance |
| - | - | - | X | Create a temporary ssh keypair with a particular name, clean it up |
| - | - | - | - | Create a temporary ssh keypair with a default name, clean it up |