yahoo-eng-team team mailing list archive

[Balazs Gibizer <balazs.gibizer@xxxxxxxxxxxx>]

Public bug reported:

In the nova documentation the power of 2 (GiB, MiB) and the power of 10
(GB, MB) units are used inconsistently.

Examples:

ebalgib@elxa95hld12:~/upstream/git/nova/doc$ egrep -n -e '(GB)|(GiB)' -R ../api-ref/
../api-ref/source/parameters.yaml:910:    Filters the response by a minimum disk space, in GiB. For example, ``100``.
../api-ref/source/parameters.yaml:1557:    Amount of disk in GiB the node has.
../api-ref/source/parameters.yaml:2075:    The actual free disk on this hypervisor(in GB).
../api-ref/source/parameters.yaml:2492:    The size of the root disk that will be created in GiB. If 0 the
../api-ref/source/parameters.yaml:2504:    The size of the root disk that was created in GiB.
../api-ref/source/parameters.yaml:2511:    GiB. Ephemeral disks may be written over on server state
../api-ref/source/parameters.yaml:2520:    The size of the ephemeral disk that was created, in GiB.
../api-ref/source/parameters.yaml:2527:    GiB. Ephemeral disks may be written over on server state
../api-ref/source/parameters.yaml:2941:    The disk size on the host (in GB).
../api-ref/source/parameters.yaml:3158:    The free disk remaining on this hypervisor(in GB).
../api-ref/source/parameters.yaml:3855:    The disk in this hypervisor(in GB).
../api-ref/source/parameters.yaml:3862:    the ephemeral disk size of it (in GiB).
../api-ref/source/parameters.yaml:3869:    the ephemeral disk size of it (in GiB).
../api-ref/source/parameters.yaml:3875:    The disk used in this hypervisor(in GB).
../api-ref/source/parameters.yaml:4169:    The minimum amount of disk space an image requires to boot, in GiB. For example, ``100``.
../api-ref/source/parameters.yaml:5553:    The size of the volume, in gibibytes (GiB).
../api-ref/source/parameters.yaml:5794:    Multiplying the server disk size (in GiB) by hours the server exists,

ebalgib@elxa95hld12:~/upstream/git/nova/doc$ egrep -n -e '(MB)|(MiB)' -R ../api-ref/
../api-ref/source/parameters.yaml:916:    Filters the response by a minimum RAM, in MB. For example, ``512``.
../api-ref/source/parameters.yaml:1590:    Amount of memory in MiB the node has.
../api-ref/source/parameters.yaml:2627:    The amount of RAM a flavor has, in MiB.
../api-ref/source/parameters.yaml:2633:    The amount of RAM a flavor has, in MiB.
../api-ref/source/parameters.yaml:2669:    MiB. If 0 (the default), no dedicated swap disk will be created.
../api-ref/source/parameters.yaml:2676:    The size of a dedicated swap disk that was allocated, in MiB.
../api-ref/source/parameters.yaml:2684:    MiB. If 0 (the default), no dedicated swap disk will be created.
../api-ref/source/parameters.yaml:2888:    The free RAM in this hypervisor(in MB).
../api-ref/source/parameters.yaml:2972:    The memory size on the host (in MB).
../api-ref/source/parameters.yaml:3933:    - ``maximum`` - Amount of memory provisioned for the VM in MB (Integer)
../api-ref/source/parameters.yaml:3936:      system and its applications in MB (Integer)
../api-ref/source/parameters.yaml:3943:    The memory of this hypervisor(in MB).
../api-ref/source/parameters.yaml:3949:    The memory size of the server (in MB).
../api-ref/source/parameters.yaml:3955:    The memory size of the server (in MB).
../api-ref/source/parameters.yaml:3961:    The memory used in this hypervisor(in MB).
../api-ref/source/parameters.yaml:4175:    The minimum amount of RAM an image requires to function, in MB. For example, ``512``.
../api-ref/source/parameters.yaml:4886:    The amount of allowed server RAM, in MB, for each tenant.
../api-ref/source/parameters.yaml:4893:    The amount of allowed instance RAM, in MB, for the quota class.
../api-ref/source/parameters.yaml:4906:    The amount of allowed server RAM, in MB, for each tenant.
../api-ref/source/parameters.yaml:5801:    Multiplying the server memory size (in MB) by hours the server exists,

** Affects: nova
     Importance: Undecided
         Status: New


** Tags: api-ref doc docs

** Tags added: doc docs

** Tags added: 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/1752340

