Skip to content

Docs changes from machine PR #3799 #333

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
londoncalling merged 1 commit into from
Oct 26, 2016
Merged

Docs changes from machine PR #3799 #333

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 30 additions & 15 deletions machine/drivers/aws.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,25 +16,20 @@ To create machines on [Amazon Web Services](http://aws.amazon.com), you must sup

## Configuring credentials

Before using the amazonec2 driver, ensure that you've configured credentials.
Before using the amazonec2 driver, ensure that you've configured credentials. The driver uses Amazon's default credentials chain
to lookup credentials unless they are explicitly provided on the command line. The credential chain uses the following providers
to authenticate with AWS:

### AWS credential file

One way to configure credentials is to use the standard credential file for Amazon AWS `~/.aws/credentials` file, which might look like:

[default]
aws_access_key_id = AKID1234567890
aws_secret_access_key = MY-SECRET-KEY

On Mac OS or various flavors of Linux you can install the [AWS Command Line Interface](http://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html#cli-quick-configuration) (`aws cli`) in the terminal and use the `aws configure` command which guides you through the creation of the credentials file.

This is the simplest method, you can then create a new machine with:

$ docker-machine create --driver amazonec2 aws01
1. Command line flags
1. Environment variables
1. AWS credentials file
1. EC2 Instance Role

For more information, see the [AWS SDK for Go Developer's Guide](http://docs.aws.amazon.com/sdk-for-go/v1/developerguide/configuring-sdk.html).

### Command line flags

Alternatively, you can use the flags `--amazonec2-access-key` and `--amazonec2-secret-key` on the command line:
The first way to specify credentials is with the flags `--amazonec2-access-key` and `--amazonec2-secret-key` on the command line:

$ docker-machine create --driver amazonec2 --amazonec2-access-key AKI******* --amazonec2-secret-key 8T93C******* aws01

Expand All @@ -46,6 +41,26 @@ You can use environment variables:
$ export AWS_SECRET_ACCESS_KEY=MY-SECRET-KEY
$ docker-machine create --driver amazonec2 aws01

### AWS credentials file

You can also configure the standard credential file for Amazon AWS, `~/.aws/credentials`, which might look like:

[default]
aws_access_key_id = AKID1234567890
aws_secret_access_key = MY-SECRET-KEY

On Mac OS or various flavors of Linux you can install the [AWS Command Line Interface](http://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html#cli-quick-configuration)
(`aws cli`) in the terminal and use the `aws configure` command which guides you through the creation of the credentials file.

This is the simplest method. You can then create a new machine with:

$ docker-machine create --driver amazonec2 aws01

### EC2 Instance Role

If you are running docker-machine from an existing EC2 instance, the amazonec2 driver will use the credentials for the IAM role
assigned to the instance if they are configured.

## Options

- `--amazonec2-access-key`: Your access key id for the Amazon Web Services API.
Expand Down