Overview
An ssh
pipeline executes shell commands on remote servers using the ssh protocol. This is useful for workloads that need to run directly on the host, or are poorly suited for execution inside containers.
Example pipeline configuration:
1 ---
2 kind: pipeline
3 type: ssh
4 name: default
5
6 server:
7 host: 1.2.3.4
8 user: root
9 password:
10 from_secret: password
11
12 steps:
13 - name: greeting
14 commands:
15 - echo hello world
16
17 ...
The kind and type attributes define an ssh pipeline.
1 ---
2 kind: pipeline
3 type: ssh
The steps section defines a series of shell commands. These commands are executed on the remote server using the ssh protocol. If any command returns a non-zero exit code, the pipeline fails and exits.
1 steps:
2 - name: greeting
3 commands:
4 - echo hello world