Add plugin dev doc to TOC #263
Conversation
|
|
||
| ## How to operate a plugin | ||
| To install a plugin, use the `docker plugin install` command, which pulls the | ||
| plugin from the the configured registry, prompts you to grant permissions if |
There was a problem hiding this comment.
s/the the/the/
not sure about "configured registry", as the plugins reference determines which registry to use (e.g. myregistry:5000/my/plugin:latest). Perhaps just "registry" (or "Docker Hub")
| ``` | ||
|
|
||
| 5. Verify the plugin successfully created the volume. | ||
| 5. Use the volume `sshvolume` to start a container. |
There was a problem hiding this comment.
Almost reads as "the volume starts the container" 🐰
There was a problem hiding this comment.
Yeah I misunderstood this the first time around. Fixed.
| 2. Create manifest.json file in `/var/lib/docker/plugins/$id/`. | ||
| 3. Create a `plugin-config.json` if needed. | ||
| 4. Create or add a section to `/var/lib/docker/plugins/plugins.json`. Use | ||
| 2. Create a `rootfs` and export it to `/var/lib/docker/plugins/$id/rootfs`. |
There was a problem hiding this comment.
Not sure what is meant by "export it to" here
There was a problem hiding this comment.
Added some explanation and a pointer to the example higher up in the file.
|
Looks good from a docs perspective; once @thaJeztah 's comments are addressed, merge away! |
There was a problem hiding this comment.
Spotted two typos, but content LGTM
however, I just realized we marked this directory as "not edit here"; https://github.com/docker/docker.github.io/blob/master/.NOT_EDITED_HERE.txt#L24 😅
| @@ -78,6 +69,8 @@ started without error. | |||
| ``` | |||
|
|
|||
| 3. Create a volume using the plugin. | |||
| This example mounts the `/remmote` directory on host `1.2.3.4` into a | |||
| @@ -78,6 +69,8 @@ started without error. | |||
| ``` | |||
|
|
|||
| 3. Create a volume using the plugin. | |||
| This example mounts the `/remmote` directory on host `1.2.3.4` into a | |||
| volume nammed `sshvolume`. This volume can now be mounted into containers. | |||
|
Can I ask why /engine/extend/ wouldn't live in the docs repo? It is clearly a handwritten tutorial and not something that would ever be auto-generated, and not any more release-bound than any other writer-curated content that could be tracked in |
|
@johndmulhausen because a large part of it is "reference", which is tightly coupled to code changes, also there's a manifest in there, that should not be separated from the code. We may consider moving those parts underneath "reference" (plugin-api, plugin manifest?) |
Fixes #252 Signed-off-by: Misty Stanley-Jones <[email protected]>
mdlinville
changed the title
|
Moved the rewrite section of the PR to moby/moby#27593 |
|
@thaJeztah Fair enough. Currently, NOT_EDITED_HERE.txt is marking all of /engine/extend/ as "not edited here" -- is it just index.md, or is it really the whole directory? |
|
I'll split this up and only keep the menu part here, move the edits to On Thu, Oct 20, 2016 at 10:49 AM, Sebastiaan van Stijn <
|
Describe the proposed changes
Add link to the TOC
While I'm at it, test and update the content for clarity (several commands needed sudo, for instance)
Project version
n/a
Related issue
#252
Please take a look
@icecrime @vieux @thaJeztah