herd

package module

Go to main page

Versions in this module

v0

v0.14.0

Jan 22, 2025

Changes in this version

+ type ColorConfig struct

+ Command string

+ HostCancel string

+ HostError string

+ HostFail string

+ HostOK string

+ HostStderr string

+ HostStdout string

+ LogDebug string

+ LogError string

+ LogInfo string

+ LogWarn string

+ Provider string

+ Summary string

+ func (c ColorConfig) Merge(other ColorConfig) ColorConfig

type Host

+ LastResult *Result

type HostSet

+ func (s *HostSet) Filter(f func(*Host) bool) *HostSet

type Registry

+ func (r *Registry) AddGlobPrefix(prefix string, fnc func(string, *HostSet) (*HostSet, error))

+ func (r *Registry) GlobPrefixes() []string

type Result

+ func (r *Result) UnmarshalJSON(data []byte) error

type Runner

+ func (r *Runner) GetHostTimeout() time.Duration

v0.13.1

Oct 15, 2024

v0.13.0

Jul 8, 2024

v0.12.2

May 23, 2024

v0.12.1

Nov 9, 2023

v0.12.0

Jul 24, 2023

Changes in this version

type HostListOptions

+ CountAll bool

v0.11.0

Feb 14, 2023

Changes in this version

+ func VersionTuple() (major, minor, patch int)

type Host

+ func (h *Host) MarshalJSON() ([]byte, error)

+ type HostKeyProvider interface

+ LoadHostKeys func(ctx context.Context, l LoadingMessage) (map[string][]ssh.PublicKey, error)

type HostListOptions

+ Group string

type Registry

+ func (r *Registry) LoadHostKeys(ctx context.Context, lm LoadingMessage) error

type Runner

+ func (r *Runner) Interrupt()

+ func (r *Runner) OnSignal(s os.Signal, f func())

v0.10.0

Dec 8, 2022

Changes in this version

type Cache

+ Keep func()

+ type HostSet struct

+ func MergeHostSets(sets []*HostSet) *HostSet

+ func NewHostSet() *HostSet

+ func (s *HostSet) AddHost(host *Host)

+ func (s *HostSet) AddHosts(hosts *HostSet)

+ func (s *HostSet) Get(i int) *Host

+ func (s *HostSet) Len() int

+ func (s *HostSet) MarshalJSON() ([]byte, error)

+ func (s *HostSet) Remove(glob string, attrs MatchAttributes)

+ func (s *HostSet) Sample(attributes []string, count int)

+ func (s *HostSet) Search(hostnameGlob string, attributes MatchAttributes) *HostSet

+ func (s *HostSet) SetSortFields(attributes []string)

+ func (s *HostSet) Sort()

+ func (s *HostSet) String() string

+ func (s *HostSet) Uniq()

+ func (s *HostSet) UnmarshalJSON(b []byte) error

type Registry

+ func (r *Registry) KeepCaches()

+ func (r *Registry) Search(hostnameGlob string, attributes MatchAttributes, sampled []string, count int) *HostSet

type Runner

+ func (r *Runner) GetTimeout() time.Duration

v0.9.1

Sep 24, 2022

v0.9.0

Sep 24, 2022

v0.8.1

Mar 10, 2022

Changes in this version

+ const Finished

+ const MAJOR_VERSION

+ const MINOR_VERSION

+ const PATCH_VERSION

+ const Queued

+ const Running

+ const Waiting

+ func NewLineWriterBuffer(host *Host, stderr bool, oc chan OutputLine) *lineWriterBuffer

+ func Providers() []string

+ func RegisterProvider(name string, constructor func(string) HostProvider, magic func() HostProvider)

+ func Version() string

+ type ByteWriter interface

+ Bytes func() []byte

+ Write func([]byte) (int, error)

+ type Cache interface

+ Invalidate func()

+ SetCacheDir func(string)

+ Source func() HostProvider

+ type Connection interface

+ Close func()

+ type DataLoader interface

+ SetDataDir func(string) error

+ type Executor interface

+ Run func(ctx context.Context, host *Host, cmd string, oc chan OutputLine) *Result

+ SetConnectTimeout func(time.Duration)

+ type History []*HistoryItem

+ func (h History) Save(path string) error

+ type HistoryItem struct

+ Command string

+ ElapsedTime float64

+ EndTime time.Time

+ Hosts Hosts

+ Results map[string]*Result

+ StartTime time.Time

+ Summary struct{ ... }

+ func (h *HistoryItem) MarshalJSON() ([]byte, error)

+ type Host struct

+ Address string

+ Attributes HostAttributes

+ Connection io.Closer

+ Name string

+ func NewHost(name, address string, attributes HostAttributes) *Host

+ func (h *Host) AddPublicKey(k ssh.PublicKey)

+ func (h *Host) Amend(h2 *Host)

+ func (h *Host) GetAttribute(key string) (interface{}, bool)

+ func (h *Host) Match(hostnameGlob string, attributes MatchAttributes) bool

+ func (h *Host) PublicKeys() []ssh.PublicKey

+ func (h *Host) UnmarshalJSON(data []byte) error

+ func (host Host) String() string

+ type HostAttributes map[string]interface

+ type HostListOptions struct

+ Align bool

+ AllAttributes bool

+ Attributes []string

+ Count []string

+ Csv bool

