Versions in this module Expand all Collapse all v0 v0.2.0 Feb 10, 2026 v0.1.0 Feb 9, 2026 Changes in this version + var ErrTimeout = errors.New("Timeout step running") + func CheckSSHHosts(userPassedHosts []session.Host, nodesNames []string, phase string, ...) (map[string]string, error) + func ExecuteRemoteScriptPath(u ScriptPath, scriptName string, full bool) string + func ParseSSHPrivateKey(keyData []byte, keyName string, passphraseConsumer PassphraseConsumer) (any, string, error) + func ParseSSHPrivateKeyFile(path string, password string, logger log.Logger) (any, string, error) + func SafeClose(conn io.Closer, presentHandlers ...PresentCloseHandler) error + type BaseReverseTunnelRoutines struct + func (b *BaseReverseTunnelRoutines[T]) SetUploadDirAndCleanup(dir string) *T + func (b *BaseReverseTunnelRoutines[T]) WithCleanup() *T + func (b *BaseReverseTunnelRoutines[T]) WithUploadDir(dir string) *T + type Bundle struct + func NewBundle(sett settings.Settings, client connection.SSHClient, scriptPath string, ...) (*Bundle, error) + func (b *Bundle) Execute(ctx context.Context, parentDir, bundleDir string) ([]byte, error) + type BundleOpt func(*Bundle) + func BundleWithCommandKiller(k CommandKiller) BundleOpt + func BundleWithCommandPreparator(p CommandPreparator) BundleOpt + func BundleWithNoLogStepOutOnError(v bool) BundleOpt + func BundleWithRetries(r int) BundleOpt + func BundleWithStepHeader(r *regexp.Regexp) BundleOpt + func BundleWithStepsDelimiter(d string) BundleOpt + func UserBundleOptsOrBashible(inputOpts ...connection.BundlerOption) ([]BundleOpt, error) + type ByteSequenceMatcher struct + Pattern string + func NewByteSequenceMatcher(pattern string) *ByteSequenceMatcher + func (m *ByteSequenceMatcher) Analyze(buf []byte) int + func (m *ByteSequenceMatcher) IsMatched() bool + func (m *ByteSequenceMatcher) Reset() + func (m *ByteSequenceMatcher) WaitNonMatched() *ByteSequenceMatcher + type Check struct + Session *session.Session + func NewCheck(createCommand CommandConsumer, sess *session.Session, sett settings.Settings) *Check + func (c *Check) AwaitAvailability(ctx context.Context, loopParams retry.Params) error + func (c *Check) CheckAvailability(ctx context.Context) error + func (c *Check) ExpectAvailable(ctx context.Context) ([]byte, error) + func (c *Check) String() string + func (c *Check) WithDelaySeconds(seconds int) ssh.Check + type CommandConsumer func(*session.Session, string) ssh.Command + type CommandKiller func(connection.Command) + type CommandPreparator func(connection.Command) + type DefaultPassphraseOnlyConsumer struct + func NewDefaultPassphraseOnlyConsumer(defaultPassword string) *DefaultPassphraseOnlyConsumer + func (c *DefaultPassphraseOnlyConsumer) AskPassword(prompt string) ([]byte, error) + func (c DefaultPassphraseOnlyConsumer) DefaultPassword() []byte + type EmptyReverseTunnelKiller struct + func (k EmptyReverseTunnelKiller) KillTunnel(context.Context) (string, error) + type PassphraseConsumer interface + AskPassword func(prompt string) ([]byte, error) + DefaultPassword func() []byte + type PresentCloseHandler func(isPresent bool) + type RunScriptReverseTunnelChecker struct + func NewRunScriptReverseTunnelChecker(c ssh.SSHClient, scriptPath string) *RunScriptReverseTunnelChecker + func (s *RunScriptReverseTunnelChecker) CheckTunnel(ctx context.Context) (string, error) + type RunScriptReverseTunnelKiller struct + func NewRunScriptReverseTunnelKiller(c ssh.SSHClient, scriptPath string) *RunScriptReverseTunnelKiller + func (s *RunScriptReverseTunnelKiller) KillTunnel(ctx context.Context) (string, error) + type ScriptPath interface + IsSudo func() bool + Settings func() settings.Settings + UploadDir func() string + type TerminalPassphraseConsumer struct + func NewTerminalPassphraseConsumer(logger log.Logger, defaultPassword []byte) *TerminalPassphraseConsumer + func (c *TerminalPassphraseConsumer) AskPassword(prompt string) ([]byte, error) + func (c TerminalPassphraseConsumer) DefaultPassword() []byte
Go to main page