Title:
  inconsistent use of units like GiB and GB in the documentation

Status in OpenStack Compute (nova):
  New

Bug description:
  In the nova documentation the power of 2 (GiB, MiB) and the power of
  10 (GB, MB) units are used inconsistently.

  Examples:

  ebalgib@elxa95hld12:~/upstream/git/nova/doc$ egrep -n -e '(GB)|(GiB)' -R ../api-ref/
  ../api-ref/source/parameters.yaml:910:    Filters the response by a minimum disk space, in GiB. For example, ``100``.
  ../api-ref/source/parameters.yaml:1557:    Amount of disk in GiB the node has.
  ../api-ref/source/parameters.yaml:2075:    The actual free disk on this hypervisor(in GB).
  ../api-ref/source/parameters.yaml:2492:    The size of the root disk that will be created in GiB. If 0 the
  ../api-ref/source/parameters.yaml:2504:    The size of the root disk that was created in GiB.
  ../api-ref/source/parameters.yaml:2511:    GiB. Ephemeral disks may be written over on server state
  ../api-ref/source/parameters.yaml:2520:    The size of the ephemeral disk that was created, in GiB.
  ../api-ref/source/parameters.yaml:2527:    GiB. Ephemeral disks may be written over on server state
  ../api-ref/source/parameters.yaml:2941:    The disk size on the host (in GB).
  ../api-ref/source/parameters.yaml:3158:    The free disk remaining on this hypervisor(in GB).
  ../api-ref/source/parameters.yaml:3855:    The disk in this hypervisor(in GB).
  ../api-ref/source/parameters.yaml:3862:    the ephemeral disk size of it (in GiB).
  ../api-ref/source/parameters.yaml:3869:    the ephemeral disk size of it (in GiB).
  ../api-ref/source/parameters.yaml:3875:    The disk used in this hypervisor(in GB).
  ../api-ref/source/parameters.yaml:4169:    The minimum amount of disk space an image requires to boot, in GiB. For example, ``100``.
  ../api-ref/source/parameters.yaml:5553:    The size of the volume, in gibibytes (GiB).
  ../api-ref/source/parameters.yaml:5794:    Multiplying the server disk size (in GiB) by hours the server exists,

  ebalgib@elxa95hld12:~/upstream/git/nova/doc$ egrep -n -e '(MB)|(MiB)' -R ../api-ref/
  ../api-ref/source/parameters.yaml:916:    Filters the response by a minimum RAM, in MB. For example, ``512``.
  ../api-ref/source/parameters.yaml:1590:    Amount of memory in MiB the node has.
  ../api-ref/source/parameters.yaml:2627:    The amount of RAM a flavor has, in MiB.
  ../api-ref/source/parameters.yaml:2633:    The amount of RAM a flavor has, in MiB.
  ../api-ref/source/parameters.yaml:2669:    MiB. If 0 (the default), no dedicated swap disk will be created.
  ../api-ref/source/parameters.yaml:2676:    The size of a dedicated swap disk that was allocated, in MiB.
  ../api-ref/source/parameters.yaml:2684:    MiB. If 0 (the default), no dedicated swap disk will be created.
  ../api-ref/source/parameters.yaml:2888:    The free RAM in this hypervisor(in MB).
  ../api-ref/source/parameters.yaml:2972:    The memory size on the host (in MB).
  ../api-ref/source/parameters.yaml:3933:    - ``maximum`` - Amount of memory provisioned for the VM in MB (Integer)
  ../api-ref/source/parameters.yaml:3936:      system and its applications in MB (Integer)
  ../api-ref/source/parameters.yaml:3943:    The memory of this hypervisor(in MB).
  ../api-ref/source/parameters.yaml:3949:    The memory size of the server (in MB).
  ../api-ref/source/parameters.yaml:3955:    The memory size of the server (in MB).
  ../api-ref/source/parameters.yaml:3961:    The memory used in this hypervisor(in MB).
  ../api-ref/source/parameters.yaml:4175:    The minimum amount of RAM an image requires to function, in MB. For example, ``512``.
  ../api-ref/source/parameters.yaml:4886:    The amount of allowed server RAM, in MB, for each tenant.
  ../api-ref/source/parameters.yaml:4893:    The amount of allowed instance RAM, in MB, for the quota class.
  ../api-ref/source/parameters.yaml:4906:    The amount of allowed server RAM, in MB, for each tenant.
  ../api-ref/source/parameters.yaml:5801:    Multiplying the server memory size (in MB) by hours the server exists,

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