yahoo-eng-team team mailing list archive

[OpenStack Infra <1736502@xxxxxxxxxxxxxxxxxx>]

Reviewed:  https://review.openstack.org/525928
Committed: https://git.openstack.org/cgit/openstack/nova/commit/?id=35dd1f9185bfac607bca1deff85af94033535cb6
Submitter: Zuul
Branch:    master

commit 35dd1f9185bfac607bca1deff85af94033535cb6
Author: Takashi NATSUME <natsume.takashi@xxxxxxxxxxxxx>
Date:   Wed Dec 6 16:23:12 2017 +0900

    api-ref: Fix a description for 'guest_format'
    
    There is a wrong format 'ephemeral' in the description.
    So remove it and valid formats ('ext2', 'ext3', 'ext4' and 'xfs')
    are added.
    The parameter is optional, so fix it as well.
    
    Change-Id: Icc04cac3a287955ab1a98b7813e3c7ec8183b120
    Closes-Bug: #1736502


** Changed in: nova
       Status: In Progress => Fix Released

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

Title:
  Compute API: Invalid options for guest_format in
  block_device_mapping_v2

Status in OpenStack Compute (nova):
  Fix Released

Bug description:

  This bug tracker is for errors with the documentation, use the
  following as a template and remove or add fields as you see fit.
  Convert [ ] into [x] to check boxes:

  - [X] This doc is inaccurate in this way: The description of the guest_format field of block_device_mapping_v2 says ephemeral is a valid option, but it is not
  - [ ] This is a doc addition request.
  - [X] I have a fix to the document that I can paste below including example: input and output. 

  If you have a troubleshooting or support issue, use the following
  resources:

   - Ask OpenStack: http://ask.openstack.org
   - The mailing list: http://lists.openstack.org
   - IRC: 'openstack' channel on Freenode

  -----------------------------------
  Release: 17.0.0.0b2.dev472 on 'Tue Dec 5 13:32:26 2017, commit 6ecb535'
  SHA: 
  Source: Can't derive source file URL
  URL: https://developer.openstack.org/api-ref/compute/

  -----------------------------------

  The doumentation for the Compute API method "POST /servers" has bad
  examples for the block_device_mapping_v2.guest_format field. In the
  description of this field it says ephemeral is a valid option, but
  using it results in an error that says ephemeral is not a valid
  format.

  Current: "Specifies the guest server disk file system format, such as ephemeral or swap."
  Change to something like: "Specifies the guest server disk file system format. A valid value is ext2, ext3, ext4, or xfs"

  I got those valid values from here: https://github.com/openstack/nova/blob/faacfeb07646115e7c8c91584d0e467a3e0064d7/nova/virt/libvirt/driver.py#L8102
  It may not be a complete list though, as I'm not sure where else the guest_format value is used. This file was just where the traceback I got when I used "ephemeral" led.

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