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

Markdown linting 

Signed-off-by: David Gageot <david@gageot.net>
This commit is contained in:
David Gageot 2015-12-08 09:20:53 +01:00
parent 3322b8e70c
commit db9ca3c3b7
7 changed files with 84 additions and 79 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

41
CHANGELOG.md
View File

@ -3,31 +3,34 @@
# 0.5.2 (2015-11-30)
General
- Bash autocompletion and helpers fixed
- Remove `RawDriver` from `config.json` - Driver parameters can now be edited
- Bash autocompletion and helpers fixed
- Remove `RawDriver` from `config.json` - Driver parameters can now be edited
directly again in this file.
- Change fish `env` variable setting to be global
- Add `docker-machine version` command
- Move back to normal `codegangsta/cli` upstream
- `--tls-san` flag for extra SANs
- Change fish `env` variable setting to be global
- Add `docker-machine version` command
- Move back to normal `codegangsta/cli` upstream
- `--tls-san` flag for extra SANs
Drivers
- Fix `GetURL` IPv6 compatibility
- Add documentation page for available 3rd party drivers
- VirtualBox
- Support for shared folders and virtualization detection on Linux hosts
- Improved detection of invalid host-only interface settings
- Google
- Update default images
- VMware Fusion
- Add option to disable shared folder
- Generic
- New environment variables for flags
- Fix `GetURL` IPv6 compatibility
- Add documentation page for available 3rd party drivers
- VirtualBox
- Support for shared folders and virtualization detection on Linux hosts
- Improved detection of invalid host-only interface settings
- Google
- Update default images
- VMware Fusion
- Add option to disable shared folder
- Generic
- New environment variables for flags
Provisioners
- Support for Ubuntu >=15.04. This means Ubuntu machines can be created which
- Support for Ubuntu >=15.04. This means Ubuntu machines can be created which
work with `overlay` driver of lib network.
- Fix issue with current netstat / daemon availability checking
- Fix issue with current netstat / daemon availability checking
# 0.5.1 (2015-11-16)

26
docs/AVAILABLE_DRIVER_PLUGINS.md
View File

