插件

管理服务器上的插件。

上提供的方法 client.plugins ：

class PluginCollection

get(name)

获取一个插件。

参数:

name (str) -- 插件的名称。

返回:

插件。

返回类型:

(Plugin )

抛出:

• docker.errors.NotFound --

• exist. --

• docker.errors.APIError -- 如果服务器返回错误。

install(remote_name, local_name=None)

拉入并安装一个插件。

参数:

• remote_name (string) -- 要安装的插件的远程引用。这个 :latest 标记是可选的，如果省略，则为默认标记。

• local_name (string) -- 已拉出插件的本地名称。这个 :latest 标记是可选的，如果省略，则为默认标记。可选的。

返回:

已安装的插件

返回类型:

(Plugin )

抛出:

docker.errors.APIError -- 如果服务器返回错误。

list()

列出服务器上安装的插件。

返回:

插件。

返回类型:

(列表 Plugin )

抛出:

docker.errors.APIError -- 如果服务器返回错误。

插件对象

class Plugin

服务器上的一个插件。

id

对象的ID。

short_id

对象的ID，截断为12个字符。

name

插件的名称。

enabled

插件是否已启用。

settings

表示插件配置的词典。

attrs

服务器中此对象的原始表示形式。

configure(options)

更新插件的设置。

参数:

options (dict) -- 选项的键值映射。

抛出:

docker.errors.APIError -- 如果服务器返回错误。

disable(force=False)

禁用该插件。

参数:

force (bool) -- 强制禁用。默认：FALSE

抛出:

docker.errors.APIError -- 如果服务器返回错误。

enable(timeout=0)

启用插件。

参数:

timeout (int) -- 超时(以秒为单位)。默认：0

抛出:

docker.errors.APIError -- 如果服务器返回错误。

reload()

再次从服务器加载此对象并更新 attrs 使用新的数据。

push()

将插件推送到远程注册表。

返回:

一个DICT迭代器，用于流式传输上载状态。

抛出:

docker.errors.APIError -- 如果服务器返回错误。

remove(force=False)

从服务器上删除该插件。

参数:

force (bool) -- 即使插件已启用，也将其删除。默认：FALSE

抛出:

docker.errors.APIError -- 如果服务器返回错误。

upgrade(remote=None)

升级插件。

参数:

remote (string) -- 要升级到的远程引用。这个 :latest 标记是可选的，如果省略，则为默认标记。默认：此插件的名称。

返回:

生成器对解码的API日志进行流传输