Flavor property "hw_rng:rate_period" should be milliseconds

Bug #1843542 reported by Jordan Ansell on 2019-09-11
12
This bug affects 1 person
Affects Status Importance Assigned to Milestone
OpenStack Compute (nova)
Medium
Takashi Natsume
Pike
Medium
Unassigned
Queens
Medium
Takashi Natsume
Rocky
Medium
Takashi Natsume
Stein
Medium
Takashi Natsume
Train
Medium
Takashi Natsume

Bug Description

Error in "doc/source/user/flavors.rst"

In "Random-number generator" section

Currently reads:
"RATE-PERIOD: (integer) Duration of the read period in seconds."

Should read:
"RATE-PERIOD: (integer) Duration of the read period in milliseconds."

Please see: https://libvirt.org/formatdomain.html#elementsRng for reference.

Either the documentation needs to be updated of the nova needs to convert the given value into milliseconds before passing it to libvirt.

Matt Riedemann (mriedem) wrote :

Seems that's been removed from the latest docs:

https://docs.openstack.org/nova/latest/user/flavors.html

tags: added: doc
Matt Riedemann (mriedem) wrote :

Oh nevermind it's there on master as well.

Matt Riedemann (mriedem) wrote :

Looking at the libvirt driver code it does not do any conversion from seconds to milliseconds so yeah the docs are wrong when looking at the libvirt docs. The flavor extra spec docs should also mention that is a libvirt-only spec at the moment, no other compute driver is using that spec.

tags: added: low-hanging-fruit
Changed in nova:
status: New → Confirmed
importance: Undecided → Medium
Changed in nova:
assignee: nobody → Takashi NATSUME (natsume-takashi)

Fix proposed to branch: master
Review: https://review.opendev.org/683051

Changed in nova:
status: Confirmed → In Progress

Reviewed: https://review.opendev.org/683051
Committed: https://git.openstack.org/cgit/openstack/nova/commit/?id=976120cb20da46258df87b8fa43ba0f8ee6dc675
Submitter: Zuul
Branch: master

commit 976120cb20da46258df87b8fa43ba0f8ee6dc675
Author: Takashi NATSUME <email address hidden>
Date: Thu Sep 19 16:38:25 2019 +0900

    Fix unit of hw_rng:rate_period

    Replace seconds with milliseconds
    in the description of hw_rng:rate_period.

    * https://libvirt.org/formatdomain.html#elementsRng

    Change-Id: I285f68c81b0587c6a197d4791b09234a1697f5e7
    Closes-Bug: #1843542

Changed in nova:
status: In Progress → Fix Released

Reviewed: https://review.opendev.org/688083
Committed: https://git.openstack.org/cgit/openstack/nova/commit/?id=875826df959bf953609aa66d793793afa5ad618a
Submitter: Zuul
Branch: stable/train

commit 875826df959bf953609aa66d793793afa5ad618a
Author: Takashi NATSUME <email address hidden>
Date: Thu Sep 19 16:38:25 2019 +0900

    Fix unit of hw_rng:rate_period

    Replace seconds with milliseconds
    in the description of hw_rng:rate_period.

    * https://libvirt.org/formatdomain.html#elementsRng

    Change-Id: I285f68c81b0587c6a197d4791b09234a1697f5e7
    Closes-Bug: #1843542
    (cherry picked from commit 976120cb20da46258df87b8fa43ba0f8ee6dc675)

Reviewed: https://review.opendev.org/689153
Committed: https://git.openstack.org/cgit/openstack/nova/commit/?id=792ec7c1df7fd5c191da6f2feb961ad43f81dfa4
Submitter: Zuul
Branch: stable/stein

commit 792ec7c1df7fd5c191da6f2feb961ad43f81dfa4
Author: Takashi NATSUME <email address hidden>
Date: Thu Sep 19 16:38:25 2019 +0900

    Fix unit of hw_rng:rate_period

    Replace seconds with milliseconds
    in the description of hw_rng:rate_period.

    * https://libvirt.org/formatdomain.html#elementsRng

    Change-Id: I285f68c81b0587c6a197d4791b09234a1697f5e7
    Closes-Bug: #1843542
    (cherry picked from commit 976120cb20da46258df87b8fa43ba0f8ee6dc675)
    (cherry picked from commit 875826df959bf953609aa66d793793afa5ad618a)

Reviewed: https://review.opendev.org/689154
Committed: https://git.openstack.org/cgit/openstack/nova/commit/?id=ff57ea7fb6a15ff90ff33b0dc7a28426adc840ee
Submitter: Zuul
Branch: stable/rocky

commit ff57ea7fb6a15ff90ff33b0dc7a28426adc840ee
Author: Takashi NATSUME <email address hidden>
Date: Thu Sep 19 16:38:25 2019 +0900

    Fix unit of hw_rng:rate_period

    Replace seconds with milliseconds
    in the description of hw_rng:rate_period.

    * https://libvirt.org/formatdomain.html#elementsRng

    Change-Id: I285f68c81b0587c6a197d4791b09234a1697f5e7
    Closes-Bug: #1843542
    (cherry picked from commit 976120cb20da46258df87b8fa43ba0f8ee6dc675)
    (cherry picked from commit 875826df959bf953609aa66d793793afa5ad618a)
    (cherry picked from commit 792ec7c1df7fd5c191da6f2feb961ad43f81dfa4)

Reviewed: https://review.opendev.org/689155
Committed: https://git.openstack.org/cgit/openstack/nova/commit/?id=55a3796692406e916e17213c5d841281f18e6cc1
Submitter: Zuul
Branch: stable/queens

commit 55a3796692406e916e17213c5d841281f18e6cc1
Author: Takashi NATSUME <email address hidden>
Date: Thu Sep 19 16:38:25 2019 +0900

    Fix unit of hw_rng:rate_period

    Replace seconds with milliseconds
    in the description of hw_rng:rate_period.

    * https://libvirt.org/formatdomain.html#elementsRng

    Change-Id: I285f68c81b0587c6a197d4791b09234a1697f5e7
    Closes-Bug: #1843542
    (cherry picked from commit 976120cb20da46258df87b8fa43ba0f8ee6dc675)
    (cherry picked from commit 875826df959bf953609aa66d793793afa5ad618a)
    (cherry picked from commit 792ec7c1df7fd5c191da6f2feb961ad43f81dfa4)
    (cherry picked from commit ff57ea7fb6a15ff90ff33b0dc7a28426adc840ee)

This issue was fixed in the openstack/nova 17.0.13 release.

This issue was fixed in the openstack/nova 20.0.1 release.

This issue was fixed in the openstack/nova 19.1.0 release.

This issue was fixed in the openstack/nova 18.3.0 release.

To post a comment you must log in.
This report contains Public information  Edit
Everyone can see this information.

Duplicates of this bug

Other bug subscribers