saops/k8s-bitbucket-pipe

k8s pipe 镜像文档

镜像概述

k8s pipe 是一个轻量级的 Kubernetes 工作流管道工具镜像，专注于简化容器化应用在 K8s 集群中的自动化部署流程。通过直观的工作流定义与任务编排，帮助开发与运维团队实现 CI/CD 流程的标准化与自动化，减少人工操作成本，提升部署效率与系统可靠性。

核心功能与特性

核心功能

• 工作流定义：支持 YAML/JSON 格式的工作流配置文件，可定义多阶段任务序列（如构建、测试、部署）
• 任务调度：基于 K8s 原生资源（如 Job、CronJob）实现任务调度，支持并行/串行任务执行
• 依赖管理：支持任务间依赖关系配置（如前置任务完成后执行后续任务）
• 状态监控：提供工作流执行状态实时反馈，支持失败重试与通知机制（邮件、Webhook）
• K8s 原生集成：直接对接 K8s API，支持集群内资源（Deployment、Service 等）的创建与更新

特性

• 轻量级：镜像体积小于 100MB，资源占用低
• 无状态设计：支持水平扩展，适合多节点部署
• 配置灵活：支持自定义环境变量、挂载卷及 K8s 认证配置
• 兼容性强：支持 K8s 1.18+ 版本，兼容主流云厂商 K8s 服务（EKS、GKE、ACK 等）

使用场景与适用范围

适用场景

• 开发环境自动化部署：代码提交后自动触发构建、测试、部署至开发集群
• 生产环境持续交付：通过审批节点控制生产环境部署，支持灰度发布与回滚
• 多集群应用管理：统一管理跨多 K8s 集群的应用部署流程
• 定时任务执行：配置周期性任务（如数据备份、日志清理）

适用用户

• 中小型团队的 DevOps 工程师
• 需要简化 K8s 部署流程的开发团队
• 对 CI/CD 自动化有需求的运维团队

使用方法与配置说明

前置要求

• 已安装 Docker 1.19+
• 目标 K8s 集群版本 1.18+，且客户端（宿主机）已配置 kubectl 访问权限（或提供 KUBECONFIG 文件）

快速启动（docker run）

基本用法

bash
docker run -d \
  --name k8s-pipe \
  -v $HOME/.kube/config:/root/.kube/config:ro \  # 挂载 K8s 认证配置
  -v /path/to/workflows:/workflows:ro \          # 挂载工作流配置文件目录
  -e LOG_LEVEL=info \                           # 日志级别（debug/info/warn/error）
  k8s-pipe:latest \
  --workflow /workflows/deploy-app.yaml         # 指定工作流配置文件

带通知功能的启动

bash
docker run -d \
  --name k8s-pipe \
  -v $HOME/.kube/config:/root/.kube/config:ro \
  -v /path/to/workflows:/workflows:ro \
  -e NOTIFY_WEBHOOK_URL="https://your-webhook-service" \  # 配置通知 Webhook
  -e NOTIFY_LEVEL=success,failure \                       # 通知触发条件（成功/失败）
  k8s-pipe:latest \
  --workflow /workflows/prod-deploy.yaml \
  --namespace prod \                                      # 指定 K8s 命名空间
  --retry 3                                              # 任务失败重试次数

docker-compose 配置示例

yaml
version: "3.8"
services:
  k8s-pipe:
    image: k8s-pipe:latest
    container_name: k8s-pipe
    restart: always
    volumes:
      - $HOME/.kube/config:/root/.kube/config:ro
      - ./workflows:/workflows:ro
      - ./logs:/logs  # 挂载日志目录
    environment:
      - LOG_LEVEL=info
      - KUBECONFIG=/root/.kube/config
      - WORKFLOW_DIR=/workflows
    command: --watch /workflows  # 监控工作流配置文件变化并自动执行

配置参数说明

工作流配置文件示例（deploy-app.yaml）

yaml
name: deploy-app
namespace: dev
tasks:
  - name: build-image
    type: job
    image: docker:20.10
    command: ["docker", "build", "-t", "my-app:latest", "."]
    volumes:
      - /var/run/docker.sock:/var/run/docker.sock  # 挂载 Docker 套接字

  - name: deploy-to-k8s
    type: k8s-apply
    depends_on: [build-image]  # 依赖 build-image 任务完成
    manifest: |
      apiVersion: apps/v1
      kind: Deployment
      metadata:
        name: my-app
      spec:
        replicas: 3
        selector:
          matchLabels:
            app: my-app
        template:
          metadata:
            labels:
              app: my-app
          spec:
            containers:
              - name: my-app
                image: my-app:latest
                ports:
                  - containerPort: 8080

注意事项

1. 挂载 KUBECONFIG 时需确保宿主机 kubectl 有权限操作目标 K8s 集群
2. 工作流配置文件中 type: k8s-apply 任务会直接执行 kubectl apply -f -，请确保配置内容正确
3. 生产环境建议通过环境变量或密钥管理服务注入敏感信息（如镜像仓库凭证）
4. 日志默认输出至标准输出，如需持久化可挂载日志目录并指定 --log-file 参数