Skip to main content

Viper is a handy tool for easily running infrastructure management tasks and commands.

Project description

Viper Infrastructure Commander

PyPI version PyPI pyversions Build Status codecov Code style: black

Viper is a handy tool for easily running infrastructure management tasks and commands.

Viper CLI Examples.

Initialize current workspace (creates a viperdb.sqlite3 file)

viper init

# or remove or overwrite existing data with "-f" / "--force"

viper init -f

Load hosts from file

viper hosts:from-file tests/data/hosts.csv --indent 4

# or with a custom loader

viper hosts:from-file tests/data/hosts.json --loader viper.demo.loaders.json --indent 4

Load hosts from Python object

viper hosts:from-obj viper.demo.hosts.group1 --indent 4

Let's save the hosts

viper hosts:from-obj viper.demo.hosts.group1 > /tmp/hosts.json

Filter hosts

cat /tmp/hosts.json | viper hosts:filter viper.demo.filters.ip_starts_with_2 --indent 4

Assign tasks to the given hosts

cat /tmp/hosts.json | viper hosts:task --indent 4

Run the assigned tasks

cat /tmp/hosts.json | viper hosts:task | viper task-runners:run --indent 4

# or use a shortcut

cat /tmp/hosts.json | viper hosts:run-task --indent 4

Run tasks in parallel using multiple workers

cat /tmp/hosts.json | viper hosts:run-task --max-workers 50 --indent 4

Get the past task results of the hosts from DB

cat /tmp/hosts.json | viper hosts:task-results --indent 4 --debug

Or get the past task results by task

viper task:from-obj | viper task-results:by-task -i 4

# Or

viper task:from-obj | viper task:results -i 4

Let's save the result

viper task:from-obj | viper task:results > /tmp/results.json

Now filter the results by their status

# success
cat /tmp/results.json | viper task-results:filter viper.demo.filters.result_ok -i 4

# failed
cat /tmp/results.json | viper task-results:filter viper.demo.filters.result_errored -i 4

Pipe the results to a custom handler

cat /tmp/results.json | viper task-results:pipe viper.demo.handlers.print_status

Let's do that again in one go

viper hosts:from-obj viper.demo.hosts.group1 | viper hosts:run-task-then-pipe viper.demo.handlers.print_status


pip install -U viper-infra-commander

Viper CLI Reference

usage: viper [-h] [--version] [--debug]

Viper CLI v0.0.1

positional arguments:
    init                initialize the current workspace
    task:from-obj       get the task from a python object location
    task:results        get the past task results of given task
    hosts:from-file     get a group of hosts from a file
    hosts:from-obj      get a group of hosts from a python object location
    hosts:filter        filter hosts by a given function
    hosts:count         count the number of hosts
    hosts:sort          sort the hosts
    hosts:pipe          pipe the hosts to the given function
    hosts:task          assign a task to each host
    hosts:run-task      assign a task to each host and run
                        run the given task on the hosts and then pipe the
                        result to the given function
    hosts:task-results  get the past task results of the hosts
                        filter task runners by a given function
    task-runners:count  count the number of task runners
    task-runners:sort   sort the task runners
    task-runners:pipe   pipe the task runners to the given function
    task-runners:run    run the assigned tasks
    task-runners:hosts  get the hohsts from the task runners
                        filter task results by a given function
    task-results:count  count the number of task results
    task-results:sort   sort the task results
    task-results:pipe   pipe the task results to the given function
    task-results:hosts  get the hosts from the task results
                        get the past task results of given task

optional arguments:
  -h, --help            show this help message and exit
  --version             show program's version number and exit
  --debug               show traceback information when an exception is raised

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

viper-infra-commander-0.0.1.tar.gz (12.4 kB view hashes)

Uploaded Source

Built Distribution

viper_infra_commander-0.0.1-py3-none-any.whl (14.1 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page