使用go模板将docker swarm集群服务导出为yaml文件

简介

在使用个docker swarm集群中,我们常常使用docker swarm Compose来部署我们的应用,但docker swarm集群目前无法像k8s那样将已部署好的应用导出为yaml部署文件,在个别情况下我们又希望将已部署好的应用信息写回yaml文件。
应用场景:

  1. 部署文件丢失,需要已经现有环境重新生成yaml部署文档
  2. 备份我们的现在运行的应用程序
  3. 使用了太多在线改动的参数,不像逐一查看改动

原理

编写自定义模板,使用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应用"

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 200,783评论 5 472
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 84,396评论 2 377
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 147,834评论 0 333
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,036评论 1 272
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,035评论 5 362
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,242评论 1 278
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,727评论 3 393
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,376评论 0 255
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,508评论 1 294
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,415评论 2 317
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,463评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,140评论 3 316
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,734评论 3 303
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,809评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,028评论 1 255
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,521评论 2 346
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,119评论 2 341

推荐阅读更多精彩内容