Metadata-Version: 2.4
Name: python-vigieclient
Version: 0.0.5
Summary: Client library for the Operator API
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>=2.0.0
Requires-Dist: osc-lib>=2.2.1
Requires-Dist: python-openstackclient>=5.0.0
Requires-Dist: keystoneauth1>=4.5.0
Requires-Dist: requests>=2.25.0
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: home-page
Dynamic: requires-dist
Dynamic: summary

==================
python-vigieclient
==================

Python client library and CLI plugin for the Vigie operator API srvice.

Description
-----------

This package provides a Python client library and OpenStack CLI plugin for
interacting with the Vigie operator API service. It allows operators to
schedule, list and manage operator operations through command-line interfaces
or programmatically.

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

Install using pip::

    pip install python-vigieclient

Prerequisites
-------------

- OpenStack environment with Vigie service deployed
- Valid OpenStack credentials
- python-openstackclient installed

CLI Usage
---------

Once installed, the Vigie commands are available through the openstack CLI:

    openstack vigie evacluate compute <compute-host>
    openstack vigie validate compute <compute-host>
        [--keep-enabled | --disable-after-validation] [--wait]
    openstack vigie validate clean-up [--wait]
    openstack vigie purge project <project-uuid-or-name>

The ``--keep-enabled`` and ``--disable-after-validation`` options of the
validate compute command override, for this call, the server-side
``[validate_compute]/keep_enabled`` configuration default. Note that the
compute node is always disabled again when the validation fails.

With ``--wait``, the command polls the API until the validation task
completes, then displays its final state, and its error message if it
failed. ``--wait-timeout`` caps the polling time (default: 600 seconds).
While waiting, each new operation of the validation (spawning the VM,
running the checks, and so on) is printed, so that the progress of the
validation can be followed.

List all operations:

    openstack vigie list

The ``openstack vigie task list`` and ``openstack vigie task show
<task-id>`` commands display the ``operation`` column, which shows
what the worker is currently doing for a task (for example "Waiting
for another validation to finish." or "Finished.").

The ``openstack vigie validate clean-up`` command schedules the
deletion of everything the validations may have left behind: the
hosts-to-validate aggregate, the validation trait, and the whole vgt
project with all of its resources. With ``--wait``, the progress of
the clean-up is printed while it runs.

License
-------

Apache License, Version 2.0

