docker.api.plugin.PluginApiMixin

class documentation

class PluginApiMixin: (source)

Known subclasses: docker.api.client.APIClient

Undocumented

Method	`configure_plugin`	Configure a plugin.
Method	`create_plugin`	Create a new plugin.
Method	`disable_plugin`	Disable an installed plugin.
Method	`enable_plugin`	Enable an installed plugin.
Method	`inspect_plugin`	Retrieve plugin metadata.
Method	`plugin_privileges`	Retrieve list of privileges to be granted to a plugin.
Method	`plugins`	Retrieve a list of installed plugins.
Method	`pull_plugin`	Pull and install a plugin. After the plugin is installed, it can be enabled using :py:meth:`~enable_plugin`.
Method	`push_plugin`	Push a plugin to the registry.
Method	`remove_plugin`	Remove an installed plugin.
Method	`upgrade_plugin`	Upgrade an installed plugin.

@utils.minimum_version('1.25')
@utils.check_resource('name')
def configure_plugin(self, name, options): (source) ¶

Configure a plugin. Args: name (string): The name of the plugin. The ``:latest`` tag is optional, and is the default if omitted. options (dict): A key-value mapping of options Returns: ``True`` if successful

@utils.minimum_version('1.25')
def create_plugin(self, name, plugin_data_dir, gzip=False): (source) ¶

Create a new plugin. Args: name (string): The name of the plugin. The ``:latest`` tag is optional, and is the default if omitted. plugin_data_dir (string): Path to the plugin data directory. Plugin data directory must contain the ``config.json`` manifest file and the ``rootfs`` directory. gzip (bool): Compress the context using gzip. Default: False Returns: ``True`` if successful

@utils.minimum_version('1.25')
def disable_plugin(self, name, force=False): (source) ¶

Disable an installed plugin. Args: name (string): The name of the plugin. The ``:latest`` tag is optional, and is the default if omitted. force (bool): To enable the force query parameter. Returns: ``True`` if successful

@utils.minimum_version('1.25')
def enable_plugin(self, name, timeout=0): (source) ¶

Enable an installed plugin. Args: name (string): The name of the plugin. The ``:latest`` tag is optional, and is the default if omitted. timeout (int): Operation timeout (in seconds). Default: 0 Returns: ``True`` if successful

@utils.minimum_version('1.25')
def inspect_plugin(self, name): (source) ¶

Retrieve plugin metadata. Args: name (string): The name of the plugin. The ``:latest`` tag is optional, and is the default if omitted. Returns: A dict containing plugin info

@utils.minimum_version('1.25')
def plugin_privileges(self, name): (source) ¶

Retrieve list of privileges to be granted to a plugin. Args: name (string): Name of the remote plugin to examine. The ``:latest`` tag is optional, and is the default if omitted. Returns: A list of dictionaries representing the plugin's permissions

@utils.minimum_version('1.25')
def plugins(self): (source) ¶

Retrieve a list of installed plugins. Returns: A list of dicts, one per plugin

@utils.minimum_version('1.25')
def pull_plugin(self, remote, privileges, name=None): (source) ¶

Pull and install a plugin. After the plugin is installed, it can be enabled using :py:meth:`~enable_plugin`. Args: remote (string): Remote reference for the plugin to install. The ``:latest`` tag is optional, and is the default if omitted. privileges (:py:class:`list`): A list of privileges the user consents to grant to the plugin. Can be retrieved using :py:meth:`~plugin_privileges`. name (string): Local name for the pulled plugin. The ``:latest`` tag is optional, and is the default if omitted. Returns: An iterable object streaming the decoded API logs

@utils.minimum_version('1.25')
@utils.check_resource('name')
def push_plugin(self, name): (source) ¶

Push a plugin to the registry. Args: name (string): Name of the plugin to upload. The ``:latest`` tag is optional, and is the default if omitted. Returns: ``True`` if successful

@utils.minimum_version('1.25')
@utils.check_resource('name')
def remove_plugin(self, name, force=False): (source) ¶

Remove an installed plugin. Args: name (string): Name of the plugin to remove. The ``:latest`` tag is optional, and is the default if omitted. force (bool): Disable the plugin before removing. This may result in issues if the plugin is in use by a container. Returns: ``True`` if successful

@utils.minimum_version('1.26')
@utils.check_resource('name')
def upgrade_plugin(self, name, remote, privileges): (source) ¶

Upgrade an installed plugin. Args: name (string): Name of the plugin to upgrade. The ``:latest`` tag is optional and is the default if omitted. remote (string): Remote reference to upgrade to. The ``:latest`` tag is optional and is the default if omitted. privileges (:py:class:`list`): A list of privileges the user consents to grant to the plugin. Can be retrieved using :py:meth:`~plugin_privileges`. Returns: An iterable object streaming the decoded API logs