简介
在使用个docker swarm集群中,我们常常使用docker swarm Compose来部署我们的应用,但docker swarm集群目前无法像k8s那样将已部署好的应用导出为yaml部署文件,在个别情况下我们又希望将已部署好的应用信息写回yaml文件。
应用场景:
- 部署文件丢失,需要已经现有环境重新生成yaml部署文档
- 备份我们的现在运行的应用程序
- 使用了太多在线改动的参数,不像逐一查看改动
原理
编写自定义模板,使用docker提供的go模板打印docker服务信息,模板参照docker Compose格式进行格式化。
缺点
目前docker管理节点并不能完全获取在运行容器的所有信息,如容器环境变量和entrypoint等信息,所以收集后的信息没法直接使用,需要进一步处理,如需要合并多个服务重复项等信息,感兴趣的可以自行探索。
使用方法
在管理节点上编写模板文件docker-compose-template.tmpl
,文件内容如下:
cat > docker-compose-template.tmpl
version: 3
services:
{{ .Spec.Name }}:
image: "{{.Spec.TaskTemplate.ContainerSpec.Image}}"
labels:
{{- range $k,$v :=.Spec.TaskTemplate.ContainerSpec.Labels}}
{{printf "%s: %q" $k $v}}
{{- end}}
extra_hosts:
{{- range .Spec.TaskTemplate.ContainerSpec.Hosts}}
{{printf "- %s" .}}
{{- end}}
environment:
{{- range .Spec.TaskTemplate.ContainerSpec.Env}}
{{printf "- %s" .}}
{{- end}}
volumes:
{{- range .Spec.TaskTemplate.ContainerSpec.Mounts}}
{{printf "- %s:%s" .Source .Target}}{{ if .ReadOnly }}:ro{{ end }}
{{- end}}
networks:
- default
ports:
{{- range .Spec.EndpointSpec.Ports}}
- {{.PublishedPort}}:{{.TargetPort}}/{{.Protocol}}
{{- end}}
configs:
{{- range .Spec.TaskTemplate.ContainerSpec.Configs}}
- source: {{.ConfigName}}
target: {{.File.Name}}
{{- end}}
deploy:
labels:
{{- range $k,$v :=.Spec.Labels}}
{{printf "%s: %q" $k $v}}
{{- end}}
mode: {{if .Spec.Mode.Global}}global{{else}}replicated
replicas: {{.Spec.Mode.Replicated.Replicas}}{{end}}
endpoint_mode: {{.Endpoint.Spec.Mode}}
restart_policy:
condition: {{.Spec.TaskTemplate.RestartPolicy.Condition}}
placement:
constraints:
{{- range .Spec.TaskTemplate.Placement.Constraints}}
{{printf "- %q" .}}
{{- end}}
networks:
default:
configs:
{{- range .Spec.TaskTemplate.ContainerSpec.Configs}}
{{.ConfigName}}:
name: {{.ConfigName}}
external: yes
{{- end}}
volumes:
{{- range .Spec.TaskTemplate.ContainerSpec.Mounts }}{{ if ( eq .Type "volume") }}
{{ .Source }}:{{ end }}
{{- end }}
选择要转换的服务
# 查看在运行的服务
docker service ls
# 导出服务my_traefik的信息,后面要使用引号扩起来
docker service inspect my_traefik --format "$(cat docker-compose-template.tmpl)"
# 将导出的内容保存为文件
docker service inspect 服务名 --format "$(cat docker-compose-template.tmpl)" > 文件名.yaml
# 导出所有的服务到同一个文件
docker service ls | awk 'NR>1{printf "%s ",$2}' | xargs docker service inspect --format "$(cat docker-compose-template.tmpl)" > 文件名.yaml
# 导出所有服务,每个服务单独写成一个文件,文件名就是服务名
docker service ls | awk 'NR>1{print $2}' |while read svc; do docker service inspect --format "$(cat docker-compose-template.tmpl)" $svc > $svc.yaml; done
inspect可以同时查看多个服务,如:
docker service inspect 服务A 服务B 服务C ...
命令执行后输出内容示例:
version: 3
services:
my_traefik:
image: "traefik:v2.10"
labels:
com.docker.stack.namespace: "my"
extra_hosts:
environment:
- TZ=Asia/Shanghai
volumes:
- /var/run/docker.sock:/var/run/docker.sock:ro
networks:
- default
configs:
ports:
- 80:80/tcp
- 443:443/tcp
deploy:
labels:
com.docker.stack.image: "traefik:v2.10"
com.docker.stack.namespace: "my"
traefik.enable: "true"
traefik.http.routers.traefik-router.entrypoints: "http"
traefik.http.routers.traefik-router.middlewares: "traefik-auth@docker"
traefik.http.routers.traefik-router.rule: "Host(`dashboard.docker.lan`)"
traefik.http.routers.traefik-router.service: "api@internal"
traefik.http.services.traefik-router.loadbalancer.server.port: "80"
mode: replicated
replicas: 1
endpoint_mode: vip
restart_policy:
condition: on-failure
placement:
constraints:
- "node.role == manager"
networks:
default:
configs:
volumes:
由上面的输出可以看出没能成功打印服务的hosts文件配置信息和容器运行参数等信息,这部数据需要到具体节点上去才能收集,可以尝试自己编写go模板来获得,推荐使用[docker-autocompose][autocompose] 命令了,它支持将当前节点运行的容器导出Compose文件,再将容器的和服务的两部分缺失内容相互补齐,就能完成地还原当前应用的部署文件。
如有需要调整的话可以跟据go模板语法进行模板调整。
参考资料:
docker swarm Compose文件语法文档
GO-template模板语法文档
[autocompose]:https://github.com/Red5d/docker-autocompose "docker容器导出yaml应用"