workerlib

Documentation

Overview

Package workerlib encompasses the set of functions that a worker may execute, like uploading files to target machines, executing commands over SSH, WinRM, etc.

Index

• func Load(options ...Option) script.Option
• type Dependencies
• type Option
  • func WithSSH(env ssh.Environment) Option

Functions

func Load

func Load(options ...Option) script.Option

Load is a script Option that loads worker libraries into a script's execution environment.

Types

type Dependencies

type Dependencies struct {
	SSH ssh.Environment
}

Dependencies holds library dependencies that may be accessed by workerlib functions.

type Option

type Option func(*Dependencies)

An Option enables configuration of workerlib dependencies.

func WithSSH

func WithSSH(env ssh.Environment) Option

WithSSH configures the dependencies used by SSH methods.