sup

package module
v0.7.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 26, 2020 License: MIT Imports: 17 Imported by: 0

README

分支说明

更新远地址已过时的内容

安装

go install github.com/millim/sup

Documentation

Index

Constants

View Source 
const VERSION = "0.5"

Variables

View Source 
var (
	Colors = []string{
		"\033[32m",
		"\033[33m",
		"\033[36m",
		"\033[35m",
		"\033[31m",
		"\033[34m",
	}
	ResetColor = "\033[0m"
)

Functions

func LocalTarCmdArgs 

func LocalTarCmdArgs(path, exclude string) []string

func NewTarStreamReader 

func NewTarStreamReader(cwd, path, exclude string) (io.Reader, error)

NewTarStreamReader creates a tar stream reader from a local path. TODO: Refactor. Use "archive/tar" instead.

func RemoteTarCommand 

func RemoteTarCommand(dir string) string

RemoteTarCommand returns command to be run on remote SSH host to properly receive the created TAR stream. TODO: Check for relative directory.

func ResolveLocalPath 

func ResolveLocalPath(cwd, path, env string) (string, error)

Types

type Client 

type Client interface {
	Connect(host string) error
	Run(task *Task) error
	Wait() error
	Close() error
	Prefix() (string, int)
	Write(p []byte) (n int, err error)
	WriteClose() error
	Stdin() io.WriteCloser
	Stderr() io.Reader
	Stdout() io.Reader
	Signal(os.Signal) error
}

type Command 

type Command struct {
	Name   string   `yaml:"-"`      // Command name.
	Desc   string   `yaml:"desc"`   // Command description.
	Local  string   `yaml:"local"`  // Command(s) to be run locally.
	Run    string   `yaml:"run"`    // Command(s) to be run remotelly.
	Script string   `yaml:"script"` // Load command(s) from script and run it remotelly.
	Upload []Upload `yaml:"upload"` // See Upload struct.
	Stdin  bool     `yaml:"stdin"`  // Attach localhost STDOUT to remote commands' STDIN?
	Once   bool     `yaml:"once"`   // The command should be run "once" (on one host only).
	Serial int      `yaml:"serial"` // Max number of clients processing a task in parallel.

	// API backward compatibility. Will be deprecated in v1.0.
	RunOnce bool `yaml:"run_once"` // The command should be run once only.
}

Command represents command(s) to be run remotely.

type Commands 

type Commands struct {
	Names []string
	// contains filtered or unexported fields
}

Commands is a list of user-defined commands

func (*Commands) Get 

func (c *Commands) Get(name string) (Command, bool)

func (*Commands) UnmarshalYAML 

func (c *Commands) UnmarshalYAML(unmarshal func(interface{}) error) error

type EnvList 

type EnvList []*EnvVar

EnvList is a list of environment variables that maps to a YAML map, but maintains order, enabling late variables to reference early variables.

func (*EnvList) AsExport 

func (e *EnvList) AsExport() string

func (*EnvList) ResolveValues 

func (e *EnvList) ResolveValues() error

func (*EnvList) Set 

func (e *EnvList) Set(key, value string)

Set key to be equal value in this list.

func (EnvList) Slice 

func (e EnvList) Slice() []string

func (*EnvList) UnmarshalYAML 

func (e *EnvList) UnmarshalYAML(unmarshal func(interface{}) error) error

type EnvVar 

type EnvVar struct {
	Key   string
	Value string
}

EnvVar represents an environment variable

func (EnvVar) AsExport 

func (e EnvVar) AsExport() string

AsExport returns the environment variable as a bash export statement

func (EnvVar) String 

func (e EnvVar) String() string

type ErrConnect 

type ErrConnect struct {
	User   string
	Host   string
	Reason string
}

func (ErrConnect) Error 

func (e ErrConnect) Error() string

type ErrMustUpdate 

type ErrMustUpdate struct {
	Msg string
}

func (ErrMustUpdate) Error 

func (e ErrMustUpdate) Error() string

type ErrTask 

type ErrTask struct {
	Task   *Task
	Reason string
}

func (ErrTask) Error 

func (e ErrTask) Error() string

type ErrUnsupportedSupfileVersion 

type ErrUnsupportedSupfileVersion struct {
	Msg string
}

func (ErrUnsupportedSupfileVersion) Error 

func (e ErrUnsupportedSupfileVersion) Error() string

type LocalhostClient 

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

Client is a wrapper over the SSH connection/sessions.

func (*LocalhostClient) Close 

func (c *LocalhostClient) Close() error

func (*LocalhostClient) Connect 

func (c *LocalhostClient) Connect(_ string) error

func (*LocalhostClient) Prefix 

func (c *LocalhostClient) Prefix() (string, int)

func (*LocalhostClient) Run 

func (c *LocalhostClient) Run(task *Task) error

func (*LocalhostClient) Signal 

func (c *LocalhostClient) Signal(sig os.Signal) error

func (*LocalhostClient) Stderr 

func (c *LocalhostClient) Stderr() io.Reader

func (*LocalhostClient) Stdin 

func (c *LocalhostClient) Stdin() io.WriteCloser

