openstack/python-ironicclient
Code Issues Proposed changes
A python client implementing the Ironic API.
1,304 Commits 5 Branches 44 Tags 21 MiB
Python 100%
f8b0d1af1d
Go to file
Tony Breeds f8b0d1af1d Uncap jsonschema 
We have jsonschema capped at a fairly old version. Other than some
specific releases, it looks like keeping it below 3.0 was added in
I943fd68b9fab3bce1764305a5058df5339470757 without really any explanation
why.

In order to update to a 3.x release we need to:
1. Remove the cap from global-requirements.txt (see Depends-On), leaving
   upper-constraints.txt at a 2.x release
2. Remove the cap from all consumers (this change)
3. Release a new version of consumers that are published to pypi
4. Update upper-constraints.txt with those new releases
5. Update jsonschema in upper-constraints.txt to a 3.X release
   (See: https://review.openstack.org/649789)
6. Test consumers with the change from 5.
7. [Optional] fix issues in consumers that arise from 6.
8. Merge the change from 5.

Change-Id: I27ce9430d3f20a3c6cf0fbeac5a2a277667b4c3e
Co-Authored-by: Sean McGinnis <sean.mcginnis@gmail.com>
Depends-On: https://review.openstack.org/649669
2019-04-04 14:00:11 +11:00
doc Allocation API: client API and CLI 2019-02-16 15:51:38 +01:00
ironicclient Merge "Use endpoint_override in version negotiation" 2019-03-20 11:02:36 +00:00
playbooks/functional Run jobs under python2 and python3 2019-03-15 17:43:19 +01:00
releasenotes Update master for stable/stein 2019-03-18 14:51:47 +00:00
tools Move to zuulv3 2019-03-11 11:00:08 +01:00
zuul.d Replace openstack.org git:// URLs with https:// 2019-03-24 20:35:50 +00:00
.coveragerc Fix coverage target 2016-07-27 14:12:42 -07:00
.gitignore Remove testrepository 2018-07-11 17:49:59 +07: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
lower-constraints.txt Merge "Fix lower-constraints.txt" 2018-07-14 01:25:55 +00:00
README.rst Modify useful links to project resources in README 2018-09-28 14:26:05 +01:00
requirements.txt Uncap jsonschema 2019-04-04 14:00:11 +11:00
setup.cfg Deploy templates: client support 2019-03-01 14:24:28 +00:00
setup.py Updated from global requirements 2017-03-02 11:54:32 +00:00
test-requirements.txt Switch to using stestr 2018-06-05 08:53:23 -04:00
tox.ini Run jobs under python2 and python3 2019-03-15 17:43:19 +01:00

README.rst

Python bindings for the Ironic API

Team and repository tags

image

Overview

This is a client for the OpenStack Bare Metal 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:

Project resources

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