目錄 搜尋
Compose About versions and upgrading (Compose) ASP.NET Core + SQL Server on Linux (Compose) CLI environment variables (Compose) Command-line completion (Compose) Compose(组成) Compose command-line reference(组合命令行参考) Control startup order (Compose) Django and PostgreSQL (Compose) Docker stacks and distributed application bundles (Compose) docker-compose build(docker-compose构建) docker-compose bundle docker-compose config docker-compose create docker-compose down docker-compose events docker-compose exec docker-compose help docker-compose images docker-compose kill docker-compose logs docker-compose pause docker-compose port docker-compose ps docker-compose pull docker-compose push docker-compose restart docker-compose rm docker-compose run docker-compose scale docker-compose start docker-compose stop docker-compose top docker-compose unpause docker-compose up Environment file (Compose) Environment variables in Compose Extend services in Compose Frequently asked questions (Compose) Getting started (Compose) Install Compose Link environment variables (deprecated) (Compose) Networking in Compose Overview of Docker Compose Overview of docker-compose CLI Quickstart: Compose and WordPress Rails and PostgreSQL (Compose) Sample apps with Compose Using Compose in production Using Compose with Swarm Engine .NET Core application (Engine) About images, containers, and storage drivers (Engine) Add nodes to the swarm (Engine) Apply custom metadata (Engine) Apply rolling updates (Engine) apt-cacher-ng Best practices for writing Dockerfiles (Engine) Binaries (Engine) Bind container ports to the host (Engine) Breaking changes (Engine) Build your own bridge (Engine) Configure container DNS (Engine) Configure container DNS in user-defined networks (Engine) CouchDB (Engine) Create a base image (Engine) Create a swarm (Engine) Customize the docker0 bridge (Engine) Debian (Engine) Default bridge network Delete the service (Engine) Deploy a service (Engine) Deploy services to a swarm (Engine) Deprecated Engine features Docker container networking (Engine) Docker overview (Engine) Docker run reference (Engine) Dockerfile reference (Engine) Dockerize an application Drain a node (Engine) Engine FAQ (Engine) Fedora (Engine) Get started (Engine) Get started with macvlan network driver (Engine) Get started with multi-host networking (Engine) How nodes work (Engine) How services work (Engine) Image management (Engine) Inspect the service (Engine) Install Docker (Engine) IPv6 with Docker (Engine) Join nodes to a swarm (Engine) Legacy container links (Engine) Lock your swarm (Engine) Manage nodes in a swarm (Engine) Manage sensitive data with Docker secrets (Engine) Manage swarm security with PKI (Engine) Manage swarm service networks (Engine) Migrate to Engine 1.10 Optional Linux post-installation steps (Engine) Overview (Engine) PostgreSQL (Engine) Raft consensus in swarm mode (Engine) Riak (Engine) Run Docker Engine in swarm mode Scale the service (Engine) SDKs (Engine) Select a storage driver (Engine) Set up for the tutorial (Engine) SSHd (Engine) Storage driver overview (Engine) Store service configuration data (Engine) Swarm administration guide (Engine) Swarm mode key concepts (Engine) Swarm mode overlay network security model (Engine) Swarm mode overview (Engine) Understand container communication (Engine) Use multi-stage builds (Engine) Use swarm mode routing mesh (Engine) Use the AUFS storage driver (Engine) Use the Btrfs storage driver (Engine) Use the Device mapper storage driver (Engine) Use the OverlayFS storage driver (Engine) Use the VFS storage driver (Engine) Use the ZFS storage driver (Engine) Engine: Admin Guide Amazon CloudWatch logs logging driver (Engine) Bind mounts (Engine) Collect Docker metrics with Prometheus (Engine) Configuring and running Docker (Engine) Configuring logging drivers (Engine) Control and configure Docker with systemd (Engine) ETW logging driver (Engine) Fluentd logging driver (Engine) Format command and log output (Engine) Google Cloud logging driver (Engine) Graylog Extended Format (GELF) logging driver (Engine) Journald logging driver (Engine) JSON File logging driver (Engine) Keep containers alive during daemon downtime (Engine) Limit a container's resources (Engine) Link via an ambassador container (Engine) Log tags for logging driver (Engine) Logentries logging driver (Engine) PowerShell DSC usage (Engine) Prune unused Docker objects (Engine) Run multiple services in a container (Engine) Runtime metrics (Engine) Splunk logging driver (Engine) Start containers automatically (Engine) Storage overview (Engine) Syslog logging driver (Engine) tmpfs mounts Troubleshoot volume problems (Engine) Use a logging driver plugin (Engine) Using Ansible (Engine) Using Chef (Engine) Using Puppet (Engine) View a container's logs (Engine) Volumes (Engine) Engine: CLI Daemon CLI reference (dockerd) (Engine) docker docker attach docker build docker checkpoint docker checkpoint create docker checkpoint ls docker checkpoint rm docker commit docker config docker config create docker config inspect docker config ls docker config rm docker container docker container attach docker container commit docker container cp docker container create docker container diff docker container exec docker container export docker container inspect docker container kill docker container logs docker container ls docker container pause docker container port docker container prune docker container rename docker container restart docker container rm docker container run docker container start docker container stats docker container stop docker container top docker container unpause docker container update docker container wait docker cp docker create docker deploy docker diff docker events docker exec docker export docker history docker image docker image build docker image history docker image import docker image inspect docker image load docker image ls docker image prune docker image pull docker image push docker image rm docker image save docker image tag docker images docker import docker info docker inspect docker kill docker load docker login docker logout docker logs docker network docker network connect docker network create docker network disconnect docker network inspect docker network ls docker network prune docker network rm docker node docker node demote docker node inspect docker node ls docker node promote docker node ps docker node rm docker node update docker pause docker plugin docker plugin create docker plugin disable docker plugin enable docker plugin inspect docker plugin install docker plugin ls docker plugin push docker plugin rm docker plugin set docker plugin upgrade docker port docker ps docker pull docker push docker rename docker restart docker rm docker rmi docker run docker save docker search docker secret docker secret create docker secret inspect docker secret ls docker secret rm docker service docker service create docker service inspect docker service logs docker service ls docker service ps docker service rm docker service scale docker service update docker stack docker stack deploy docker stack ls docker stack ps docker stack rm docker stack services docker start docker stats docker stop docker swarm docker swarm ca docker swarm init docker swarm join docker swarm join-token docker swarm leave docker swarm unlock docker swarm unlock-key docker swarm update docker system docker system df docker system events docker system info docker system prune docker tag docker top docker unpause docker update docker version docker volume docker volume create docker volume inspect docker volume ls docker volume prune docker volume rm docker wait Use the Docker command line (Engine) Engine: Extend Access authorization plugin (Engine) Docker log driver plugins Docker network driver plugins (Engine) Extending Engine with plugins Managed plugin system (Engine) Plugin configuration (Engine) Plugins API (Engine) Volume plugins (Engine) Engine: Security AppArmor security profiles for Docker (Engine) Automation with content trust (Engine) Content trust in Docker (Engine) Delegations for content trust (Engine) Deploying Notary (Engine) Docker security (Engine) Docker security non-events (Engine) Isolate containers with a user namespace (Engine) Manage keys for content trust (Engine) Play in a content trust sandbox (Engine) Protect the Docker daemon socket (Engine) Seccomp security profiles for Docker (Engine) Secure Engine Use trusted images Using certificates for repository client verification (Engine) Engine: Tutorials Engine tutorials Network containers (Engine) Get Started Part 1: Orientation Part 2: Containers Part 3: Services Part 4: Swarms Part 5: Stacks Part 6: Deploy your app Machine Amazon Web Services (Machine) Digital Ocean (Machine) docker-machine active docker-machine config docker-machine create docker-machine env docker-machine help docker-machine inspect docker-machine ip docker-machine kill docker-machine ls docker-machine provision docker-machine regenerate-certs docker-machine restart docker-machine rm docker-machine scp docker-machine ssh docker-machine start docker-machine status docker-machine stop docker-machine upgrade docker-machine url Driver options and operating system defaults (Machine) Drivers overview (Machine) Exoscale (Machine) Generic (Machine) Get started with a local VM (Machine) Google Compute Engine (Machine) IBM Softlayer (Machine) Install Machine Machine Machine CLI overview Machine command-line completion Machine concepts and help Machine overview Microsoft Azure (Machine) Microsoft Hyper-V (Machine) Migrate from Boot2Docker to Machine OpenStack (Machine) Oracle VirtualBox (Machine) Provision AWS EC2 instances (Machine) Provision Digital Ocean Droplets (Machine) Provision hosts in the cloud (Machine) Rackspace (Machine) VMware Fusion (Machine) VMware vCloud Air (Machine) VMware vSphere (Machine) Notary Client configuration (Notary) Common Server and signer configurations (Notary) Getting started with Notary Notary changelog Notary configuration files Running a Notary service Server configuration (Notary) Signer configuration (Notary) Understand the service architecture (Notary) Use the Notary client
文字

