← Back to team overview

yahoo-eng-team team mailing list archive

[Bug 1817963] [NEW] API reference tells users to not create servers with availability_zone "nova" but the server create samples use "nova" for the AZ :(

 

Public bug reported:

https://developer.openstack.org/api-ref/compute/?expanded=create-server-
detail#create-server

>From the "availability_zone" parameter description:

"You can list the available availability zones by calling the os-
availability-zone API, but you should avoid using the default
availability zone when booting the instance. In general, the default
availability zone is named nova. This AZ is only shown when listing the
availability zones as an admin."

And the user docs on AZs:

https://docs.openstack.org/nova/latest/user/aggregates.html
#availability-zones-azs

Yet the 2.1 and 2.63 samples use:

"availability_zone": "nova",

The API samples should be updated to match the warning in the parameter
description.

** Affects: nova
     Importance: Medium
     Assignee: Matt Riedemann (mriedem)
         Status: Triaged


** Tags: api-ref docs

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

Title:
  API reference tells users to not create servers with availability_zone
  "nova" but the server create samples use "nova" for the AZ :(

Status in OpenStack Compute (nova):
  Triaged

Bug description:
  https://developer.openstack.org/api-ref/compute/?expanded=create-
  server-detail#create-server

  From the "availability_zone" parameter description:

  "You can list the available availability zones by calling the os-
  availability-zone API, but you should avoid using the default
  availability zone when booting the instance. In general, the default
  availability zone is named nova. This AZ is only shown when listing
  the availability zones as an admin."

  And the user docs on AZs:

  https://docs.openstack.org/nova/latest/user/aggregates.html
  #availability-zones-azs

  Yet the 2.1 and 2.63 samples use:

  "availability_zone": "nova",

  The API samples should be updated to match the warning in the
  parameter description.

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


Follow ups