NAME
API::Docker::Type::Plugin::Config - The config of a plugin
VERSION
version 0.004
DESCRIPTION
Generated from the inline Config schema of the Plugin definition in spec/v1.51.yaml.
docker_version
Docker Version used to create the plugin.
Depending on how the plugin was created, this field may be empty or omitted.
Deprecated: this field is no longer set, and will be removed in the next API version.
description
Undocumented upstream. The plugin's own one-line description, "A sample volume plugin for Docker" in the swagger's example.
documentation
Undocumented upstream. A URL, https://docs.docker.com/engine/extend/plugins/ in the swagger's example.
interface
The interface between Docker and the plugin. See API::Docker::Type::Plugin::Config::Interface.
entrypoint
Undocumented upstream. The command the plugin's process is started with, one string per argument: ["/usr/bin/sample-volume-plugin", "/data"] in the swagger's example.
work_dir
Undocumented upstream. The working directory that process starts in, "/bin/" in the swagger's example.
user
Undocumented upstream. Two uint32s, both 1000 in the swagger's example. See API::Docker::Type::Plugin::Config::User.
network
Undocumented upstream. One field, a network mode; host in the swagger's example. See API::Docker::Type::Plugin::Config::Network.
linux
Undocumented upstream. The Linux capabilities the plugin needs, whether it may use every device, and the devices it declares by hand. See API::Docker::Type::Plugin::Config::Linux.
propagated_mount
Undocumented upstream. A path, "/mnt/volumes" in the swagger's example. That example is all the swagger offers about it.
ipc_host
Undocumented upstream.
pid_host
Undocumented upstream.
mounts
Undocumented upstream. The mounts the plugin declares. "settings" in API::Docker::Type::Plugin carries the same list as it stands after a user has changed it. See API::Docker::Type::PluginMount.
env
Undocumented upstream. The environment variables the plugin declares, each an object with its own description and value: the swagger's example is a single DEBUG, "if set, prints debug messages", currently "0". "env" in API::Docker::Type::Plugin::Settings carries the same variables as bare NAME=value strings. See API::Docker::Type::PluginEnv.
args
Undocumented upstream. The plugin's command line as one named item -- args, "command line arguments", in the swagger's example -- not one item per argument. See API::Docker::Type::Plugin::Config::Args.
rootfs
Undocumented upstream. A type and a list of layer digests, both spelled in lower case upstream. See API::Docker::Type::Plugin::Config::RootFS. Serialised as rootfs -- spelled out, because deriving it from the Perl name would produce Rootfs.
SUPPORT
Issues
Please report bugs and feature requests on GitHub at https://github.com/Getty/p5-api-docker/issues.
CONTRIBUTING
Contributions are welcome! Please fork the repository and submit a pull request.
AUTHOR
Torsten Raudssus <getty@cpan.org>
COPYRIGHT AND LICENSE
This software is copyright (c) 2026 by Torsten Raudssus <torsten@raudssus.de> https://raudssus.de/.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.