SSH

by appleboy

MIT License

插件源码README插件镜像 (Image)原始文档

使用 SSH 插件在远程服务器上执行命令。

YAML 配置示例

kind: pipeline
name: default

steps:
- name: ssh
  image: appleboy/drone-ssh
  settings:
    host:
      - example1.com
      - example2.com
    username: ubuntu
    password:
      from_secret: ssh_password
    port: 22
    command_timeout: 2m
    script:
      - echo "Hello World"

字段属性说明

• host

  string必填项

  服务器的主机名或 IP 地址。

  默认值：none

• port

  string可选项

  服务器的端口。

  默认值：22

• username

  string可选项

  目标主机用户的账户。

  默认值：none

• password

  string可选项

  登录服务器的密码。

  推荐使用密钥 (Secret) 功能

  默认值：none

• key

  string可选项

  用户私人密钥的纯文本

  推荐使用密钥 (Secret) 功能

  默认值：none

• key_path

  string可选项

  用于登录服务器的私人密钥的路径。

  默认值：none

• envs

  array可选项

  脚本部分提供的自定义秘密。

  默认值：none

• script

  string可选项

  要在服务器上执行的命令。

  默认值：none

• script_stop

  boolean可选项

  第一次失败后停止脚本。

  默认值：false

• timeout

  string可选项

  超时是 ssh 连接建立的最长时间。

  默认值：30s

• command_timeout

  string可选项

  命令超时是执行命令的最长时间

  默认值：10m

• proxy_host

  string可选项

  代理主机名或 IP 地址。

  默认值：none

• proxy_port

  string可选项

  代理端口。

  默认值：none

• proxy_username

  string可选项

  代理用户名。

  默认值：none

• proxy_password

  string可选项

  代理密码。

  推荐使用密钥 (Secret) 功能

  默认值：none

• proxy_key

  string可选项

  代理私人密钥的纯文本。

  推荐使用密钥 (Secret) 功能

  默认值：none

• proxy_key_path

  string可选项

  登录代理的私钥路径。

  默认值：none