← Back to team overview

yahoo-eng-team team mailing list archive

[Bug 1956506] [NEW] Doc typos in Availability Zones in nova

 

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:

- [ ] This doc is inaccurate in this way: ______
- [ ] This is a doc addition request.
- [x] I have a fix to the document that I can paste below including example: input and output.

The warning clause in the first part has a few typos.
Here is a suggestion to a one (with hopefully no typos):

The use of the default availability zone name in requests can be very
error-prone. Since the users can see the list of availability zones,
they have no way to know whether the default availability zone name
(currently nova) is provided because a host belongs to an aggregate
whose AZ metadata key is set to nova, or because there is at least one
host not belonging to any aggregate. Consequently, it is highly
recommended for users to never ever ask for booting an instance by
specifying an explicit AZ named nova and for operators to never set the
AZ metadata for an aggregate to nova. This can result in some problems
due to the fact that the instance AZ information is explicitly attached
to nova, which could break further move operations when either the host
is moved to another aggregate or when the user would like to migrate the
instance.


URL: https://docs.openstack.org/nova/latest/admin/availability-zones.html

** Affects: nova
     Importance: Undecided
         Status: New


** Tags: doc

** Description changed:

- 
  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:
  
  - [ ] This doc is inaccurate in this way: ______
  - [ ] This is a doc addition request.
- - [x] I have a fix to the document that I can paste below including example: input and output. 
+ - [x] I have a fix to the document that I can paste below including example: input and output.
  
  The warning clause in the first part has a few typos.
  Here is a suggestion to a one (with hopefully no typos):
  
  The use of the default availability zone name in requests can be very
  error-prone. Since the users can see the list of availability zones,
  they have no way to know whether the default availability zone name
  (currently nova) is provided because a host belongs to an aggregate
  whose AZ metadata key is set to nova, or because there is at least one
  host not belonging to any aggregate. Consequently, it is highly
  recommended for users to never ever ask for booting an instance by
  specifying an explicit AZ named nova and for operators to never set the
  AZ metadata for an aggregate to nova. This can result in some problems
  due to the fact that the instance AZ information is explicitly attached
  to nova, which could break further move operations when either the host
  is moved to another aggregate or when the user would like to migrate the
  instance.
  
- -----------------------------------
- Release: 24.1.0.dev143 on 2020-08-10 23:45:11
- SHA: c52d8f735192cac2f6091f25ae4350e3429d59e9
- Source: https://opendev.org/openstack/nova/src/doc/source/admin/availability-zones.rst
+ 
  URL: https://docs.openstack.org/nova/latest/admin/availability-zones.html

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

Title:
  Doc typos in Availability Zones in nova

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:

  - [ ] This doc is inaccurate in this way: ______
  - [ ] This is a doc addition request.
  - [x] I have a fix to the document that I can paste below including example: input and output.

  The warning clause in the first part has a few typos.
  Here is a suggestion to a one (with hopefully no typos):

  The use of the default availability zone name in requests can be very
  error-prone. Since the users can see the list of availability zones,
  they have no way to know whether the default availability zone name
  (currently nova) is provided because a host belongs to an aggregate
  whose AZ metadata key is set to nova, or because there is at least one
  host not belonging to any aggregate. Consequently, it is highly
  recommended for users to never ever ask for booting an instance by
  specifying an explicit AZ named nova and for operators to never set
  the AZ metadata for an aggregate to nova. This can result in some
  problems due to the fact that the instance AZ information is
  explicitly attached to nova, which could break further move operations
  when either the host is moved to another aggregate or when the user
  would like to migrate the instance.

  
  URL: https://docs.openstack.org/nova/latest/admin/availability-zones.html

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



Follow ups