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

Merge pull request #2926 from jeanlaurent/enhancedoc 

Enhance globaly the documentation following #2912
This commit is contained in:
Jean-Laurent de Morlhon 2016-01-26 11:33:22 +01:00
parent 5d7afcad02 bb370d7227
commit a4d3248c88
3 changed files with 13 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
docs/drivers/aws.md
View File

@ -14,12 +14,12 @@ Create machines on [Amazon Web Services](http://aws.amazon.com).
To create machines on [Amazon Web Services](http://aws.amazon.com), you must supply two parameters: the AWS Access Key ID and the AWS Secret Access Key. To create machines on [Amazon Web Services](http://aws.amazon.com), you must supply two parameters: the AWS Access Key ID and the AWS Secret Access Key.
## Configuring credentials ## Configuring credentials
Before using the amazonec2 driver, ensure that you've configured credentials. Before using the amazonec2 driver, ensure that you've configured credentials.
### AWS credential file ### 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: One way to configure credentials is to use the standard credential file for Amazon AWS `~/.aws/credentials` file, which might look like:
[default] [default]
@ -33,11 +33,13 @@ This is the simplest case, you can then create a new machine with:
$ docker-machine create --driver amazonec2 aws01 $ docker-machine create --driver amazonec2 aws01
### Command line flags ### Command line flags
Alternatively, you can use the flags `--amazonec2-access-key` and `--amazonec2-secret-key` on the command line: Alternatively, you can use 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 $ docker-machine create --driver amazonec2 --amazonec2-access-key AKI******* --amazonec2-secret-key 8T93C******* aws01
### Environment variables ### Environment variables
You can use environment variables: You can use environment variables:
$ export AWS_ACCESS_KEY_ID=AKID1234567890 $ export AWS_ACCESS_KEY_ID=AKID1234567890
@ -96,7 +98,7 @@ Environment variables and default values:
| `--amazonec2-private-address-only` | - | `false` | | `--amazonec2-private-address-only` | - | `false` |
| `--amazonec2-monitoring` | - | `false` | | `--amazonec2-monitoring` | - | `false` |
| `--amazonec2-use-ebs-optimized-instance` | - | `false` | | `--amazonec2-use-ebs-optimized-instance` | - | `false` |
| `--amazonec2-ssh-keypath` |`AWS_SSH_KEYPATH` | - | | `--amazonec2-ssh-keypath` | `AWS_SSH_KEYPATH` | - |
## Default AMIs ## Default AMIs
@ -117,6 +119,7 @@ By default, the Amazon EC2 driver will use a daily image of Ubuntu 15.10 LTS.
| us-gov-west-1 | ami-b0bad893 | | us-gov-west-1 | ami-b0bad893 |
## Security Group ## Security Group
Note that a security group will be created and associated to the host. This security group will have the following ports opened inbound: Note that a security group will be created and associated to the host. This security group will have the following ports opened inbound:
- ssh (22/tcp) - ssh (22/tcp)
@ -126,8 +129,8 @@ 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.
## VPC ID ## VPC ID
We determine your default vpc id at the start of a command. We determine your default vpc id at the start of a command.
In some cases, either because your account does not have a default vpc, or you don't want to use the default one, you can specify a vpc with the `--amazonec2-vpc-id` flag. In some cases, either because your account does not have a default vpc, or you don't want to use the default one, you can specify a vpc with the `--amazonec2-vpc-id` flag.
@ -147,8 +150,9 @@ To create a machine with a non-default vpc-id:
This example assumes the VPC ID was found in the `a` availability zone. Use the`--amazonec2-zone` flag to specify a zone other than the `a` zone. For example, `--amazonec2-zone c` signifies `us-east1-c`. This example assumes the VPC ID was found in the `a` availability zone. Use the`--amazonec2-zone` flag to specify a zone other than the `a` zone. For example, `--amazonec2-zone c` signifies `us-east1-c`.
## Custom AMI and SSH username ## Custom AMI and SSH username
The default SSH username for the default AMIs is `ubuntu`. The default SSH username for the default AMIs is `ubuntu`.
You need to change the SSH username only if the custom AMI you use has a different SSH username. You need to change the SSH username only if the custom AMI you use has a different SSH username.
You can change the SSH username with the `--amazonec2-ssh-user` according to the AMI you selected with the `--amazonec2-ami`. You can change the SSH username with the `--amazonec2-ssh-user` according to the AMI you selected with the `--amazonec2-ami`.

1
docs/index.md
View File

@ -10,7 +10,6 @@ identifier="workw_machine"
# Docker Machine # Docker Machine
-
- Install a machine on your [local system using VirtualBox](get-started.md). - Install a machine on your [local system using VirtualBox](get-started.md).
- Install multiple machines [on your cloud provider](get-started-cloud.md). - Install multiple machines [on your cloud provider](get-started-cloud.md).
- [Docker Machine driver reference](drivers/index.md) - [Docker Machine driver reference](drivers/index.md)

10
docs/overview.md
View File

@ -39,16 +39,16 @@ create containers on the host.
To create a virtual machine, you supply Docker Machine with the name of the To create a virtual machine, you supply Docker Machine with the name of the
driver you want use. The driver represents the virtual environment. For example, driver you want use. The driver represents the virtual environment. For example,
on a local Linux, Mac, or Windows system the driver is typically Oracle Virtual on a local Linux, Mac, or Windows system the driver is typically Oracle
Box. For cloud providers, Docker Machine supports drivers such as AWS, Microsoft VirtualBox. For cloud providers, Docker Machine supports drivers such as AWS,
Azure, Digital Ocean and many more. The Docker Machine reference includes a Microsoft Azure, Digital Ocean and many more. The Docker Machine reference
complete [list of the supported drivers](drivers/index.md). includes a complete [list of the supported drivers](drivers/index.md).
Since Docker runs on Linux, each VM that Docker Machine provisions relies on a Since Docker runs on Linux, each VM that Docker Machine provisions relies on a
base operating system. For convenience, there are default base operating base operating system. For convenience, there are default base operating
systems. For the Oracle Virtual Box driver, this base operating system is the systems. For the Oracle Virtual Box driver, this base operating system is the
`boot2docker.iso`. For drivers used to connect to cloud providers, the base `boot2docker.iso`. For drivers used to connect to cloud providers, the base
operating system is Ubuntu 12.04+. You can change this default when you create a operating system is Ubuntu 15.10. You can change this default when you create a
machine. The Docker Machine reference includes a complete [list of the supported machine. The Docker Machine reference includes a complete [list of the supported
operating systems](drivers/os-base.md). operating systems](drivers/os-base.md).