Metadata-Version: 2.4
Name: vigie
Version: 0.0.1
Summary: VM Migration Scheduler for OpenStack
Home-page: https://www.openstack.org/
Author: OpenStack
Author-email: openstack-discuss@lists.openstack.org
Classifier: Environment :: OpenStack
Classifier: Intended Audience :: Information Technology
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Dist: pbr>=5.7.0
Requires-Dist: Flask>=2.0.0
Requires-Dist: oslo.config>=8.7.0
Requires-Dist: oslo.context>=4.1.0
Requires-Dist: oslo.db>=12.1.0
Requires-Dist: oslo.log>=4.1.0
Requires-Dist: oslo.messaging>=12.5.2
Requires-Dist: keystonemiddleware>=9.1.0
Requires-Dist: alembic>=1.7.0
Requires-Dist: sqlalchemy>=1.4.0
Requires-Dist: tooz>=2.7.1
Requires-Dist: python-mistralclient>=4.1.1
Requires-Dist: Jinja2>=2.11.3
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: home-page
Dynamic: requires-dist
Dynamic: summary

==================
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

