将 Docker Compose 文件转换为 Kubernetes 资源

Kompose 是什么？它是一个将所有 compose 相关内容（主要是 Docker Compose）转换为容器编排器（Kubernetes 或 OpenShift）的转换工具。

更多信息请参见 Kompose 官方网站：https://kompose.kubernetes.ac.cn。

开始之前

你需要拥有一个 Kubernetes 集群，并且 kubectl 命令行工具需要配置为能够与你的集群通信。建议在本教程中使用一个至少有两个非控制平面主机的节点组成的集群。如果你还没有集群，可以使用 minikube 创建一个，或者使用以下 Kubernetes 演练场：

要检查版本，请输入 kubectl version。

安装 Kompose

我们有多种安装 Kompose 的方法。我们首选的方法是从最新的 GitHub Release 下载二进制文件。

Kompose 每三周通过 GitHub 发布一次，你可以在 GitHub 发布页面上查看所有当前版本。

# Linux
curl -L https://github.com/kubernetes/kompose/releases/download/v1.34.0/kompose-linux-amd64 -o kompose

# macOS
curl -L https://github.com/kubernetes/kompose/releases/download/v1.34.0/kompose-darwin-amd64 -o kompose

# Windows
curl -L https://github.com/kubernetes/kompose/releases/download/v1.34.0/kompose-windows-amd64.exe -o kompose.exe

chmod +x kompose
sudo mv ./kompose /usr/local/bin/kompose

另外，你也可以下载 tarball。

使用 go get 进行安装会从 master 分支拉取最新的开发更改。

go get -u github.com/kubernetes/kompose

在 macOS 上，你可以通过 Homebrew 安装最新版本

brew install kompose

使用 Kompose

通过几个步骤，我们将引导你从 Docker Compose 迁移到 Kubernetes。你只需要一个现有的 docker-compose.yml 文件。

  1. 进入包含 docker-compose.yml 文件的目录。如果你没有，可以使用这个文件进行测试。

    
services:

  redis-leader:
    container_name: redis-leader
    image: redis
    ports:
      - "6379"

  redis-replica:
    container_name: redis-replica
    image: redis
    ports:
      - "6379"
    command: redis-server --replicaof redis-leader 6379 --dir /tmp

  web:
    container_name: web
    image: quay.io/kompose/web
    ports:
      - "8080:8080"
    environment:
      - GET_HOSTS_FROM=dns
    labels:
      kompose.service.type: LoadBalancer

  2. 要将 docker-compose.yml 文件转换为可与 kubectl 一起使用的文件，请运行 kompose convert，然后运行 kubectl apply -f <output file>。

    kompose convert

    输出类似于

    INFO Kubernetes file "redis-leader-service.yaml" created
INFO Kubernetes file "redis-replica-service.yaml" created
INFO Kubernetes file "web-tcp-service.yaml" created
INFO Kubernetes file "redis-leader-deployment.yaml" created
INFO Kubernetes file "redis-replica-deployment.yaml" created
INFO Kubernetes file "web-deployment.yaml" created

     kubectl apply -f web-tcp-service.yaml,redis-leader-service.yaml,redis-replica-service.yaml,web-deployment.yaml,redis-leader-deployment.yaml,redis-replica-deployment.yaml

    输出类似于

    deployment.apps/redis-leader created
deployment.apps/redis-replica created
deployment.apps/web created
service/redis-leader created
service/redis-replica created
service/web-tcp created

    你的 Deployment 已在 Kubernetes 中运行。

  3. 访问你的应用程序。

    如果你已将 minikube 用于你的开发过程

    minikube service web-tcp

    否则，我们来看看你的 Service 正在使用哪个 IP！

    kubectl describe svc web-tcp

     Name:                     web-tcp
 Namespace:                default
 Labels:                   io.kompose.service=web-tcp
 Annotations:              kompose.cmd: kompose convert
                           kompose.service.type: LoadBalancer
                           kompose.version: 1.33.0 (3ce457399)
 Selector:                 io.kompose.service=web
 Type:                     LoadBalancer
 IP Family Policy:         SingleStack
 IP Families:              IPv4
 IP:                       10.102.30.3
 IPs:                      10.102.30.3
 Port:                     8080  8080/TCP
 TargetPort:               8080/TCP
 NodePort:                 8080  31624/TCP
 Endpoints:                10.244.0.5:8080
 Session Affinity:         None
 External Traffic Policy:  Cluster
 Events:                   <none>

    如果你使用的是云提供商，你的 IP 将列在 LoadBalancer Ingress 旁边。

    curl http://192.0.2.89

  4. 清理。

    完成示例应用程序部署测试后，只需在你的 shell 中运行以下命令即可删除使用的资源。

    kubectl delete -f web-tcp-service.yaml,redis-leader-service.yaml,redis-replica-service.yaml,web-deployment.yaml,redis-leader-deployment.yaml,redis-replica-deployment.yaml