@ -19,17 +19,17 @@ you informed of upstream changes.
**NOTE**: The linked repositories are not maintained by or formally associated
with Docker Inc. Use 3rd party plugins at your own risk.
| Name | Repository | Maintainer GitHub Handle | Maintainer Email |
| ---------------------- | -------------------------------------------------------------- | --------------------------------------------------- | ------------------------- |
| Amazon Cloud Formation | <https://github.com/jeffellin/machine-cloudformation> | [Jeff Ellin](https://github.com/jeffellin) | acf@ellin.com |
| BrightBox | <https://github.com/brightbox/docker-machine-driver-brightbox> | [NeilW](https://github.com/NeilW) | neil@aldur.co.uk |
| Docker-In-Docker | <https://github.com/nathanleclaire/docker-machine-driver-dind> | [nathanleclaire](https://github.com/nathanleclaire) | nathan.leclaire@gmail.com |
| HPE OneView | <https://github.com/HewlettPackard/docker-machine-oneview> | [wenlock](https://github.com/wenlock) | wenlock@hpe.com |
| OVH Cloud | <https://github.com/yadutaf/docker-machine-driver-ovh> | [yadutaf](https://github.com/yadutaf) | jt@yadutaf.fr |
| Packet | <https://github.com/packethost/docker-machine-driver-packet> | [betawaffle](https://github.com/betawaffle) | andy@packet.net |
| Parallels for OSX | <https://github.com/Parallels/docker-machine-parallels> | [legal90](https://github.com/legal90) | legal90@gmail.com |
| SAKURA CLOUD | <https://github.com/yamamoto-febc/docker-machine-sakuracloud> | [yamamoto-febc](https://github.com/yamamoto-febc) | yamamoto.febc@gmail.com |
| Name | Repository | Maintainer GitHub Handle | Maintainer Email |
| ---------------------- | ------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | ------------------------------------------------------------ |
| Amazon Cloud Formation | <https://github.com/jeffellin/machine-cloudformation> | [Jeff Ellin](https://github.com/jeffellin) | acf@ellin.com |
| BrightBox | <https://github.com/brightbox/docker-machine-driver-brightbox> | [NeilW](https://github.com/NeilW) | neil@aldur.co.uk |
| Docker-In-Docker | <https://github.com/nathanleclaire/docker-machine-driver-dind> | [nathanleclaire](https://github.com/nathanleclaire) | nathan.leclaire@gmail.com |
| HPE OneView | <https://github.com/HewlettPackard/docker-machine-oneview> | [wenlock](https://github.com/wenlock) | wenlock@hpe.com |
| OVH Cloud | <https://github.com/yadutaf/docker-machine-driver-ovh> | [yadutaf](https://github.com/yadutaf) | jt@yadutaf.fr |
| Packet | <https://github.com/packethost/docker-machine-driver-packet> | [betawaffle](https://github.com/betawaffle) | andy@packet.net |
| Parallels for OSX | <https://github.com/Parallels/docker-machine-parallels> | [legal90](https://github.com/legal90) | legal90@gmail.com |
| SAKURA CLOUD | <https://github.com/yamamoto-febc/docker-machine-sakuracloud> | [yamamoto-febc](https://github.com/yamamoto-febc) | yamamoto.febc@gmail.com |
| Ubiquity Hosting | <https://github.com/ubiquityhosting/docker-machine-driver-ubiquity> | [Justin Canington](https://github.com/justacan)<br>[Andrew Ayers](https://github.com/andrew-ayers) | justin.canington@nobistech.net<br>andrew.ayers@nobistech.net |
| UCloud | <https://github.com/ucloud/docker-machine-ucloud> | [xiaohui](https://github.com/xiaohui) | xiaohui.zju@gmail.com |
| VULTR | <https://github.com/janeczku/docker-machine-vultr> | [janeczku](https://github.com/janeczku) | jb@festplatte.eu.org |
| xhyve | <https://github.com/zchee/docker-machine-driver-xhyve> | [zchee](https://github.com/zchee) | zchee.io@gmail.com |
| UCloud | <https://github.com/ucloud/docker-machine-ucloud> | [xiaohui](https://github.com/xiaohui) | xiaohui.zju@gmail.com |
| VULTR | <https://github.com/janeczku/docker-machine-vultr> | [janeczku](https://github.com/janeczku) | jb@festplatte.eu.org |
| xhyve | <https://github.com/zchee/docker-machine-driver-xhyve> | [zchee](https://github.com/zchee) | zchee.io@gmail.com |

24
docs/drivers/azure.md
View File

@ -46,15 +46,15 @@ Options:
Environment variables and default values:
| CLI option | Environment variable | Default |
| ------------------------------- | ----------------------------- | ---------------------- |
| `--azure-docker-port` | - | `2376` |
| `--azure-image` | `AZURE_IMAGE` | _Ubuntu 15.10 x64_ |
| `--azure-location` | `AZURE_LOCATION` | `West US` |
| `--azure-password` | - | - |
| `--azure-publish-settings-file` | `AZURE_PUBLISH_SETTINGS_FILE` | - |
| `--azure-size` | `AZURE_SIZE` | `Small` |
| `--azure-ssh-port` | - | `22` |
| **`--azure-subscription-cert`** | `AZURE_SUBSCRIPTION_CERT` | - |
| **`--azure-subscription-id`** | `AZURE_SUBSCRIPTION_ID` | - |
| `--azure-username` | - | `ubuntu` |
| CLI option | Environment variable | Default |
| ------------------------------- | ----------------------------- | ------------------ |
| `--azure-docker-port` | - | `2376` |
| `--azure-image` | `AZURE_IMAGE` | _Ubuntu 15.10 x64_ |
| `--azure-location` | `AZURE_LOCATION` | `West US` |
| `--azure-password` | - | - |
| `--azure-publish-settings-file` | `AZURE_PUBLISH_SETTINGS_FILE` | - |
| `--azure-size` | `AZURE_SIZE` | `Small` |
| `--azure-ssh-port` | - | `22` |
| **`--azure-subscription-cert`** | `AZURE_SUBSCRIPTION_CERT` | - |
| **`--azure-subscription-id`** | `AZURE_SUBSCRIPTION_ID` | - |
| `--azure-username` | - | `ubuntu` |

4
docs/drivers/virtualbox.md
View File

