Skip to content

Egress SSH/SFTP

Responsibility

SSH command execution and SFTP file operations via capability providers.

This page covers the egress-ssh service. A separate standalone SFTP service registers sftp.list / sftp.download / sftp.upload (no egress. prefix).

Capabilities (egress-ssh)

Capability Path Purpose
egress.ssh.exec /exec Remote command execution
egress.ssh.sftp /sftp SFTP actions on the SSH service

Capabilities (standalone sftp service)

Capability Path
sftp.list /sftp/list
sftp.download /sftp/download
sftp.upload /sftp/upload
sftp.connection connection type

Architecture

Capability providers (see Deploy integration contract):

  • Register with capability-registry at startup
  • Orchestrator discovers endpoints via the registry
  • No first-class type: ssh / type: sftp workflow steps — use service_call

Inbound Authentication

  • internal-only services, called by orchestrator after registry lookup

Outbound Authentication

  • username/password and/or private key credentials from connection/step payload

Example workflow step (SSH exec)

- id: remote_df
  type: service_call
  capability_name: egress.ssh.exec
  capability_version: "^1.0"
  path: /exec
  connection: my_ssh
  payload: |
    {
      "command": "df -h"
    }
  timeout_seconds: 60

Example workflow step (standalone SFTP list)

- id: list_files
  type: service_call
  capability_name: sftp.list
  capability_version: "^1.0"
  path: /sftp/list
  connection: my_sftp
  payload: |
    {
      "remote_path": "."
    }

Key Config

  • SSH timeout and host key/network access controls

Health

  • GET /healthz
  • GET /readyz
  • GET /internal/capabilities