用户指南

Kompose 支持两个提供商：OpenShift 和 Kubernetes。你可以使用全局选项 --provider 选择目标提供商。如果未指定提供商，则默认设置为 Kubernetes。

kompose convert

Kompose 支持将 V1、V2 和 V3 版本的 Docker Compose 文件转换为 Kubernetes 和 OpenShift 对象。

Kubernetes kompose convert 示例

kompose --file docker-voting.yml convert

WARN Unsupported key networks - ignoring
WARN Unsupported key build - ignoring
INFO Kubernetes file "worker-svc.yaml" created
INFO Kubernetes file "db-svc.yaml" created
INFO Kubernetes file "redis-svc.yaml" created
INFO Kubernetes file "result-svc.yaml" created
INFO Kubernetes file "vote-svc.yaml" created
INFO Kubernetes file "redis-deployment.yaml" created
INFO Kubernetes file "result-deployment.yaml" created
INFO Kubernetes file "vote-deployment.yaml" created
INFO Kubernetes file "worker-deployment.yaml" created
INFO Kubernetes file "db-deployment.yaml" created

ls

db-deployment.yaml  docker-compose.yml         docker-gitlab.yml  redis-deployment.yaml  result-deployment.yaml  vote-deployment.yaml  worker-deployment.yaml
db-svc.yaml         docker-voting.yml          redis-svc.yaml     result-svc.yaml        vote-svc.yaml           worker-svc.yaml

你也可以同时提供多个 docker-compose 文件

kompose -f docker-compose.yml -f docker-guestbook.yml convert

INFO Kubernetes file "frontend-service.yaml" created         
INFO Kubernetes file "mlbparks-service.yaml" created         
INFO Kubernetes file "mongodb-service.yaml" created          
INFO Kubernetes file "redis-master-service.yaml" created     
INFO Kubernetes file "redis-slave-service.yaml" created      
INFO Kubernetes file "frontend-deployment.yaml" created      
INFO Kubernetes file "mlbparks-deployment.yaml" created      
INFO Kubernetes file "mongodb-deployment.yaml" created       
INFO Kubernetes file "mongodb-claim0-persistentvolumeclaim.yaml" created
INFO Kubernetes file "redis-master-deployment.yaml" created  
INFO Kubernetes file "redis-slave-deployment.yaml" created   

ls

mlbparks-deployment.yaml  mongodb-service.yaml                       redis-slave-service.jsonmlbparks-service.yaml  
frontend-deployment.yaml  mongodb-claim0-persistentvolumeclaim.yaml  redis-master-service.yaml
frontend-service.yaml     mongodb-deployment.yaml                    redis-slave-deployment.yaml
redis-master-deployment.yaml

当提供多个 docker-compose 文件时，配置将被合并。任何相同的配置将被后续文件中的配置覆盖。

OpenShift kompose convert 示例

kompose --provider openshift --file docker-voting.yml convert

WARN [worker] Service cannot be created because of missing port.
INFO OpenShift file "vote-service.yaml" created             
INFO OpenShift file "db-service.yaml" created               
INFO OpenShift file "redis-service.yaml" created            
INFO OpenShift file "result-service.yaml" created           
INFO OpenShift file "vote-deploymentconfig.yaml" created    
INFO OpenShift file "vote-imagestream.yaml" created         
INFO OpenShift file "worker-deploymentconfig.yaml" created  
INFO OpenShift file "worker-imagestream.yaml" created       
INFO OpenShift file "db-deploymentconfig.yaml" created      
INFO OpenShift file "db-imagestream.yaml" created           
INFO OpenShift file "redis-deploymentconfig.yaml" created   
INFO OpenShift file "redis-imagestream.yaml" created        
INFO OpenShift file "result-deploymentconfig.yaml" created  
INFO OpenShift file "result-imagestream.yaml" created

它还支持为 Service 中的 build 指令创建 buildconfig。默认情况下，它使用当前 git 分支的远程仓库作为源仓库，使用当前分支作为构建的源分支。你可以分别使用 --build-repo 和 --build-branch 选项指定不同的源仓库和分支。

kompose --provider openshift --file buildconfig/docker-compose.yml convert

WARN [foo] Service cannot be created because of missing port.
INFO OpenShift Buildconfig using git@github.com:rtnpro/kompose.git::master as source.
INFO OpenShift file "foo-deploymentconfig.yaml" created     
INFO OpenShift file "foo-imagestream.yaml" created          
INFO OpenShift file "foo-buildconfig.yaml" created

其他转换选项

默认的 kompose 转换会生成 Kubernetes Deployment 和 Service 对象，格式为 yaml。你也可以使用 -j 选项生成 json 格式。另外，你还可以生成 Replication Controller 对象、DaemonSet 或 Helm chart。

