openstack/cinder-specs
Code Issues Proposed changes

Fix: docs job

Browse Source 
The warnings for footnotes not being referenced are now treated
as errors and we see gate is failing with the following errors.

2024-11-04 08:55:48.092592 | ubuntu-jammy | /home/zuul/src/opendev.org/openstack/cinder-specs/doc/source/specs/liberty/rootwrap-daemon-mode.rst:180: WARNING: Footnote [#] is not referenced. [ref.footnote]
2024-11-04 08:55:48.093125 | ubuntu-jammy | /home/zuul/src/opendev.org/openstack/cinder-specs/doc/source/specs/liberty/rootwrap-daemon-mode.rst:186: WARNING: Footnote [#] is not referenced. [ref.footnote]
2024-11-04 08:55:48.093154 | ubuntu-jammy | /home/zuul/src/opendev.org/openstack/cinder-specs/doc/source/specs/liberty/rootwrap-daemon-mode.rst:189: WARNING: Footnote [#] is not referenced. [ref.footnote]

This is easy to fix by adding references to the footnotes as done
in this patch.

Change-Id: I9991ad83abac99b10d8d7421c0934e1eb84b26cc
This commit is contained in:
Rajat Dhasmana
2024-11-04 14:28:26 +05:30
parent 48e03693e4
commit 6e6af443fb
1 changed files with 7 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
specs/liberty/rootwrap-daemon-mode.rst
View File

@@ -16,14 +16,14 @@ and rootwrap produce significant performance overhead. This blueprint
is one of the series of blueprints that would cover mitigating rootwrap is one of the series of blueprints that would cover mitigating rootwrap
part of the overhead using new mode of operations for rootwrap - daemon part of the overhead using new mode of operations for rootwrap - daemon
mode. These blueprints will be created in several projects starting mode. These blueprints will be created in several projects starting
with oslo.rootwrap [#rw_bp]. with oslo.rootwrap [#rw_bp]_.
Problem description Problem description
=================== ===================
As you can see in [#ne_ml] rootwrap presents big performance overhead for As you can see in [#ne_ml]_ rootwrap presents big performance overhead for
Neutron. Impact on Cinder is not as significant but it is still there. Neutron. Impact on Cinder is not as significant but it is still there.
Details of the overhead are covered in [#rw_bp]. Details of the overhead are covered in [#rw_bp]_.
Use Cases Use Cases
========= =========
@@ -42,7 +42,7 @@ Note that this is not usual RPC over some message queue. It uses UNIX socket,
so no remote connections are available. It also uses digest authentication so no remote connections are available. It also uses digest authentication
with key shared over stdout (pipe) with parent process, so no other processes with key shared over stdout (pipe) with parent process, so no other processes
will have access to the daemon. Further details of rootwrap daemon are covered will have access to the daemon. Further details of rootwrap daemon are covered
in [#rw_bp]. in [#rw_bp]_.
``use_rootwrap_daemon`` configuration option should be added that will make ``use_rootwrap_daemon`` configuration option should be added that will make
``utils.execute`` use daemon instead of usual rootwrap. ``utils.execute`` use daemon instead of usual rootwrap.
@@ -50,7 +50,7 @@ in [#rw_bp].
Alternatives Alternatives
------------ ------------
Alternative approaches have been discussed in [#rw_eth]. Alternative approaches have been discussed in [#rw_eth]_.
Data model impact Data model impact
----------------- -----------------
@@ -69,7 +69,7 @@ This change requires additional endpoint to be available to run as root -
``cinder-rootwrap-daemon``. ``cinder-rootwrap-daemon``.
All security issues with using client+daemon instead of plain rootwrap are All security issues with using client+daemon instead of plain rootwrap are
covered in [#rw_bp]. covered in [#rw_bp]_.
Notifications impact Notifications impact
-------------------- --------------------
@@ -87,7 +87,7 @@ Performance Impact
This change introduces performance boost for disk operations that are This change introduces performance boost for disk operations that are
required to be run with root privileges. Current state of rootwrap daemon required to be run with root privileges. Current state of rootwrap daemon
in Neutron shows over 10x speedup comparing to usual ``sudo rootwrap`` call. in Neutron shows over 10x speedup comparing to usual ``sudo rootwrap`` call.
Total speedup for Cinder shows impressive results too [#rw_perf]: Total speedup for Cinder shows impressive results too [#rw_perf]_:
test scenario CinderVolumes.create_and_delete_volume test scenario CinderVolumes.create_and_delete_volume
Current performance : Current performance :