Update README.md.
This commit is contained in:
parent
d8619a5190
commit
92bae8bd61
1 changed files with 43 additions and 2 deletions
45
README.md
45
README.md
|
@ -5,8 +5,21 @@ A resource type for a ssh resource
|
|||
## Source configuration
|
||||
|
||||
```
|
||||
|
||||
|
||||
resource_types:
|
||||
- name: ssh
|
||||
type: registry-image
|
||||
source:
|
||||
repository: redxef/concourse-ssh-resource
|
||||
resources:
|
||||
- name: my-server
|
||||
type: ssh
|
||||
source:
|
||||
hostname: ((my-server.hostname))
|
||||
port: ((my-server.port))
|
||||
user: ((my-server.user))
|
||||
identity: ((my-server.identity))
|
||||
hostkey: ((my-server.hostkey))
|
||||
files: []
|
||||
```
|
||||
|
||||
- hostname: *Required*. Servers hostname to connect to.
|
||||
|
@ -15,3 +28,31 @@ A resource type for a ssh resource
|
|||
- identity: *Required*. The private key used to authenticate.
|
||||
- hostkey: *Required*. The hostkey of the server.
|
||||
- files: *Optional*. File paths on the remote to get/put
|
||||
- directory: *Optional*. *Default* `$HOME`. The remote directory from which to base paths on.
|
||||
|
||||
## `check`
|
||||
|
||||
Check if any of the listed files on the remote server have been updated.
|
||||
|
||||
## `in` receive files
|
||||
|
||||
Receive all configured files.
|
||||
|
||||
## `out` push files and run command
|
||||
|
||||
Push all configured files to the server and run the specified command afterwards.
|
||||
|
||||
### Configuration
|
||||
|
||||
```
|
||||
- put: my-server
|
||||
params:
|
||||
command:
|
||||
- ls
|
||||
- -la
|
||||
```
|
||||
|
||||
### parameters
|
||||
|
||||
- workdir: *Optional*. *Default* `$HOME`. The remote directory to use as `cwd` when running commands.
|
||||
- command: *Optional*. *Default* `[true]`. A command to execute on the remote, given as list.
|
||||
|
|
Loading…
Reference in a new issue