From c25592000ba34ad522ec12c56ef25724115f274e Mon Sep 17 00:00:00 2001 From: Evan Hazlett Date: Thu, 22 Jan 2015 16:43:08 -0500 Subject: [PATCH] update docs Signed-off-by: Evan Hazlett --- README.md | 12 +++++++----- docs/dockermachine.md | 12 +++++++----- drivers/amazonec2/amazonec2.go | 8 ++++---- 3 files changed, 18 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 80470f581c..e5b6560e4f 100644 --- a/README.md +++ b/README.md @@ -94,15 +94,17 @@ Create machines on [Amazon Web Services](http://aws.amazon.com). You will need Options: - - `--amazonec2-access-key`: Your access key id for the Amazon Web Services API. - - `--amazonec2-ami`: The AMI ID of the instance to use Default: `ami-a00461c8` + - `--amazonec2-access-key`: **required** Your access key id for the Amazon Web Services API. + - `--amazonec2-ami`: The AMI ID of the instance to use Default: `ami-4ae27e22` - `--amazonec2-instance-type`: The instance type to run. Default: `t2.micro` - `--amazonec2-region`: The region to use when launching the instance. Default: `us-east-1` - `--amazonec2-root-size`: The root disk size of the instance (in GB). Default: `16` - - `--amazonec2-secret-key`: Your secret access key for the Amazon Web Services API. + - `--amazonec2-secret-key`: **required** Your secret access key for the Amazon Web Services API. + - `--amazonec2-security-group-name`: AWS VPC security group name. Default: `docker-machine` - `--amazonec2-session-token`: Your session token for the Amazon Web Services API. - - `--amazonec2-vpc-id`: Your VPC ID to launch the instance in. - - `--amazonec2-zone`: The AWS zone launch the instance in (i.e. one of a,b,c,d,e). + - `--amazonec2-subnet-id`: AWS VPC subnet id + - `--amazonec2-vpc-id`: **required** Your VPC ID to launch the instance in. + - `--amazonec2-zone`: The AWS zone launch the instance in (i.e. one of a,b,c,d,e). Default: `a` ### Google Compute Engine diff --git a/docs/dockermachine.md b/docs/dockermachine.md index b5863f3680..9c7191ec75 100644 --- a/docs/dockermachine.md +++ b/docs/dockermachine.md @@ -454,15 +454,17 @@ Create machines on [Amazon Web Services](http://aws.amazon.com). You will need Options: - - `--amazonec2-access-key`: Your access key id for the Amazon Web Services API. - - `--amazonec2-ami`: The AMI ID of the instance to use Default: `ami-a00461c8` + - `--amazonec2-access-key`: **required** Your access key id for the Amazon Web Services API. + - `--amazonec2-ami`: The AMI ID of the instance to use Default: `ami-4ae27e22` - `--amazonec2-instance-type`: The instance type to run. Default: `t2.micro` - `--amazonec2-region`: The region to use when launching the instance. Default: `us-east-1` - `--amazonec2-root-size`: The root disk size of the instance (in GB). Default: `16` - - `--amazonec2-secret-key`: Your secret access key for the Amazon Web Services API. + - `--amazonec2-secret-key`: **required** Your secret access key for the Amazon Web Services API. + - `--amazonec2-security-group`: AWS VPC security group name. Default: `docker-machine` - `--amazonec2-session-token`: Your session token for the Amazon Web Services API. - - `--amazonec2-vpc-id`: Your VPC ID to launch the instance in. - - `--amazonec2-zone`: The AWS zone launch the instance in (i.e. one of a,b,c,d,e). + - `--amazonec2-subnet-id`: AWS VPC subnet id + - `--amazonec2-vpc-id`: **required** Your VPC ID to launch the instance in. + - `--amazonec2-zone`: The AWS zone launch the instance in (i.e. one of a,b,c,d,e). Default: `a` #### Digital Ocean Creates machines on [Digital Ocean](https://www.digitalocean.com/). You need to create a personal access token under "Apps & API" in the Digital Ocean Control Panel and pass that to `docker-machine create` with the `--digitalocean-access-token` option. diff --git a/drivers/amazonec2/amazonec2.go b/drivers/amazonec2/amazonec2.go index 9f42c3fe43..5dcf86992f 100644 --- a/drivers/amazonec2/amazonec2.go +++ b/drivers/amazonec2/amazonec2.go @@ -125,10 +125,10 @@ func GetCreateFlags() []cli.Flag { EnvVar: "AWS_SUBNET_ID", }, cli.StringFlag{ - Name: "amazonec2-security-group-name", - Usage: "AWS VPC security group name", + Name: "amazonec2-security-group", + Usage: "AWS VPC security group", Value: "docker-machine", - EnvVar: "AWS_SECURITY_GROUP_NAME", + EnvVar: "AWS_SECURITY_GROUP", }, cli.StringFlag{ Name: "amazonec2-instance-type", @@ -159,7 +159,7 @@ func (d *Driver) SetConfigFromFlags(flags drivers.DriverOptions) error { d.InstanceType = flags.String("amazonec2-instance-type") d.VpcId = flags.String("amazonec2-vpc-id") d.SubnetId = flags.String("amazonec2-subnet-id") - d.SecurityGroupName = flags.String("amazonec2-security-group-name") + d.SecurityGroupName = flags.String("amazonec2-security-group") zone := flags.String("amazonec2-zone") d.Zone = zone[:] d.RootSize = int64(flags.Int("amazonec2-root-size"))