← Back to team overview

yahoo-eng-team team mailing list archive

[Bug 1673869] [NEW] api-ref: os-pci API is not documented at all

 

Public bug reported:

This API is not in the compute API reference at all:

https://github.com/openstack/nova/blob/master/nova/api/openstack/compute/pci.py

https://developer.openstack.org/api-ref/compute/

There are really three parts there:

1. PciServerController shows PCI information for a given server, so
that's an extension of the /servers API. That puts the os-
pci:pci_devices key in the server response body.

2. PciHypervisorController shows PCI devices on a given compute node, so
that's an extension of the /os-hypervisors API. That puts the os-
pci:pci_stats key in the os-hypervisors response body.

3. PciController is for listing all PCI devices and showing details
about a specific PCI device. When listing PCI devices in this API, we
query all compute nodes, and then for each compute node we get the PCI
devices and dump those into a list of dicts where the keys are
whitelisted and based on whether or not we're listing PCI devices with
details or not.

** Affects: nova
     Importance: Low
         Status: Confirmed


** Tags: api-ref pci

-- 
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/1673869

Title:
  api-ref: os-pci API is not documented at all

Status in OpenStack Compute (nova):
  Confirmed

Bug description:
  This API is not in the compute API reference at all:

  https://github.com/openstack/nova/blob/master/nova/api/openstack/compute/pci.py

  https://developer.openstack.org/api-ref/compute/

  There are really three parts there:

  1. PciServerController shows PCI information for a given server, so
  that's an extension of the /servers API. That puts the os-
  pci:pci_devices key in the server response body.

  2. PciHypervisorController shows PCI devices on a given compute node,
  so that's an extension of the /os-hypervisors API. That puts the os-
  pci:pci_stats key in the os-hypervisors response body.

  3. PciController is for listing all PCI devices and showing details
  about a specific PCI device. When listing PCI devices in this API, we
  query all compute nodes, and then for each compute node we get the PCI
  devices and dump those into a list of dicts where the keys are
  whitelisted and based on whether or not we're listing PCI devices with
  details or not.

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


Follow ups