yahoo-eng-team team mailing list archive

[rob356 <holt.r94@xxxxxxxxx>]

Public bug reported:


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.

** Affects: nova
     Importance: Undecided
         Status: New


** Tags: api-ref

-- 
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):
  New

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