Guest24897
/
DockerCLI
mirror of https://github.com/docker/cli.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
DockerCLI/docs/reference/commandline/plugin_rm.md

52 lines
1.3 KiB
Markdown
Raw Normal View History

move plugins out of experimental Signed-off-by: Victor Vieux <vieux@docker.com>
2016-11-09 20:49:09 -05:00
# plugin rm
docker plugin commandline reference Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2016-06-09 17:57:15 -04:00
docs: generate markdown Keep frontmatter for docker, dockerd and index markdown files. Also needs to move cli.md > docker.md before generation and then move it back because cli.md is needed for yaml generation on docs website: https://github.com/docker/cli/pull/3924#discussion_r1059986605 Signed-off-by: Kevin Alvarez <crazy-max@users.noreply.github.com> Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2023-01-06 13:04:05 -05:00
<!---MARKER_GEN_START-->
check inconsistant command in docs/reference/commandline Signed-off-by: lixiaobing10051267 <li.xiaobing1@zte.com.cn>
2016-09-01 00:11:02 -04:00
Remove one or more plugins
docker plugin commandline reference Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2016-06-09 17:57:15 -04:00
docs: generate markdown Keep frontmatter for docker, dockerd and index markdown files. Also needs to move cli.md > docker.md before generation and then move it back because cli.md is needed for yaml generation on docs website: https://github.com/docker/cli/pull/3924#discussion_r1059986605 Signed-off-by: Kevin Alvarez <crazy-max@users.noreply.github.com> Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2023-01-06 13:04:05 -05:00
### Aliases
docker plugin commandline reference Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2016-06-09 17:57:15 -04:00
docs: generate markdown Keep frontmatter for docker, dockerd and index markdown files. Also needs to move cli.md > docker.md before generation and then move it back because cli.md is needed for yaml generation on docs website: https://github.com/docker/cli/pull/3924#discussion_r1059986605 Signed-off-by: Kevin Alvarez <crazy-max@users.noreply.github.com> Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2023-01-06 13:04:05 -05:00
`docker plugin rm`, `docker plugin remove`
### Options
| Name | Type | Default | Description |
|:----------------|:-----|:--------|:--------------------------------------|
| `-f`, `--force` | | | Force the removal of an active plugin |
<!---MARKER_GEN_END-->
docker plugin commandline reference Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2016-06-09 17:57:15 -04:00
Standardized formatting of CLI reference commands Command name should be a H1 Only Description, Examples, and Related Commands should be H2 Changed 'Related information' heading to 'Related commands' since 99% it is only linking commands Added some examples where relevant Signed-off-by: Misty Stanley-Jones <misty@docker.com>
2017-02-07 18:42:48 -05:00
## Description
replace active by enabled for consistency in plugins Signed-off-by: Victor Vieux <vieux@docker.com>
2016-08-04 19:19:46 -04:00
Removes a plugin. You cannot remove a plugin if it is enabled, you must disable
docker plugin commandline reference Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2016-06-09 17:57:15 -04:00
a plugin using the [`docker plugin disable`](plugin_disable.md) before removing
Add --force to docker plugin remove Signed-off-by: Victor Vieux <vieux@docker.com>
2016-07-22 11:24:54 -04:00
it (or use --force, use of force is not recommended, since it can affect
functioning of running containers using the plugin).
docker plugin commandline reference Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2016-06-09 17:57:15 -04:00
Standardized formatting of CLI reference commands Command name should be a H1 Only Description, Examples, and Related Commands should be H2 Changed 'Related information' heading to 'Related commands' since 99% it is only linking commands Added some examples where relevant Signed-off-by: Misty Stanley-Jones <misty@docker.com>
2017-02-07 18:42:48 -05:00
## Examples
The following example disables and removes the `sample-volume-plugin:latest`
plugin:
docker plugin commandline reference Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2016-06-09 17:57:15 -04:00
docs: use "console" code-hint for shell examples This replaces the use of bash where suitable, to allow easier copy/pasting of shell examples without copying the prompt or process output. Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2021-08-21 08:54:14 -04:00
```console
replace no-remove by sample-volume-plugin in docs Signed-off-by: Victor Vieux <vieux@docker.com>
2016-12-14 03:35:34 -05:00
$ docker plugin disable tiborvass/sample-volume-plugin
fix some typos for plugin Signed-off-by: yuexiao-wang <wang.yuexiao@zte.com.cn>
2017-04-27 17:24:49 -04:00
replace no-remove by sample-volume-plugin in docs Signed-off-by: Victor Vieux <vieux@docker.com>
2016-12-14 03:35:34 -05:00
tiborvass/sample-volume-plugin
docs: update reference docs for plugins the output/response slightly changed in 340964db1c8f161a2ad156023eb47dcc93bf804b, and `:latest` is no longer required for various actions. Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2016-07-20 17:37:55 -04:00
replace no-remove by sample-volume-plugin in docs Signed-off-by: Victor Vieux <vieux@docker.com>
2016-12-14 03:35:34 -05:00
$ docker plugin rm tiborvass/sample-volume-plugin:latest
fix some typos for plugin Signed-off-by: yuexiao-wang <wang.yuexiao@zte.com.cn>
2017-04-27 17:24:49 -04:00
replace no-remove by sample-volume-plugin in docs Signed-off-by: Victor Vieux <vieux@docker.com>
2016-12-14 03:35:34 -05:00
tiborvass/sample-volume-plugin
docker plugin commandline reference Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2016-06-09 17:57:15 -04:00
```
Standardized formatting of CLI reference commands Command name should be a H1 Only Description, Examples, and Related Commands should be H2 Changed 'Related information' heading to 'Related commands' since 99% it is only linking commands Added some examples where relevant Signed-off-by: Misty Stanley-Jones <misty@docker.com>
2017-02-07 18:42:48 -05:00
## Related commands
docker plugin commandline reference Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2016-06-09 17:57:15 -04:00
Add plugin create functionality. Signed-off-by: Anusha Ragunathan <anusha@docker.com>
2016-10-04 15:01:19 -04:00
* [plugin create](plugin_create.md)
docker plugin commandline reference Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2016-06-09 17:57:15 -04:00
* [plugin disable](plugin_disable.md)
Add docs for plugin push Signed-off-by: Anusha Ragunathan <anusha@docker.com>
2016-11-14 11:38:06 -05:00
* [plugin enable](plugin_enable.md)
docker plugin commandline reference Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2016-06-09 17:57:15 -04:00
* [plugin inspect](plugin_inspect.md)
* [plugin install](plugin_install.md)
Add docs for plugin push Signed-off-by: Anusha Ragunathan <anusha@docker.com>
2016-11-14 11:38:06 -05:00
* [plugin ls](plugin_ls.md)
* [plugin push](plugin_push.md)
support env for docker plugin set Signed-off-by: Victor Vieux <vieux@docker.com>
2016-10-31 20:07:05 -04:00
* [plugin set](plugin_set.md)
Add docker plugin upgrade This allows a plugin to be upgraded without requiring to uninstall/reinstall a plugin. Since plugin resources (e.g. volumes) are tied to a plugin ID, this is important to ensure resources aren't lost. The plugin must be disabled while upgrading (errors out if enabled). This does not add any convenience flags for automatically disabling/re-enabling the plugin during before/after upgrade. Since an upgrade may change requested permissions, the user is required to accept permissions just like `docker plugin install`. Signed-off-by: Brian Goff <cpuguy83@gmail.com>
2017-01-28 19:54:32 -05:00
* [plugin upgrade](plugin_upgrade.md)