README
¶
Logo designed by dgim-studio
Omnivore is an interactive distributed SSH tool. Designed to quickly identify output anomalies and inconsistencies in large environments.
This program was developed alongside https://github.com/discoriver/massh, and is tightly integrated with it. It's my hope that Omnivore not only serves as a useful tool, but also as a demonstration of how one might utilise Massh elegantly to provide powerful programs that require advanced SSH output processing.
Example Usage (including host panels and search)
Upcoming features
- Generally more interactive ability from within the program itself. Running new commands on the same host set, changing public key used, viewing output for individual hosts in their own views etc.
- Ability for scripts to be executed.
- Ability to retry failed hosts a configurable number of times.
- Better SSH key handling.
- Omnivore will eventually offload in-memory storage of host output to files within
~/.omnivore/history/, however we need to build a system for preserving in-memory functionality as a fallback if writing fails, to avoid crashing completely.
Known Issues
- If using iTerm2 on MacOS, you will need to edit your profile, and under the
Terminalheading, uncheck the optionSave lines to scrollback in alternate screen mode. Leaving this option checked will cause major trauma to your scroll buffer when resizing the terminal window when Omnivore is running.
Noteworthy
- Application logs are located at
~/.omnivore/history/. There is a timestamped directory for each run of omnivore, containing a file for each host containing it's output, and a log file for that run.
Testing
Testing group should be appended to all tests, either UnitWorkflow or IntegrationWorkflow.
Running a group can be done with the -run flag;
go test -v ./... -run UnitWorkflowgo test -v ./... -run IntegrationWorkflow
For integration testing, which performs an SSH "hello world", Omnivore uses cluster of machines within an AWS EC2 group "omnivore". Locally, you can configure your own AWS credentials that has access to such a group and it will run against whichever hosts it finds. As long as you have credentials configured for AWS EC2, permission, and a group with the applicable name, it should run without issue.
Acknowledgements
- Dalal, for enriching my life and keeping me on the rails.
- Tim for putting his trust in me to do good work.
- Adam & Bryan for helping me see the value.
- Alysha for always propping up my ego.
Documentation
¶
There is no documentation for this package.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
internal
|
|
|
config
Package Config provides functionality to read user-required fields, and build a Massh config from which to generate a StreamCycle
|
Package Config provides functionality to read user-required fields, and build a Massh config from which to generate a StreamCycle |
|
ossh
Package ossh provides functionality for the SSH behaviours required by omnivore.
|
Package ossh provides functionality for the SSH behaviours required by omnivore. |
|
path
Package path provides file path utilities.
|
Package path provides file path utilities. |
|
store
Package store provides data storage for omnivore output.
|
Package store provides data storage for omnivore output. |
|
test
Package test contains relevant test parameters.
|
Package test contains relevant test parameters. |
|
pkg
|
|
|
aws/ec2
Package ec2 contains methods for interacting and obtaining AWS instances
|
Package ec2 contains methods for interacting and obtaining AWS instances |
|
group
Package group provides a method for taking an identifier and value pair, comparing them with other pairs, and then grouping identical values.
|
Package group provides a method for taking an identifier and value pair, comparing them with other pairs, and then grouping identical values. |
|
shell
Package Shell is a collection of shell utilities
|
Package Shell is a collection of shell utilities |