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

92 lines
17 KiB
Markdown
Raw Normal View History

Convert Markdown frontmatter to YAML Some frontmatter such as the weights, menu stuff, etc is no longer used 'draft=true' becomes 'published: false' Signed-off-by: Misty Stanley-Jones <misty@docker.com>
2016-10-14 18:30:36 -04:00
---
docs(plugins): fix typos and formatting Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-01-10 04:38:42 -05:00
title: Use Docker Engine plugins
docs: update redirect metadata for hugo docs.docker.com switched from Jekyll to Hugo, which uses "aliases" instead of "redirect_from". Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2023-11-06 12:25:49 -05:00
aliases:
Fix some redirect loops and problems Signed-off-by: Misty Stanley-Jones <misty@docker.com>
2016-11-28 12:45:00 -05:00
- "/engine/extend/plugins/"
Convert Markdown frontmatter to YAML Some frontmatter such as the weights, menu stuff, etc is no longer used 'draft=true' becomes 'published: false' Signed-off-by: Misty Stanley-Jones <misty@docker.com>
2016-10-14 18:30:36 -04:00
description: "How to add additional functionality to Docker with plugins extensions"
fix frontmatter keywords value type (string, instead of []string) Signed-off-by: Gaetan de Villele <gdevillele@gmail.com>
2016-11-03 17:21:33 -04:00
keywords: "Examples, Usage, plugins, docker, documentation, user guide"
Convert Markdown frontmatter to YAML Some frontmatter such as the weights, menu stuff, etc is no longer used 'draft=true' becomes 'published: false' Signed-off-by: Misty Stanley-Jones <misty@docker.com>
2016-10-14 18:30:36 -04:00
---
Add a link to the new build instructions Signed-off-by: Misty Stanley-Jones <misty@docker.com>
2016-10-12 19:23:01 -04:00
This document describes the Docker Engine plugins generally available in Docker
move plugins out of experimental Signed-off-by: Victor Vieux <vieux@docker.com>
2016-11-09 20:49:09 -05:00
Engine. To view information on plugins managed by Docker,
docs: rename plugins index file and add linkTitle We publish this page on docs.docker.com, and hugo expects index pages for sections to be named _index.md. We currently rename the page when we mount it to the docs repo but might as well change the filename in the source. Also adds a linkTitle to the page, which is a shorter title that will be used in the sidebar navigation and breadcrumbs. Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-09-04 05:19:55 -04:00
refer to [Docker Engine plugin system](_index.md).
Add a link to the new build instructions Signed-off-by: Misty Stanley-Jones <misty@docker.com>
2016-10-12 19:23:01 -04:00
You can extend the capabilities of the Docker Engine by loading third-party
plugins. This page explains the types of plugins and provides links to several
volume and network plugins for Docker.
## Types of plugins
docs: rename plugins index file and add linkTitle We publish this page on docs.docker.com, and hugo expects index pages for sections to be named _index.md. We currently rename the page when we mount it to the docs repo but might as well change the filename in the source. Also adds a linkTitle to the page, which is a shorter title that will be used in the sidebar navigation and breadcrumbs. Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-09-04 05:19:55 -04:00
Plugins extend Docker's functionality. They come in specific types. For
Add a link to the new build instructions Signed-off-by: Misty Stanley-Jones <misty@docker.com>
2016-10-12 19:23:01 -04:00
example, a [volume plugin](plugins_volume.md) might enable Docker
volumes to persist across multiple Docker hosts and a
[network plugin](plugins_network.md) might provide network plumbing.
Currently Docker supports authorization, volume and network driver plugins. In the future it
will support additional plugin types.
## Installing a plugin
Follow the instructions in the plugin's documentation.
## Finding a plugin
docs(plugins): fix typos and formatting Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-01-10 04:38:42 -05:00
The sections below provide an overview of available third-party plugins.
Add a link to the new build instructions Signed-off-by: Misty Stanley-Jones <misty@docker.com>
2016-10-12 19:23:01 -04:00
### Network plugins
Add Infinit plugin Signed-off-by: Misty Stanley-Jones <misty@docker.com>
2017-08-01 18:50:42 -04:00
| Plugin | Description |
docs(plugins): add Kathará engine network plugin Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2023-12-20 15:14:00 -05:00
| :--------------------------------------------------------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
Add Infinit plugin Signed-off-by: Misty Stanley-Jones <misty@docker.com>
2017-08-01 18:50:42 -04:00
| [Contiv Networking](https://github.com/contiv/netplugin) | An open source network plugin to provide infrastructure and security policies for a multi-tenant micro services deployment, while providing an integration to physical network for non-container workload. Contiv Networking implements the remote driver and IPAM APIs available in Docker 1.9 onwards. |
| [Kuryr Network Plugin](https://github.com/openstack/kuryr) | A network plugin is developed as part of the OpenStack Kuryr project and implements the Docker networking (libnetwork) remote driver API by utilizing Neutron, the OpenStack networking service. It includes an IPAM driver as well. |
docs(plugins): add Kathará engine network plugin Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2023-12-20 15:14:00 -05:00
| [Kathará Network Plugin](https://github.com/KatharaFramework/NetworkPlugin) | Docker Network Plugin used by Kathará, an open source container-based network emulation system for showing interactive demos/lessons, testing production networks in a sandbox environment, or developing new network protocols. |
Add a link to the new build instructions Signed-off-by: Misty Stanley-Jones <misty@docker.com>
2016-10-12 19:23:01 -04:00
### Volume plugins
Add Infinit plugin Signed-off-by: Misty Stanley-Jones <misty@docker.com>
2017-08-01 18:50:42 -04:00
| Plugin | Description |
|:---------------------------------------------------------------------------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [Azure File Storage plugin](https://github.com/Azure/azurefile-dockervolumedriver) | Lets you mount Microsoft [Azure File Storage](https://azure.microsoft.com/blog/azure-file-storage-now-generally-available/) shares to Docker containers as volumes using the SMB 3.0 protocol. [Learn more](https://azure.microsoft.com/blog/persistent-docker-volumes-with-azure-file-storage/). |
| [BeeGFS Volume Plugin](https://github.com/RedCoolBeans/docker-volume-beegfs) | An open source volume plugin to create persistent volumes in a BeeGFS parallel file system. |
| [Blockbridge plugin](https://github.com/blockbridge/blockbridge-docker-volume) | A volume plugin that provides access to an extensible set of container-based persistent storage options. It supports single and multi-host Docker environments with features that include tenant isolation, automated provisioning, encryption, secure deletion, snapshots and QoS. |
| [Contiv Volume Plugin](https://github.com/contiv/volplugin) | An open source volume plugin that provides multi-tenant, persistent, distributed storage with intent based consumption. It has support for Ceph and NFS. |
| [Convoy plugin](https://github.com/rancher/convoy) | A volume plugin for a variety of storage back-ends including device mapper and NFS. It's a simple standalone executable written in Go and provides the framework to support vendor-specific extensions such as snapshots, backups and restore. |
| [DigitalOcean Block Storage plugin](https://github.com/omallo/docker-volume-plugin-dostorage) | Integrates DigitalOcean's [block storage solution](https://www.digitalocean.com/products/storage/) into the Docker ecosystem by automatically attaching a given block storage volume to a DigitalOcean droplet and making the contents of the volume available to Docker containers running on that droplet. |
| [DRBD plugin](https://www.drbd.org/en/supported-projects/docker) | A volume plugin that provides highly available storage replicated by [DRBD](https://www.drbd.org). Data written to the docker volume is replicated in a cluster of DRBD nodes. |
Update Flocker plugin link ClusterHQ shutted down at the end of 2016. It seems that ScatterHQ is a group of ClusterHQ former employees that have forked Flocker. It seems that no code has been commited in the last months but if somebody comes to this Docker page it should be referenced to ScatterHQ. Signed-off-by: Miguel Angel Alvarez Cabrerizo <doncicuto@gmail.com>
2017-11-28 07:36:30 -05:00
| [Flocker plugin](https://github.com/ScatterHQ/flocker) | A volume plugin that provides multi-host portable volumes for Docker, enabling you to run databases and other stateful containers and move them around across a cluster of machines. |
Add Infinit plugin Signed-off-by: Misty Stanley-Jones <misty@docker.com>
2017-08-01 18:50:42 -04:00
| [Fuxi Volume Plugin](https://github.com/openstack/fuxi) | A volume plugin that is developed as part of the OpenStack Kuryr project and implements the Docker volume plugin API by utilizing Cinder, the OpenStack block storage service. |
| [gce-docker plugin](https://github.com/mcuadros/gce-docker) | A volume plugin able to attach, format and mount Google Compute [persistent-disks](https://cloud.google.com/compute/docs/disks/persistent-disks). |
| [GlusterFS plugin](https://github.com/calavera/docker-volume-glusterfs) | A volume plugin that provides multi-host volumes management for Docker using GlusterFS. |
| [Horcrux Volume Plugin](https://github.com/muthu-r/horcrux) | A volume plugin that allows on-demand, version controlled access to your data. Horcrux is an open-source plugin, written in Go, and supports SCP, [Minio](https://www.minio.io) and Amazon S3. |
| [HPE 3Par Volume Plugin](https://github.com/hpe-storage/python-hpedockerplugin/) | A volume plugin that supports HPE 3Par and StoreVirtual iSCSI storage arrays. |
| [Infinit volume plugin](https://infinit.sh/documentation/docker/volume-plugin) | A volume plugin that makes it easy to mount and manage Infinit volumes using Docker. |
Update most links in docs to use https by default cc @thaJeztah docker/docker.github.io#13680 Signed-off-by: Peter Dave Hello <hsu@peterdavehello.org>
2021-10-14 18:04:36 -04:00
| [IPFS Volume Plugin](https://github.com/vdemeester/docker-volume-ipfs) | An open source volume plugin that allows using an [ipfs](https://ipfs.io/) filesystem as a volume. |
Add Infinit plugin Signed-off-by: Misty Stanley-Jones <misty@docker.com>
2017-08-01 18:50:42 -04:00
| [Keywhiz plugin](https://github.com/calavera/docker-volume-keywhiz) | A plugin that provides credentials and secret management using Keywhiz as a central repository. |
Add Linode docker volume plugin Signed-off-by: Zhiwei Liang <zliang@akamai.com>
2023-06-30 21:39:58 -04:00
| [Linode Volume Plugin](https://github.com/linode/docker-volume-linode) | A plugin that adds the ability to manage Linode Block Storage as Docker Volumes from within a Linode. |
Add Infinit plugin Signed-off-by: Misty Stanley-Jones <misty@docker.com>
2017-08-01 18:50:42 -04:00
| [Local Persist Plugin](https://github.com/CWSpear/local-persist) | A volume plugin that extends the default `local` driver's functionality by allowing you specify a mountpoint anywhere on the host, which enables the files to *always persist*, even if the volume is removed via `docker volume rm`. |
| [NetApp Plugin](https://github.com/NetApp/netappdvp) (nDVP) | A volume plugin that provides direct integration with the Docker ecosystem for the NetApp storage portfolio. The nDVP package supports the provisioning and management of storage resources from the storage platform to Docker hosts, with a robust framework for adding additional platforms in the future. |
| [Netshare plugin](https://github.com/ContainX/docker-volume-netshare) | A volume plugin that provides volume management for NFS 3/4, AWS EFS and CIFS file systems. |
Fix dead external link Signed-off-by: Phong Tran <tran.pho@northeastern.edu>
2022-05-05 22:10:15 -04:00
| [Nimble Storage Volume Plugin](https://scod.hpedev.io/docker_volume_plugins/hpe_nimble_storage/index.html) | A volume plug-in that integrates with Nimble Storage Unified Flash Fabric arrays. The plug-in abstracts array volume capabilities to the Docker administrator to allow self-provisioning of secure multi-tenant volumes and clones. |
Add Infinit plugin Signed-off-by: Misty Stanley-Jones <misty@docker.com>
2017-08-01 18:50:42 -04:00
| [OpenStorage Plugin](https://github.com/libopenstorage/openstorage) | A cluster-aware volume plugin that provides volume management for file and block storage solutions. It implements a vendor neutral specification for implementing extensions such as CoS, encryption, and snapshots. It has example drivers based on FUSE, NFS, NBD and EBS to name a few. |
| [Portworx Volume Plugin](https://github.com/portworx/px-dev) | A volume plugin that turns any server into a scale-out converged compute/storage node, providing container granular storage and highly available volumes across any node, using a shared-nothing storage backend that works with any docker scheduler. |
Update most links in docs to use https by default cc @thaJeztah docker/docker.github.io#13680 Signed-off-by: Peter Dave Hello <hsu@peterdavehello.org>
2021-10-14 18:04:36 -04:00
| [Quobyte Volume Plugin](https://github.com/quobyte/docker-volume) | A volume plugin that connects Docker to [Quobyte](https://www.quobyte.com/containers)'s data center file system, a general-purpose scalable and fault-tolerant storage platform. |
Add Infinit plugin Signed-off-by: Misty Stanley-Jones <misty@docker.com>
2017-08-01 18:50:42 -04:00
| [REX-Ray plugin](https://github.com/emccode/rexray) | A volume plugin which is written in Go and provides advanced storage functionality for many platforms including VirtualBox, EC2, Google Compute Engine, OpenStack, and EMC. |
| [Virtuozzo Storage and Ploop plugin](https://github.com/virtuozzo/docker-volume-ploop) | A volume plugin with support for Virtuozzo Storage distributed cloud file system as well as ploop devices. |
| [VMware vSphere Storage Plugin](https://github.com/vmware/docker-volume-vsphere) | Docker Volume Driver for vSphere enables customers to address persistent storage requirements for Docker containers in vSphere environments. |
Add a link to the new build instructions Signed-off-by: Misty Stanley-Jones <misty@docker.com>
2016-10-12 19:23:01 -04:00
### Authorization plugins
Add Infinit plugin Signed-off-by: Misty Stanley-Jones <misty@docker.com>
2017-08-01 18:50:42 -04:00
| Plugin | Description |
|:---------------------------------------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [Casbin AuthZ Plugin](https://github.com/casbin/casbin-authz-plugin) | An authorization plugin based on [Casbin](https://github.com/casbin/casbin), which supports access control models like ACL, RBAC, ABAC. The access control model can be customized. The policy can be persisted into file or DB. |
| [HBM plugin](https://github.com/kassisol/hbm) | An authorization plugin that prevents from executing commands with certains parameters. |
| [Twistlock AuthZ Broker](https://github.com/twistlock/authz) | A basic extendable authorization plugin that runs directly on the host or inside a container. This plugin allows you to define user policies that it evaluates during authorization. Basic authorization is provided if Docker daemon is started with the --tlsverify flag (username is extracted from the certificate common name). |
Add a link to the new build instructions Signed-off-by: Misty Stanley-Jones <misty@docker.com>
2016-10-12 19:23:01 -04:00
## Troubleshooting a plugin
If you are having problems with Docker after loading a plugin, ask the authors
of the plugin for help. The Docker team may not be able to assist you.
## Writing a plugin
If you are interested in writing a plugin for Docker, or seeing how they work
docs(plugins): fix typos and formatting Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-01-10 04:38:42 -05:00
under the hood, see the [Docker plugins reference](plugin_api.md).