openstack/python-ironicclient
Code Issues Proposed changes
A python client implementing the Ironic API.
1,120 Commits 5 Branches 44 Tags 21 MiB
Python 100%
5eac09e66b
Go to file
Ruby Loo 5eac09e66b Mock filecache.CACHE in unit tests 
This mocks the global filecache.CACHE in unit tests that modify the
value. This is to avoid errors when other unit tests are running
at the same time, that use that same variable.

For example, ..unit.test_client.ClientTest.test_loader_arguments_token
has failed with  ...
    File "ironicclient/common/filecache.py", line 103, in retrieve_data
     data = _get_cache().get(key, expiration_time=expiry)
  AttributeError: 'int' object has no attribute 'get'

Change-Id: I84b9c6699c98d1fa642247808b6ddea4fae1e8d0
2017-11-06 22:45:57 -05:00
doc/source Deprecate the ironic CLI 2017-10-11 10:03:26 -04:00
ironicclient Mock filecache.CACHE in unit tests 2017-11-06 22:45:57 -05:00
releasenotes Merge "Set the default API version of OSC CLI to "latest"" 2017-10-25 22:30:44 +00:00
tools Pass os_identity_api_version into functional tests 2017-07-31 17:17:45 +03:00
.coveragerc Fix coverage target 2016-07-27 14:12:42 -07:00
.gitignore Replace testr with stestr 2017-10-06 07:20:47 +00:00
.gitreview Added .gitreview 2013-05-14 22:28:31 +00:00
.stestr.conf Replace testr with stestr 2017-10-06 07:20:47 +00:00
CONTRIBUTING.rst Update the documentation link for doc migration 2017-08-02 08:35:17 +00:00
LICENSE Add initial files 2013-09-05 16:35:21 -07:00
README.rst Deprecate the ironic CLI 2017-10-11 10:03:26 -04:00
requirements.txt Do not depend on python-openstackclient 2017-09-18 12:37:09 +03:00
setup.cfg Updated from global requirements 2017-09-24 12:27:45 +00:00
setup.py Updated from global requirements 2017-03-02 11:54:32 +00:00
test-requirements.txt Cleanup test-requirements 2017-09-24 12:08:17 +08:00
tox.ini Replace testr with stestr 2017-10-06 07:20:47 +00:00

README.rst

Team and repository tags

image

Python bindings for the Ironic API

This is a client for the OpenStack Ironic API. It provides:

  • a Python API: the ironicclient module, and
  • two command-line interfaces: openstack baremetal and ironic (deprecated, please use openstack baremetal).

Development takes place via the usual OpenStack processes as outlined in the developer guide. The master repository is on git.openstack.org.

python-ironicclient is licensed under the Apache License, Version 2.0, like the rest of OpenStack.

Contents:

Python API

Quick-start Example:

>>> from ironicclient import client
>>>
>>> kwargs = {'os_auth_token': '3bcc3d3a03f44e3d8377f9247b0ad155',
>>>           'ironic_url': 'http://ironic.example.org:6385/'}
>>> ironic = client.get_client(1, **kwargs)

openstack baremetal CLI

The openstack baremetal command line interface is available when the bare metal plugin (included in this package) is used with the OpenStackClient.

There are two ways to install the OpenStackClient (python-openstackclient) package:

  • along with this python-ironicclient package:

    # pip install python-ironicclient[cli]

  • directly:

    # pip install python-openstackclient

An example of creating a basic node with the ipmi driver:

$ openstack baremetal node create --driver ipmi

An example of creating a port on a node:

$ openstack baremetal port create --node <UUID> AA:BB:CC:DD:EE:FF

An example of updating driver properties for a node:

$ openstack baremetal node set --driver-info ipmi_address=<IPaddress> <UUID or name>

For more information about the openstack baremetal command and the subcommands available, run:

$ openstack help baremetal

ironic CLI (deprecated)

This is deprecated and will be removed in the S* release. Please use the openstack baremetal CLI instead.

This package will install the ironic command line interface that you can use to interact with the ironic API.

In order to use the ironic CLI you'll need to provide your OpenStack tenant, username, password and authentication endpoint. You can do this with the --os-tenant-name, --os-username, --os-password and --os-auth-url parameters, though it may be easier to set them as environment variables:

$ export OS_PROJECT_NAME=project
$ export OS_USERNAME=user
$ export OS_PASSWORD=pass
$ export OS_AUTH_URL=http://auth.example.com:5000/v2.0

To use a specific Ironic API endpoint:

$ export IRONIC_URL=http://ironic.example.com:6385

An example of creating a basic node with the ipmi driver:

$ ironic node-create -d ipmi

An example of creating a port on a node:

$ ironic port-create -a AA:BB:CC:DD:EE:FF -n nodeUUID

An example of updating driver properties for a node:

$ ironic node-update nodeUUID add driver_info/ipmi_address=<IPaddress>
$ ironic node-update nodeUUID add driver_info/ipmi_username=<username>
$ ironic node-update nodeUUID add driver_info/ipmi_password=<password>

For more information about the ironic command and the subcommands available, run:

$ ironic help

Useful Links