k0sproject / rig Goto Github PK

Note: The main branch contains a work in progress for rig v2. If you are looking for the stable version, please browse the tags of v0.x releases.

A golang package for adding multi-protocol connectivity and multi-os operation functionality to your application's Host objects.

Rig's intention is to be easy to use and extend.

It should be easy to add support for new operating systems and to add new components to the multi-os support mechanism without breaking type safety and testability.

Currently rig comes with the most common ways to connect to hosts:

• SSH for connecting to hosts that accept SSH connections. With ssh agent and config support and sane familiar defaults. Pageant or openssh agent can be used on Windows.
• OpenSSH for connecting to hosts using the system's own openssh "ssh" executable and utilizing session multiplexing for performance.
• WinRM as an alternative to SSH for windows hosts (SSH works too)
• Localhost for treating the local host as it was a remote host using go's os/exec.

TBD - for now see godoc, tests and sources.