kompose convert -j
INFO Kubernetes file "redis-svc.json" created
INFO Kubernetes file "web-svc.json" created
INFO Kubernetes file "redis-deployment.json" created
INFO Kubernetes file "web-deployment.json" created

*-deployment.json 文件包含 Deployment 对象。

kompose convert --replication-controller
INFO Kubernetes file "redis-svc.yaml" created
INFO Kubernetes file "web-svc.yaml" created
INFO Kubernetes file "redis-replicationcontroller.yaml" created
INFO Kubernetes file "web-replicationcontroller.yaml" created

*-replicationcontroller.yaml 文件包含 Replication Controller 对象。如果你想指定副本数量（默认是 1），可以使用 --replicas 标志：kompose convert --replication-controller --replicas 3。

kompose convert --daemon-set
INFO Kubernetes file "redis-svc.yaml" created
INFO Kubernetes file "web-svc.yaml" created
INFO Kubernetes file "redis-daemonset.yaml" created
INFO Kubernetes file "web-daemonset.yaml" created

*-daemonset.yaml 文件包含 DaemonSet 对象。

如果你想生成可用于 Helm 的 Chart，请运行

kompose convert -c

INFO Kubernetes file "web-svc.yaml" created
INFO Kubernetes file "redis-svc.yaml" created
INFO Kubernetes file "web-deployment.yaml" created
INFO Kubernetes file "redis-deployment.yaml" created
chart created in "./docker-compose/"

tree docker-compose/

docker-compose
├── Chart.yaml
├── README.md
└── templates
    ├── redis-deployment.yaml
    ├── redis-svc.yaml
    ├── web-deployment.yaml
    └── web-svc.yaml

chart 结构旨在为构建你的 Helm chart 提供一个骨架。

标签

kompose 支持在 docker-compose.yml 文件中使用 Kompose 特定的标签，以便在转换时显式定义 Service 的行为。

  • kompose.service.type 定义要创建的 Service 类型。

    例如

    version: "2"
services:
  nginx:
    image: nginx
    dockerfile: foobar
    build: ./foobar
    cap_add:
      - ALL
    container_name: foobar
    labels:
      kompose.service.type: nodeport

  • kompose.service.expose 定义 Service 是否需要从集群外部访问。如果值为 "true"，提供商会自动设置端点；对于任何其他值，该值将设置为 hostname。如果在 Service 中定义了多个端口，则选择第一个端口进行暴露。

    • 对于 Kubernetes 提供商，会创建一个 ingress 资源，并且假设已经配置了 ingress 控制器。
    • 对于 OpenShift 提供商，会创建一个 route。

    例如

    version: "2"
services:
  web:
    image: tuna/docker-counter23
    ports:
    - "5000:5000"
    links:
    - redis
    labels:
      kompose.service.expose: "counter.example.com"
  redis:
    image: redis:3.0
    ports:
    - "6379"

当前支持的选项包括

键值
kompose.service.typenodeport / clusterip / loadbalancer
kompose.service.exposetrue / hostname

重启

如果你想创建不带控制器的普通 Pod，可以使用 docker-compose 的 restart 构造来定义。请参考下表，了解 restart 值对应的行为。

docker-compose restart创建的对象Pod restartPolicy
""控制器对象Always
always控制器对象Always
on-failurePodOnFailure
noPodNever

例如，下面的 pival Service 将会变成 Pod。此容器计算了 pi 的值。

version: '2'

services:
  pival:
    image: perl
    command: ["perl",  "-Mbignum=bpi", "-wle", "print bpi(2000)"]
    restart: "on-failure"

关于 Deployment 配置的警告

如果 Docker Compose 文件为 Service 指定了 volume，则 Deployment (Kubernetes) 或 DeploymentConfig (OpenShift) 策略会从 "RollingUpdate"（默认）更改为 "Recreate"。这样做是为了避免 Service 的多个实例同时访问同一个 volume。

如果 Docker Compose 文件中的 Service 名称包含 _（例如 web_service），则 _ 将被替换为 -，并且 Service 名称会相应地更改（例如 web-service）。Kompose 执行此操作是因为 Kubernetes 不允许对象名称中包含 _。

请注意，更改 Service 名称可能会破坏某些 docker-compose 文件。

Docker Compose 版本

Kompose 支持 Docker Compose 版本 1、2 和 3。由于版本 2.1 和 3.2 的实验性，我们对其支持有限。

所有三个版本之间的完整兼容性列表列在我们的转换文档中，其中包括所有不兼容的 Docker Compose 键列表。

最后修改时间：2025年2月28日 太平洋标准时间下午 7:30：移除 kompose 的 Fedora 和 CentOS 包 (52bd40a393)