ssh

Documentation

Overview

Package ssh manages servers over the system ssh client, so ~/.ssh/config, agents, keys and jump hosts work exactly as they do in a terminal.

Index

• func New(_ core.Env, c *spec.Component) (any, error)
• type Host
• type Options
• type SSH
  • func (s *SSH) Actions() []core.Action
  • func (s *SSH) Hosts(ctx context.Context) ([]core.Host, error)
  • func (s *SSH) Shell(ctx context.Context, name string, command []string) (*exec.Cmd, error)

Functions

func New

func New(_ core.Env, c *spec.Component) (any, error)

Types

type Host

type Host struct {
	Name   string            `yaml:"name"`
	Addr   string            `yaml:"addr"`
	User   string            `yaml:"user"`
	Port   int               `yaml:"port"`
	Key    string            `yaml:"key"`
	Jump   string            `yaml:"jump"`
	Roles  []string          `yaml:"roles"`
	Labels map[string]string `yaml:"labels"`
}

type Options

type Options struct {
	Defaults Host   `yaml:"defaults"`
	Hosts    []Host `yaml:"hosts"`
}

type SSH

type SSH struct {
	// contains filtered or unexported fields
}

func (*SSH) Actions

func (s *SSH) Actions() []core.Action

func (*SSH) Hosts

func (s *SSH) Hosts(ctx context.Context) ([]core.Host, error)

func (*SSH) Shell

func (s *SSH) Shell(ctx context.Context, name string, command []string) (*exec.Cmd, error)