Skip to content

Commit 3df1495

Browse files
dvdksndvdksn
committed
docs(plugins): fix typos and formatting
Signed-off-by: David Karlsson <[email protected]>
1 parent cfe18f5 commit 3df1495

File tree

9 files changed

+266
-340
lines changed

9 files changed

+266
-340
lines changed

‎docs/extend/config.md‎

Lines changed: 92 additions & 99 deletions
Original file line numberDiff line numberDiff line change
@@ -1,192 +1,185 @@
11
---
22
description: "How to develop and use a plugin with the managed plugin system"
33
keywords: "API, Usage, plugins, documentation, developer"
4+
title: Plugin Config Version 1 of Plugin V2
45
---
56

6-
<!-- This file is maintained within the docker/cli GitHub
7-
repository at https://github.com/docker/cli/. Make all
8-
pull requests against that repo. If you see this file in
9-
another repository, consider it read-only there, as it will
10-
periodically be overwritten by the definitive file. Pull
11-
requests which include edits to this file in other repositories
12-
will be rejected.
13-
-->
14-
15-
16-
# Plugin Config Version 1 of Plugin V2
17-
187
This document outlines the format of the V0 plugin configuration.
198

20-
Plugin configs describe the various constituents of a docker plugin. Plugin
21-
configs can be serialized to JSON format with the following media types:
9+
Plugin configs describe the various constituents of a Docker engine plugin.
10+
Plugin configs can be serialized to JSON format with the following media types:
2211

2312
| Config Type | Media Type |
2413
|-------------|-----------------------------------------|
25-
| config | "application/vnd.docker.plugin.v1+json" |
14+
| config | `application/vnd.docker.plugin.v1+json` |
2615

27-
## *Config* Field Descriptions
16+
## Config Field Descriptions
2817

29-
Config provides the base accessible fields for working with V0 plugin format
30-
in the registry.
18+
Config provides the base accessible fields for working with V0 plugin format in
19+
the registry.
3120

32-
- **`description`** *string*
21+
- `description` string
3322

34-
description of the plugin
23+
Description of the plugin
3524

36-
- **`documentation`** *string*
25+
- `documentation` string
3726

38-
link to the documentation about the plugin
27+
Link to the documentation about the plugin
3928

40-
- **`interface`** *PluginInterface*
29+
- `interface` PluginInterface
4130

42-
interface implemented by the plugins, struct consisting of the following fields
31+
Interface implemented by the plugins, struct consisting of the following fields:
4332

44-
- **`types`** *string array*
33+
- `types` string array
4534

46-
types indicate what interface(s) the plugin currently implements.
35+
Types indicate what interface(s) the plugin currently implements.
4736

48-
currently supported:
37+
Supported types:
4938

50-
- **docker.volumedriver/1.0**
39+
- `docker.volumedriver/1.0`
5140

52-
- **docker.networkdriver/1.0**
41+
- `docker.networkdriver/1.0`
5342

54-
- **docker.ipamdriver/1.0**
43+
- `docker.ipamdriver/1.0`
5544

56-
- **docker.authz/1.0**
45+
- `docker.authz/1.0`
5746

58-
- **docker.logdriver/1.0**
47+
- `docker.logdriver/1.0`
5948

60-
- **docker.metricscollector/1.0**
49+
- `docker.metricscollector/1.0`
6150

62-
- **`socket`** *string*
51+
- `socket` string
6352

64-
socket is the name of the socket the engine should use to communicate with the plugins.
65-
the socket will be created in `/run/docker/plugins`.
53+
Socket is the name of the socket the engine should use to communicate with the plugins.
54+
the socket will be created in `/run/docker/plugins`.
6655

56+
- `entrypoint` string array
6757

