將 Docker Compose 檔案轉換為 Kubernetes 資源

Kompose 是什麼？它是一個將所有 Compose（特別是 Docker Compose）檔案轉換為容器編排器（Kubernetes 或 OpenShift）資源的轉換工具。

更多資訊請訪問 Kompose 網站：https://kompose.io/。

準備工作

你需要有一個 Kubernetes 叢集，並且 kubectl 命令列工具必須配置為與你的叢集通訊。建議在至少有兩個不是控制平面主機的節點組成的叢集上執行本教程。如果你還沒有叢集，可以使用 minikube 建立一個，或者使用以下某個 Kubernetes 遊樂場。

要檢查版本，請輸入 kubectl version。

安裝 Kompose

我們有多種方法安裝 Kompose。我們首選的方法是從最新的 GitHub 版本下載二進位制檔案。

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 進行安裝會從主分支拉取最新的開發更改。

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

    你的部署正在 Kubernetes 中執行。

  3. 訪問你的應用程式。

    如果你已經在開發過程中使用 minikube

    minikube service web-tcp

    否則，讓我們查詢你的服務正在使用的 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

它還支援為服務中的構建指令建立 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 部署和 服務，格式為 YAML。你也可以使用 -j 生成 JSON 格式。此外，你還可以生成 Replication Controllers 物件、Daemon Sets 或 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 的標籤，以便在轉換時明確定義服務的行為。

  • kompose.service.type 定義要建立的服務型別。

    例如

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

  • kompose.service.expose 定義服務是否需要從叢集外部訪問。如果值設定為 "true"，則提供商會自動設定端點，對於任何其他值，該值將設定為主機名。如果服務中定義了多個埠，則選擇第一個埠作為公開埠。

    • 對於 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 服務將在此處變為 Pod。此容器計算 pi 的值。

version: '2'

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

關於部署配置的警告

如果 Docker Compose 檔案為服務指定了卷，則 Deployment (Kubernetes) 或 DeploymentConfig (OpenShift) 策略將更改為 "Recreate" 而不是 "RollingUpdate"（預設）。這樣做是為了避免服務的多個例項同時訪問一個卷。

如果 Docker Compose 檔案中的服務名稱包含 _（例如，web_service），則它將替換為 -，服務名稱也將相應地重新命名（例如，web-service）。Kompose 之所以這樣做，是因為 "Kubernetes" 不允許物件名稱中包含 _。

請注意，更改服務名稱可能會破壞某些 docker-compose 檔案。

Docker Compose 版本

Kompose 支援 Docker Compose 版本：1、2 和 3。由於它們的實驗性質，我們對版本 2.1 和 3.2 的支援有限。

所有三個版本之間的相容性完整列表列在我們的 轉換文件中，其中還包括所有不相容的 Docker Compose 鍵的列表。

最後修改於 2025 年 5 月 7 日太平洋標準時間上午 3:00：[en] update kompose link (1d83783462)