wisshes

README

wisshes

wisshes Is SSH + Extra Steps

What

Pure GO answer to Infrastructure as Code tools like Ansible

Documentation

Index

• Variables
• func ArtifactsDir() string
• func CtxSSHClient(ctx context.Context) *goph.Client
• func CtxWithInventory(ctx context.Context, inv *Inventory) context.Context
• func CtxWithPreviousStep(ctx context.Context, step StepStatus) context.Context
• func CtxWithSSHClient(ctx context.Context, client *goph.Client) context.Context
• func Run(ctx context.Context, steps ...Step) error
• func RunFn(client *goph.Client, format string, args ...any) (string, error)
• func TempDir() string
• type AptitudeStatus
• type CtxKey
• type Inventory
  • func CtxInventory(ctx context.Context) *Inventory
  • func NewInventory(rootPassword string, namesAndIPs ...string) (inv *Inventory, err error)
  • func (inv *Inventory) Close()
  • func (inv *Inventory) Run(ctx context.Context, steps ...Step) (StepStatus, error)
• type Step
  • func Aptitude(desiredStatus AptitudeStatus, packageNames ...string) Step
  • func Commands(cmds ...string) Step
  • func FileRemote(remotePath string, contents []byte) Step
  • func IfCond(cond bool, steps ...Step) Step
  • func IfPreviousChanged(steps ...Step) Step
  • func RunAll(steps ...Step) Step
  • func Ternary(cond bool, ifTrue, ifFalse Step) Step
• type StepStatus
  • func CtxPreviousStep(ctx context.Context) StepStatus

Variables

var WishDir = ".wisshes"

Functions

func ArtifactsDir

func ArtifactsDir() string

func CtxSSHClient

func CtxSSHClient(ctx context.Context) *goph.Client

func CtxWithInventory

func CtxWithInventory(ctx context.Context, inv *Inventory) context.Context

func CtxWithPreviousStep

func CtxWithPreviousStep(ctx context.Context, step StepStatus) context.Context

func CtxWithSSHClient

func CtxWithSSHClient(ctx context.Context, client *goph.Client) context.Context

func Run

func Run(ctx context.Context, steps ...Step) error

func RunFn

func RunFn(client *goph.Client, format string, args ...any) (string, error)

func TempDir

func TempDir() string

Types

type AptitudeStatus

type AptitudeStatus string

const (
	AptitudeStatusUninstalled AptitudeStatus = "uninstalled"
	AptitudeStatusInstalled   AptitudeStatus = "installed"
)

type CtxKey

type CtxKey string

type Inventory

type Inventory struct {
	Hosts     []*goph.Client
	HostNames []string
}

func CtxInventory

func CtxInventory(ctx context.Context) *Inventory

func NewInventory

func NewInventory(rootPassword string, namesAndIPs ...string) (inv *Inventory, err error)

func (*Inventory) Close

func (inv *Inventory) Close()

func (*Inventory) Run

func (inv *Inventory) Run(ctx context.Context, steps ...Step) (StepStatus, error)

type Step

type Step func(ctx context.Context) (revisedCtx context.Context, name string, status StepStatus, err error)

func Aptitude

func Aptitude(desiredStatus AptitudeStatus, packageNames ...string) Step

func Commands

func Commands(cmds ...string) Step

func FileRemote

func FileRemote(remotePath string, contents []byte) Step

func IfCond

func IfCond(cond bool, steps ...Step) Step

func IfPreviousChanged

func IfPreviousChanged(steps ...Step) Step

func RunAll

func RunAll(steps ...Step) Step

func Ternary

func Ternary(cond bool, ifTrue, ifFalse Step) Step

type StepStatus

type StepStatus string

const (
	StepStatusUnchanged StepStatus = "unchanged"
	StepStatusChanged   StepStatus = "changed"
	StepStatusFailed    StepStatus = "failed"
)

func CtxPreviousStep

func CtxPreviousStep(ctx context.Context) StepStatus