cfje/tomcat-resource

Tomcat Concourse Resource 镜像文档

概述

Tomcat Concourse Resource是专为Concourse CI/CD流水线设计的资源类型，用于与Apache Tomcat服务器进行交互。它提供了在流水线中部署Java Web应用（WAR/EAR包）、检查应用状态、执行版本回滚等核心能力，旨在简化Java Web项目与Tomcat服务器集成的持续集成/持续部署（CI/CD）流程，提升流水线自动化程度。

核心功能与特性

• 应用部署：支持将WAR/EAR格式的应用包部署到Tomcat服务器的指定上下文路径，兼容Tomcat 7+版本。
• 状态检查：定期检查Tomcat服务器上应用的部署状态（如运行状态、版本信息、部署时间），支持异常状态识别。
• 版本管理：跟踪部署到Tomcat的应用版本，支持基于版本标识的精准部署和历史版本回滚。
• 安全认证：集成Tomcat Manager认证机制，支持基本认证（需配置manager-script角色），保障服务器交互安全性。
• 轻量集成：与Concourse流水线无缝对接，配置简单，无需编写复杂脚本即可实现自动化交互。

使用场景与适用范围

• Java Web应用CI/CD流水线：适用于使用Tomcat作为应用服务器的Java Web项目，需在Concourse中实现从构建到部署的全自动化流程。
• 多环境部署管理：支持开发、测试、生产等多环境Tomcat服务器的差异化配置，实现环境隔离的部署流程。
• 部署验证与监控：需在流水线中自动验证应用部署状态，确保部署成功后再执行后续步骤（如通知、集成测试）的场景。
• 版本化部署与回滚：需要对Tomcat上的应用版本进行记录和管理，支持故障时快速回滚到稳定版本的场景。

使用方法与配置说明

1. 资源类型定义（Resource Type）

在Concourse流水线配置（pipeline.yml）中，首先需定义Tomcat Concourse Resource的资源类型：

yaml
resource_types:
- name: tomcat-resource
  type: docker-image
  source:
    repository: [镜像仓库地址]  # 例如：your-registry/tomcat-concourse-resource
    tag: latest  # 或指定具体版本，如v1.0.0

2. 资源实例配置（Resource）

定义具体的Tomcat资源实例，配置与目标Tomcat服务器的连接信息：

yaml
resources:
- name: prod-tomcat
  type: tomcat-resource
  source:
    tomcat_url: "http://prod-tomcat:8080"  # Tomcat服务器基础URL（含协议、主机、端口）
    username: "tomcat-admin"  # Tomcat管理用户名（需具备manager-script角色）
    password: ((tomcat-password))  # Tomcat管理密码（建议通过Concourse Secrets管理）
    app_path: "/my-webapp"  # 应用部署上下文路径（默认使用WAR包文件名，不含.war后缀）
    manager_path: "/manager"  # Tomcat Manager应用路径（默认/manager，部分环境可能自定义）

source参数说明：

• tomcat_url：必填，Tomcat服务器的基础访问URL（如http://tomcat:8080）。
• username：必填，Tomcat管理用户，需在tomcat-users.xml中配置manager-script角色。
• password：必填，Tomcat管理用户密码，建议通过Concourse Secrets（如Vault、CredHub）引用，避免明文。
• app_path：可选，应用部署后的上下文路径（如/app），默认使用WAR包文件名（如myapp.war对应/myapp）。
• manager_path：可选，Tomcat Manager的访问路径，默认/manager（Tomcat默认配置），若自定义需修改。

3. 流水线任务配置（Job）

通过Concourse任务（Job）中的get（检查）和put（部署/回滚）步骤使用资源。

3.1 部署应用（put操作）

将构建产物（WAR包）部署到Tomcat服务器：

yaml
jobs:
- name: deploy-to-tomcat
  plan:
  - get: webapp-source  # 假设通过git/s3等资源获取源码或WAR包
    trigger: true  # 源码变更时触发部署
  - task: build-war  # 若需构建，可添加编译任务（如Maven/Gradle构建）
    config:
      platform: linux
      image_resource:
        type: docker-image
        source: {repository: maven, tag: 3.8.5-openjdk-11}
      inputs: [{name: webapp-source}]
      outputs: [{name: webapp-war}]
      run:
        path: sh
        args:
          - -c
          - |
            cd webapp-source
            mvn clean package -DskipTests
            cp target/*.war ../webapp-war/
  - put: prod-tomcat  # 部署到Tomcat
    params:
      war_path: webapp-war/*.war  # WAR包在流水线工作目录中的路径（支持通配符）
      version: "${BUILD_ID}"  # 可选，版本标识（如Concourse构建ID，用于版本跟踪）

部署参数（params）：

• war_path：必填，WAR包在流水线工作目录中的相对路径（支持*.war通配符匹配单个文件）。
• version：可选，自定义版本标识字符串（如构建号、Git Commit ID），用于后续回滚或状态检查。

3.2 检查部署状态（get操作）

获取Tomcat上应用的当前状态（如版本、运行状态）：

yaml
jobs:
- name: verify-deployment
  plan:
  - get: prod-tomcat  # 检查Tomcat应用状态
    trigger: false  # 不自动触发，需手动或通过上游任务触发
    params:
      output_file: deployment-status.json  # 可选，状态输出文件（默认deployment-status.json）
  - task: print-status  # 打印状态信息（示例）
    config:
      platform: linux
      image_resource:
        type: docker-image
        source: {repository: alpine, tag: latest}
      inputs: [{name: prod-tomcat}]
      run:
        path: cat
        args: [prod-tomcat/deployment-status.json]

检查参数（params）：

• output_file：可选，指定状态输出文件路径（默认在资源目录下生成deployment-status.json），文件包含应用版本、部署时间、运行状态等信息。

3.3 版本回滚（put操作）

回滚到Tomcat上的历史版本：

yaml
jobs:
- name: rollback-tomcat
  plan:
  - put: prod-tomcat  # 执行回滚
    params:
      rollback: true  # 启用回滚模式
      target_version: "1234"  # 需回滚到的版本标识（与部署时的version参数对应）

回滚参数（params）：

• rollback：必填，设为true启用回滚功能。
• target_version：必填，需回滚到的历史版本标识（必须是之前部署时通过version参数指定的值）。

注意事项

• Tomcat配置要求：需确保Tomcat服务器启用Manager应用（默认位于webapps/manager），并在conf/tomcat-users.xml中配置具备manager-script角色的用户，示例：

  xml
  <role rolename="manager-script"/>
  <user username="admin" password="secure-password" roles="manager-script"/>
  

• WAR包兼容性：部署的WAR包需与Tomcat版本兼容（如Servlet规范版本匹配），避免因兼容性问题导致部署失败。
• 敏感信息保护：Tomcat用户名/密码等敏感信息需通过Concourse Secrets管理（如((secret-name))引用），禁止明文写入流水线配置。
• 网络可达性：Concourse Worker需能够访问Tomcat服务器的8080端口（或自定义端口）及Manager路径，确保网络通畅。