func (*LocalhostClient) Stdout 

func (c *LocalhostClient) Stdout() io.Reader

func (*LocalhostClient) Wait 

func (c *LocalhostClient) Wait() error

func (*LocalhostClient) Write 

func (c *LocalhostClient) Write(p []byte) (n int, err error)

func (*LocalhostClient) WriteClose 

func (c *LocalhostClient) WriteClose() error

type Network 

type Network struct {
	Env       EnvList  `yaml:"env"`
	Inventory string   `yaml:"inventory"`
	Hosts     []string `yaml:"hosts"`
	Bastion   string   `yaml:"bastion"` // Jump host for the environment

	// Should these live on Hosts too? We'd have to change []string to struct, even in Supfile.
	User         string // `yaml:"user"`
	IdentityFile string // `yaml:"identity_file"`
}

Network is group of hosts with extra custom env vars.

func (Network) ParseInventory 

func (n Network) ParseInventory() ([]string, error)

ParseInventory runs the inventory command, if provided, and appends the command's output lines to the manually defined list of hosts.

type Networks 

type Networks struct {
	Names []string
	// contains filtered or unexported fields
}

Networks is a list of user-defined networks

func (*Networks) Get 

func (n *Networks) Get(name string) (Network, bool)

func (*Networks) UnmarshalYAML 

func (n *Networks) UnmarshalYAML(unmarshal func(interface{}) error) error

type SSHClient 

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

Client is a wrapper over the SSH connection/sessions.

func (*SSHClient) Close 

func (c *SSHClient) Close() error

Close closes the underlying SSH connection and session.

func (*SSHClient) Connect 

func (c *SSHClient) Connect(host string) error

Connect creates SSH connection to a specified host. It expects the host of the form "[ssh://]host[:port]".

func (*SSHClient) ConnectWith 

func (c *SSHClient) ConnectWith(host string, dialer SSHDialFunc) error

ConnectWith creates a SSH connection to a specified host. It will use dialer to establish the connection. TODO: Split Signers to its own method.

func (*SSHClient) DialThrough 

func (sc *SSHClient) DialThrough(net, addr string, config *ssh.ClientConfig) (*ssh.Client, error)

DialThrough will create a new connection from the ssh server sc is connected to. DialThrough is an SSHDialer.

func (*SSHClient) Prefix 

func (c *SSHClient) Prefix() (string, int)

func (*SSHClient) Run 

func (c *SSHClient) Run(task *Task) error

Run runs the task.Run command remotely on c.host.

func (*SSHClient) Signal 

func (c *SSHClient) Signal(sig os.Signal) error

func (*SSHClient) Stderr 

func (c *SSHClient) Stderr() io.Reader

func (*SSHClient) Stdin 

func (c *SSHClient) Stdin() io.WriteCloser

func (*SSHClient) Stdout 

func (c *SSHClient) Stdout() io.Reader

func (*SSHClient) Wait 

func (c *SSHClient) Wait() error

Wait waits until the remote command finishes and exits. It closes the SSH session.

func (*SSHClient) Write 

func (c *SSHClient) Write(p []byte) (n int, err error)

func (*SSHClient) WriteClose 

func (c *SSHClient) WriteClose() error

type SSHDialFunc 

type SSHDialFunc func(net, addr string, config *ssh.ClientConfig) (*ssh.Client, error)

SSHDialFunc can dial an ssh server and return a client

type Stackup 

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

func New 

func New(conf *Supfile) (*Stackup, error)

func (*Stackup) Debug 

func (sup *Stackup) Debug(value bool)

func (*Stackup) Prefix 

func (sup *Stackup) Prefix(value bool)

func (*Stackup) Run 

func (sup *Stackup) Run(network *Network, envVars EnvList, commands ...*Command) error

Run runs set of commands on multiple hosts defined by network sequentially. TODO: This megamoth method needs a big refactor and should be split 

to multiple smaller methods.

type Supfile 

type Supfile struct {
	Networks Networks `yaml:"networks"`
	Commands Commands `yaml:"commands"`
	Targets  Targets  `yaml:"targets"`
	Env      EnvList  `yaml:"env"`
	Version  string   `yaml:"version"`
}

Supfile represents the Stack Up configuration YAML file.

func NewSupfile 

func NewSupfile(data []byte) (*Supfile, error)

NewSupfile parses configuration file and returns Supfile or error.

type Targets 

type Targets struct {
	Names []string
	// contains filtered or unexported fields
}

Targets is a list of user-defined targets

func (*Targets) Get 

func (t *Targets) Get(name string) ([]string, bool)

func (*Targets) UnmarshalYAML 

func (t *Targets) UnmarshalYAML(unmarshal func(interface{}) error) error

type Task 

type Task struct {
	Run     string
	Input   io.Reader
	Clients []Client
	TTY     bool
}

Task represents a set of commands to be run.

type Upload 

type Upload struct {
	Src string `yaml:"src"`
	Dst string `yaml:"dst"`
	Exc string `yaml:"exclude"`
}

Upload represents file copy operation from localhost Src path to Dst path of every host in a given Network.

Source Files

View all Source files

Directories

Path Synopsis
cmd
sup

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.