dronelab/artifactory

Dronelab

镜像概述和主要用途

Dronelab是一个包装器和Docker镜像集，旨在让用户能够在Gitlab CI管道中使用Drone CI插件。它通过转换参数和环境变量，使Drone CI插件能够在Gitlab CI环境中正常工作，无需对插件本身进行修改。

核心功能和特性

• Drone插件兼容：支持在Gitlab CI中直接使用现有的Drone CI插件，无需重写或适配
• 多参数提供方式：支持通过环境变量、YAML格式变量、命令行参数等多种方式为插件提供参数
• 参数优先级处理：明确不同参数提供方式的优先级，确保参数设置的灵活性
• 秘密管理：支持Gitlab CI的秘密变量，可直接用于Drone插件的认证配置
• 多执行器支持：兼容Gitlab CI的Docker、Docker Machine、Docker Machine SSH和Kubernetes等执行器

使用场景和适用范围

适用于需要在Gitlab CI管道中使用Drone CI插件的场景，尤其是当团队已经有现成的Drone插件，但希望在Gitlab CI环境中复用这些插件时。例如：文件下载、云服务部署、消息通知等常见CI/CD任务。

详细使用方法和配置说明

基本用法

以下以Download插件为例，展示在Gitlab CI中使用Dronelab的基本方式。

在Drone中的基本用法：

yaml
# .drone.yml
pipeline:
  download:
    image: plugins/download
    source: https://example.com/file.tar.gz

在Gitlab CI中使用Dronelab的对应配置：

yaml
download:
  image: dronelab/download
  script: dronelab
  variables:
    source: https://example.com/file.tar.gz

说明：

• 使用dronelab/[插件名]作为镜像
• 必须指定script: dronelab（Gitlab CI要求script为必填项）
• 通过variables提供插件所需参数

参数提供方式

1. 作为单个YAML变量提供参数

可将插件参数以YAML字符串形式放在plugin变量中，适用于需要提供对象类型参数的场景：

yaml
download:
  image: dronelab/download
  script: dronelab
  variables:
    plugin: |
      source: https://example.com/file.tar.gz

对于需要复杂参数（如对象）的插件（如CloudFormation插件）：

Drone中的配置：

yaml
# .drone.yml
pipeline:
  deploy:
    image: robertstettner/drone-cloudformation
    stackname: my-awesome-stack
    template: templates/stack.yml
    params:
      Version: 123
      Environment: staging

Gitlab CI中使用Dronelab的配置：

yaml
awscf:
  image: dronelab/cloudformation
  script: dronelab
  variables:
    stackname: my-awesome-stack
    template: templates/stack.yml
    plugin: |
      params:
        Version: 123
        Environment: staging

2. 作为dronelab命令的参数提供

通过-p选项为dronelab命令提供参数，适用于需要覆盖模板变量的场景：

yaml
.awscf-template: &cftemplate
  image: dronelab/cloudformation
  variables:
    template: templates/stack.yml
    plugin: |
      params:
        Version: 123
        Environment: staging

stackone:
  <<: *cftemplate
  script: dronelab -p stackname stackone

stacktwo:
  <<: *cftemplate
  script: dronelab -p stackname stacktwo

可多次使用-p选项提供多个参数：

yaml
stackthree:
  <<: *cftemplate
  script: >
    dronelab
    -p stackname stacktwo
    -p region eu-west-1
    -p mode createOrUpdate

3. 秘密和直接创建插件变量

Drone插件通常通过环境变量工作，Dronelab会自动将参数转换为PLUGIN_<变量名>格式的环境变量。对于秘密参数，Drone插件通常使用<插件名>_<变量名>格式（无PLUGIN_前缀），可通过Gitlab CI的CI/CD变量配置。

以Matrix插件为例，假设在Gitlab CI/CD设置中配置了MATRIX_PASSWORD秘密变量：

yaml
message-one:
  image: dronelab/matrix
  script: dronelab
  variables:
    username: matrix_user
    homeserver: https://matrix.org
    roomid: abcdefghijklmnopqrstuvwxyz:matrix.org
    template: Hello from Gitlab!

也可显式引用秘密变量：

yaml
message-two:
  image: dronelab/matrix
  script: dronelab
  variables:
    username: matrix_user
    password: $MATRIX_PASSWORD
    homeserver: https://matrix.org
    roomid: abcdefghijklmnopqrstuvwxyz:matrix.org
    template: Hello from Gitlab!

参数优先级

当通过多种方式提供相同参数时，优先级从低到高为：

1. 直接提供的PLUGIN_<变量名>或秘密变量（如<插件名>_<变量名>）
2. variables中的独立变量
3. plugin YAML变量
4. 通过-p选项提供的命令行参数

示例：

yaml
download:
  image: dronelab/download
  script: dronelab -p source https://example.com/file_version_1.gz  # 优先级最高
  variables:
    source: https://example.com/file_version_2.gz  # 优先级次之
    plugin: |
      source: https://example.com/file_version_3.gz  # 优先级最低

上述配置将使用https://example.com/file_version_1.gz作为source参数。

与Drone使用的区别

步骤间的制品

在Drone中，所有插件共享同一个工作空间，步骤间的文件自动可用。在Gitlab CI中，若全局缓存未启用，需显式配置cache或artifacts以在作业间传递文件。

工作原理

Dronelab镜像基于Alpine构建，包含dronelab二进制文件。其工作流程如下：

1. 读取通过各种方式提供的参数
2. 将参数转换为Drone插件期望的环境变量格式（如PLUGIN_<变量名>）
3. 转换Gitlab CI的预定义变量为Drone兼容格式
4. 执行DRONELAB环境变量指定的上游插件二进制文件

注意：并非所有Drone环境变量在Dronelab中都可用，部分变量可能格式不同，但大多数插件仅依赖少量变量，因此兼容性良好。

联系方式

如需报告bug或提问，请https://github.com/mprasil/dronelab/issues/new%E3%80%82