API to get required and optional driver_info properties

Registered by Ruby Loo on 2014-06-24

It is possible to create a node without specifying any driver_info in the initial POST -- this is reasonable and fine. However, the API does not expose what driver_info properties are required for the node's driver. The client cannot know what fields to send in subsequent PATCH requests without reading Ironic's developer docs (or source code!).

This blueprint proposes an API that returns the required and optional driver_info properties, along with a description for each property.

Blueprint information

Status:
Complete
Approver:
devananda
Priority:
High
Drafter:
Ruby Loo
Direction:
Approved
Assignee:
Ruby Loo
Definition:
Approved
Series goal:
Accepted for juno
Implementation:
Implemented
Milestone target:
milestone icon 2014.2
Started by
devananda on 2014-07-17
Completed by
Ruby Loo on 2014-07-24

Related branches

Sprints

Whiteboard

Gerrit topic: https://review.openstack.org/#q,topic:bp/get-required-driver-info,n,z

Gerrit topic: https://review.openstack.org/#q,topic:bug/1261915,n,z

Addressed by: https://review.openstack.org/107092
    Add drivers.base.BaseDriver.get_properties()
    MERGED

Addressed by: https://review.openstack.org/107096
    Implement API to get driver properties
    MERGED

Addressed by: python-ironicclient CLI change: https://review.openstack.org/#/c/76338
    Add driver-properties command
    MERGED

(?)

Work Items

This blueprint contains Public information 
Everyone can see this information.

Subscribers

No subscribers.