Skip to content
This repository was archived by the owner on Sep 26, 2021. It is now read-only.

Commit db9ca3c

Browse files
committed
Markdown linting
Signed-off-by: David Gageot <[email protected]>
1 parent 3322b8e commit db9ca3c

File tree

7 files changed

+84
-79
lines changed

7 files changed

+84
-79
lines changed

CHANGELOG.md

+22-19
Original file line numberDiff line numberDiff line change
@@ -3,31 +3,34 @@
33
# 0.5.2 (2015-11-30)
44

55
General
6-
- Bash autocompletion and helpers fixed
7-
- Remove `RawDriver` from `config.json` - Driver parameters can now be edited
6+
7+
- Bash autocompletion and helpers fixed
8+
- Remove `RawDriver` from `config.json` - Driver parameters can now be edited
89
directly again in this file.
9-
- Change fish `env` variable setting to be global
10-
- Add `docker-machine version` command
11-
- Move back to normal `codegangsta/cli` upstream
12-
- `--tls-san` flag for extra SANs
10+
- Change fish `env` variable setting to be global
11+
- Add `docker-machine version` command
12+
- Move back to normal `codegangsta/cli` upstream
13+
- `--tls-san` flag for extra SANs
1314

1415
Drivers
15-
- Fix `GetURL` IPv6 compatibility
16-
- Add documentation page for available 3rd party drivers
17-
- VirtualBox
18-
- Support for shared folders and virtualization detection on Linux hosts
19-
- Improved detection of invalid host-only interface settings
20-
- Google
21-
- Update default images
22-
- VMware Fusion
23-
- Add option to disable shared folder
24-
- Generic
25-
- New environment variables for flags
16+
17+
- Fix `GetURL` IPv6 compatibility
18+
- Add documentation page for available 3rd party drivers
19+
- VirtualBox
20+
- Support for shared folders and virtualization detection on Linux hosts
21+
- Improved detection of invalid host-only interface settings
22+
- Google
23+
- Update default images
24+
- VMware Fusion
25+
- Add option to disable shared folder
26+
- Generic
27+
- New environment variables for flags
2628

2729
Provisioners
28-
- Support for Ubuntu >=15.04. This means Ubuntu machines can be created which
30+
31+
- Support for Ubuntu >=15.04. This means Ubuntu machines can be created which
2932
work with `overlay` driver of lib network.
30-
- Fix issue with current netstat / daemon availability checking
33+
- Fix issue with current netstat / daemon availability checking
3134

3235
# 0.5.1 (2015-11-16)
3336

docs/AVAILABLE_DRIVER_PLUGINS.md

+13-13
Original file line numberDiff line numberDiff line change
@@ -19,17 +19,17 @@ you informed of upstream changes.
1919
**NOTE**: The linked repositories are not maintained by or formally associated
2020
with Docker Inc. Use 3rd party plugins at your own risk.
2121

