cfje/artifactory-resource

Artifactory Concourse Resource

概述

Artifactory Concourse Resource是专为Concourse CI/CD平台设计的资源类型，用于与JFrog Artifactory制品仓库深度集成。通过该资源，用户可在Concourse管道中实现对Artifactory制品的自动化管理，包括制品的上传、下载、版本跟踪及元数据操作，无缝衔接CI/CD流程中的构建、测试与部署环节。

核心功能与特性

• 制品双向传输：支持从Concourse任务向Artifactory上传制品（out操作）及从Artifactory下载制品至Concourse任务（in操作）。
• 版本自动跟踪：通过check操作自动检测Artifactory中制品的版本变化，支持基于路径、属性、时间戳等规则的版本筛选。
• 元数据管理：支持读取和写入制品元数据（如构建信息、环境标签、自定义属性），增强制品可追溯性。
• 多制品类型支持：兼容Artifactory支持的各类制品格式，包括Docker镜像、Maven/Gradle包、npm包、RPM/DEB包、通用文件等。
• 安全凭据管理：支持通过Concourse Credentials Manager或环境变量配置Artifactory访问凭据，避免明文信息暴露。

使用场景与适用范围

• CI流程制品上传：构建任务完成后，自动将生成的二进制制品（如应用包、Docker镜像）上传至Artifactory指定仓库。
• CD流程制品下载：部署任务执行前，从Artifactory下载指定版本的制品至部署环境。
• 制品版本控制：在多环境部署（开发、测试、生产）中，通过版本跟踪确保使用正确的制品版本。
• 元数据驱动部署：基于制品元数据（如测试结果、构建编号）触发条件化部署流程。
• 多团队协作：跨团队共享Artifactory制品时，通过标准化资源配置确保访问一致性。

使用方法与配置说明

资源定义

在Concourse Pipeline配置（pipeline.yml）中，通过resource_types声明资源类型（若未全局注册），并在resources中定义Artifactory资源实例。

1. 资源类型声明（如需）

yaml
resource_types:
- name: artifactory-resource
  type: docker-image
  source:
    repository: releases-docker.jfrog.io/jfrog/artifactory-concourse-resource
    tag: latest  # 建议指定具体版本，如v1.15.0

2. 资源实例定义

yaml
resources:
- name: my-artifactory-artifact
  type: artifactory-resource
  source:
    url: https://my-artifactory.example.com/artifactory  # Artifactory实例URL
    username: ((artifactory-username))  # 访问凭据（通过Concourse Credentials Manager注入）
    password: ((artifactory-password))
    repo: my-generic-repo  # Artifactory仓库名称（需提前创建）
    path: my-apps/  # 制品存储路径（支持通配符，如my-apps/*.tar.gz）
    # 可选配置
    pattern: "*.tar.gz"  # 制品文件名匹配模式（若path中未包含）
    build_name: my-app-build  # 关联的构建名称（用于元数据关联）
    build_number: ((build-number))  # 构建编号（可通过任务输出注入）
    properties:  # 制品元数据属性（键值对）
      environment: production
      team: backend

资源操作

Artifactory资源支持Concourse资源的三种标准操作：check（版本检测）、in（制品输入）、out（制品输出）。

1. Check操作（版本检测）

自动检测Artifactory中符合source.path和pattern的制品版本，返回最新版本信息（按修改时间或版本号排序）。
触发条件：Pipeline启动、定时触发或手动触发。
输出：版本列表（含制品路径、修改时间、版本号等）。

2. In操作（制品输入）

将Artifactory中的制品下载至Concourse任务工作目录。
任务配置示例：

yaml
jobs:
- name: download-artifact
  plan:
  - get: my-artifactory-artifact
    trigger: true  # 检测到新版本时自动触发
  - task: use-artifact
    config:
      platform: linux
      image_resource:
        type: docker-image
        source: {repository: alpine}
      inputs:
      - name: my-artifactory-artifact  # 下载的制品存放于该目录
      run:
        path: sh
        args:
        - -c
        - |
          ls -l my-artifactory-artifact/  # 列出下载的制品

3. Out操作（制品输出）

将Concourse任务生成的制品上传至Artifactory。
任务配置示例：

yaml
jobs:
- name: upload-artifact
  plan:
  - task: build-artifact
    config:
      platform: linux
      image_resource:
        type: docker-image
        source: {repository: alpine}
      outputs:
      - name: build-output  # 任务输出目录（存放待上传制品）
      run:
        path: sh
        args:
        - -c
        - |
          echo "hello world" > build-output/my-app-v1.0.0.tar.gz  # 生成示例制品
  - put: my-artifactory-artifact
    params:
      file: build-output/*.tar.gz  # 待上传制品路径（相对于任务输出目录）
      # 可选参数
      flatten: true  # 是否移除本地目录结构，仅上传文件
      props:  # 覆盖或追加元数据属性
        version: 1.0.0
        commit: ((git-commit-sha))

关键配置参数说明

安全注意事项

• 凭据管理：避免在配置中明文填写username/password，通过Concourse Credentials Manager（如Vault、CredHub）或环境变量注入敏感信息。
• 权限控制：Artifactory用户应遵循最小权限原则，仅授予资源所需的仓库读写权限（如read权限用于in操作，write权限用于out操作）。
• TLS加密：确保Artifactory URL使用https协议，避免传输过程中凭据或制品数据泄露。

版本兼容性

• 支持Concourse CI v6.0.0+。
• 支持Artifactory v6.0.0+（推荐v7.0.0+以获取完整元数据功能）。
• 资源镜像版本建议与Artifactory版本匹配，具体参考官方版本矩阵。