driver properties not discoverable in REST API

Bug #1475744 reported by aeva black
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
Ironic
Fix Released
High
Anusha

Bug Description

Drivers expose their required properties via the REST endpoint "/v1/drivers/XXXX/properties"

However, this is not discoverable via the API today.

curl -H "X-OpenStack-Ironic-API-Version: 1.8" http://127.0.0.1:6385/v1/drivers/ | json_pp
{
   "drivers" : [
      {
         "hosts" : [
            "Leni"
         ],
         "links" : [
            {
               "rel" : "self",
               "href" : "http://127.0.0.1:6385/v1/drivers/pxe_amt"
            },
            {
               "rel" : "bookmark",
               "href" : "http://127.0.0.1:6385/drivers/pxe_amt"
            }
         ],
         "name" : "pxe_amt"
      },
....

curl -H "X-OpenStack-Ironic-API-Version: 1.8" http://127.0.0.1:6385/v1/drivers/pxe_ssh | json_pp
{
   "hosts" : [
      "Leni"
   ],
   "name" : "pxe_ssh",
   "links" : [
      {
         "href" : "http://127.0.0.1:6385/v1/drivers/pxe_ssh",
         "rel" : "self"
      },
      {
         "href" : "http://127.0.0.1:6385/drivers/pxe_ssh",
         "rel" : "bookmark"
      }
   ]
}

curl -H "X-OpenStack-Ironic-API-Version: 1.8" http://127.0.0.1:6385/v1/drivers/pxe_ssh/properties | json_pp
{
   "deploy_kernel" : "UUID (from Glance) of the deployment kernel. Required.",
   "ssh_port" : "port on the node to connect to; default is 22. Optional.",
   "ssh_address" : "IP address or hostname of the node to ssh into. Required.",
   "deploy_ramdisk" : "UUID (from Glance) of the ramdisk that is mounted at boot time. Required.",
   "ssh_key_filename" : "(list of) filename(s) of optional private key(s) for authentication. One of this, ssh_key_contents, or ssh_password must be specified.",
   "ssh_virt_type" : "virtualization software to use; one of vbox, virsh, vmware, parallels. Required.",
   "ssh_password" : "password to use for authentication or for unlocking a private key. One of this, ssh_key_contents, or ssh_key_filename must be specified.",
   "ssh_key_contents" : "private key(s). One of this, ssh_key_filename, or ssh_password must be specified.",
   "ssh_username" : "username to authenticate as. Required."
}

Tags: api
aeva black (tenbrae)
Changed in ironic:
status: New → Confirmed
importance: Undecided → High
tags: added: api
Anusha (anusha-iiitm)
Changed in ironic:
assignee: nobody → Anusha (anusha-iiitm)
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/203921

Changed in ironic:
status: Confirmed → In Progress
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Change abandoned on ironic (master)

Change abandoned by Anusha Ramineni (<email address hidden>) on branch: master
Review: https://review.openstack.org/203921
Reason: Merged this patch with https://review.openstack.org/#/c/205895/14 , so abandoning this review

Changed in ironic:
milestone: none → 4.2.0
Changed in ironic:
assignee: Anusha (anusha-iiitm) → Lucas Alvares Gomes (lucasagomes)
Changed in ironic:
assignee: Lucas Alvares Gomes (lucasagomes) → Anusha (anusha-iiitm)
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to ironic (master)

Reviewed: https://review.openstack.org/205895
Committed: https://git.openstack.org/cgit/openstack/ironic/commit/?id=3274cdeed452e6fb37872001b615a0b37ed69d65
Submitter: Jenkins
Branch: master

commit 3274cdeed452e6fb37872001b615a0b37ed69d65
Author: Anusha Ramineni <email address hidden>
Date: Fri Jul 24 13:43:56 2015 +0530

    Make end-points discoverable via Ironic API

    This commit makes the following API end-points
    discoverable via Ironic API
    1. '/v1/nodes/<uuid>/states'
    2. '/v1/drivers/<driver-name>/properties'

    API Micro version is bumped to v1.14 with this change.

    Closes-Bug:#1311288
    Closes-Bug: #1475744
    Co-Authored-By: Lucas Alvares Gomes <email address hidden>
    Change-Id: Ibc0013b8c09c80d90042bf12b31a54820b00b43c

Changed in ironic:
status: In Progress → Fix Committed
Thierry Carrez (ttx)
Changed in ironic:
status: Fix Committed → Fix Released
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.