openstack/python-ironic-inspector-client

Go to file

Dmitry Tantsur bd3737c6a1 Drop comment about changing functional tests to use released inspector

If we ever use released ironic-inspector, we'll not be able to test
new features until they're released in ironic-inspector. It slows down
the development, and is also inconsistent with other projects.

tl;dr we'll use ironic-inspector git master for functional testing.

Change-Id: I7bf4b2a434f1976676ad6570071a30e1f8ba9fd0

2015-08-12 14:43:45 +02:00

ironic_inspector_client

Implement optional API versioning

2015-08-04 12:50:13 +02:00

.gitignore

Switch to pbr

2015-06-18 12:38:50 +02:00

.gitreview

Add gitreview file

2015-06-18 08:41:36 +02:00

functest-requirements.txt

Drop comment about changing functional tests to use released inspector

2015-08-12 14:43:45 +02:00

LICENSE

Initial import

2015-06-09 13:49:07 +02:00

MANIFEST.in

Initial import

2015-06-09 13:49:07 +02:00

README.rst

Implement optional API versioning

2015-08-04 12:50:13 +02:00

requirements.txt

Updated from global requirements

2015-08-11 01:38:40 +00:00

setup.cfg

Use pbr without explicit version

2015-06-18 13:52:31 +02:00

setup.py

Updated from global requirements

2015-07-17 16:17:44 +00:00

test-requirements.txt

Updated from global requirements

2015-07-22 04:59:33 +00:00

tox.ini

Create own functional tests for the client

2015-07-23 14:13:38 +02:00

README.rst

Ironic Inspector Client

This is a client library and tool for Ironic Inspector.

Install from PyPI:

pip install python-ironic-inspector-client

Please follow usual OpenStack Gerrit Workflow to submit a patch, see Inspector contributing guide for more detail.

Usage

CLI tool is based on OpenStackClient with prefix openstack baremetal introspection. Accepts optional argument --inspector-url with the Ironic Inspector API endpoint.

Start introspection on a node:

ironic_inspector_client.introspect(uuid, new_ipmi_username=None, new_ipmi_password=None)
```
$ openstack baremetal introspection start UUID [--new-ipmi-password=PWD [--new-ipmi-username=USER]]
```
- uuid - Ironic node UUID;
- new_ipmi_username and new_ipmi_password - if these are set, Ironic Inspector will switch to manual power on and assigning IPMI credentials on introspection. See Setting IPMI Credentials for details.
Query introspection status:

ironic_inspector_client.get_status(uuid)
```
$ openstack baremetal introspection status UUID
```
- uuid - Ironic node UUID.

Every call accepts additional optional arguments:

base_url Ironic Inspector API endpoint, defaults to 127.0.0.1:5050,
auth_token Keystone authentication token.
api_version requested API version; can be a tuple (MAJ, MIN), string "MAJ.MIN" or integer (only major). Defaults to DEFAULT_API_VERSION.

Refer to HTTP-API.rst for information on the Ironic Inspector HTTP API.

API Versioning

Starting with version 2.1.0 Ironic Inspector supports optional API versioning. Version is a tuple (X, Y), where X is always 1 for now.

The server has maximum and minimum supported versions. If no version is requested, the server assumes (1, 0).

There is a helper function to figure out the current server API versions range:

ironic_inspector_client.server_api_versions()

Returns a tuple (minimum version, maximum version). Supports optional argument:
- base_url Ironic Inspector API endpoint, defaults to 127.0.0.1:5050,

Two constants are exposed by the client:

DEFAULT_API_VERSION server API version used by default, always (1, 0) for now.
MAX_API_VERSION maximum API version this client was designed to work with. This does not mean that other versions won't work at all - the server might still support them.