將 Docker Compose 檔案轉換為 Kubernetes 資源

什麼是 Kompose？它是一個轉換工具，適用於所有 compose（即 Docker Compose）到容器協調器（Kubernetes 或 OpenShift）。

更多資訊可以在 Kompose 網站 https://kompose.dev.org.tw 上找到。

開始之前

您需要有一個 Kubernetes 叢集，並且必須設定 kubectl 命令列工具以與您的叢集通訊。建議在至少有兩個節點且未充當控制平面主機的叢集上執行本教學課程。如果您還沒有叢集，可以使用 minikube 建立一個，或者您可以使用以下 Kubernetes playground 之一

若要檢查版本，請輸入 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

Kompose 位於 EPEL CentOS 儲存庫中。如果您尚未安裝並啟用 EPEL 儲存庫，您可以執行 sudo yum install epel-release 來執行此操作。

如果您已在系統中啟用 EPEL，則可以像安裝任何其他套件一樣安裝 Kompose。

sudo yum -y install kompose

Kompose 位於 Fedora 24、25 和 26 儲存庫中。您可以像安裝任何其他套件一樣安裝它。

sudo dnf -y install 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

它也支援為服務中的 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 Deployments 和 Services，格式為 yaml。您可以使用 -j 選擇產生 json 的替代選項。此外，您可以選擇產生 Replication Controllers 物件、Daemon Sets 或 Helm charts。

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 物件。

如果您想要產生一個 Chart 以與 Helm 搭配使用，請執行

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 charts 提供骨架。

標籤

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"

目前支援的選項如下：

鍵 (Key)值 (Value)
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"

關於 Deployment Configurations 的警告

如果 Docker Compose 檔案為服務指定了 Volume，則 Deployment (Kubernetes) 或 DeploymentConfig (OpenShift) 策略將變更為 "Recreate" 而不是 "RollingUpdate" (預設)。這樣做是為了避免服務的多個實例同時存取同一個 Volume。

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

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

Docker Compose 版本

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

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

上次修改時間：2024 年 6 月 21 日上午 10:11 PST：修復映像檔拉取失敗問題並更新命令和輸出 (cca76d50c1)