pyrsh/concourse-ssh-resource

Concourse SSH资源镜像

 ![Docker Repository on Quay]([***] !stability-stable

Concourse CI的SSH资源工具

镜像概述

本镜像为Concourse CI提供SSH资源支持，允许用户在CI/CD流程中通过SSH连接远程机器并执行指定脚本，支持静态值和文件动态内容的占位符替换，适用于自动化部署、远程命令执行等场景。

核心功能

1. SSH远程执行：通过SSH在远程机器上运行指定脚本。
2. 占位符替换：支持静态值（value）和文件动态内容（file）的占位符替换，增强脚本灵活性。
3. 多解释器支持：可指定远程机器上的脚本解释器（如/bin/sh、/usr/bin/python3）。

使用场景

• CI/CD流程中远程服务器的自动化部署操作。
• 远程机器的批量命令执行任务。
• 需要动态参数替换的远程脚本执行场景。

配置说明

源配置（Source Configuration）

• host：远程机器的主机名或IP地址。
• port：SSH服务器端口，默认22。
• user：执行脚本的远程用户。
• password：远程用户的明文密码。
• private_key：远程用户的SSH私钥。

注意：若同时提供password和private_key，将优先使用password进行认证。

输出行为（out: Run commands via SSH）

该资源仅支持put操作（check和in无实际功能），用于执行远程脚本。

参数（Parameters）

• interpreter：远程机器上的脚本解释器路径，默认/bin/sh。
• script：需在远程机器执行的脚本内容。
• placeholders：占位符映射列表，每个占位符包含：
  • name：脚本中的占位符名称。
  • value：静态替换值（二选一）。
  • file：读取文件内容作为替换值（仅取第一行，二选一）。

示例配置

yaml
---
resource_types:
- name: ssh
  type: docker-image
  source:
    repository: quay.io/pyr-sh/concourse-ssh-resource

resources:
- name: staging-server
  type: ssh
  source:
    host: 127.0.0.1
    user: root
    password: ((ssh_password))

jobs:
- name: echo
  plan:
  # 基础用法
  - put: staging-server
    params:
      interpreter: /usr/bin/env python3
      script: |
        print("Hello, world!")
  # 占位符用法
  - put: staging-server
    params:
      interpreter: /bin/sh
      script: |
        echo "<static_value>"
        echo "|dynamic_value|"
      placeholders:
        - name: "<static_value>"
          value: "foo"
        - name: "|dynamic_value|"
          file: "bar"

测试方法

1. 启动测试SSH服务器：docker run -d -p 22:22 quay.io/pyr-sh/alpine-ssh
2. 执行测试：make test

贡献者

按字母顺序排列：

• https://github.com/EugenMayer

许可证

MIT