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

Merge pull request #2506 from dgageot/fix-installation-notes 

Fix installation notes for 0.5.3
This commit is contained in:
David Gageot 2015-12-08 09:39:01 +01:00
parent 8f6b8da399 db9ca3c3b7
commit c41476ee74
8 changed files with 92 additions and 87 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
CHANGELOG.md
View File

@ -3,6 +3,7 @@
# 0.5.2 (2015-11-30) # 0.5.2 (2015-11-30)
General General
- Bash autocompletion and helpers fixed - Bash autocompletion and helpers fixed
- Remove `RawDriver` from `config.json` - Driver parameters can now be edited - Remove `RawDriver` from `config.json` - Driver parameters can now be edited
directly again in this file. directly again in this file.
@ -12,6 +13,7 @@ General
- `--tls-san` flag for extra SANs - `--tls-san` flag for extra SANs
Drivers Drivers
- Fix `GetURL` IPv6 compatibility - Fix `GetURL` IPv6 compatibility
- Add documentation page for available 3rd party drivers - Add documentation page for available 3rd party drivers
- VirtualBox - VirtualBox
@ -25,6 +27,7 @@ Drivers
- New environment variables for flags - New environment variables for flags
Provisioners 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. work with `overlay` driver of lib network.
- Fix issue with current netstat / daemon availability checking - Fix issue with current netstat / daemon availability checking

2
docs/AVAILABLE_DRIVER_PLUGINS.md
View File

@ -20,7 +20,7 @@ you informed of upstream changes.
with Docker Inc. Use 3rd party plugins at your own risk. with Docker Inc. Use 3rd party plugins at your own risk.
| Name | Repository | Maintainer GitHub Handle | Maintainer Email | | 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 | | 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 | | 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 | | Docker-In-Docker | <https://github.com/nathanleclaire/docker-machine-driver-dind> | [nathanleclaire](https://github.com/nathanleclaire) | nathan.leclaire@gmail.com |

2
docs/drivers/azure.md
View File

@ -47,7 +47,7 @@ Options:
Environment variables and default values: Environment variables and default values:
| CLI option | Environment variable | Default | | CLI option | Environment variable | Default |
| ------------------------------- | ----------------------------- | ---------------------- | | ------------------------------- | ----------------------------- | ------------------ |
| `--azure-docker-port` | - | `2376` | | `--azure-docker-port` | - | `2376` |
| `--azure-image` | `AZURE_IMAGE` | _Ubuntu 15.10 x64_ | | `--azure-image` | `AZURE_IMAGE` | _Ubuntu 15.10 x64_ |
| `--azure-location` | `AZURE_LOCATION` | `West US` | | `--azure-location` | `AZURE_LOCATION` | `West US` |

2
docs/drivers/virtualbox.md
View File

