Viper provides a simple API (Python and CLI) to easily manage large infrastructures.
Project description
Viper provides a simple API (Python and CLI) to easily manage large infrastructures.
Getting Started
Installation
pip install -U viper-infra-commander
# Or install with batteries included
pip install -U "viper-infra-commander[batteries]"
Initialization
# (Optional) enable tab completion
eval "$(viper autocomplete $(basename $SHELL))"
# See the help menu
viper -h
# Initialize SQLite DB
viper init -f
Viper in Action (Basic Mode)
Define a set of hosts in csv format (json and yml are also supported) in hosts.csv:
cat > hosts.csv << EOF
ip,hostname,login_name,identity_file
192.168.0.11,host11,root,/root/.ssh/id_rsa.pub
192.168.0.12,host12,root,/root/.ssh/id_rsa.pub
192.168.0.13,host13,root,/root/.ssh/id_rsa.pub
192.168.0.14,host14,root,/root/.ssh/id_rsa.pub
192.168.0.15,host15,root,/root/.ssh/id_rsa.pub
EOF
Define a task in task.py:
cat > task.py << EOF
from viper import Task
def ping_command(host):
return "ping", "-c", "1", host.ip
def ping():
return Task(
name="Ping once",
command_factory=ping_command
)
EOF
Perform the following actions:
Run the task on the set of hosts in parallel with 5 workers,
filter only the results where the task failed,
re-run the task on them,
store the results in DB
viper hosts:from-file hosts.csv \
| viper hosts:run-task task.ping --max-worker 5 \
| viper results:where returncode IS_NOT 0 \
| viper results:re-run --indent 4
See the stdout of the final results from DB:
viper results \
| viper results:final \
| viper results:format "{host.hostname}: {stdout}"
Export the results to a csv file:
viper results --final \
| viper results:to-file results.csv --indent 4
Define a job using the Python API (CLI and Python API are almost similar):
cat > job.py << EOF
from viper import WhereConditions
from task import ping
def ping_and_export(hosts):
return (
hosts.task(ping())
.run(max_workers=5)
.final()
.to_file("results.csv")
)
EOF
Run the job using CLI:
viper hosts:from-file hosts.csv \
| viper run job.ping_and_export \
| viper results:format "{host.hostname}: {stdout}"
Viperfile in Action (Advanced Mode)
Define a project with custom subcommands in viperfile:
cat > viperfile.py << EOF
from viper import Hosts, Task
from viper.project import Project, arg
foo = Project(prefix="foo")
@foo.hostgroup(args=[arg("-f", "--file", default="hosts.csv")])
def allhosts(args):
return Hosts.from_file(args.file)
def remote_exec_command(host, command):
return (
"ssh",
"-i",
host.identity_file,
"-l",
host.login_name,
"-p",
str(host.port),
"-o",
"StrictHostKeyChecking=no",
"-o",
"PubkeyAuthentication=yes",
host.ip,
command,
)
@foo.job(
args=[
arg("command", help="command to execute"),
arg("-w", "--workers", type=int, default=1),
]
)
def remote_exec(hosts, args):
return (
hosts.task(
Task(
name="Remote execute command",
command_factory=remote_exec_command,
timeout=5,
),
args.command,
)
.run(max_workers=args.workers)
.final()
)
EOF
See the auto generated custom subcommands:
viper --help
Run the job:
viper @foo:allhosts \
| viper @foo:remote_exec "uname -a" --workers 5 \
| viper results:to-file results.csv \
| viper results:format "{task.name} [{host.hostname}]: {returncode}: {stdout}"
Further Readings
API Docs with Examples ☞ https://viper-infra-commander.netlify.com
Contributing To Viper
Contribution Guidelines ☞ https://github.com/sayanarijit/viper/blob/master/CONTRIBUTING.md
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for viper-infra-commander-0.28.3.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0d814ad64e6d7b0621e72a35fe048ed1a8d122d627dbbd7066983214335b15d1 |
|
MD5 | cf99d573a1982115b4ed5959cce3c226 |
|
BLAKE2b-256 | 967c0ead9d4325b22ad586f168ad35db7926730c36a071969eda7a8c72c5768c |
Hashes for viper_infra_commander-0.28.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 27516e5134411c80a61fc408ccb7a6090819ca98d2d135e7a88629562ecb7659 |
|
MD5 | 7c031cd4a8f6d9069d6e298758a7668d |
|
BLAKE2b-256 | d32800177562414cdd12dc1fb6807b59049ec01766241136d76404d0ef6118c2 |