@ -31,7 +31,7 @@ Options:
- `--virtualbox-import-boot2docker-vm`: The name of a Boot2Docker VM to import.
- `--virtualbox-hostonly-cidr`: The CIDR of the host only adapter.
- `--virtualbox-hostonly-nictype`: Host Only Network Adapter Type. Possible values are are '82540EM' (Intel PRO/1000), 'Am79C973' (PCnet-FAST III) and 'virtio-net' Paravirtualized network adapter.
- `--virtualbox-hostonly-nicpromisc`: Host Only Network Adapter Promiscuous Mode. Possible options are deny , allow-vms, allow-all
- `--virtualbox-hostonly-nicpromisc`: Host Only Network Adapter Promiscuous Mode. Possible options are deny , allow-vms, allow-all
- `--virtualbox-no-share`: Disable the mount of your home directory
- `--virtualbox-dns-proxy`: Proxy all DNS requests to the host (Boolean value, default to false)
@ -75,4 +75,4 @@ Environment variables and default values:
| `--virtualbox-hostonly-nictype` | `VIRTUALBOX_HOSTONLY_NIC_TYPE` | `82540EM` |
| `--virtualbox-hostonly-nicpromisc` | `VIRTUALBOX_HOSTONLY_NIC_PROMISC` | `deny` |
| `--virtualbox-no-share` | `VIRTUALBOX_NO_SHARE` | `false` |
| `--virtualbox-dns-proxy` | `VIRTUALBOX_DNS_PROXY | `false` |
| `--virtualbox-dns-proxy` | `VIRTUALBOX_DNS_PROXY` | `false` |

6
experimental/README.md
View File

@ -1,4 +1,4 @@
# Docker Machine Experimental Features
# Docker Machine Experimental Features
Docker Machine’s experimental features gives you access to bleeding edge features. By identifying experimental features, you can try out features early and give feedback to the Docker Machine maintainers. In this way, we hope to refine our feature designs by exposing them earlier to real-world usage.
@ -11,7 +11,7 @@ please feel free to provide any feedback on these features you wish.
## Current experimental features
Currently, you can experiment with [migrating a Boot2Docker created VM to Docker Machine](b2d_migration.md). Also, consider reviewing our [rough plan for the migration](b2d_migration_tasks.md).
Currently, you can experiment with [migrating a Boot2Docker created VM to Docker Machine](b2d_migration.md). Also, consider reviewing our [rough plan for the migration](b2d_migration_tasks.md).
Additional experimental features include support for Red Hat, Debian, CentOS, Fedora, and RancherOS as base OSes. These features have no separate feature documentation. We simply encourage you to try them.
@ -19,4 +19,4 @@ Additional experimental features include support for Red Hat, Debian, CentOS, Fe
Each feature's documentation includes a list of proposal pull requests or PRs associated with the feature. If you want to comment on or suggest a change to a feature, please add it to the existing feature PR.
Issues or problems with a feature? Inquire for help on the `#docker-machine` IRC channel or in on the [Docker Google group](https://groups.google.com/forum/#!forum/docker-user).
Issues or problems with a feature? Inquire for help on the `#docker-machine` IRC channel or in on the [Docker Google group](https://groups.google.com/forum/#!forum/docker-user).

56
experimental/b2d_migration.md
View File

@ -16,51 +16,47 @@ To migrate a Boot2Docker VM, run the following command where `<boot2docker-vm-na
> To get the name of your Boot2Docker VM, use the `boot2docker config` command. Default: `boot2docker-vm`.
```
docker-machine create -d virtualbox --virtualbox-import-boot2docker-vm <boot2docker-vm-name> <new-machine-name>
```
docker-machine create -d virtualbox --virtualbox-import-boot2docker-vm <boot2docker-vm-name> <new-machine-name>
> Note: this will stop the Boot2Docker VM in order to safely copy the virtual disk
You should see output similar to the following:
```
$> docker-machine create -d virtualbox --virtualbox-import-boot2docker-vm boot2docker-vm dev
INFO[0000] Creating VirtualBox VM...
INFO[0001] Starting VirtualBox VM...
INFO[0001] Waiting for VM to start...
INFO[0035] "dev" has been created and is now the active machine.
INFO[0035] To point your Docker client at it, run this in your shell: eval "$(docker-machine env dev)"
```
$> docker-machine create -d virtualbox --virtualbox-import-boot2docker-vm boot2docker-vm dev
INFO[0000] Creating VirtualBox VM...
INFO[0001] Starting VirtualBox VM...
INFO[0001] Waiting for VM to start...
INFO[0035] "dev" has been created and is now the active machine.
INFO[0035] To point your Docker client at it, run this in your shell: eval "$(docker-machine env dev)"
You now should have a Machine that contains all of the Docker data from the Boot2Docker VM. See the Docker Machine [usage docs](http://docs.docker.com/machine/#getting-started-with-docker-machine-using-a-local-vm) for details on working with Machine.
# Cleanup
When migrating a Boot2Docker VM to Docker Machine the Boot2Docker VM is left intact. Once you have verified that all of your Docker data (containers, images, etc) are in the new Machine, you can remove the Boot2Docker VM using `boot2docker delete`.
# Command Comparison
| boot2docker cli | machine | machine description |
|----|----|----|
| init | create | creates a new docker host |
| up | start | starts a stopped machine |
| ssh | ssh | runs a command or interactive ssh session on the machine |
| save | - | n/a |
| down | stop | stops a running machine |
| poweroff | stop | stops a running machine |
| reset | restart | restarts a running machine |
| config | inspect (*) | shows details about machine |
| status | ls (**) | shows a list of all machines |
| info | inspect (*) | shows details about machine |
| ip | url (***) | shows the Docker URL for the machine |
| shellinit | env | shows the environment configuration needed to configure the Docker CLI for the machine |
| delete | rm | removes a machine |
| download | - | |
| upgrade | upgrade | upgrades Docker on the machine to the latest stable release |
| boot2docker cli | machine | machine description |
| --------------- | ----------- | -------------------------------------------------------------------------------------- |
| init | create | creates a new docker host |
| up | start | starts a stopped machine |
| ssh | ssh | runs a command or interactive ssh session on the machine |
| save | - | n/a |
| down | stop | stops a running machine |
| poweroff | stop | stops a running machine |
| reset | restart | restarts a running machine |
| config | inspect (*) | shows details about machine |
| status | ls (**) | shows a list of all machines |
| info | inspect (*) | shows details about machine |
| ip | url (***) | shows the Docker URL for the machine |
| shellinit | env | shows the environment configuration needed to configure the Docker CLI for the machine |
| delete | rm | removes a machine |
| download | - | |
| upgrade | upgrade | upgrades Docker on the machine to the latest stable release |
\* provides similar functionality but not exact
** `ls` will show all machines including their status
*** the `url` command reports the entire Docker URL including the IP / Hostname
*** the `url` command reports the entire Docker URL including the IP / Hostname

6
experimental/b2d_migration_tasks.md
View File

@ -10,34 +10,40 @@ parent="mn_install"
<![end-metadata]-->
# Boot2Docker Migration
This document is a rough guide to what will need to be completed to support
migrating from boot2docker-cli to Machine. It is not meant to be a user guide
but more so an internal guide to what we will want to support.
## Existing Boot2Docker Instances
We will need to import the disk to "migrate" the existing Docker data to the
new Machine. This should not be too much work as instead of creating the
virtual disk we will simply copy this one. From there, provisioning should
happen as normal (cert regeneration, option configuration, etc).
## CLI
Currently almost every b2d command has a comparable Machine command. I do not
feel we need to have the exact same naming but we will want to create a
migration user guide to inform the users of what is different.
## Boot2Docker Host Alias
Boot2Docker also modifies the local system host file to create a `boot2docker`
alias that can be used by the host system. We will need to decide if we want
to support this and, if so, how to implement. Perhaps local aliases for each
Machine name?
## Installer and Initial Setup
There is a Boot2Docker installer that assists the users in getting started.
It installs VirtualBox along with the b2d CLI. We will need something similar.
This will probably be part of a larger installation project with the various
Docker platform tools.
## Updates
Machine already supports the `upgrade` command to update the Machine instances.
I'm not sure if we want to add a mechanism to update the local Machine binary
and/or the Docker CLI binary as well. We will need to discuss.