@ -75,4 +75,4 @@ Environment variables and default values:
| `--virtualbox-hostonly-nictype` | `VIRTUALBOX_HOSTONLY_NIC_TYPE` | `82540EM` | | `--virtualbox-hostonly-nictype` | `VIRTUALBOX_HOSTONLY_NIC_TYPE` | `82540EM` |
| `--virtualbox-hostonly-nicpromisc` | `VIRTUALBOX_HOSTONLY_NIC_PROMISC` | `deny` | | `--virtualbox-hostonly-nicpromisc` | `VIRTUALBOX_HOSTONLY_NIC_PROMISC` | `deny` |
| `--virtualbox-no-share` | `VIRTUALBOX_NO_SHARE` | `false` | | `--virtualbox-no-share` | `VIRTUALBOX_NO_SHARE` | `false` |
| `--virtualbox-dns-proxy` | `VIRTUALBOX_DNS_PROXY | `false` | | `--virtualbox-dns-proxy` | `VIRTUALBOX_DNS_PROXY` | `false` |

16
docs/install-machine.md
View File

@ -28,34 +28,34 @@ instructions in the next section.
1. Install <a href="https://docs.docker.com/installation/" 1. Install <a href="https://docs.docker.com/installation/"
target="_blank">the Docker binary</a>. target="_blank">the Docker binary</a>.
2. Download the archive containing the Docker Machine binaries and extract them 2. Download the archive containing the Docker Machine binary and extract it
to your PATH. to your PATH.
Linux: Linux:
$ curl -L https://github.com/docker/machine/releases/download/v0.5.0/docker-machine_linux-amd64.zip >machine.zip && \ $ curl -L https://github.com/docker/machine/releases/download/v0.5.3/docker-machine_linux-amd64.zip >machine.zip && \
unzip machine.zip && \ unzip machine.zip && \
rm machine.zip && \ rm machine.zip && \
mv docker-machine* /usr/local/bin mv docker-machine /usr/local/bin
OSX: OSX:
$ curl -L https://github.com/docker/machine/releases/download/v0.5.0/docker-machine_darwin-amd64.zip >machine.zip && \ $ curl -L https://github.com/docker/machine/releases/download/v0.5.3/docker-machine_darwin-amd64.zip >machine.zip && \
unzip machine.zip && \ unzip machine.zip && \
rm machine.zip && \ rm machine.zip && \
mv docker-machine* /usr/local/bin mv docker-machine /usr/local/bin
Windows (using Git Bash): Windows (using Git Bash):
$ curl -L https://github.com/docker/machine/releases/download/v0.5.0/docker-machine_windows-amd64.zip >machine.zip && \ $ curl -L https://github.com/docker/machine/releases/download/v0.5.3/docker-machine_windows-amd64.zip >machine.zip && \
unzip machine.zip && \ unzip machine.zip && \
rm machine.zip && \ rm machine.zip && \
mv docker-machine* /usr/local/bin mv docker-machine /usr/local/bin
3. Check the installation by displaying the Machine version: 3. Check the installation by displaying the Machine version:
$ docker-machine version $ docker-machine version
docker-machine version 0.5.2 (0456b9f) docker-machine version 0.5.3
## Installing bash completion scripts ## Installing bash completion scripts

8
experimental/b2d_migration.md
View File

@ -16,32 +16,29 @@ 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`. > 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 > Note: this will stop the Boot2Docker VM in order to safely copy the virtual disk
You should see output similar to the following: You should see output similar to the following:
```
$> docker-machine create -d virtualbox --virtualbox-import-boot2docker-vm boot2docker-vm dev $> docker-machine create -d virtualbox --virtualbox-import-boot2docker-vm boot2docker-vm dev
INFO[0000] Creating VirtualBox VM... INFO[0000] Creating VirtualBox VM...
INFO[0001] Starting VirtualBox VM... INFO[0001] Starting VirtualBox VM...
INFO[0001] Waiting for VM to start... INFO[0001] Waiting for VM to start...
INFO[0035] "dev" has been created and is now the active machine. 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)" 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. 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 # 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`. 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 # Command Comparison
| boot2docker cli | machine | machine description | | boot2docker cli | machine | machine description |
|----|----|----| | --------------- | ----------- | -------------------------------------------------------------------------------------- |
| init | create | creates a new docker host | | init | create | creates a new docker host |
| up | start | starts a stopped machine | | up | start | starts a stopped machine |
| ssh | ssh | runs a command or interactive ssh session on the machine | | ssh | ssh | runs a command or interactive ssh session on the machine |
@ -58,7 +55,6 @@ When migrating a Boot2Docker VM to Docker Machine the Boot2Docker VM is left int
| download | - | | | download | - | |
| upgrade | upgrade | upgrades Docker on the machine to the latest stable release | | upgrade | upgrade | upgrades Docker on the machine to the latest stable release |
\* provides similar functionality but not exact \* provides similar functionality but not exact
** `ls` will show all machines including their status ** `ls` will show all machines including their status

6
experimental/b2d_migration_tasks.md
View File

@ -10,34 +10,40 @@ parent="mn_install"
<![end-metadata]--> <![end-metadata]-->
# Boot2Docker Migration # Boot2Docker Migration
This document is a rough guide to what will need to be completed to support 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 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. but more so an internal guide to what we will want to support.
## Existing Boot2Docker Instances ## Existing Boot2Docker Instances
We will need to import the disk to "migrate" the existing Docker data to the 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 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 virtual disk we will simply copy this one. From there, provisioning should
happen as normal (cert regeneration, option configuration, etc). happen as normal (cert regeneration, option configuration, etc).
## CLI ## CLI
Currently almost every b2d command has a comparable Machine command. I do not 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 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. migration user guide to inform the users of what is different.
## Boot2Docker Host Alias ## Boot2Docker Host Alias
Boot2Docker also modifies the local system host file to create a `boot2docker` 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 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 to support this and, if so, how to implement. Perhaps local aliases for each
Machine name? Machine name?
## Installer and Initial Setup ## Installer and Initial Setup
There is a Boot2Docker installer that assists the users in getting started. 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. 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 This will probably be part of a larger installation project with the various
Docker platform tools. Docker platform tools.
## Updates ## Updates
Machine already supports the `upgrade` command to update the Machine instances. 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 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. and/or the Docker CLI binary as well. We will need to discuss.