68-
- **`entrypoint`** *string array*
58+
Entrypoint of the plugin, see [`ENTRYPOINT`](https://docs.docker.com/engine/reference/builder/#entrypoint)
6959

70-
entrypoint of the plugin, see [`ENTRYPOINT`](https://docs.docker.com/engine/reference/builder/#entrypoint)
60+
- `workdir` string
7161

72-
- **`workdir`** *string*
62+
Working directory of the plugin, see [`WORKDIR`](https://docs.docker.com/engine/reference/builder/#workdir)
7363

74-
workdir of the plugin, see [`WORKDIR`](https://docs.docker.com/engine/reference/builder/#workdir)
64+
- `network` PluginNetwork
7565

76-
- **`network`** *PluginNetwork*
66+
Network of the plugin, struct consisting of the following fields:
7767

78-
network of the plugin, struct consisting of the following fields
68+
- `type` string
7969

80-
- **`type`** *string*
70+
Network type.
8171

82-
network type.
72+
Supported types:
8373

84-
currently supported:
74+
- `bridge`
75+
- `host`
76+
- `none`
8577

86-
- **bridge**
87-
- **host**
88-
- **none**
78+
- `mounts` PluginMount array
8979

90-
- **`mounts`** *PluginMount array*
80+
Mount of the plugin, struct consisting of the following fields.
81+
See [`MOUNTS`](https://github.com/opencontainers/runtime-spec/blob/master/config.md#mounts).
9182

92-
mount of the plugin, struct consisting of the following fields, see [`MOUNTS`](https://github.com/opencontainers/runtime-spec/blob/master/config.md#mounts)
83+
- `name` string
9384

94-
- **`name`** *string*
85+
Name of the mount.
9586

96-
name of the mount.
87+
- `description` string
9788

98-
- **`description`** *string*
89+
Description of the mount.
9990

100-
description of the mount.
91+
- `source` string
10192

102-
- **`source`** *string*
93+
Source of the mount.
10394

104-
source of the mount.
95+
- `destination` string
10596

106-
- **`destination`** *string*
97+
Destination of the mount.
10798

108-
destination of the mount.
99+
- `type` string
109100

110-
- **`type`** *string*
101+
Mount type.
111102

112-
mount type.
103+
- `options` string array
113104

114-
- **`options`** *string array*
105+
Options of the mount.
115106

116-
options of the mount.
107+
- `ipchost` Boolean
117108

118-
- **`ipchost`** *boolean*
119109
Access to host ipc namespace.
120-
- **`pidhost`** *boolean*
121-
Access to host pid namespace.
122110

123-
- **`propagatedMount`** *string*
111+
- `pidhost` Boolean
112+
113+
Access to host PID namespace.
114+
115+
- `propagatedMount` string
124116

125-
path to be mounted as rshared, so that mounts under that path are visible to docker. This is useful for volume plugins.
126-
This path will be bind-mounted outside of the plugin rootfs so it's contents
127-
are preserved on upgrade.
117+
Path to be mounted as rshared, so that mounts under that path are visible to
118+
Docker. This is useful for volume plugins. This path will be bind-mounted
119+
outside of the plugin rootfs so it's contents are preserved on upgrade.
128120

129-
- **`env`** *PluginEnv array*
121+
- `env` PluginEnv array
130122

131-
env of the plugin, struct consisting of the following fields
123+
Environment variables of the plugin, struct consisting of the following fields:
132124

133-
- **`name`** *string*
125+
- `name` string
134126

135-
name of the env.
127+
Name of the environment variable.
136128

137-
- **`description`** *string*
129+
- `description` string
138130

139-
description of the env.
131+
Description of the environment variable.
140132

141-
- **`value`** *string*
133+
- `value` string
142134

143-
value of the env.
135+
Value of the environment variable.
144136

145-
- **`args`** *PluginArgs*
137+
- `args` PluginArgs
146138

147-
args of the plugin, struct consisting of the following fields
139+
Arguments of the plugin, struct consisting of the following fields:
148140

149-
- **`name`** *string*
141+
- `name` string
150142

151-
name of the args.
143+
Name of the arguments.
152144

153-
- **`description`** *string*
145+
- `description` string
154146

155-
description of the args.
147+
Description of the arguments.
156148

157-
- **`value`** *string array*
149+
- `value` string array
158150

159-
values of the args.
151+
Values of the arguments.
160152

161-
- **`linux`** *PluginLinux*
153+
- `linux` PluginLinux
162154

163-
- **`capabilities`** *string array*
155+
- `capabilities` string array
164156

165-
capabilities of the plugin (*Linux only*), see list [`here`](https://github.com/opencontainers/runc/blob/master/libcontainer/SPEC.md#security)
157+
Capabilities of the plugin (Linux only), see list [`here`](https://github.com/opencontainers/runc/blob/master/libcontainer/SPEC.md#security)
166158

167-
- **`allowAllDevices`** *boolean*
159+
- `allowAllDevices` Boolean
168160

169-
If `/dev` is bind mounted from the host, and allowAllDevices is set to true, the plugin will have `rwm` access to all devices on the host.
161+
If `/dev` is bind mounted from the host, and allowAllDevices is set to true, the plugin will have `rwm` access to all devices on the host.
170162

171-
- **`devices`** *PluginDevice array*
163+
- `devices` PluginDevice array
172164

173-
device of the plugin, (*Linux only*), struct consisting of the following fields, see [`DEVICES`](https://github.com/opencontainers/runtime-spec/blob/master/config-linux.md#devices)
165+
Device of the plugin, (Linux only), struct consisting of the following fields.
166+
See [`DEVICES`](https://github.com/opencontainers/runtime-spec/blob/master/config-linux.md#devices).
174167

175-
- **`name`** *string*
168+
- `name` string
176169

177-
name of the device.
170+
Name of the device.
178171

179-
- **`description`** *string*
172+
- `description` string
180173

181-
description of the device.
174+
Description of the device.
182175

183-
- **`path`** *string*
176+
- `path` string
184177

185-
path of the device.
178+
Path of the device.
186179

187180
## Example Config
188181

189-
*Example showing the 'tiborvass/sample-volume-plugin' plugin config.*
182+
The following example shows the 'tiborvass/sample-volume-plugin' plugin config.
190183

191184
```json
192185
{

0 commit comments

Comments
 (0)