==================
Vigie Operator API
==================

Vigie (Operator API) is an OpenStack service for managing a cloud
deployment form an operator perspective.

Features
--------

* evacuate host
* purge project

Planned features
----------------

* Public image management
* Project pre-delete

Installation
------------

Use the Debian package or invent a deployment method yourself.

Configuration
-------------

The service requires a configuration file typically located at
``/etc/vigie/vigie.conf``.

Example configuration::

    [DEFAULT]
    [database]
    connection=sqlite:///var/lib/vigie/vigie.db

    [keystone_authtoken]
    www_authenticate_uri = http://keystone:5000
    auth_url = http://keystone:5000
    auth_type = password
    project_domain_name = Default
    user_domain_name = Default
    project_name = service
    username = vigie
    password = vigie_password

Usage
-----

Start the API service using uwsgi.

Start the worker daemon::

    vigie-worker

API Endpoints
-------------

* ``POST /v2/evacutate-compute`` - Evacuate a compute node
* ``POST /v2/purge-project`` - Purge a project
