mirror of
https://github.com/moby/moby.git
synced 2022-11-09 12:21:53 -05:00
03c6949739
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>
72 lines
2.3 KiB
Markdown
72 lines
2.3 KiB
Markdown
---
|
|
title: "plugin install"
|
|
description: "the plugin install command description and usage"
|
|
keywords: "plugin, install"
|
|
---
|
|
|
|
<!-- This file is maintained within the docker/docker Github
|
|
repository at https://github.com/docker/docker/. Make all
|
|
pull requests against that repo. If you see this file in
|
|
another repository, consider it read-only there, as it will
|
|
periodically be overwritten by the definitive file. Pull
|
|
requests which include edits to this file in other repositories
|
|
will be rejected.
|
|
-->
|
|
|
|
# plugin install
|
|
|
|
```markdown
|
|
Usage: docker plugin install [OPTIONS] PLUGIN [KEY=VALUE...]
|
|
|
|
Install a plugin
|
|
|
|
Options:
|
|
--alias string Local name for plugin
|
|
--disable Do not enable the plugin on install
|
|
--disable-content-trust Skip image verification (default true)
|
|
--grant-all-permissions Grant all permissions necessary to run the plugin
|
|
--help Print usage
|
|
```
|
|
|
|
Installs and enables a plugin. Docker looks first for the plugin on your Docker
|
|
host. If the plugin does not exist locally, then the plugin is pulled from
|
|
the registry. Note that the minimum required registry version to distribute
|
|
plugins is 2.3.0
|
|
|
|
|
|
The following example installs `vieus/sshfs` plugin and [set](plugin_set.md) it's env variable
|
|
`DEBUG` to 1. Install consists of pulling the plugin from Docker Hub, prompting
|
|
the user to accept the list of privileges that the plugin needs, settings parameters
|
|
and enabling the plugin.
|
|
|
|
```bash
|
|
$ docker plugin install vieux/sshfs DEBUG=1
|
|
|
|
Plugin "vieux/sshfs" is requesting the following privileges:
|
|
- network: [host]
|
|
- device: [/dev/fuse]
|
|
- capabilities: [CAP_SYS_ADMIN]
|
|
Do you grant the above permissions? [y/N] y
|
|
vieux/sshfs
|
|
```
|
|
|
|
After the plugin is installed, it appears in the list of plugins:
|
|
|
|
```bash
|
|
$ docker plugin ls
|
|
|
|
ID NAME TAG DESCRIPTION ENABLED
|
|
69553ca1d123 vieux/sshfs latest sshFS plugin for Docker true
|
|
```
|
|
|
|
## Related information
|
|
|
|
* [plugin create](plugin_create.md)
|
|
* [plugin disable](plugin_disable.md)
|
|
* [plugin enable](plugin_enable.md)
|
|
* [plugin inspect](plugin_inspect.md)
|
|
* [plugin ls](plugin_ls.md)
|
|
* [plugin push](plugin_push.md)
|
|
* [plugin rm](plugin_rm.md)
|
|
* [plugin set](plugin_set.md)
|
|
* [plugin upgrade](plugin_upgrade.md)
|