codefresh/engine

Codefresh 运行时引擎

镜像概述

Codefresh 运行时引擎是 Codefresh DevOps 平台的核心组件，负责执行 CI/CD 流水线任务，支持自动化构建、测试和部署流程。该引擎基于容器化技术，与 Codefresh 平台深度集成，提供高效、可扩展的任务执行环境，适用于开发团队的持续集成与持续部署需求。

核心功能与特性

• CI/CD 任务执行：支持执行构建、测试、部署等完整CI/CD流水线步骤，自动化软件交付流程
• 容器化架构：基于Docker容器运行，确保执行环境一致性，避免依赖冲突
• 平台集成：与Codefresh平台无缝对接，支持从平台控制台配置和管理流水线任务
• 可配置性：通过环境变量和配置文件自定义执行参数，适应不同项目需求
• 日志与监控：提供详细任务执行日志，支持问题排查和流程优化

使用场景与适用范围

• 开发团队CI/CD自动化：适用于需要自动化构建、测试和部署流程的开发团队，提升交付效率
• 多环境部署管理：支持开发、测试、生产等多环境的自动化部署，确保部署一致性
• 持续集成测试：集成单元测试、集成测试流程，在代码提交后自动触发测试任务
• DevOps流程优化：帮助团队落地DevOps最佳实践，缩短从开发到生产的交付周期

使用方法与配置说明

基本使用（Docker Run）

通过docker run命令启动引擎并执行指定CI/CD任务：

bash
docker run -d \
  --name codefresh-runtime \
  -e CODEFRESH_API_TOKEN="your-api-token" \
  -e PIPELINE_ID="your-pipeline-id" \
  -v /var/run/docker.sock:/var/run/docker.sock \
  codefresh/runtime-engine:latest

环境变量配置

使用示例

Docker Compose配置

创建docker-compose.yml文件：

yaml
version: '3'
services:
  codefresh-runtime:
    image: codefresh/runtime-engine:latest
    container_name: codefresh-runtime
    environment:
      - CODEFRESH_API_TOKEN=your-api-token
      - PIPELINE_ID=your-pipeline-id
      - LOG_LEVEL=info
      - TIMEOUT=3600
    volumes:
      - /var/run/docker.sock:/var/run/docker.sock
      - ./workdir:/codefresh
    restart: unless-stopped

启动服务：

bash
docker-compose up -d

配置文件说明

除环境变量外，可通过挂载配置文件进行高级配置。默认配置文件路径为/codefresh/config.yaml，支持定义流水线步骤、资源限制、通知设置等。示例配置片段：

yaml
pipeline:
  steps:
    - name: build
      type: build
      image: docker:latest
      commands: ["docker build -t my-app:latest ."]
  resources:
    cpu: 1
    memory: 2G
notifications:
  slack:
    webhook: "https://hooks.slack.com/services/XXX"

注意事项

1. 确保Docker环境版本≥19.03，以支持容器化执行特性
2. CODEFRESH_API_TOKEN需从Codefresh平台获取，需具备流水线执行权限
3. 挂载/var/run/docker.sock用于与主机Docker守护进程通信，支持容器内构建镜像操作
4. 任务执行日志可通过docker logs codefresh-runtime命令查看