自定义 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.在模板中，来自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 资源定义中。组成 Bridge 允许您自定义转换以匹配您自己的基础设施决策和偏好，具有不同程度的灵活性和努力。

修改默认模板

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

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

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

然后，您可以使用转换作为替换：

$ compose-bridge convert --transformations mycompany/transform

添加您自己的模板

对于不受 Compose Bridge 默认转换管理的资源，您可以构建自己的模板。这compose.yamlmodel 可能无法提供全部填充目标清单所需的配置属性。如果是这种情况，您可以然后依靠 Compose 自定义扩展来更好地描述应用程序，并提供不可知的转换。

例如，如果您将x-virtual-host元数据到compose.yamlfile 中，您可以使用以下自定义属性要生成 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 镜像，旨在获取 Compose 模型从/in/compose.yaml并在/out.这个简单 contract 使得使用 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 转换协定中。

下一步是什么？

探索高级集成