使用drone-scp插件在Drone CI/CD中通过SSH复制文件

drone-scp是一个用于Drone CI/CD系统的插件，它允许你在构建管道中通过SSH协议复制文件和构建产物到远程服务器。下面我将详细介绍如何使用这个插件。

基本概念

drone-scp插件主要功能：

• 通过SSH连接远程服务器
• 上传文件或目录
• 支持SCP和SFTP协议
• 可配置SSH密钥认证

安装与配置

1. 在.drone.yml中添加步骤

kind: pipeline
type: docker
name: default

steps:
- name: build
  image: golang:1.18
  commands:
    - go build -o myapp ./cmd/myapp

- name: deploy
  image: appleboy/drone-scp
  settings:
    host: your-server.com
    username: deploy
    port: 22
    key: 
      from_secret: ssh_key
    source: myapp
    target: /home/deploy/apps/
    rm: true

2. 配置SSH密钥

在Drone的仓库设置中添加一个名为ssh_key的secret，值为你的SSH私钥内容。

详细配置选项

- name: deploy
  image: appleboy/drone-scp
  settings:
    # 必填项
    host: your-server.com       # 远程服务器地址
    username: deploy            # SSH用户名
    port: 22                    # SSH端口
    key: 
      from_secret: ssh_key      # SSH私钥
    
    # 文件传输相关
    source: "dist/*"            # 要上传的文件/目录(支持通配符)
    target: "/var/www/html"     # 远程目标路径
    rm: true                    # 上传前删除目标目录内容
    overwrite: true             # 覆盖已存在文件
    timeout: 60                 # 超时时间(秒)
    
    # 可选配置
    command_timeout: 10         # 命令执行超时
    strip_components: 0         # 去除源路径中的前N级目录
    tar_tmp_path: "/tmp"        # 临时tar文件路径
    tar_exec: "tar"             # tar命令路径
    
    # 调试选项
    debug: true                 # 启用调试输出
    verbose: true               # 详细输出

实际示例

示例1：部署Go应用

steps:
- name: build
  image: golang:1.18
  commands:
    - go build -o app ./cmd/app
    - tar czf app.tar.gz app

- name: deploy
  image: appleboy/drone-scp
  settings:
    host: production.example.com
    username: deploy
    port: 2222
    key:
      from_secret: production_key
    source: app.tar.gz
    target: /tmp/
    strip_components: 1

示例2：部署前端项目

steps:
- name: build
  image: node:16
  commands:
    - npm install
    - npm run build

- name: deploy
  image: appleboy/drone-scp
  settings:
    host: web.example.com
    username: www-data
    port: 22
    key:
      from_secret: web_key
    source: dist/*
    target: /var/www/html
    rm: true
    overwrite: true

高级用法

1. 使用多个目标

- name: deploy
  image: appleboy/drone-scp
  settings:
    host:
      - server1.example.com
      - server2.example.com
    username: deploy
    key:
      from_secret: ssh_key
    source: build/*
    target: /opt/myapp/

2. 使用密码认证

- name: deploy
  image: appleboy/drone-scp
  settings:
    host: legacy.example.com
    username: olduser
    password:
      from_secret: ssh_password
    source: app
    target: /home/olduser/app

3. 执行远程命令

- name: deploy
  image: appleboy/drone-scp
  settings:
    host: db.example.com
    username: admin
    key:
      from_secret: db_key
    source: migrations/*.sql
    target: /tmp/migrations/
    command: 
      - "mysql -u root -p$$DB_PASSWORD mydb < /tmp/migrations/latest.sql"
    env:
      DB_PASSWORD:
        from_secret: db_password

常见问题解决

1. 权限问题：确保目标目录对SSH用户可写
2. 连接超时：检查防火墙设置和SSH服务是否运行
3. 认证失败：验证SSH密钥是否正确，确保公钥已添加到远程服务器的~/.ssh/authorized_keys
4. 路径问题：使用绝对路径更可靠

安全建议

1. 使用SSH密钥而非密码
2. 为CI/CD创建专用部署用户
3. 限制部署用户的权限
4. 定期轮换SSH密钥

通过合理配置drone-scp插件，你可以轻松实现构建产物的自动化部署，提高CI/CD流程的效率。