22-
| Name | Repository | Maintainer GitHub Handle | Maintainer Email |
23-
| ---------------------- | -------------------------------------------------------------- | --------------------------------------------------- | ------------------------- |
24-
| Amazon Cloud Formation | <https://github.com/jeffellin/machine-cloudformation> | [Jeff Ellin](https://github.com/jeffellin) | [email protected] |
25-
| BrightBox | <https://github.com/brightbox/docker-machine-driver-brightbox> | [NeilW](https://github.com/NeilW) | [email protected] |
26-
| Docker-In-Docker | <https://github.com/nathanleclaire/docker-machine-driver-dind> | [nathanleclaire](https://github.com/nathanleclaire) | [email protected] |
27-
| HPE OneView | <https://github.com/HewlettPackard/docker-machine-oneview> | [wenlock](https://github.com/wenlock) | [email protected] |
28-
| OVH Cloud | <https://github.com/yadutaf/docker-machine-driver-ovh> | [yadutaf](https://github.com/yadutaf) | [email protected] |
29-
| Packet | <https://github.com/packethost/docker-machine-driver-packet> | [betawaffle](https://github.com/betawaffle) | [email protected] |
30-
| Parallels for OSX | <https://github.com/Parallels/docker-machine-parallels> | [legal90](https://github.com/legal90) | [email protected] |
31-
| SAKURA CLOUD | <https://github.com/yamamoto-febc/docker-machine-sakuracloud> | [yamamoto-febc](https://github.com/yamamoto-febc) | [email protected] |
22+
| Name | Repository | Maintainer GitHub Handle | Maintainer Email |
23+
| ---------------------- | ------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | ------------------------------------------------------------ |
24+
| Amazon Cloud Formation | <https://github.com/jeffellin/machine-cloudformation> | [Jeff Ellin](https://github.com/jeffellin) | [email protected] |
25+
| BrightBox | <https://github.com/brightbox/docker-machine-driver-brightbox> | [NeilW](https://github.com/NeilW) | [email protected] |
26+
| Docker-In-Docker | <https://github.com/nathanleclaire/docker-machine-driver-dind> | [nathanleclaire](https://github.com/nathanleclaire) | [email protected] |
27+
| HPE OneView | <https://github.com/HewlettPackard/docker-machine-oneview> | [wenlock](https://github.com/wenlock) | [email protected] |
28+
| OVH Cloud | <https://github.com/yadutaf/docker-machine-driver-ovh> | [yadutaf](https://github.com/yadutaf) | [email protected] |
29+
| Packet | <https://github.com/packethost/docker-machine-driver-packet> | [betawaffle](https://github.com/betawaffle) | [email protected] |
30+
| Parallels for OSX | <https://github.com/Parallels/docker-machine-parallels> | [legal90](https://github.com/legal90) | [email protected] |
31+
| SAKURA CLOUD | <https://github.com/yamamoto-febc/docker-machine-sakuracloud> | [yamamoto-febc](https://github.com/yamamoto-febc) | [email protected] |
3232
| Ubiquity Hosting | <https://github.com/ubiquityhosting/docker-machine-driver-ubiquity> | [Justin Canington](https://github.com/justacan)<br>[Andrew Ayers](https://github.com/andrew-ayers) | [email protected]<br>[email protected] |
33-
| UCloud | <https://github.com/ucloud/docker-machine-ucloud> | [xiaohui](https://github.com/xiaohui) | [email protected] |
34-
| VULTR | <https://github.com/janeczku/docker-machine-vultr> | [janeczku](https://github.com/janeczku) | [email protected] |
35-
| xhyve | <https://github.com/zchee/docker-machine-driver-xhyve> | [zchee](https://github.com/zchee) | [email protected] |
33+
| UCloud | <https://github.com/ucloud/docker-machine-ucloud> | [xiaohui](https://github.com/xiaohui) | [email protected] |
34+
| VULTR | <https://github.com/janeczku/docker-machine-vultr> | [janeczku](https://github.com/janeczku) | [email protected] |
35+
| xhyve | <https://github.com/zchee/docker-machine-driver-xhyve> | [zchee](https://github.com/zchee) | [email protected] |

docs/drivers/azure.md

+12-12
Original file line numberDiff line numberDiff line change
@@ -46,15 +46,15 @@ Options:
4646

4747
Environment variables and default values:
4848

49-
| CLI option | Environment variable | Default |
50-
| ------------------------------- | ----------------------------- | ---------------------- |
51-
| `--azure-docker-port` | - | `2376` |
52-
| `--azure-image` | `AZURE_IMAGE` | _Ubuntu 15.10 x64_ |
53-
| `--azure-location` | `AZURE_LOCATION` | `West US` |
54-
| `--azure-password` | - | - |
55-
| `--azure-publish-settings-file` | `AZURE_PUBLISH_SETTINGS_FILE` | - |
56-
| `--azure-size` | `AZURE_SIZE` | `Small` |
57-
| `--azure-ssh-port` | - | `22` |
58-
| **`--azure-subscription-cert`** | `AZURE_SUBSCRIPTION_CERT` | - |
59-
| **`--azure-subscription-id`** | `AZURE_SUBSCRIPTION_ID` | - |
60-
| `--azure-username` | - | `ubuntu` |
49+
| CLI option | Environment variable | Default |
50+
| ------------------------------- | ----------------------------- | ------------------ |
51+
| `--azure-docker-port` | - | `2376` |
52+
| `--azure-image` | `AZURE_IMAGE` | _Ubuntu 15.10 x64_ |
53+
| `--azure-location` | `AZURE_LOCATION` | `West US` |
54+
| `--azure-password` | - | - |
55+
| `--azure-publish-settings-file` | `AZURE_PUBLISH_SETTINGS_FILE` | - |
56+
| `--azure-size` | `AZURE_SIZE` | `Small` |
57+
| `--azure-ssh-port` | - | `22` |
58+
| **`--azure-subscription-cert`** | `AZURE_SUBSCRIPTION_CERT` | - |
59+
| **`--azure-subscription-id`** | `AZURE_SUBSCRIPTION_ID` | - |
60+
| `--azure-username` | - | `ubuntu` |