Docker插件API

Docker插件是进程外扩展,它为Docker引擎添加了功能。

本文档描述了Docker Engine插件API。要查看由Docker Engine管理的插件的信息,请参阅Docker Engine插件系统。

本页面适用于想要开发自己的Docker插件的人员。如果你只是想了解或使用Docker插件,请看这里。

什么插件

插件是与docker守护进程运行在相同或不同主机上的进程,它通过将文件放置在插件发现中描述的插件目录之一中的同一个docker主机上进行注册。

插件具有人类可读的名称,它们是短小的字符串。例如,flockerweave

插件可以在容器内部或外部运行。目前建议在容器外部运行它们。

插件发现

每当用户或容器尝试按名称使用插件时,Docker都会通过在插件目录中查找插件来发现插件。

有三种类型的文件可以放在插件目录中。

  • .sock 文件是UNIX域套接字。

  • .spec文件是包含URL的文本文件,例如unix:///other.socktcp://localhost:8080

  • .json 文件是包含插件的完整json规范的文本文件。

具有UNIX域套接字文件的插件必须在相同的docker主机上运行,而具有spec或json文件的插件可以在不同的主机上运行(如果指定了远程URL)。

UNIX域套接字文件必须位于下/run/docker/plugins,而规范的文件可以在位于/etc/docker/plugins/usr/lib/docker/plugins

