mirror of https://github.com/tektoncd/catalog.git synced 2024-11-21 05:55:35 +00:00

History

Quan Zhang e294e1246b [TEP-0110] Update Tekton Catalog installation instructions Prior to this change, the installation instructions directly use the resource urls in the Catalog repo, which results in tight coupling between the organization and how users fetch resources (as described in TEP-0110). This commit updates the installation guide to install Tekton Catalog resources via Tekton Hub Api: https://github.com/tektoncd/hub/pull/539 This change decouples the Tekton Catalog organization from resouces resolution, which enables Tekton Catalog reorganization.		2022-08-16 16:25:52 +01:00
..
samples	Add task which can run shell commands on remote Host	2020-07-24 10:26:00 +01:00
README.md	[TEP-0110] Update Tekton Catalog installation instructions	2022-08-16 16:25:52 +01:00
remote-ssh-commands.yaml	Add linux/amd64 platform annotation to the rest of the tasks	2021-10-29 17:08:38 +01:00

README.md

Remote SSH Commands

This task can be used to run shell commands on remote machine and produce the result. It is done by SSHing into the remote Host by providing the required credentials and the shell script which we want to run over there.

Install the Task

kubectl apply -f https://api.hub.tekton.dev/v1/resource/tekton/task/remote-ssh-commands/0.1/raw

Parameters

HOST: The server host to which you want to connect. (Required)
USERNAME: Connect as an user. (Required)
PORT: Port number to connect (default: 22).
SSH_SCRIPT: The shell script which you want to run on remote host. (Required)
USE_INSECURE_CIPHER: Boolean value to include ciphers or not. (default:"false")

Workspaces

credentials: The workspace contains secrets can be used to authenticate with the HOST.
Secrets
- privatekey: The private SSH key in case public SSH key is present on host.
- passphrase: The passphrase used at the time of generating the private key for encryption.
- password: User password to connect to host.
- fingerprint: Fingerprint SHA256 of the host public key, default is to skip verification.
- ciphers: The allowed cipher algorithms. If unspecified then a sensible.

Platforms

The Task can be run on linux/amd64 platform.

Usage

Create the Secret by putting in the required values

apiVersion: v1
kind: Secret
type: Opaque
metadata:
  name: remote-ssh-secret
data:
  passphrase: passphrase
  privatekey: privatekey

Create the TaskRun

apiVersion: tekton.dev/v1beta1
kind: TaskRun
metadata:
  name: remote-ssh-commands-run
spec:
  taskRef:
    name: remote-ssh-commands
  workspaces:
    - name: credentials
      secret:
        secretName: remote-ssh-secret
  params:
    - name: HOST
      value: "127.0.0.1"
    - name: USERNAME
      value: "username"
    - name: SSH_SCRIPT
      value: |
        #!/bin/sh
        hostname
        echo "--------"
        pwd
        ls -a

Output

$ tkn t logs -f
? Select task: remote-ssh-commands
[ssh] + export 'script=#!/bin/sh
[ssh] hostname
[ssh] echo --------
[ssh] pwd
[ssh] ls -a
[ssh] '
[ssh] + cmd=
[ssh] + '[[' -f ./privatekey ]]
[ssh] + cmd=' -i ./privatekey'
[ssh] + '[[' -f ./password ]]
[ssh] + '[[' -f ./passphrase ]]
[ssh] + cat ./passphrase
[ssh] + cmd=' -i ./privatekey --ssh-passphrase XXXXXX'
[ssh] + '[[' -f ./fingerprint ]]
[ssh] + '[[' -f ./ciphers ]]
[ssh] + '[[' false '==' true ]]
[ssh] + drone-ssh -H 127.0.0.1 -p 22 -u username -s '#!/bin/sh
[ssh] hostname
[ssh] echo --------
[ssh] pwd
[ssh] ls -a
[ssh] ' -i ./privatekey --ssh-passphrase 'XXXXX'
[ssh] ======CMD======
[ssh] #!/bin/sh
[ssh] hostname
[ssh] echo --------
[ssh] pwd
[ssh] ls -a
[ssh]
[ssh] ======END======
[ssh] out: ssh-test
[ssh] out: --------
[ssh] out: /home/username
[ssh] out: .
[ssh] out: ..
[ssh] out: .bash_history
[ssh] out: .bash_logout
[ssh] out: .bashrc
[ssh] out: .gnupg
[ssh] out: .profile
[ssh] out: .ssh
[ssh] out: desktop
[ssh] ==============================================
[ssh] ✅ Successfully executed commands to all host.
[ssh] ==============================================