← Back to team overview

yahoo-eng-team team mailing list archive

[Bug 1526446] [NEW] compute evacuate documentation doesn't match api behavior

 

Public bug reported:

I am using OpenStack Liberty, installed using the ansible all-in-one
deployment. The documentation for the evacuate command in the compute
v2.1 API does not appear to match what I am seeing.

http://developer.openstack.org/api-ref-compute-v2.1.html#evacuate

1. The on_shared_storage attribute in the documentation should actually
be onSharedStorage. When I use on_shared_storage, I get the following
error message: "Invalid input for field/attribute evacuate. Value:
{u'on_shared_storage': False}. Additional properties are not allowed
(u'on_shared_storage' was unexpected)". When I leave the attribute off
entirely, I get this error which lead me to the correct attribute name:
"Invalid input for field/attribute evacuate. Value: {}.
'onSharedStorage' is a required property".

2. The admin_password attribute in the documentation does not appear to
be a valid attribute at all. When I use admin_password, I get the
following error message: "Invalid input for field/attribute evacuate.
Value: {u'onSharedStorage': False, u'admin_password': u'top-secret-
password'}. Additional properties are not allowed (u'admin_password' was
unexpected)". I also tried adminPassword (see #1 as for why I thought
that may work) but that was rejected with a similar error message.

Here is the response from the compute versions endpoint, in case that
helps narrow down which version I am using. I am not sending a
microversion header.

{
  "versions": [
    {
      "status": "SUPPORTED",
      "updated": "2011-01-21T11:33:21Z",
      "links": [
        {
          "href": "http://104.130.30.68:8774/v2/";,
          "rel": "self"
        }
      ],
      "min_version": "",
      "version": "",
      "id": "v2.0"
    },
    {
      "status": "CURRENT",
      "updated": "2013-07-23T11:33:21Z",
      "links": [
        {
          "href": "http://104.130.30.68:8774/v2.1/";,
          "rel": "self"
        }
      ],
      "min_version": "2.1",
      "version": "2.12",
      "id": "v2.1"
    }
  ]
}

** Affects: keystone
     Importance: Undecided
         Status: New

** Affects: openstack-api-site
     Importance: Undecided
         Status: New

** Also affects: openstack-api-site
   Importance: Undecided
       Status: New

-- 
You received this bug notification because you are a member of Yahoo!
Engineering Team, which is subscribed to OpenStack Identity (keystone).
https://bugs.launchpad.net/bugs/1526446

Title:
  compute evacuate documentation doesn't match api behavior

Status in OpenStack Identity (keystone):
  New
Status in openstack-api-site:
  New

Bug description:
  I am using OpenStack Liberty, installed using the ansible all-in-one
  deployment. The documentation for the evacuate command in the compute
  v2.1 API does not appear to match what I am seeing.

  http://developer.openstack.org/api-ref-compute-v2.1.html#evacuate

  1. The on_shared_storage attribute in the documentation should
  actually be onSharedStorage. When I use on_shared_storage, I get the
  following error message: "Invalid input for field/attribute evacuate.
  Value: {u'on_shared_storage': False}. Additional properties are not
  allowed (u'on_shared_storage' was unexpected)". When I leave the
  attribute off entirely, I get this error which lead me to the correct
  attribute name: "Invalid input for field/attribute evacuate. Value:
  {}. 'onSharedStorage' is a required property".

  2. The admin_password attribute in the documentation does not appear
  to be a valid attribute at all. When I use admin_password, I get the
  following error message: "Invalid input for field/attribute evacuate.
  Value: {u'onSharedStorage': False, u'admin_password': u'top-secret-
  password'}. Additional properties are not allowed (u'admin_password'
  was unexpected)". I also tried adminPassword (see #1 as for why I
  thought that may work) but that was rejected with a similar error
  message.

  Here is the response from the compute versions endpoint, in case that
  helps narrow down which version I am using. I am not sending a
  microversion header.

  {
    "versions": [
      {
        "status": "SUPPORTED",
        "updated": "2011-01-21T11:33:21Z",
        "links": [
          {
            "href": "http://104.130.30.68:8774/v2/";,
            "rel": "self"
          }
        ],
        "min_version": "",
        "version": "",
        "id": "v2.0"
      },
      {
        "status": "CURRENT",
        "updated": "2013-07-23T11:33:21Z",
        "links": [
          {
            "href": "http://104.130.30.68:8774/v2.1/";,
            "rel": "self"
          }
        ],
        "min_version": "2.1",
        "version": "2.12",
        "id": "v2.1"
      }
    ]
  }

To manage notifications about this bug go to:
https://bugs.launchpad.net/keystone/+bug/1526446/+subscriptions


Follow ups