robgonnella / ops

A terminal UI app for managing on-premise bare-metal servers and VMs

On-Prem Server Management

Ops is a terminal UI application for managing on-premise bare-metal servers and VMs. It allows you see servers currently on your network and quickly ssh to them. Within the UI, you can create and manage multiple network configurations, you can choose a default set of ssh credentials to use for all servers, and you can override those defaults for individual IPs where needed.

This project is heavily inspired by derailed's amazing work on k9s for managing kubernetes clusters via a terminal ui application.

Runtime Dependencies

Ops has some external runtime dependencies: libpcap.

• mac

brew install libpcap

• debian

sudo apt update && sudo apt install -y libpcap-dev

Build Dependencies

If building Ops from source you will need a few other build dependencies.

• mac

brew install make go git

• debian

sudo apt update && sudo apt install -y make golang git

Installation

When installing using golang or building from source, you may want to add the following lines to one of your rc files to add your user's go bin to the PATH variable. This will make the ops command available in your shell.

export GOPATH="$HOME/go"
PATH="${GOPATH}/bin:$PATH"

• install using golang
  • dependencies
    • golang
    • libpcap
    • git

go install github.com/robgonnella/ops@latest

• build from source
  • dependencies
    • golang
    • make
    • libpcap
    • git

git clone https://github.com/robgonnella/ops.git
cd ops
make install

• use pre-built binaries: https://github.com/robgonnella/ops/releases
  • dependencies
    • libpcap

Usage

On first launch a default configuration will be generated based on your machines default network settings. If your machine is not connected to a network the app will fail to start.

• start application

# Due to the usage of libpcap, ops must be run with root privileges.
sudo ops

• clear config file and log file

sudo ops clear

• show help / usage

ops help
# or
ops --help
# or
ops <cmd> --help

Demo

Files and Config

• config.json: Stores network configurations for scanning ~/.config/ops/config.json
• ops.log: Additional logging ~/.config/ops/ops.log

Technologies

• tview is used to build the frontend. This is a wonderful open source terminal ui library provided by rivo!