+ Header bool

+ OneLine bool

+ Separator string

+ SortByCount bool

+ Template string

+ type HostProvider interface

+ Equivalent func(p HostProvider) bool

+ Load func(ctx context.Context, l LoadingMessage) (Hosts, error)

+ Name func() string

+ ParseViper func(v *viper.Viper) error

+ Prefix func() string

+ func NewProvider(pname, name string) (HostProvider, error)

+ type Hosts []*Host

+ func (h Hosts) Sample(attributes []string, count int) Hosts

+ func (h Hosts) Sort(fields []string)

+ func (h Hosts) Uniq() Hosts

+ func (hosts Hosts) String() string

+ type LoadingMessage func(string, bool, error)

+ type MatchAttribute struct

+ FuzzyTyping bool

+ Name string

+ Negate bool

+ Regex bool

+ Value interface{}

+ func (m MatchAttribute) Match(value interface{}) (matches bool)

+ func (m MatchAttribute) String() string

+ type MatchAttributes []MatchAttribute

+ type MultiError struct

+ Subject string

+ func (m *MultiError) Add(e error)

+ func (m *MultiError) Error() string

+ func (m *MultiError) HasErrors() bool

+ type OutputLine struct

+ Data []byte

+ Host *Host

+ Stderr bool

+ type OutputMode int

+ const OutputAll

+ const OutputInline

+ const OutputPerhost

+ const OutputTail

+ type ProgressMessage struct

+ Host *Host

+ Result *Result

+ State ProgressState

+ type ProgressState int

+ type Registry struct

+ func NewRegistry(dataDir, cacheDir string) *Registry

+ func (r *Registry) AddMagicProvider(p HostProvider)

+ func (r *Registry) AddProvider(p HostProvider)

+ func (r *Registry) GetHosts(hostnameGlob string, attributes MatchAttributes, sampled []string, count int) Hosts

+ func (r *Registry) InvalidateCache()

+ func (r *Registry) LoadHosts(ctx context.Context, lm LoadingMessage) error

+ func (r *Registry) LoadMagicProviders()

+ func (r *Registry) LoadProviders(c *viper.Viper) error

+ func (r *Registry) Settings() (string, map[string]interface{})

+ type Result struct

+ ElapsedTime float64

+ EndTime time.Time

+ Err error

+ ExitStatus int

+ Host *Host

+ StartTime time.Time

+ Stderr []byte

+ Stdout []byte

+ func (r Result) MarshalJSON() ([]byte, error)

+ func (r Result) String() string

+ type Runner struct

+ func NewRunner(executor Executor) *Runner

+ func (r *Runner) AddHosts(hosts Hosts)

+ func (r *Runner) End()

+ func (r *Runner) GetHosts() Hosts

+ func (r *Runner) RemoveHosts(glob string, attrs MatchAttributes)

+ func (r *Runner) Run(command string, pc chan ProgressMessage, oc chan OutputLine) (*HistoryItem, error)

+ func (r *Runner) SetConnectTimeout(t time.Duration)

+ func (r *Runner) SetHostTimeout(t time.Duration)

+ func (r *Runner) SetParallel(p int)

+ func (r *Runner) SetSortFields(s []string)

+ func (r *Runner) SetSplay(t time.Duration)

+ func (r *Runner) SetTimeout(t time.Duration)

+ func (r *Runner) Settings() (string, map[string]interface{})

+ type SettingsFunc func() (string, map[string]interface{})

+ type SimpleUI struct

+ func NewSimpleUI() *SimpleUI

+ func (ui *SimpleUI) BindLogrus()

+ func (ui *SimpleUI) End()

+ func (ui *SimpleUI) LoadingMessage(what string, done bool, err error)

+ func (ui *SimpleUI) OutputChannel(r *Runner) chan OutputLine

+ func (ui *SimpleUI) PrintHistoryItem(hi *HistoryItem)

+ func (ui *SimpleUI) PrintHostList(hosts Hosts, opts HostListOptions)

+ func (ui *SimpleUI) PrintSettings(funcs ...SettingsFunc)

+ func (ui *SimpleUI) ProgressChannel(r *Runner) chan ProgressMessage

+ func (ui *SimpleUI) SetOutputMode(o OutputMode)

+ func (ui *SimpleUI) SetOutputTimestamp(e bool)

+ func (ui *SimpleUI) SetPagerEnabled(e bool)

+ func (ui *SimpleUI) Settings() (string, map[string]interface{})

+ func (ui *SimpleUI) Sync()

+ func (ui *SimpleUI) Write(msg []byte) (int, error)

+ type TimeoutError struct

+ Message string

+ func (e TimeoutError) Error() string

+ type UI interface

+ BindLogrus func()

+ End func()

+ LoadingMessage func(what string, done bool, err error)

+ OutputChannel func(r *Runner) chan OutputLine

+ PrintHistoryItem func(hi *HistoryItem)

+ PrintHostList func(hosts Hosts, opts HostListOptions)

+ PrintSettings func(...SettingsFunc)

+ ProgressChannel func(r *Runner) chan ProgressMessage

+ SetOutputMode func(OutputMode)

+ SetOutputTimestamp func(bool)

+ SetPagerEnabled func(bool)

+ Settings func() (string, map[string]interface{})

+ Sync func()

+ Write func([]byte) (int, error)

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL