From a9aa9908cd41196552603d1894968417e571d131 Mon Sep 17 00:00:00 2001 From: DanHam Date: Sun, 13 May 2018 18:55:21 +0100 Subject: [PATCH] Document use of T2 Unlimited for enabled Amazon builders --- .../source/docs/builders/amazon-ebs.html.md | 24 +++++++++++++++++++ .../docs/builders/amazon-ebssurrogate.html.md | 24 +++++++++++++++++++ .../docs/builders/amazon-ebsvolume.html.md | 24 +++++++++++++++++++ .../docs/builders/amazon-instance.html.md | 24 +++++++++++++++++++ 4 files changed, 96 insertions(+) diff --git a/website/source/docs/builders/amazon-ebs.html.md b/website/source/docs/builders/amazon-ebs.html.md index d5ed5b497..2901bd249 100644 --- a/website/source/docs/builders/amazon-ebs.html.md +++ b/website/source/docs/builders/amazon-ebs.html.md @@ -169,6 +169,30 @@ builder. Note: you must make sure enhanced networking is enabled on your instance. See [Amazon's documentation on enabling enhanced networking](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/enhanced-networking.html#enabling_enhanced_networking). Default `false`. +- `enable_t2_unlimited` (boolean) - Enabling T2 Unlimited allows the source + instance to burst additional CPU beyond its available [CPU Credits] + (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/t2-credits-baseline-concepts.html) + for as long as the demand exists. + This is in contrast to the standard configuration that only allows an + instance to consume up to its available CPU Credits. + See the AWS documentation for [T2 Unlimited] + (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/t2-unlimited.html) + and the 'T2 Unlimited Pricing' section of the [Amazon EC2 On-Demand + Pricing](https://aws.amazon.com/ec2/pricing/on-demand/) document for more + information. + By default this option is disabled and Packer will set up a [T2 + Standard](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/t2-std.html) + instance instead. + + To use T2 Unlimited you must use a T2 instance type e.g. t2.micro. + Additionally, T2 Unlimited cannot be used in conjunction with Spot + Instances e.g. when the `spot_price` option has been configured. + Attempting to do so will cause an error. + + !> **Warning!** Additional costs may be incurred by enabling T2 + Unlimited - even for instances that would usually qualify for the + [AWS Free Tier](https://aws.amazon.com/free/). + - `force_deregister` (boolean) - Force Packer to first deregister an existing AMI if one with the same name already exists. Default `false`. diff --git a/website/source/docs/builders/amazon-ebssurrogate.html.md b/website/source/docs/builders/amazon-ebssurrogate.html.md index 8cf9508b4..720521536 100644 --- a/website/source/docs/builders/amazon-ebssurrogate.html.md +++ b/website/source/docs/builders/amazon-ebssurrogate.html.md @@ -162,6 +162,30 @@ builder. Note: you must make sure enhanced networking is enabled on your instance. See [Amazon's documentation on enabling enhanced networking](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/enhanced-networking.html#enabling_enhanced_networking). Default `false`. +- `enable_t2_unlimited` (boolean) - Enabling T2 Unlimited allows the source + instance to burst additional CPU beyond its available [CPU Credits] + (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/t2-credits-baseline-concepts.html) + for as long as the demand exists. + This is in contrast to the standard configuration that only allows an + instance to consume up to its available CPU Credits. + See the AWS documentation for [T2 Unlimited] + (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/t2-unlimited.html) + and the 'T2 Unlimited Pricing' section of the [Amazon EC2 On-Demand + Pricing](https://aws.amazon.com/ec2/pricing/on-demand/) document for more + information. + By default this option is disabled and Packer will set up a [T2 + Standard](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/t2-std.html) + instance instead. + + To use T2 Unlimited you must use a T2 instance type e.g. t2.micro. + Additionally, T2 Unlimited cannot be used in conjunction with Spot + Instances e.g. when the `spot_price` option has been configured. + Attempting to do so will cause an error. + + !> **Warning!** Additional costs may be incurred by enabling T2 + Unlimited - even for instances that would usually qualify for the + [AWS Free Tier](https://aws.amazon.com/free/). + - `force_deregister` (boolean) - Force Packer to first deregister an existing AMI if one with the same name already exists. Default `false`. diff --git a/website/source/docs/builders/amazon-ebsvolume.html.md b/website/source/docs/builders/amazon-ebsvolume.html.md index a39a31fcd..1bab5eb62 100644 --- a/website/source/docs/builders/amazon-ebsvolume.html.md +++ b/website/source/docs/builders/amazon-ebsvolume.html.md @@ -120,6 +120,30 @@ builder. Note: you must make sure enhanced networking is enabled on your instance. See [Amazon's documentation on enabling enhanced networking](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/enhanced-networking.html#enabling_enhanced_networking). Default `false`. +- `enable_t2_unlimited` (boolean) - Enabling T2 Unlimited allows the source + instance to burst additional CPU beyond its available [CPU Credits] + (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/t2-credits-baseline-concepts.html) + for as long as the demand exists. + This is in contrast to the standard configuration that only allows an + instance to consume up to its available CPU Credits. + See the AWS documentation for [T2 Unlimited] + (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/t2-unlimited.html) + and the 'T2 Unlimited Pricing' section of the [Amazon EC2 On-Demand + Pricing](https://aws.amazon.com/ec2/pricing/on-demand/) document for more + information. + By default this option is disabled and Packer will set up a [T2 + Standard](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/t2-std.html) + instance instead. + + To use T2 Unlimited you must use a T2 instance type e.g. t2.micro. + Additionally, T2 Unlimited cannot be used in conjunction with Spot + Instances e.g. when the `spot_price` option has been configured. + Attempting to do so will cause an error. + + !> **Warning!** Additional costs may be incurred by enabling T2 + Unlimited - even for instances that would usually qualify for the + [AWS Free Tier](https://aws.amazon.com/free/). + - `iam_instance_profile` (string) - The name of an [IAM instance profile](https://docs.aws.amazon.com/IAM/latest/UserGuide/instance-profiles.html) to launch the EC2 instance with. diff --git a/website/source/docs/builders/amazon-instance.html.md b/website/source/docs/builders/amazon-instance.html.md index 77d7c2f5b..52686aeec 100644 --- a/website/source/docs/builders/amazon-instance.html.md +++ b/website/source/docs/builders/amazon-instance.html.md @@ -193,6 +193,30 @@ builder. Note: you must make sure enhanced networking is enabled on your instance. See [Amazon's documentation on enabling enhanced networking](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/enhanced-networking.html#enabling_enhanced_networking). Default `false`. +- `enable_t2_unlimited` (boolean) - Enabling T2 Unlimited allows the source + instance to burst additional CPU beyond its available [CPU Credits] + (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/t2-credits-baseline-concepts.html) + for as long as the demand exists. + This is in contrast to the standard configuration that only allows an + instance to consume up to its available CPU Credits. + See the AWS documentation for [T2 Unlimited] + (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/t2-unlimited.html) + and the 'T2 Unlimited Pricing' section of the [Amazon EC2 On-Demand + Pricing](https://aws.amazon.com/ec2/pricing/on-demand/) document for more + information. + By default this option is disabled and Packer will set up a [T2 + Standard](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/t2-std.html) + instance instead. + + To use T2 Unlimited you must use a T2 instance type e.g. t2.micro. + Additionally, T2 Unlimited cannot be used in conjunction with Spot + Instances e.g. when the `spot_price` option has been configured. + Attempting to do so will cause an error. + + !> **Warning!** Additional costs may be incurred by enabling T2 + Unlimited - even for instances that would usually qualify for the + [AWS Free Tier](https://aws.amazon.com/free/). + - `force_deregister` (boolean) - Force Packer to first deregister an existing AMI if one with the same name already exists. Defaults to `false`.