文件的名称(不包括扩展名)确定插件名称。

例如,flocker插件可能会在中创建一个UNIX套接字/run/docker/plugins/flocker.sock

如果您想将相互隔离的定义隔离起来,您可以将每个插件定义到一个单独的子目录中。例如,您可以在容器内创建flocker套接字/run/docker/plugins/flocker/flocker.sock并仅将其安装/run/docker/plugins/flocker在该flocker容器内。

Docker总是首先搜索unix套接字/run/docker/plugins。它检查规范或json文件/etc/docker/plugins/usr/lib/docker/plugins如果套接字不存在。目录扫描只要找到具有给定名称的第一个插件定义就会停止。

JSON规范

这是插件的JSON格式:

{  "Name": "plugin-example",  "Addr": "https://example.com/docker/plugin",  "TLSConfig": {    "InsecureSkipVerify": false,    "CAFile": "/usr/shared/docker/certs/example-ca.pem",    "CertFile": "/usr/shared/docker/certs/example-cert.pem",    "KeyFile": "/usr/shared/docker/certs/example-key.pem"  }}

TLSConfig字段是可选的,只有在配置存在时才会验证TLS。

插件生命周期

插件应该在Docker之前启动,并在Docker之后停止。例如,在为支持的平台打包插件时systemd,可以使用systemd依赖关系来管理启动和关闭顺序。

升级插件时,应首先停止Docker守护程序,升级插件,然后再次启动Docker。

插件激活

当插件首次被引用时 - 无论是由用户引用它的名称(例如docker run --volume-driver=foo)还是已经配置为使用插件的容器 -  Docker在插件目录中查找指定的插件,并通过握手激活它。请参阅下面的握手API。

在Docker守护程序启动时插件不会自动激活。相反,它们只在需要时才会被懒惰地或按需地激活。

Systemd套接字激活

插件也可能被套接字激活systemd。官方的插件助手本地支持套接字激活。为了插件被套接字激活,它需要一个service文件和一个socket文件。

service文件(例如/lib/systemd/system/your-plugin.service):

[Unit]Description=Your plugin
Before=docker.service
After=network.target your-plugin.socket
Requires=your-plugin.socket docker.service[Service]ExecStart=/usr/lib/docker/your-plugin[Install]WantedBy=multi-user.target

socket文件(例如/lib/systemd/system/your-plugin.socket):

[Unit]Description=Your plugin[Socket]ListenStream=/run/docker/plugins/your-plugin.sock[Install]WantedBy=sockets.target

当Docker守护进程连接到它们正在监听的套接字(例如守护进程第一次使用它们或者其中一个插件意外关闭)时,这将允许插件实际启动。

API设计

插件API是基于HTTP的RPC风格的JSON,非常像webhook。

请求FlowDocker守护该插件。所以插件需要实现一个HTTP服务器并将其绑定到“plugin discovery”部分中提到的UNIX套接字。

所有请求都是HTTPPOST请求。

该API通过一个Accept标头进行版本控制,该标头目前始终设置为application/vnd.docker.plugins.v1+json

Handshake API

通过以下“handshake”API调用来激活插件。

/Plugin.Activate

请求:empty body

回应:

{    "Implements": ["VolumeDriver"]}

响应此插件实现的Docker子系统列表。激活后,插件将从这个子系统发送事件。

可能的值是:

  • authz

  • NetworkDriver

  • VolumeDriver

插件重试

尝试调用插件上的方法将重试指数回退长达30秒。当将插件封装为容器时,这可能会有所帮助,因为它使得插件容器在发生依赖于它们的任何用户容器失败之前有机会启动。

插件助手

为了简化插件开发,我们sdk为Docker /go-plugins-helpers目前支持的各种插件提供了一个插件。

上一篇: 下一篇: