谈一谈Docker Remote API应用

DurkBlue 2020-02-27 1726

默认

摘要： 熟悉Docker的朋友都知道，Docker是可以开启远程控制API的，默认监听TCP 2375端口，它有非常丰富的接口方法，可以用来远程控制Docker Daemon来做很多操作。...

熟悉Docker的朋友都知道，Docker是可以开启远程控制API的，默认监听TCP 2375端口，它有非常丰富的接口方法，可以用来远程控制Docker Daemon来做很多操作。Docker版本迭代很快，因此不同的版本官方也提供了不同版本的API文档，本文主要基于当前最新的v1.40简单介绍下一些常用操作及最佳实践。

一、安装Docker

Centos 系统可以直接使用yum命令在线安装，具体可以参考官方文档，下面提供一个Linux系统通用的在线安装方法：

1、国外的主机：

curl -sSL https://get.docker.com | sh

2、国内的主机：

curl -sSL https://get.daocloud.io/docker | sh

成功安装后，可执行 docker info、docker version、docker ps 等命令测试是否正常，具体过程不再赘述。

3、镜像加速

如果是国内的主机，为了让后面的实践操作更加顺畅，这里可以配置一下DaoCloud提供的的Docker镜像加速，执行如下2条命令即可：

# 配置加速curl -sSL https://get.daocloud.io/daotools/set_mirror.sh | sh -s http://f1361db2.m.daocloud.io# 重启Dockersystemctl restart docker

二、启用API

为了保证安全，Docker安装后默认不会启用远程API服务，因为这个服务默认不做权限认证。本文主要是做实践分享，且用于内网生产环境，安全上会有保证，如果是外网生产环境建议做好iptables安全加固或用完即焚或使用TLS安全认证，此处不表。

开启方法比较简单，此处只分享CentOS 7系统的启用步骤：

1、修改配置：

vi /lib/systemd/system/docker.service

找到ExecStart配置项，默认如下：

ExecStart=/usr/bin/dockerd -H fd:// --containerd=/run/containerd/containerd.sock

在其中插入监听选项：-H tcp://0.0.0.0:2375（如果是内网生产环境，请将0.0.0.0改为内网IP），最后为：

ExecStart=/usr/bin/dockerd -H fd:// -H tcp://0.0.0.0:2375 --containerd=/run/containerd/containerd.sock

2、重启Docker：

systemctl daemon-reloadsystemctl restart docker

3、查看结果，如下即为成功：

[root@centos ~]# netstat -nutlp | grep 2375tcp6       0      0 :::2375                 :::*                    LISTEN      3586/dockerd

4、查看API版本：

[root@centos ~]# docker versionClient: Docker Engine - CommunityVersion:           19.03.2API version:       1.40  # 本机Docker作为客户端的版本Go version:        go1.12.8Git commit:        6a30dfcBuilt:             Thu Aug 29 05:28:55 2019OS/Arch:           linux/amd64Experimental:      falseServer: Docker Engine - CommunityEngine:Version:          19.03.2API version:      1.40 (minimum version 1.12) # 本机Docker作为服务端的版本Go version:       go1.12.8Git commit:       6a30dfcBuilt:            Thu Aug 29 05:27:34 2019OS/Arch:          linux/amd64Experimental:     falsecontainerd:Version:          1.2.6GitCommit:        894b81a4b802e4eb2a91d1ce216b8817763c29fbrunc:Version:          1.0.0-rc8GitCommit:        425e105d5a03fabd737a126ad93d62a9eeede87fdocker-init:Version:          0.18.0GitCommit:        fec3683

三、Docker API初探

完成上述步骤后，Docker就已经支持远程控制了，我们先参考官方文档试试拉起一个镜像（下文的操作均在本地完成，因此IP均为127.0.0.1）：

1、调用API拉取centos最新镜像：

curl -XPOST "http://127.0.0.1:2375/v1.40/images/create?fromImage=centos&tag=latest"

2、调用API创建一个容器，指定一个前台阻塞命令 tail -f /dev/null：

curl -H "Content-Type: application/json" http://127.0.0.1:2375/containers/create?name=demo1 -d '{"Image": "centos:latest","HostConfig": {"NetworkMode": "host","Binds": ["/tmp:/tmp"]},"Cmd": ["tail","-f","/dev/null"]}'

成功返回如下：

{"Id":"b88c7c986ecd5fdf174f79b00e024087b47241cd40653bcb05df70fba5cc398f","Warnings":[]}

3、调用API启动刚刚创建的容器：

# 可以使用上一步返回的id来启动：curl -XPOST http://127.0.0.1:2375/containers/b88c7c986ecd5fdf174f79b00e024087b47241cd40653bcb05df70fba5cc398f/start# 也可以使用上一步定义的容器名称demo1来启动：curl -XPOST http://127.0.0.1:2375/demo1/start

4、查看启动中的容器：

[root@centos ~]# docker ps | grep demo1ed9f2150f8d5        centos:latest       "tail -f /dev/null"   About a minute ago   Up About a minute                       demo1

5、调用容器执行命令：

调用API，对已存在的容器demo1创建命令实例：

curl -H "Content-Type: application/json" http://127.0.0.1:2375/containers/demo1/exec -d '{  "AttachStdin": false,"AttachStdout": true,"AttachStderr": true,"DetachKeys": "ctrl-p,ctrl-q","Tty": false,"Cmd": ["sh","-c","date | tee /tmp/test_exec.log"],"Env": ["FOO=bar","BAZ=quux"]}'

返回结果为命令实例Id：

{"Id":"08552937782f6c5b696454d5524b140337fb0652d5f39142ac57ceaf46732bb4"}

继续调用API启动这个命令实例：

curl -XPOST -H "Content-Type: application/json" http://127.0.0.1:2375/exec/08552937782f6c5b696454d5524b140337fb0652d5f39142ac57ceaf46732bb4/start  -d '{             "Detach": false,"Tty": false}'Fri Oct  4 03:21:36 UTC 2019

如上返回了一个date命令的回显，并且会在挂载的/tmp目录生成test_exec.log文本，内容和上一步回显一致：

[root@centos ~]# cat /tmp/test_exec.log Fri Oct  4 03:21:36 UTC 2019

说明命令被成功执行！

上述步骤，简单的展示了Docker API的常见场景，可以说Docker API极大的简化了运维工作，比如我们常说的CI/CD就可以不再依赖ssh通道或自建agent了，一个接口就可以搞定应用的全生命周期，简直是运维大救星！

Ps：更多Docker API的用法可以参考官方文档。

四、Python-SDK初探

Docker是如此的流行，肯定少不了各语言配套的SDK，运维最常用的高级语言是Python，因此这里简单的介绍下Docker的Python SDK，并使用Python的SDK来实现上文API的繁琐操作：

1、安装SDK：

# 如果没有pip，先安装pip：yum install python-pippip install --upgrade pip# 安装SDKpip install docker

2、寥寥数行代码就可以实现第三步的繁琐过程：

# -- coding: utf8 --import docker# 初始化，这里可以根据目标docker版本执行API版本，如果后面报错则需要调整此处为目标的同版本或更低版本client = docker.DockerClient(version='1.40', base_url='tcp://127.0.0.1:2375')# 拉取镜像client.images.pull('centos:latest')# 拉起容器client.containers.run(image='centos:latest', name='demo1', command='tail -f /dev/null',volumes={'/data': {'bind': '/tmp', 'mode': 'rw'}}, detach=True)# 先通过容器名获取对象container = client.containers.get('demo1')# 通过对象执行命令result = container.exec_run(cmd='sh -c "date | tee /tmp/test_sdk.log"', detach=False, tty=True, stdin=True, stdout=True)# 输出执行命令的返回码和返回结果print(result.exit_code)print(result.output.decode())

上述代码保存为 test_sdk.py，执行 python test_sdk.py 后查看结果：

[root@centos ~]# python test_sdk.py 0Sun Oct  6 01:48:58 UTC 2019[root@centos ~]# cat /data/test_sdk.log Fri Oct  4 03:35:14 UTC 2019

通过SDK的操作演示，可以很明显的看到操作步骤极大的简化了，整体过程变得更加流畅！

Ps：更多的玩法可以参考官方文档。

五、实战Haproxy远程管理

上文的实践证明，有了Docker Remote API这个运维利器（通道），很多传统运维手段都可以被革新，下面简单介绍一下，我们如何利用Docker Remote API来实现Haoproxy的远程管理（所有代码和镜像均已上传到GitHub和DockerHub）。

1、原理介绍

首先，我们构建一个Haporxy配置集中管理服务，用于界面化管理Haproxy配置，并提供可拉取到指定配置内容的接口，比如：

curl -s --max-time 120 --retry 3 -w %{http_code} -o 192.168.1.100.cfg http://192.168.1.1/haproxy/192.168.1.100

然后，在Haproxy镜像里面集成一个shell脚本，用于拉取、比对、更新Haproxy的配置文件。

最后，远程调用Docker Remote API 执行Haproxy容器里面的shell脚本更新Haproxy配置，如果更新成功则继续调用Docker API 重载Haproxy配置，即可完成Haproxy配置的平滑更新。

2、快速构建中心配置管理服务

为了快速演示效果，这里直接使用Nginx部署一个Haproxy配置的下载服务，实际使用肯定要构建一个更完善的管理平台。

# 安装Nginxyum install -y nginx# 启动Nginx/sbin/nginx# 创建一个极简haproxy配置文件cat > /usr/share/nginx/html/127.0.0.1 <<EOFglobalnbproc 1pidfile /usr/local/haproxy/logs/127.0.0.1.piddefaultstimeout connect  300stimeout client   300stimeout server   300slisten admin_statbind 0.0.0.0:8080mode httpstats refresh 60sstats uri /haproxystats auth admin:123456stats admin if TRUE################################################## status end ###############################################EOF# 请求测试，有上述内容即为成功curl http://127.0.0.1/127.0.0.1

3、制作Haproxy镜像：

这里直接基于官方的镜像，额外集成用于更新Haproxy配置的脚本以及一些常用命令（curl、vim、ps）：

Dockerfile内容如下：

FROM haproxy:latestRUN apt-get update \&& apt-get install -y curl vim procps \&& apt-get purge -y --auto-remove -o APT::AutoRemove::RecommendsImportant=falseCOPY update_cfg.sh /opt/COPY docker-entrypoint.sh /CMD ["haproxy","-f","/etc/haproxy.cfg"]

update_cfg.sh 用于下载、比对、更新Haproxy配置，语法、逻辑都比较简单，感兴趣的可以看看：

#!/bin/bashsource /etc/profileif [ -z $VIP ];thenecho 'ENV ${VIP} is not SET, Plz check!'exit 1fi# Define and create storage directoryetc_dir=${STORAGE_DIR:-/usr/local/haproxy/etc}temp_dir=${etc_dir}/tempback_dir=${etc_dir}/backupmkdir -p ${back_dir} ${temp_dir}# Define the configration filecurrent_cfg=${etc_dir}/${VIP}.cfgbackup_cfg=${back_dir}/${VIP}_$(date +%F-%H%M%S).cfgtemp_cfg=${temp_dir}/${VIP}.cfg# Define file download configrationcurl_bin=$(which curl)cfg_manage_api=${CFG_GET_URL:-http://your_haporxy_download_svr/haproxy/}${VIP} # 这里需要根据配置管理服务的实际情况修改地址# console logreport_log(){echo "[$(date '+%F %H:%M:%S')] $*"}# backup current configration filebackup_cfg(){if [ -f ${current_cfg} ];thencp -a ${current_cfg} ${backup_cfg} && \report_log "Backup ${current_cfg} to  ${backup_cfg} success." || \report_log "Backup ${current_cfg} to  ${backup_cfg} failed."elsereport_log "${current_cfg} is not exist, maybe the first release, skiped."fi}# update current configration filecover_cfg(){   if [ -f ${temp_cfg} ];thencp -a ${temp_cfg} ${current_cfg} && \report_log "Cover ${temp_cfg} to ${current_cfg} success." || (report_log "Cover ${temp_cfg} to ${current_cfg} failed."exit 1)elsereport_log "${temp_cfg} is not exist, Unknow Error, exited."exit 1fi}# download latest configration file from download svrdownload_cfg(){report_log "Starting Download configration file to ${temp_cfg} ..."ret_code=$(${curl_bin} -s --max-time 120 --retry 3 -w %{http_code} -o ${temp_cfg} ${cfg_manage_api})if [ $ret_code -eq 200 ] && [ $? -eq 0 ];thenreport_log "Download configration file ${temp_cfg} success."elsereport_log "Download configration file ${temp_cfg} failed."exit 1fi}# check the latest configration check_cfg(){old_md5=$(test -f ${current_cfg} && md5sum ${current_cfg} | awk '{print $1}' 2>/dev/null )new_md5=$(md5sum ${temp_cfg}|awk '{print $1}')if [ "$old_md5" = "$new_md5" ];thenreport_log "The configuration file ${VIP}.cfg is the same, no need update."return 2fiif haproxy -c -W -f ${temp_cfg} >/dev/null ;thenreport_log "Configuration file ${temp_cfg} is valid."return 0elsereport_log "Configuration file ${temp_cfg} is invalid."return 1fi}download_cfgif check_cfg;thenbackup_cfgcover_cfg && \report_log "${current_cfg} is updated success!"elseexit $?fi

