自定义 Compose Bridge

实验性

Compose Bridge 是一个实验性产品。

此页面解释了 Compose Bridge 如何利用模板有效地将 Docker Compose 文件转换为 Kubernetes 清单。它还解释了如何根据您的具体需求自定义这些模板，或者如何构建您自己的转换。

工作原理

Compose Bridge 使用转换将 Compose 模型转换为其他形式。

转换打包为 Docker 镜像，该镜像接收完全解析的 Compose 模型作为/in/compose.yaml，并可以在/out下生成任何目标格式文件。

Compose Bridge 使用 Go 模板提供其 Kubernetes 转换，以便可以通过替换或附加您自己的模板轻松扩展以进行自定义。

语法

Compose Bridge 使用模板将 Compose 配置文件转换为 Kubernetes 清单。模板是使用Go 模板语法的纯文本文件。这使得可以插入逻辑和数据，使模板根据 Compose 模型变得动态和适应性强。

执行模板时，必须生成 YAML 文件，这是 Kubernetes 清单的标准格式。只要用---分隔，就可以生成多个文件。

每个 YAML 输出文件都以自定义标题表示法开头，例如

#! manifest.yaml

在下面的示例中，模板迭代compose.yaml文件中定义的服务。对于每个服务，都会生成一个专用的 Kubernetes 清单文件，其名称根据服务命名，并包含指定的配置。

{{ range $name, $service := .services }}
---
#! {{ $name }}-manifest.yaml
# Generated code, do not edit
key: value
## ...
{{ end }}

输入

输入 Compose 模型是您可以通过运行docker compose config获得的规范 YAML 模型。在模板中，使用点表示法访问compose.yaml中的数据，允许您浏览嵌套的数据结构。例如，要访问服务的部署模式，您可以使用service.deploy.mode

# iterate over a yaml sequence
{{ range $name, $service := .services }}
 # access a nested attribute using dot notation
 {{ if eq $service.deploy.mode "global" }}
kind: DaemonSet
 {{ end }}
{{ end }}

您可以查看Compose 规范 JSON 模式以全面了解 Compose 模型。此模式概述了 Compose 模型中所有可能的配置及其数据类型。

辅助工具

作为 Go 模板语法的一部分，Compose Bridge 提供了一组 YAML 辅助函数，旨在有效地操作模板中的数据。

seconds：将持续时间转换为整数
uppercase：将字符串转换为大写字符
title：通过将每个单词的首字母大写来转换字符串
safe：将字符串转换为安全的标识符，将所有字符（小写 a-z 除外）替换为-
truncate：从列表中删除前 N 个元素
join：使用分隔符将列表中的元素组合到单个字符串中
base64：将字符串编码为 base64，在 Kubernetes 中用于编码机密
map：根据表示为"value -> newValue"字符串的映射转换值
indent：编写缩进 N 个空格的字符串内容
helmValue：将字符串内容作为最终文件中的模板值写入

在下面的示例中，模板检查是否为服务指定了健康检查间隔，应用seconds函数将此间隔转换为秒，并将值赋给periodSeconds属性。

{{ if $service.healthcheck.interval }}
            periodSeconds: {{ $service.healthcheck.interval | seconds }}{{ end }}
{{ end }}

自定义

由于Kubernetes是一个多功能平台，因此有很多方法可以将Compose概念映射到Kubernetes资源定义中。Compose Bridge允许您自定义转换以匹配您自己的基础设施决策和偏好，并提供不同级别的灵活性和工作量。

修改默认模板

您可以通过运行compose-bridge transformations create --from docker/compose-bridge-kubernetes my-template并调整模板以满足您的需求，来提取默认转换docker/compose-bridge-kubernetes使用的模板。

模板被提取到一个以您的模板名称命名的目录中，在本例中为my-template。
它包括一个Dockerfile，允许您创建自己的镜像来分发您的模板，以及一个包含模板文件的目录。
您可以自由编辑现有文件、删除它们或添加新文件，以便随后生成满足您需求的Kubernetes清单。
然后，您可以使用生成的Dockerfile将您的更改打包到一个新的转换镜像中，然后您可以将其与Compose Bridge一起使用。

$ docker build --tag mycompany/transform --push .

然后您可以使用您的转换进行替换。

$ compose-bridge convert --transformations mycompany/transform

添加您自己的模板

对于Compose Bridge默认转换未管理的资源，您可以构建自己的模板。compose.yaml模型可能无法提供填充目标清单所需的所有配置属性。如果是这种情况，您可以依赖Compose自定义扩展来更好地描述应用程序，并提供一个与平台无关的转换。

例如，如果您在compose.yaml文件中服务的定义中添加x-virtual-host元数据，您可以使用以下自定义属性来生成Ingress规则。

{{ $project := .name }}
#! {{ $name }}-ingress.yaml
# Generated code, do not edit
apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
  name: virtual-host-ingress
  namespace: {{ $project }}
spec:
  rules:  
{{ range $name, $service := .services }}
{{ if $service.x-virtual-host }}
  - host: ${{ $service.x-virtual-host }}
    http:
      paths:
      - path: "/"
        backend:
          service:
            name: ${{ name }}
            port:
              number: 80  
{{ end }}
{{ end }}

打包到Docker镜像后，除了其他转换之外，您还可以使用此自定义模板将Compose模型转换为Kubernetes。

$ compose-bridge convert \
    --transformation docker/compose-bridge-kubernetes \
    --transformation mycompany/transform

构建您自己的转换

虽然Compose Bridge模板使您可以轻松地进行最小更改的自定义，但您可能需要进行重大更改，或依赖于现有的转换工具。

Compose Bridge转换是一个Docker镜像，旨在从/in/compose.yaml获取Compose模型，并在/out下生成平台清单。这个简单的约定使得使用Kompose打包替代转换变得很容易。

FROM alpine

# Get kompose from github release page
RUN apk add --no-cache curl
ARG VERSION=1.32.0
RUN ARCH=$(uname -m | sed 's/armv7l/arm/g' | sed 's/aarch64/arm64/g' | sed 's/x86_64/amd64/g') && \
    curl -fsL \
    "https://github.com/kubernetes/kompose/releases/download/v${VERSION}/kompose-linux-${ARCH}" \
    -o /usr/bin/kompose
RUN chmod +x /usr/bin/kompose

CMD ["/usr/bin/kompose", "convert", "-f", "/in/compose.yaml", "--out", "/out"]

此Dockerfile捆绑了Kompose，并根据Compose Bridge转换约定定义了运行此工具的命令。

下一步是什么？

探索高级集成