docker
/
docs
mirror of https://github.com/docker/docs.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #2750 from jeffellin/1904-UseEBSOptimizedInstanceFlag 

Add option to create amazon ec2 instances with the EbsOptimized setting.
This commit is contained in:
Jean-Laurent de Morlhon 2016-01-11 15:22:47 +01:00
parent 36abac3891 0ff18a7c7d
commit 8f1e7653ce
3 changed files with 95 additions and 51 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

50
docs/drivers/aws.md
View File

@ -54,6 +54,7 @@ This example assumes the VPC ID was found in the `a` availability zone. Use the`
- `--amazonec2-use-private-address`: Use the private IP address for docker-machine, but still create a public IP address. - `--amazonec2-use-private-address`: Use the private IP address for docker-machine, but still create a public IP address.
- `--amazonec2-private-address-only`: Use the private IP address only. - `--amazonec2-private-address-only`: Use the private IP address only.
- `--amazonec2-monitoring`: Enable CloudWatch Monitoring. - `--amazonec2-monitoring`: Enable CloudWatch Monitoring.
- `--amazonec2-use-ebs-optimized-instance`: Create an EBS Optimized Instance, instance type must support it.
By default, the Amazon EC2 driver will use a daily image of Ubuntu 15.10 LTS. By default, the Amazon EC2 driver will use a daily image of Ubuntu 15.10 LTS.
@ -73,29 +74,31 @@ By default, the Amazon EC2 driver will use a daily image of Ubuntu 15.10 LTS.
Environment variables and default values: Environment variables and default values:
| CLI option | Environment variable | Default | | CLI option | Environment variable | Default |
| ----------------------------------- | ----------------------- | ---------------- | | ---------------------------------------- | ----------------------- | ---------------- |
| **`--amazonec2-access-key`** | `AWS_ACCESS_KEY_ID` | - | | **`--amazonec2-access-key`** | `AWS_ACCESS_KEY_ID` | - |
| **`--amazonec2-secret-key`** | `AWS_SECRET_ACCESS_KEY` | - | | **`--amazonec2-secret-key`** | `AWS_SECRET_ACCESS_KEY` | - |
| `--amazonec2-session-token` | `AWS_SESSION_TOKEN` | - | | `--amazonec2-session-token` | `AWS_SESSION_TOKEN` | - |
| `--amazonec2-ami` | `AWS_AMI` | `ami-5f709f34` | | `--amazonec2-ami` | `AWS_AMI` | `ami-5f709f34` |
| `--amazonec2-region` | `AWS_DEFAULT_REGION` | `us-east-1` | | `--amazonec2-region` | `AWS_DEFAULT_REGION` | `us-east-1` |
| **`--amazonec2-vpc-id`** | `AWS_VPC_ID` | - | | **`--amazonec2-vpc-id`** | `AWS_VPC_ID` | - |
| `--amazonec2-zone` | `AWS_ZONE` | `a` | | `--amazonec2-zone` | `AWS_ZONE` | `a` |
| `--amazonec2-subnet-id` | `AWS_SUBNET_ID` | - | | `--amazonec2-subnet-id` | `AWS_SUBNET_ID` | - |
| `--amazonec2-security-group` | `AWS_SECURITY_GROUP` | `docker-machine` | | `--amazonec2-security-group` | `AWS_SECURITY_GROUP` | `docker-machine` |
| `--amazonec2-tags` | `AWS_TAGS` | - | | `--amazonec2-tags` | `AWS_TAGS` | - |
| `--amazonec2-instance-type` | `AWS_INSTANCE_TYPE` | `t2.micro` | | `--amazonec2-instance-type` | `AWS_INSTANCE_TYPE` | `t2.micro` |
| `--amazonec2-device-name` | `AWS_DEVICE_NAME` | `/dev/sda1` | | `--amazonec2-device-name` | `AWS_DEVICE_NAME` | `/dev/sda1` |
| `--amazonec2-root-size` | `AWS_ROOT_SIZE` | `16` | | `--amazonec2-root-size` | `AWS_ROOT_SIZE` | `16` |
| `--amazonec2-volume-type` | `AWS_VOLUME_TYPE` | `gp2` | | `--amazonec2-volume-type` | `AWS_VOLUME_TYPE` | `gp2` |
| `--amazonec2-iam-instance-profile` | `AWS_INSTANCE_PROFILE` | - | | `--amazonec2-iam-instance-profile` | `AWS_INSTANCE_PROFILE` | - |
| `--amazonec2-ssh-user` | `AWS_SSH_USER` | `ubuntu` | | `--amazonec2-ssh-user` | `AWS_SSH_USER` | `ubuntu` |
| `--amazonec2-request-spot-instance` | - | `false` | | `--amazonec2-request-spot-instance` | - | `false` |
| `--amazonec2-spot-price` | - | `0.50` | | `--amazonec2-spot-price` | - | `0.50` |
| `--amazonec2-use-private-address` | - | `false` | | `--amazonec2-use-private-address` | - | `false` |
| `--amazonec2-private-address-only` | - | `false` | | `--amazonec2-private-address-only` | - | `false` |
| `--amazonec2-monitoring` | - | `false` | | `--amazonec2-monitoring` | - | `false` |
| `--amazonec2-use-ebs-optimized-instance` | - | `false` |
## Security Group ## Security Group
@ -107,3 +110,4 @@ Note that a security group will be created and associated to the host. This secu
If you specify a security group yourself using the `--amazonec2-security-group` flag, the above ports will be checked and opened and the security group modified. If you specify a security group yourself using the `--amazonec2-security-group` flag, the above ports will be checked and opened and the security group modified.
If you want more ports to be opened, like application specific ports, use the aws console and modify the configuration manually. If you want more ports to be opened, like application specific ports, use the aws console and modify the configuration manually.

64
drivers/amazonec2/amazonec2.go
View File

@ -52,34 +52,35 @@ var (
type Driver struct { type Driver struct {
*drivers.BaseDriver *drivers.BaseDriver
Id string Id string
AccessKey string AccessKey string
SecretKey string SecretKey string
SessionToken string SessionToken string
Region string Region string
AMI string AMI string
SSHKeyID int SSHKeyID int
KeyName string KeyName string
InstanceId string InstanceId string
InstanceType string InstanceType string
PrivateIPAddress string PrivateIPAddress string
SecurityGroupId string SecurityGroupId string
SecurityGroupName string SecurityGroupName string
Tags string Tags string
ReservationId string ReservationId string
DeviceName string DeviceName string
RootSize int64 RootSize int64
VolumeType string VolumeType string
IamInstanceProfile string IamInstanceProfile string
VpcId string VpcId string
SubnetId string SubnetId string
Zone string Zone string
keyPath string keyPath string
RequestSpotInstance bool RequestSpotInstance bool
SpotPrice string SpotPrice string
PrivateIPOnly bool PrivateIPOnly bool
UsePrivateIP bool UsePrivateIP bool
Monitoring bool UseEbsOptimizedInstance bool
Monitoring bool
} }
func (d *Driver) GetCreateFlags() []mcnflag.Flag { func (d *Driver) GetCreateFlags() []mcnflag.Flag {
@ -193,6 +194,10 @@ func (d *Driver) GetCreateFlags() []mcnflag.Flag {
Name: "amazonec2-monitoring", Name: "amazonec2-monitoring",
Usage: "Set this flag to enable CloudWatch monitoring", Usage: "Set this flag to enable CloudWatch monitoring",
}, },
mcnflag.BoolFlag{
Name: "amazonec2-use-ebs-optimized-instance",
Usage: "Create an EBS optimized instance",
},
} }
} }
@ -249,6 +254,7 @@ func (d *Driver) SetConfigFromFlags(flags drivers.DriverOptions) error {
d.PrivateIPOnly = flags.Bool("amazonec2-private-address-only") d.PrivateIPOnly = flags.Bool("amazonec2-private-address-only")
d.UsePrivateIP = flags.Bool("amazonec2-use-private-address") d.UsePrivateIP = flags.Bool("amazonec2-use-private-address")
d.Monitoring = flags.Bool("amazonec2-monitoring") d.Monitoring = flags.Bool("amazonec2-monitoring")
d.UseEbsOptimizedInstance = flags.Bool("amazonec2-use-ebs-optimized-instance")
d.SetSwarmConfigFromFlags(flags) d.SetSwarmConfigFromFlags(flags)
if d.AccessKey == "" { if d.AccessKey == "" {
@ -429,6 +435,7 @@ func (d *Driver) Create() error {
IamInstanceProfile: &ec2.IamInstanceProfileSpecification{ IamInstanceProfile: &ec2.IamInstanceProfileSpecification{
Name: &d.IamInstanceProfile, Name: &d.IamInstanceProfile,
}, },
EbsOptimized: &d.UseEbsOptimizedInstance,
BlockDeviceMappings: []*ec2.BlockDeviceMapping{bdm}, BlockDeviceMappings: []*ec2.BlockDeviceMapping{bdm},
}, },
InstanceCount: aws.Int64(1), InstanceCount: aws.Int64(1),
@ -494,6 +501,7 @@ func (d *Driver) Create() error {
IamInstanceProfile: &ec2.IamInstanceProfileSpecification{ IamInstanceProfile: &ec2.IamInstanceProfileSpecification{
Name: &d.IamInstanceProfile, Name: &d.IamInstanceProfile,
}, },
EbsOptimized: &d.UseEbsOptimizedInstance,
BlockDeviceMappings: []*ec2.BlockDeviceMapping{bdm}, BlockDeviceMappings: []*ec2.BlockDeviceMapping{bdm},
}) })

32
test/integration/amazonec2/create-ebsinstance.bats Normal file
View File

@ -0,0 +1,32 @@
#!/usr/bin/env bats
load ${BASE_TEST_DIR}/helpers.bash
force_env DRIVER amazonec2
#Use Instance Type that supports EBS Optimize
export AWS_INSTANCE_TYPE=m4.large
only_if_env AWS_DEFAULT_REGION
only_if_env AWS_ACCESS_KEY_ID
only_if_env AWS_SECRET_ACCESS_KEY
only_if_env AWS_SUBNET_ID
@test "$DRIVER: Should Create an EBS Optimized Instance" {
machine create -d amazonec2 --amazonec2-use-ebs-optimized-instance $NAME
run docker $(machine config $NAME) run --rm -e AWS_ACCESS_KEY_ID=$AWS_ACCESS_KEY_ID -e AWS_SECRET_ACCESS_KEY=$AWS_SECRET_ACCESS_KEY -e AWS_DEFAULT_REGION=$AWS_DEFAULT_REGION blendle/aws-cli ec2 describe-instances --filters Name=tag:Name,Values=$NAME Name=instance-state-name,Values=running --query 'Reservations[0].Instances[0].EbsOptimized' --output text
[[ ${lines[*]:-1} =~ "True" ]]
}