cloud-shepherd 2.0.5

Control cloud servers using the provider's API

Shepherd

A.k.a. cloud-shepherd.

This is a tool for controlling a stable of hosts listed in an Ansible inventory file. (By the use of non-standard Ansible variables that identify the cloud provider, region and ID of the host.) It can also show their status.

Unlike Ansible, the purpose of Shepherd is to manage hosts without having to log into them. Actions are perfomed by contacting the API of one or more cloud providers.

Shepherd is intended to be used like virsh or service(1). Currently, only AWS is supported. For certain tasks, it is friendlier than vendor-provided tools like aws-cli (ec2 subcommand).

Specifying the inventory file

The filename can either be put into the ANSIBLE_INVENTORY environment variable, or supplied on the command line with --inventory-file=/x/y/z (short option is -i).

Why not use Ansible's Dynamic Inventory feature?

The Dynamic Inventory plugin allow Ansible to pull down a list of hosts from a cloud provider and then manage them.

However, it can be handy to keep track hosts with names that are different from those in the AWS EC2 instance name tag, for example. Therefore the intent of Shepherd is to make the inventory file the locus of host management. It is deliberately not dynamic.

Installation

Run pip3 install cloud-shepherd

Setup

The following extra host variables must (unless specified) be present in the inventory file otherwise the host will not be operated on and a warning will be shown:

• cloud_provider -- choices: aws
• cloud_account -- optional (account ID for AWS)
• cloud_region
• cloud_instance_id

A Makefile is provided (see shepherd/Makefile) that uses an internal AWK script to generate an Ansible inventory file from your .ssh/config file. This brings all the regular Ansible variables across from corresponding SSH settings in the file.

Note that the Makefile currently ignores all hosts in .ssh/config that aren't preceeded by a comment line that starts with an AWS EC2 instance ID.

YMMV.

Usage

Shepherd takes an action argument on the command line, plus a host pattern that will match one or more hosts in the inventory file. The program can be invoked in one of two ways.

virsh mode:

shepherd <action> <host-pattern>
shepherd list

...where <action> is one of:-

• dominfo
• start
• reboot
• shutdown
• destroy

Or service(1) mode:

shepherd <host-pattern> <action>

...where <action> is one of:-

• status
• fullstatus
• start
• restart
• stop
• kill

Also, the following AWS action names can be used instead:

• start
• reboot
• stop
• terminate

Options

Examples

Licence

GNU General Public License v3.0 or later

See COPYING to see the full text.