X Tutup
Skip to content

Commit 736e485

Browse files
Update some driver/plugin-related documentation
Signed-off-by: Nathan LeClaire <nathan.leclaire@gmail.com>
1 parent a0b75d1 commit 736e485

File tree

3 files changed

+28
-15
lines changed

3 files changed

+28
-15
lines changed

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,14 @@ Full documentation [is available here](https://docs.docker.com/machine/).
5454

5555
Want to hack on Machine? Please start with the [Contributing Guide](https://github.com/docker/machine/blob/master/CONTRIBUTING.md).
5656

57+
## Driver Plugins
58+
59+
In addition to the core driver plugins bundled alongside Docker Machine, users
60+
can make and distribute their own plugin for any virtualization technology or
61+
cloud provider. To browse the list of known Docker Machine plugins, please [see
62+
this document in our
63+
repo](https://github.com/docker/machine/blob/master/docs/AVAILABLE_DRIVER_PLUGINS.md).
64+
5765
## Troubleshooting
5866

5967
Docker Machine tries to do the right thing in a variety of scenarios but

docs/AVAILABLE_DRIVER_PLUGINS.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Available driver plugins
2+
3+
This document is intended to act as a reference for the available 3rd-party
4+
driver plugins available in the ecosystem beyond the core Machine drivers. If
5+
you have created a Docker Machine driver, we highly encourage you to submit a
6+
pull request adding the relevant information to the list. Submitting your
7+
driver here will allow others to discover it and the core Machine team to keep
8+
you informed of upstream changes.
9+
10+
__NOTE__: The linked repositories are not maintained by or formally associated
11+
with Docker Inc. Use 3rd party plugins at your own risk.
12+
13+
| Name | Repository | Maintainer GitHub Handle | Maintainer Email |
14+
| ---- | ---------- | ------------------------- | ---------------- |
15+
| BrightBox | https://github.com/brightbox/docker-machine-driver-brightbox | [NeilW](NeilW) | neil@aldur.co.uk |
16+
| Docker-In-Docker | https://github.com/nathanleclaire/docker-machine-driver-dind | [nathanleclaire](https://github.com/nathanleclaire) | nathan.leclaire@gmail.com |
17+
| Parallels for OSX | https://github.com/Parallels/docker-machine-parallels | [legal90](https://github.com/legal90) | legal90@gmail.com |
18+
| SAKURA CLOUD | https://github.com/yamamoto-febc/docker-machine-sakuracloud | [yamamoto-febc](https://github.com/yamamoto-febc) | ? |

docs/DRIVER_SPEC.md

Lines changed: 2 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -36,11 +36,6 @@ The provider must offer SSH access to control the instance. This does not
3636
have to be public, but must offer it as Machine relies on SSH for system
3737
level maintenance.
3838

39-
## Maintainer
40-
To be supported as an official driver, it will need to be maintained. There
41-
can be multiple driver maintainers and they will be identified in the
42-
maintainers file.
43-
4439
# Provider Operations
4540
The following instance operations should be supported by the provider.
4641

@@ -84,16 +79,8 @@ Testing is strongly recommended for drivers. Unit tests are preferred as well
8479
as inclusion into the [integration tests](https://github.com/docker/machine#integration-tests).
8580

8681
# Maintaining
87-
Driver contributors are strongly encouraged to maintain the driver to keep
88-
it supported. We recommend and encourage contributors to join in the weekly
89-
meetings to give feedback and participate in the development around Machine.
90-
Driver maintainers will be notified and consulted for issues regarding their
91-
driver.
92-
93-
# Third Party Libraries
94-
If you want to use a third party library to interact with the provider, you
95-
will need to make sure it is compliant with the Docker license terms (non-GPL).
96-
For more information, contact a project maintainer.
82+
Driver plugin maintainers are encouraged to host their own repo and distribute
83+
the driver plugins as executables.
9784

9885
# Implementation
9986
The following describes what is needed to create a Machine Driver. The driver

0 commit comments

Comments
 (0)
X Tutup