Add amazonec2 commands that were missing documentation (#3589)

This commit is contained in:
Thomas Grainger 2017-06-26 21:29:49 +01:00 committed by Misty Stanley-Jones
parent c1dbb5b012
commit 464b983761
1 changed files with 25 additions and 19 deletions

View File

@ -43,29 +43,35 @@ You can use environment variables:
## Options
- `--amazonec2-access-key`: Your access key ID for the Amazon Web Services API.
- `--amazonec2-secret-key`: Your secret access key for the Amazon Web Services API.
- `--amazonec2-session-token`: Your session token for the Amazon Web Services API.
- `--amazonec2-ami`: The AMI ID of the instance to use.
- `--amazonec2-block-duration-minutes`: AWS spot instance duration in minutes (60, 120, 180, 240, 300, or 360).
- `--amazonec2-device-name`: The root device name of the instance.
- `--amazonec2-endpoint`: Optional endpoint URL (hostname only or fully qualified URI)
- `--amazonec2-iam-instance-profile`: The AWS IAM role name to be used as the instance profile.
- `--amazonec2-insecure-transport`: Disable SSL when sending requests
- `--amazonec2-instance-type`: The instance type to run.
- `--amazonec2-keypair-name`: AWS keypair to use; requires --amazonec2-ssh-keypath
- `--amazonec2-monitoring`: Enable CloudWatch Monitoring.
- `--amazonec2-open-port`: Make the specified port number accessible from the Internet.
- `--amazonec2-private-address-only`: Use the private IP address only.
- `--amazonec2-region`: The region to use when launching the instance.
- `--amazonec2-request-spot-instance`: Use spot instances.
- `--amazonec2-retries`: Set retry count for recoverable failures (use -1 to disable)
- `--amazonec2-root-size`: The root disk size of the instance (in GB).
- `--amazonec2-secret-key`: Your secret access key for the Amazon Web Services API.
- `--amazonec2-security-group`: AWS VPC security group name.
- `--amazonec2-session-token`: Your session token for the Amazon Web Services API.
- `--amazonec2-spot-price`: Spot instance bid price (in dollars). Require the `--amazonec2-request-spot-instance` flag.
- `--amazonec2-ssh-keypath`: Path to Private Key file to use for instance. Matching public key with .pub extension should exist
- `--amazonec2-ssh-user`: The SSH Login username, which must match the default SSH user set in the ami used.
- `--amazonec2-subnet-id`: AWS VPC subnet ID.
- `--amazonec2-tags`: AWS extra tag key-value pairs (comma-separated, e.g. key1,value1,key2,value2).
- `--amazonec2-use-ebs-optimized-instance`: Create an EBS Optimized Instance, instance type must support it.
- `--amazonec2-use-private-address`: Use the private IP address for docker-machine, but still create a public IP address.
- `--amazonec2-userdata`: Path to file with cloud-init user data.
- `--amazonec2-volume-type`: The Amazon EBS volume type to be attached to the instance.
- `--amazonec2-vpc-id`: Your VPC ID to launch the instance in.
- `--amazonec2-zone`: The AWS zone to launch the instance in (i.e. one of a,b,c,d,e).
- `--amazonec2-subnet-id`: AWS VPC subnet ID.
- `--amazonec2-security-group`: AWS VPC security group name.
- `--amazonec2-tags`: AWS extra tag key-value pairs (comma-separated, e.g. key1,value1,key2,value2).
- `--amazonec2-instance-type`: The instance type to run.
- `--amazonec2-device-name`: The root device name of the instance.
- `--amazonec2-root-size`: The root disk size of the instance (in GB).
- `--amazonec2-volume-type`: The Amazon EBS volume type to be attached to the instance.
- `--amazonec2-iam-instance-profile`: The AWS IAM role name to be used as the instance profile.
- `--amazonec2-ssh-user`: The SSH Login username, which must match the default SSH user set in the ami used.
- `--amazonec2-request-spot-instance`: Use spot instances.
- `--amazonec2-spot-price`: Spot instance bid price (in dollars). Require the `--amazonec2-request-spot-instance` flag.
- `--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-monitoring`: Enable CloudWatch Monitoring.
- `--amazonec2-use-ebs-optimized-instance`: Create an EBS Optimized Instance, instance type must support it.
- `--amazonec2-ssh-keypath`: Path to Private Key file to use for instance. Matching public key with .pub extension should exist
- `--amazonec2-retries`: Set retry count for recoverable failures (use -1 to disable)
#### Environment variables and default values: