os-faults/README.rst

OS-Faults

OpenStack faults injection library

The library does destructive actions inside an OpenStack cloud. It provides an abstraction layer over different types of cloud deployments. The actions are implemented as drivers (e.g. DevStack driver, Fuel driver, Libvirt driver, IPMI driver).

• Free software: Apache license
• Documentation: http://os-faults.readthedocs.io
• Source: https://github.com/openstack/os-faults
• Bugs: http://bugs.launchpad.net/os_faults

Usage

The cloud deployment configuration schema is an extension to the cloud config used by the os-client-config library:

cloud_config = {
    'cloud_management': {
        'driver': 'devstack',
        'address': 'devstack.local',
        'username': 'root',
    },
    'power_management': {
        'driver': 'libvirt',
        'address': 'host.local',
        'username': 'root',
    }
}

Establish a connection to the cloud and verify it:

destructor = os_faults.connect(cloud_config)
destructor.verify()

The library can also read configuration from a file and the file can be in the following three formats: os-faults.{json,yaml,yml}. The configuration file can be specified in the OS_FAULTS_CONFIG environment variable or can be read from one of the default locations: * current directory * ~/.config/os-faults * /etc/openstack

Make some destructive actions:

destructor.get_service(name='keystone').restart()

The library operates with 2 types of objects:

• service - is a software that runs in the cloud, e.g. nova-api
• nodes - nodes that host the cloud, e.g. a hardware server with a hostname

Simplified API

Simplified API is used to inject faults in a human-friendly form.

Service-based command performs specified action against service on all, on one random node or on the node specified by FQDN:

<action> <service> service [on (random|one|single|<fqdn> node[s])]

Node-based command performs specified action on all or selected service's node:

<action> [random|one|single] <service> node[s]

Network-management command is a subset of node-based query:

disable|enable network <network name> on <service> node[s]

Examples:

• Restart Keystone service - restarts Keystone service on all nodes
• kill nova-api service on one node - restarts Nova API on one of nodes
• Reboot one node with mysql - reboots one random node with MySQL
• Reboot node-2.domain.tld node - reboot node with specified name

Extended API

1. Service actions

Get a service and restart it:

destructor = os_faults.connect(cloud_config)
service = destructor.get_service(name='glance-api')
service.restart()

Available actions:

• start - start Service
• terminate - terminate Service gracefully
• restart - restart Service
• kill - terminate Service abruptly
• unplug - unplug Service out of network
• plug - plug Service into network

2. Node actions

Get all nodes in the cloud and reboot them:

nodes = destructor.get_nodes()
nodes.reboot()

Available actions:

• reboot - reboot all nodes gracefully
• poweroff - power off all nodes abruptly
• reset - reset (cold restart) all nodes
• oom - fill all node's RAM
• disable_network - disable network with the specified name on all nodes
• enable_network - enable network with the specified name on all nodes

3. Operate with nodes

Get all nodes where a service runs, pick one of them and reset:

nodes = service.get_nodes()
one = nodes.pick()
one.reset()

Get nodes where l3-agent runs and disable the management network on them:

fqdns = neutron.l3_agent_list_hosting_router(router_id)
nodes = destructor.get_nodes(fqdns=fqdns)
nodes.disable_network(network_name='management')

4. Operate with services

Restart a service on a single node:

service = destructor.get_service(name='keystone')
nodes = service.get_nodes().pick()
service.restart(nodes)