ioagel/linkerd-await

ioagel/linkerd-await镜像文档

镜像概述

ioagel/linkerd-await是一个轻量级工具镜像，专为在Linkerd服务网格环境中运行的Kubernetes作业（Jobs）和定时任务（CronJobs）设计。其核心功能是解决因Linkerd代理注入导致的作业无法正常完成问题，确保作业能够干净地启动和关闭。

核心功能与特性

• Linkerd代理协调：提供与Linkerd代理的就绪状态同步机制
• 干净关闭支持：确保作业完成后正确关闭Linkerd代理，避免作业挂起
• 轻量级设计：镜像体积小，资源占用低
• Kubernetes原生集成：与Kubernetes Jobs/CronJobs无缝配合
• 灵活配置：支持通过命令参数自定义行为

使用场景

适用于所有在Linkerd服务网格中运行的Kubernetes任务：

• 需要确保正常退出的批处理作业
• 定时执行的CronJobs
• 任何启用了Linkerd注入（linkerd.io/inject: enabled）的一次性任务

使用方法与配置说明

前提条件

• Kubernetes集群已部署Linkerd服务网格
• 目标作业已配置Linkerd注入（通过注解linkerd.io/inject: enabled）

基本配置步骤

1. 添加init容器：使用linkerd-await镜像将工具复制到共享卷
2. 配置共享卷：创建emptyDir卷用于在init容器和主容器间共享工具
3. 主容器配置：使用linkerd-await作为入口命令，指定实际作业脚本

Kubernetes CronJob配置示例

yaml
apiVersion: batch/v1
kind: CronJob
metadata:
  name: mysql-backup-job
spec:
  # 每天00:00执行备份
  schedule: "0 0 * * *"
  jobTemplate:
    spec:
      template:
        metadata:
          annotations:
            linkerd.io/inject: enabled  # 启用Linkerd注入
            config.linkerd.io/skip-outbound-ports: "22"  # 跳过SSH端口的Linkerd代理
        spec:
          restartPolicy: OnFailure
          # init容器：复制linkerd-await工具到共享卷
          initContainers:
            - name: linkerd-await
              image: ioagel/linkerd-await:0.2.7
              command: [ "cp" ]
              args: [ "/tmp/linkerd-await", "/linkerd/await" ]
              volumeMounts:
                - mountPath: /linkerd
                  name: linkerd-await
          containers:
            - name: mysql-backup
              image: ioagel/mysql-rsync:8.0
              command: [ "/linkerd/await" ]  # 使用linkerd-await作为入口命令
              args: [ "--shutdown", "--", "/scripts/backup_mysql.sh" ]  # 配置关闭参数和实际作业脚本
              env:
                # 环境变量配置（根据实际需求调整）
                - name: MYSQL_HOST
                  value: mysql-cluster
                - name: MYSQL_PORT
                  value: "6447"
                # 其他环境变量...
              volumeMounts:
                - name: backup-script
                  mountPath: /scripts
                  readOnly: true
                - mountPath: /linkerd
                  name: linkerd-await
                  readOnly: true
                # 其他卷挂载...
          volumes:
            - name: backup-script
              configMap:
                name: backup-script-cm
                defaultMode: 0755
            - name: linkerd-await
              emptyDir: { }  # 共享卷，用于传递linkerd-await工具
            # 其他卷配置...

命令参数说明

卷配置说明

• linkerd-await卷：必须配置为emptyDir类型，用于在init容器和主容器之间共享linkerd-await工具
• 其他卷：根据实际作业需求配置（如脚本卷、密钥卷等）

注解配置

• linkerd.io/inject: enabled：启用Linkerd代理注入
• config.linkerd.io/skip-outbound-ports：指定不需要Linkerd代理的端口（如SSH的22端口）