Pipekit CLI Docker镜像文档

镜像概述

Pipekit CLI Docker镜像是一个预打包了Pipekit命令行工具的容器化镜像，旨在为用户提供便捷、一致的Pipekit CLI运行环境。该镜像消除了本地安装Pipekit及其依赖的需求，允许用户直接通过容器执行Pipekit命令，高效管理Kubernetes环境中的工作流、管道及相关资源。

核心功能与特性

• 完整工具链：包含最新稳定版Pipekit CLI，支持所有官方命令及功能
• Kubernetes集成：原生支持与Kubernetes集群交互，可直接管理工作流、管道、任务等资源
• 环境一致性：容器化设计确保在不同环境（开发、测试、CI/CD）中运行行为一致，避免依赖冲突
• 轻量级设计：基于精简基础镜像构建，体积小、启动快，资源占用低
• 灵活配置：支持通过挂载配置文件、传递环境变量等方式自定义运行参数

使用场景

• 开发环境快速上手：开发者无需在本地配置Pipekit依赖，直接通过容器体验完整功能
• CI/CD流程集成：在CI/CD流水线中嵌入容器化Pipekit命令，自动化执行管道部署、工作流触发等操作
• 多环境统一管理：在不同Kubernetes集群或命名空间中，通过统一镜像确保命令执行一致性
• 临时任务处理：用于故障排查、资源审计等临时操作，完成后即销毁容器，无残留配置

使用方法与配置说明

基本使用

通过docker run命令直接执行Pipekit CLI命令，基础语法：

docker run --rm pipekit/cli:latest <pipekit-command> [arguments]

示例：查看CLI版本

docker run --rm pipekit/cli:latest version

示例：获取帮助信息

docker run --rm pipekit/cli:latest --help

连接Kubernetes集群

Pipekit CLI需访问Kubernetes集群以管理资源，通常通过挂载本地kubeconfig文件实现：

docker run --rm \
  -v $HOME/.kube/config:/root/.kube/config \
  pipekit/cli:latest \
  kubeconfig get-contexts  # 列出Kubernetes上下文

说明：容器内默认使用/root/.kube/config作为Kubernetes配置路径，挂载本地配置文件后即可访问目标集群

环境变量配置

通过-e参数传递环境变量，自定义CLI行为：

示例：启用调试日志

docker run --rm \
  -e PIPEKIT_LOG_LEVEL=debug \
  -v $HOME/.kube/config:/root/.kube/config \
  pipekit/cli:latest \
  workflow list  # 查看工作流列表（带调试日志）

持久化配置

如需保存Pipekit CLI的本地配置（如常用集群、默认参数等），可挂载配置目录：

docker run --rm \
  -v $HOME/.kube/config:/root/.kube/config \
  -v $HOME/.pipekit:/root/.pipekit \  # 持久化Pipekit配置
  pipekit/cli:latest \
  config set default-namespace production  # 设置默认命名空间

docker-compose配置示例

创建docker-compose.yml简化多参数场景下的使用：

version: '3.8'
services:
  pipekit:
    image: pipekit/cli:latest
    volumes:
      - $HOME/.kube/config:/root/.kube/config:ro  # 只读挂载kubeconfig
      - $HOME/.pipekit:/root/.pipekit            # 持久化配置
    environment:
      - PIPEKIT_LOG_LEVEL=info
      - PIPEKIT_NAMESPACE=default

通过compose执行命令：

docker-compose run --rm pipekit workflow create my-workflow.yaml