docs/drivers/virtualbox.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ Options:
3131
- `--virtualbox-import-boot2docker-vm`: The name of a Boot2Docker VM to import.
3232
- `--virtualbox-hostonly-cidr`: The CIDR of the host only adapter.
3333
- `--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.
34-
- `--virtualbox-hostonly-nicpromisc`: Host Only Network Adapter Promiscuous Mode. Possible options are deny , allow-vms, allow-all
34+
- `--virtualbox-hostonly-nicpromisc`: Host Only Network Adapter Promiscuous Mode. Possible options are deny , allow-vms, allow-all
3535
- `--virtualbox-no-share`: Disable the mount of your home directory
3636
- `--virtualbox-dns-proxy`: Proxy all DNS requests to the host (Boolean value, default to false)
3737

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

experimental/README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Docker Machine Experimental Features
1+
# Docker Machine Experimental Features
22

33
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.
44

@@ -11,12 +11,12 @@ please feel free to provide any feedback on these features you wish.
1111

1212
## Current experimental features
1313

14-
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).
14+
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).
1515

1616
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.
1717

1818
## How to comment on an experimental feature
1919

2020
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.
2121

22-
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).
22+
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).

experimental/b2d_migration.md

+26-30
Original file line numberDiff line numberDiff line change
@@ -16,51 +16,47 @@ To migrate a Boot2Docker VM, run the following command where `<boot2docker-vm-na
1616

1717
> To get the name of your Boot2Docker VM, use the `boot2docker config` command. Default: `boot2docker-vm`.
1818
19-
```
20-
docker-machine create -d virtualbox --virtualbox-import-boot2docker-vm <boot2docker-vm-name> <new-machine-name>
21-
```
19+
docker-machine create -d virtualbox --virtualbox-import-boot2docker-vm <boot2docker-vm-name> <new-machine-name>
2220

2321
> Note: this will stop the Boot2Docker VM in order to safely copy the virtual disk
2422
2523
You should see output similar to the following:
2624

27-
```
28-
$> docker-machine create -d virtualbox --virtualbox-import-boot2docker-vm boot2docker-vm dev
29-
INFO[0000] Creating VirtualBox VM...
30-
INFO[0001] Starting VirtualBox VM...
31-
INFO[0001] Waiting for VM to start...
32-
INFO[0035] "dev" has been created and is now the active machine.
33-
INFO[0035] To point your Docker client at it, run this in your shell: eval "$(docker-machine env dev)"
34-
```
25+
$> docker-machine create -d virtualbox --virtualbox-import-boot2docker-vm boot2docker-vm dev
26+
INFO[0000] Creating VirtualBox VM...
27+
INFO[0001] Starting VirtualBox VM...
28+
INFO[0001] Waiting for VM to start...
29+
INFO[0035] "dev" has been created and is now the active machine.
30+
INFO[0035] To point your Docker client at it, run this in your shell: eval "$(docker-machine env dev)"
3531

3632
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.
3733

3834
# Cleanup
35+
3936
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`.
4037

4138
# Command Comparison
4239

43-
| boot2docker cli | machine | machine description |
44-
|----|----|----|
45-
| init | create | creates a new docker host |
46-
| up | start | starts a stopped machine |
47-
| ssh | ssh | runs a command or interactive ssh session on the machine |
48-
| save | - | n/a |
49-
| down | stop | stops a running machine |
50-
| poweroff | stop | stops a running machine |
51-
| reset | restart | restarts a running machine |
52-
| config | inspect (*) | shows details about machine |
53-
| status | ls (**) | shows a list of all machines |
54-
| info | inspect (*) | shows details about machine |
55-
| ip | url (***) | shows the Docker URL for the machine |
56-
| shellinit | env | shows the environment configuration needed to configure the Docker CLI for the machine |
57-
| delete | rm | removes a machine |
58-
| download | - | |
59-
| upgrade | upgrade | upgrades Docker on the machine to the latest stable release |
60-
40+
| boot2docker cli | machine | machine description |
41+
| --------------- | ----------- | -------------------------------------------------------------------------------------- |
42+
| init | create | creates a new docker host |
43+
| up | start | starts a stopped machine |
44+
| ssh | ssh | runs a command or interactive ssh session on the machine |
45+
| save | - | n/a |
46+
| down | stop | stops a running machine |
47+
| poweroff | stop | stops a running machine |
48+
| reset | restart | restarts a running machine |
49+
| config | inspect (*) | shows details about machine |
50+
| status | ls (**) | shows a list of all machines |
51+
| info | inspect (*) | shows details about machine |
52+
| ip | url (***) | shows the Docker URL for the machine |
53+
| shellinit | env | shows the environment configuration needed to configure the Docker CLI for the machine |
54+
| delete | rm | removes a machine |
55+
| download | - | |
56+
| upgrade | upgrade | upgrades Docker on the machine to the latest stable release |
6157

6258
\* provides similar functionality but not exact
6359

6460
** `ls` will show all machines including their status
6561

66-
*** the `url` command reports the entire Docker URL including the IP / Hostname
62+
*** the `url` command reports the entire Docker URL including the IP / Hostname

0 commit comments

Comments
 (0)