driver options should be namespaced and documented

Bug #1236533 reported by aeva black
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
Ironic
Fix Released
Medium
Lucas Alvares Gomes

Bug Description

Currently, the names of parameters stored in the driver_info dict are not necessarily consistent . We are removing nested dict support, but as there is no concise grouping of related parameters, this potentially creates conflicting or awkward names. All drivers should use common prefixes for their option names, and all drivers should document their option names clearly.

Here's a breakdown of the options today.

ipmitool:
- address
- username
- password
- terminal_port [optional, may be unused]

ipminative:
- address
- username
- password

ssh:
- address
- username
- password
- port [optional]
- key_filename [optional, req'd if password is not set]
- virt_type

pxe:
- instance_name [should be removed?]
- image_source
- deploy_kernel [optional]
- deploy_ramdisk [optional]
- root_gb
- swap_gb [optional]
- key_data [will be removed with file injection]
- pxe_deploy_key [internal use only]

aeva black (tenbrae)
Changed in ironic:
importance: Undecided → Medium
status: New → Triaged
Changed in ironic:
assignee: nobody → Lucas Alvares Gomes (lucasagomes)
status: Triaged → In Progress
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to ironic (master)

Fix proposed to branch: master
Review: https://review.openstack.org/50338

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to ironic (master)

Reviewed: https://review.openstack.org/50011
Committed: http://github.com/openstack/ironic/commit/4fe17d9319a7c03179ae5c23c53968308d85d9f5
Submitter: Jenkins
Branch: master

commit 4fe17d9319a7c03179ae5c23c53968308d85d9f5
Author: Lucas Alvares Gomes <email address hidden>
Date: Mon Oct 7 10:00:38 2013 +0100

    Remove nested 'pxe' dict from driver_info

    driver_info do not support nested objects. Self-namespace will be used
    to distinguish parameters from one driver to another.

    Change-Id: I165438fff7a032b54d3f019b727f6f85ad88d153
    Partial-Bug: #1236533

Revision history for this message
OpenStack Infra (hudson-openstack) wrote :

Reviewed: https://review.openstack.org/50338
Committed: http://github.com/openstack/ironic/commit/c879ed2410e96c9c74574861d497bf0d2b1fad7d
Submitter: Jenkins
Branch: master

commit c879ed2410e96c9c74574861d497bf0d2b1fad7d
Author: Lucas Alvares Gomes <email address hidden>
Date: Tue Oct 8 13:32:40 2013 +0100

    Remove nested 'ssh' dict from driver_info

    driver_info do not support nested objects. Self-namespace will be used
    to distinguish parameters from one driver to another.

    Change-Id: I2756abc855ddfd5388dacb083c12c8916beedd01
    Partial-Bug: #1236533

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to ironic (master)

Fix proposed to branch: master
Review: https://review.openstack.org/50598

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to ironic (master)

Reviewed: https://review.openstack.org/50598
Committed: http://github.com/openstack/ironic/commit/be328be9ff1541a2985e06d117b812b88c8f9d67
Submitter: Jenkins
Branch: master

commit be328be9ff1541a2985e06d117b812b88c8f9d67
Author: Lucas Alvares Gomes <email address hidden>
Date: Wed Oct 9 12:40:03 2013 +0100

    Remove nested 'ipmi' dict from driver_info

    driver_info do not support nested objects. Self-namespace will be used
    to distinguish parameters from one driver to another.

    Change-Id: Ia720fac4b60aa0aa18406e0ba61d8a0a8c5c8a78
    Partial-Bug: #1236533

Changed in ironic:
status: In Progress → Fix Committed
Thierry Carrez (ttx)
Changed in ironic:
milestone: none → icehouse-2
status: Fix Committed → Fix Released
Thierry Carrez (ttx)
Changed in ironic:
milestone: icehouse-2 → 2014.1
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.