ssh-action/README.md

222 lines
4.9 KiB
Markdown
Raw Normal View History

# 🚀 SSH for GitHub Actions
2019-05-14 16:31:53 +00:00
[GitHub Action](https://github.com/features/actions) for executing remote ssh commands.
2019-09-29 03:09:26 +00:00
![ssh workflow](./images/ssh-workflow.png)
[![Actions Status](https://github.com/appleboy/ssh-action/workflows/remote%20ssh%20command/badge.svg)](https://github.com/appleboy/ssh-action/actions)
## Usage
Executing remote ssh commands.
2019-09-29 03:09:26 +00:00
```yaml
2019-09-29 06:16:47 +00:00
name: remote ssh command
on: [push]
jobs:
build:
name: Build
runs-on: ubuntu-latest
steps:
- name: executing remote ssh commands using password
uses: appleboy/ssh-action@master
with:
host: ${{ secrets.HOST }}
username: ${{ secrets.USERNAME }}
password: ${{ secrets.PASSWORD }}
port: ${{ secrets.PORT }}
script: whoami
```
2019-09-29 03:09:26 +00:00
output:
```sh
======CMD======
whoami
======END======
out: ***
==============================================
✅ Successfully executed commands to all host.
==============================================
```
2019-09-29 03:09:26 +00:00
## Input variables
2019-11-21 14:53:08 +00:00
See [action.yml](./action.yml) for more detailed information.
2019-05-14 22:47:53 +00:00
2019-11-21 14:53:08 +00:00
* host - remote host
* port - remote port, default is `22`
* username - ssh username
* password - ssh password
2019-09-29 03:09:26 +00:00
* timeout - timeout for ssh to remote host, default is `30s`
* command_timeout - timeout for ssh command, default is `10m`
2019-09-29 03:09:26 +00:00
* key - content of ssh private key. ex raw content of ~/.ssh/id_rsa
* key_path - path of ssh private key
* script - execute commands
* script_stop - stop script after first failure
* envs - pass environment variable to shell script
* debug - enable debug mode
2019-05-14 22:47:53 +00:00
2019-12-07 12:05:02 +00:00
SSH Proxy Setting:
* proxy_host - proxy host
* proxy_port - proxy port, default is `22`
* proxy_username - proxy username
* proxy_password - proxy password
* proxy_timeout - timeout for ssh to proxy host, default is `30s`
* proxy_key - content of ssh proxy private key.
* proxy_key_path - path of ssh proxy private key
2019-09-29 03:09:26 +00:00
### Example
2019-05-14 22:47:53 +00:00
2019-09-29 03:09:26 +00:00
Executing remote ssh commands using password.
```yaml
- name: executing remote ssh commands using password
uses: appleboy/ssh-action@master
with:
host: ${{ secrets.HOST }}
username: ${{ secrets.USERNAME }}
password: ${{ secrets.PASSWORD }}
port: ${{ secrets.PORT }}
2019-09-29 03:45:42 +00:00
script: whoami
2019-05-14 22:47:53 +00:00
```
Using private key
2019-09-29 03:09:26 +00:00
```yaml
- name: executing remote ssh commands using ssh key
uses: appleboy/ssh-action@master
with:
host: ${{ secrets.HOST }}
username: ${{ secrets.USERNAME }}
key: ${{ secrets.KEY }}
port: ${{ secrets.PORT }}
script: whoami
2019-05-14 22:47:53 +00:00
```
2019-05-14 22:52:59 +00:00
Multiple Commands
2019-09-29 03:09:26 +00:00
```yaml
- name: multiple command
uses: appleboy/ssh-action@master
with:
host: ${{ secrets.HOST }}
username: ${{ secrets.USERNAME }}
key: ${{ secrets.KEY }}
port: ${{ secrets.PORT }}
script: |
whoami
ls -al
2019-05-14 22:52:59 +00:00
```
2019-09-29 03:09:26 +00:00
![result](./images/output-result.png)
2019-05-14 22:59:18 +00:00
2019-05-14 23:13:49 +00:00
Multiple Hosts
2019-09-29 03:09:26 +00:00
```diff
- name: multiple host
uses: appleboy/ssh-action@master
with:
- host: "foo.com"
+ host: "foo.com,bar.com"
username: ${{ secrets.USERNAME }}
key: ${{ secrets.KEY }}
port: ${{ secrets.PORT }}
script: |
whoami
ls -al
2019-05-14 23:13:49 +00:00
```
Pass environment variable to shell script
```diff
- name: pass environment
uses: appleboy/ssh-action@master
+ env:
+ FOO: "BAR"
2019-12-07 23:16:30 +00:00
+ BAR: "FOO"
with:
host: ${{ secrets.HOST }}
username: ${{ secrets.USERNAME }}
key: ${{ secrets.KEY }}
port: ${{ secrets.PORT }}
2019-12-07 23:16:30 +00:00
+ envs: FOO,BAR
script: |
echo "I am $FOO"
echo "I am $BAR"
```
2019-09-29 04:02:21 +00:00
Stop script after first failure. ex: missing `abc` folder
```diff
- name: stop script if command error
uses: appleboy/ssh-action@master
with:
host: ${{ secrets.HOST }}
username: ${{ secrets.USERNAME }}
key: ${{ secrets.KEY }}
port: ${{ secrets.PORT }}
+ script_stop: true
script: |
mkdir abc/def
ls -al
```
output:
```sh
======CMD======
mkdir abc/def
ls -al
======END======
2019/11/21 01:16:21 Process exited with status 1
err: mkdir: cannot create directory abc/def: No such file or directory
##[error]Docker run failed with exit code 1
2019-09-29 04:02:21 +00:00
```
2019-12-07 12:05:02 +00:00
How to connect remote server using `ProxyCommand`?
```bash
+--------+ +----------+ +-----------+
| Laptop | <--> | Jumphost | <--> | FooServer |
+--------+ +----------+ +-----------+
```
in your `~/.ssh/config`, you will see the following.
```bash
Host Jumphost
HostName Jumphost
User ubuntu
Port 22
IdentityFile ~/.ssh/keys/jump_host.pem
Host FooServer
HostName FooServer
User ubuntu
Port 22
ProxyCommand ssh -q -W %h:%p Jumphost
```
How to convert to YAML format of GitHubActions.
```diff
- name: ssh proxy command
uses: appleboy/ssh-action@master
with:
host: ${{ secrets.HOST }}
username: ${{ secrets.USERNAME }}
key: ${{ secrets.KEY }}
port: ${{ secrets.PORT }}
+ proxy_host: ${{ secrets.PROXY_HOST }}
+ proxy_username: ${{ secrets.PROXY_USERNAME }}
+ proxy_key: ${{ secrets.PROXY_KEY }}
+ proxy_port: ${{ secrets.PROXY_PORT }}
script: |
mkdir abc/def
ls -al
```