tcwlab/dgoss

dgoss

镜像概述和主要用途

dgoss镜像是一个用于验证容器是否按预期行为和功能运行的工具镜像。该项目封装了goss和dgoss工具，主要聚焦于如何在CI/CD环境中使用这些工具进行容器验证，而非工具本身的详细使用方法。基于Docker官方镜像构建，整合了https://github.com/aelsabbahy%E7%9A%84https://github.com/aelsabbahy/goss/%E5%8A%9F%E8%83%BD%E3%80%82

核心功能和特性

• 封装goss和dgoss工具，提供容器验证能力
• 适用于CI/CD管道集成，特别是GitLab CI环境
• 支持通过goss.yaml配置文件定义容器验证规则
• 验证内容包括文件存在性、命令执行状态、输出内容等
• 基于Linux/amd64架构构建

使用场景和适用范围

• CI/CD流程中的容器测试阶段
• 验证容器内部文件系统、命令功能是否符合预期
• 自动化容器镜像质量检查
• 确保部署前容器行为符合设计要求

使用方法和配置说明

环境准备

• 需要待测试的容器镜像
• 配置goss.yaml验证规则文件
• CI/CD环境（以GitLab CI为例）

目录结构

bash
.
├── .gitlab-ci.yml  # CI配置文件
├── Dockerfile      # 待测试容器的构建文件
├── goss            # goss配置目录
│   └── goss.yaml   # 验证规则定义文件

GitLab CI配置（.gitlab-ci.yml）

在CI/CD管道中集成dgoss进行容器验证：

yaml
validate-image:
  stage: test
  image: tcwlab/dgoss:latest
  variables:
    # goss配置文件路径（相对于仓库根目录）
    GOSS_FILES_PATH: goss
    # 文件策略，用于某些平台的兼容性处理
    GOSS_FILES_STRATEGY: cp
  script:
    # 运行容器验证，替换<YOUR_CONTAINER_IMAGE>为实际镜像名
    - dgoss run -it <YOUR_CONTAINER_IMAGE>

完整配置示例可参考官方仓库。

Dockerfile示例

基础Dockerfile示例（非多阶段构建）：

Dockerfile
FROM tcwlab/dgoss:latest
RUN echo "hello from inside"

实际应用示例可参考官方Dockerfile。

goss.yaml配置文件

定义容器验证规则，示例如下：

yaml
file:
  # 验证goss二进制文件存在
  /usr/bin/goss:
    exists: true
    filetype: file
  # 验证dgoss脚本存在
  /usr/bin/dgoss:
    exists: true
    filetype: file
command:
  # 验证goss版本
  goss:
    exit-status: 0          # 期望退出状态码
    exec: "goss -v"         # 执行命令
    stdout:                 # 期望标准输出包含内容
      - goss version v0.3.16
    stderr: []              # 期望标准错误输出为空
    timeout: 10000          # 超时时间（毫秒）
    skip: false             # 是否跳过该检查
  # 验证dgoss命令使用说明
  dgoss:
    exit-status: 1          # 期望退出状态码（未提供参数时）
    exec: "dgoss"           # 执行命令
    stdout: []              # 期望标准输出为空
    stderr:                 # 期望标准错误输出包含内容
      - USAGE
    timeout: 10000          # 超时时间（毫秒）
    skip: false             # 是否跳过该检查

完整配置示例可参考官方goss.yaml。

项目信息

维护与支持

• 维护者：Sascha Willomitzer（TCWlab项目成员）
• 获取帮助：提交issue
• 支持架构：linux/amd64
• 镜像详情：源代码仓库
• 工具文档：goss和dgoss详细使用说明见https://github.com/aelsabbahy/goss/blob/master/README.md

路线图

项目计划功能和里程碑请查看项目看板。

许可证

本项目采用Apache License v2许可。

项目状态

本项目采用"尽力维护"模式，通过自动化方式进行大部分更新，没有专门的维护团队，不提供任何明示或暗示的担保。