docker-entrypoint.sh 改自Haproxy官方镜像，在默认逻辑块加入了对VIP环境变量的判断、配置文件的更新下载、配置文件软链接建立、配置语法校验等逻辑：

#!/bin/sh# first arg is `-f` or `--some-option`if [ "${1#-}" != "$1" ]; thenset -- haproxy "$@"fiif [ "$1" = 'haproxy' ]; thenif [ -z $VIP ];thenecho echo "[$(date '+%F %H:%M:%S')] ENV \${VIP} is not SET, Plz check!"exit 1fibash /opt/update_cfg.shln -sf /usr/local/haproxy/etc/${VIP}.cfg /etc/haproxy.cfghaproxy -W -c -f /etc/haproxy.cfg || (echo "[$(date '+%F %H:%M:%S')] Haproxy Configuration file check failed, Plz check!"exit 1)shift # "haproxy"# if the user wants "haproxy", let's add a couple useful flags#   -W  -- "master-worker mode" (similar to the old "haproxy-systemd-wrapper"; allows for reload via "SIGUSR2")#   -db -- disables background modeset -- haproxy -W -db "$@"fiexec "$@"

准备好上述文件后，在文件同级目录执行如下命令构建Haproxy镜像（实际这一步也可以通过API来操作，这里不再赘述，详见官方文档）：

# 脚本给执行权限：chmod +x *.sh# 如果有私有仓库的可以撸到私有仓库，本文主要是分享，这里直接本地构建：docker build -t "haproxy-plus:latest" ./

4、拉起Haproxy容器

为了贴合文章主题，所以这里继续用Docker API远程方式拉起容器：

# -- coding: utf8 --import dockerclient = docker.DockerClient(version='1.40', base_url='tcp://127.0.0.1:2375')#client.images.pull('haproxy-plus:latest') # 本地测试，所以这里不需要拉取镜像client.containers.run(image='haproxy-plus:latest', name='demo2', volumes={'/data/images/haproxy/etc': {'bind': '/usr/local/haproxy/etc', 'mode': 'rw'}}, network_mode='host', environment=["VIP=127.0.0.1", "CFG_GET_URL=http://127.0.0.1/"], detach=True)

几个关键的设置说明：

挂载本地目录 /data/images/haproxy/etc 到容器 /usr/local/haproxy/etc 目录，用于持久化配置；
环境变量 VIP，用于指定haproxy的配置名称（在我们这边其实就是VIP地址），也是为了通过接口拉取到指定配置；
环境变量 CFG_GET_URL，拉取Haproxy配置的地址，组合VIP后就是 http://127.0.0.1/127.0.01，即上文的临时搭建的下载地址

上述Python代码保存为start.py，执行结果如下：

[root@centos haproxy]# python start.py [root@centos haproxy]# docker logs -f demo2 # 查看执行日志[2019-10-04 04:32:10] Starting Download configration file to /usr/local/haproxy/etc/temp/127.0.0.1.cfg ...[2019-10-04 04:32:10] Download configration file /usr/local/haproxy/etc/temp/127.0.0.1.cfg success.[2019-10-04 04:32:10] Configuration file /usr/local/haproxy/etc/temp/127.0.0.1.cfg is valid.[2019-10-04 04:32:10] /usr/local/haproxy/etc/127.0.0.1.cfg is not exist, maybe the first release, skiped.[2019-10-04 04:32:10] Cover /usr/local/haproxy/etc/temp/127.0.0.1.cfg to /usr/local/haproxy/etc/127.0.0.1.cfg success.[2019-10-04 04:32:10] /usr/local/haproxy/etc/127.0.0.1.cfg is updated success!Configuration file is valid[NOTICE] 276/043210 (1) : New worker #1 (27) forked

通过Docker的日志，启动过程解析如下：