Remove sphinxcontrib.seqdiag

The tool but it seems it is no longer maintained, with no
commits since late 2021 [1]. Remove it, capturing static copies of the
SVGs it was generating so we don't lose information..

Fix warnings about footnotes not being referenced by removing the
footnote marker and simply leaving the link in the references section.

[1] https://github.com/blockdiag/blockdiag

Change-Id: Ie87f5bed688c8cd1d924d95a81a509cdcf16f491
Signed-off-by: jgilaber <jgilaber@redhat.com>
This commit is contained in:
jgilaber
2026-02-26 12:59:59 +01:00
parent 08886300a2
commit c4a7d78338
10 changed files with 274 additions and 111 deletions
-1
View File
@@ -2,6 +2,5 @@
# of appearance. Changing the order has an impact on the overall integration
# process, which may cause wedges in the gate later.
sphinx>=2.0.0,!=2.1.0 # BSD
sphinxcontrib-seqdiag>=0.8.4 # BSD
openstackdocstheme>=2.2.1 # Apache-2.0
yasfb>=0.5.1
+8 -11
View File
@@ -24,7 +24,6 @@ extensions = [
'sphinx.ext.autodoc',
'openstackdocstheme',
#'sphinx.ext.intersphinx',
'sphinxcontrib.seqdiag',
'yasfb',
]
@@ -77,16 +76,14 @@ htmlhelp_basename = '%sdoc' % project
# (source start file, target name, title, author, documentclass
# [howto/manual]).
latex_documents = [
('index',
'%s.tex' % project,
'%s Documentation' % project,
'OpenStack Developers', 'manual'),
(
'index',
'%s.tex' % project,
'%s Documentation' % project,
'OpenStack Developers',
'manual',
),
]
# Example configuration for intersphinx: refer to the Python standard library.
#intersphinx_mapping = {'http://docs.python.org/': None}
# -- seqdiag configuration ----------------------------------------------------
seqdiag_html_image_format = 'SVG'
seqdiag_antialias = True
# intersphinx_mapping = {'http://docs.python.org/': None}
@@ -0,0 +1,125 @@
<?xml version='1.0' encoding='UTF-8'?>
<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.0//EN" "http://www.w3.org/TR/2001/REC-SVG-20010904/DTD/svg10.dtd">
<svg viewBox="0 0 856 885" xmlns="http://www.w3.org/2000/svg" xmlns:inkspace="http://www.inkscape.org/namespaces/inkscape" xmlns:xlink="http://www.w3.org/1999/xlink">
<defs id="defs_block">
<filter height="1.504" id="filter_blur" inkspace:collect="always" width="1.1575" x="-0.07875" y="-0.252">
<feGaussianBlur id="feGaussianBlur3780" inkspace:collect="always" stdDeviation="4.2" />
</filter>
</defs>
<title>blockdiag</title>
<desc>seqdiag {
edge_length = 200;
span_height = 15;
activation = none;
default_note_color = white;
'Nova Controller'; 'Placement'; 'Cyborg'; 'Nova Compute';
'Nova Controller' -&gt; 'Cyborg' [label =
"GET /v2/device_profiles?name=mydp"];
'Nova Controller' &lt;- 'Cyborg' [label =
'{"device_profiles": $device_profile}'];
'Nova Controller' -&gt; 'Nova Controller' [label=
'Merge request groups into request_spec'];
'Nova Controller' -&gt; 'Placement' [label=
'Get /allocation_candidates'];
'Nova Controller' &lt;- 'Placement' [label=
'allocation candidates with nested RPs'];
'Nova Controller' -&gt; 'Nova Controller' [label=
'Select a candidate'];
'Nova Controller' -&gt; 'Nova Compute' [label=
'build_and_run_instances()'];
'Nova Compute' -&gt; 'Cyborg' [label=
'POST /v2/accelerator_requests'];
'Nova Compute' &lt;- 'Cyborg' [label=
'{"arqs": [$arq, ...]'];
'Nova Compute' -&gt; 'Cyborg' [label=
'PATCH /v2/accelerator_requests'];
'Nova Compute' &lt;- 'Cyborg' [label=
'{"arqs": [$arq, ...]'];
'Cyborg' -&gt; 'Nova Controller' [label=
'POST /os-server-external-events'];
'Nova Compute' -&gt; 'Nova Compute' [label=
'Wait for notification from Cyborg'];
'Nova Compute' -&gt; 'Cyborg' [label=
'GET /v2/accelerator_requests?
instance=$uuid&amp;bind_state=resolved'];
'Nova Compute' &lt;- 'Cyborg' [label=
'{"arqs": [$arq, ....]}'];
}
</desc>
<rect fill="rgb(0,0,0)" height="40" stroke="rgb(0,0,0)" style="filter:url(#filter_blur);opacity:0.7;fill-opacity:1" width="128" x="67" y="21" />
<rect fill="rgb(0,0,0)" height="40" stroke="rgb(0,0,0)" style="filter:url(#filter_blur);opacity:0.7;fill-opacity:1" width="128" x="267" y="21" />
<rect fill="rgb(0,0,0)" height="40" stroke="rgb(0,0,0)" style="filter:url(#filter_blur);opacity:0.7;fill-opacity:1" width="128" x="467" y="21" />
<rect fill="rgb(0,0,0)" height="40" stroke="rgb(0,0,0)" style="filter:url(#filter_blur);opacity:0.7;fill-opacity:1" width="128" x="667" y="21" />
<path d="M 128 55 L 128 885" fill="none" stroke="rgb(0,0,0)" stroke-dasharray="8 4" />
<path d="M 328 55 L 328 885" fill="none" stroke="rgb(0,0,0)" stroke-dasharray="8 4" />
<path d="M 528 55 L 528 885" fill="none" stroke="rgb(0,0,0)" stroke-dasharray="8 4" />
<path d="M 728 55 L 728 885" fill="none" stroke="rgb(0,0,0)" stroke-dasharray="8 4" />
<rect fill="rgb(255,255,255)" height="40" stroke="rgb(0,0,0)" width="128" x="64" y="15" />
<text fill="rgb(0,0,0)" font-family="sans-serif" font-size="11" font-style="normal" font-weight="normal" text-anchor="middle" textLength="90" x="128.0" y="41">Nova Controller</text>
<rect fill="rgb(255,255,255)" height="40" stroke="rgb(0,0,0)" width="128" x="264" y="15" />
<text fill="rgb(0,0,0)" font-family="sans-serif" font-size="11" font-style="normal" font-weight="normal" text-anchor="middle" textLength="54" x="328.0" y="41">Placement</text>
<rect fill="rgb(255,255,255)" height="40" stroke="rgb(0,0,0)" width="128" x="464" y="15" />
<text fill="rgb(0,0,0)" font-family="sans-serif" font-size="11" font-style="normal" font-weight="normal" text-anchor="middle" textLength="36" x="528.0" y="41">Cyborg</text>
<rect fill="rgb(255,255,255)" height="40" stroke="rgb(0,0,0)" width="128" x="664" y="15" />
<text fill="rgb(0,0,0)" font-family="sans-serif" font-size="11" font-style="normal" font-weight="normal" text-anchor="middle" textLength="72" x="728.0" y="41">Nova Compute</text>
<path d="M 136 85 L 520 85" fill="none" stroke="rgb(0,0,0)" />
<polygon fill="rgb(0,0,0)" points="512,81 520,85 512,89" stroke="rgb(0,0,0)" />
<path d="M 136 125 L 520 125" fill="none" stroke="rgb(0,0,0)" />
<polygon fill="rgb(0,0,0)" points="144,121 136,125 144,129" stroke="rgb(0,0,0)" />
<path d="M 136 191 L 224 191" fill="none" stroke="rgb(0,0,0)" />
<path d="M 224 191 L 224 207" fill="none" stroke="rgb(0,0,0)" />
<path d="M 224 207 L 136 207" fill="none" stroke="rgb(0,0,0)" />
<polygon fill="rgb(0,0,0)" points="144,203 136,207 144,211" stroke="rgb(0,0,0)" />
<path d="M 136 247 L 320 247" fill="none" stroke="rgb(0,0,0)" />
<polygon fill="rgb(0,0,0)" points="312,243 320,247 312,251" stroke="rgb(0,0,0)" />
<path d="M 136 300 L 320 300" fill="none" stroke="rgb(0,0,0)" />
<polygon fill="rgb(0,0,0)" points="144,296 136,300 144,304" stroke="rgb(0,0,0)" />
<path d="M 136 353 L 224 353" fill="none" stroke="rgb(0,0,0)" />
<path d="M 224 353 L 224 369" fill="none" stroke="rgb(0,0,0)" />
<path d="M 224 369 L 136 369" fill="none" stroke="rgb(0,0,0)" />
<polygon fill="rgb(0,0,0)" points="144,365 136,369 144,373" stroke="rgb(0,0,0)" />
<path d="M 136 409 L 720 409" fill="none" stroke="rgb(0,0,0)" />
<polygon fill="rgb(0,0,0)" points="712,405 720,409 712,413" stroke="rgb(0,0,0)" />
<path d="M 536 462 L 720 462" fill="none" stroke="rgb(0,0,0)" />
<polygon fill="rgb(0,0,0)" points="544,458 536,462 544,466" stroke="rgb(0,0,0)" />
<path d="M 536 502 L 720 502" fill="none" stroke="rgb(0,0,0)" />
<polygon fill="rgb(0,0,0)" points="712,498 720,502 712,506" stroke="rgb(0,0,0)" />
<path d="M 536 555 L 720 555" fill="none" stroke="rgb(0,0,0)" />
<polygon fill="rgb(0,0,0)" points="544,551 536,555 544,559" stroke="rgb(0,0,0)" />
<path d="M 536 595 L 720 595" fill="none" stroke="rgb(0,0,0)" />
<polygon fill="rgb(0,0,0)" points="712,591 720,595 712,599" stroke="rgb(0,0,0)" />
<path d="M 136 635 L 520 635" fill="none" stroke="rgb(0,0,0)" />
<polygon fill="rgb(0,0,0)" points="144,631 136,635 144,639" stroke="rgb(0,0,0)" />
<path d="M 736 701 L 816 701" fill="none" stroke="rgb(0,0,0)" />
<path d="M 816 701 L 816 717" fill="none" stroke="rgb(0,0,0)" />
<path d="M 816 717 L 736 717" fill="none" stroke="rgb(0,0,0)" />
<polygon fill="rgb(0,0,0)" points="744,713 736,717 744,721" stroke="rgb(0,0,0)" />
<path d="M 536 796 L 720 796" fill="none" stroke="rgb(0,0,0)" />
<polygon fill="rgb(0,0,0)" points="544,792 536,796 544,800" stroke="rgb(0,0,0)" />
<path d="M 536 836 L 720 836" fill="none" stroke="rgb(0,0,0)" />
<polygon fill="rgb(0,0,0)" points="712,832 720,836 712,840" stroke="rgb(0,0,0)" />
<text fill="rgb(0,0,0)" font-family="sans-serif" font-size="11" font-style="normal" font-weight="normal" text-anchor="middle" textLength="198" x="243.0" y="81">GET /v2/device_profiles?name=mydp</text>
<text fill="rgb(0,0,0)" font-family="sans-serif" font-size="11" font-style="normal" font-weight="normal" text-anchor="middle" textLength="216" x="408.0" y="121">{"device_profiles": $device_profile}</text>
<text fill="rgb(0,0,0)" font-family="sans-serif" font-size="11" font-style="normal" font-weight="normal" text-anchor="middle" textLength="108" x="194.0" y="161">Merge request grou</text>
<text fill="rgb(0,0,0)" font-family="sans-serif" font-size="11" font-style="normal" font-weight="normal" text-anchor="middle" textLength="108" x="194.0" y="174">ps into request_sp</text>
<text fill="rgb(0,0,0)" font-family="sans-serif" font-size="11" font-style="normal" font-weight="normal" text-anchor="middle" textLength="12" x="146.0" y="187">ec</text>
<text fill="rgb(0,0,0)" font-family="sans-serif" font-size="11" font-style="normal" font-weight="normal" text-anchor="middle" textLength="156" x="222.0" y="243">Get /allocation_candidates</text>
<text fill="rgb(0,0,0)" font-family="sans-serif" font-size="11" font-style="normal" font-weight="normal" text-anchor="middle" textLength="174" x="229.0" y="283">allocation candidates with ne</text>
<text fill="rgb(0,0,0)" font-family="sans-serif" font-size="11" font-style="normal" font-weight="normal" text-anchor="middle" textLength="48" x="292.0" y="296">sted RPs</text>
<text fill="rgb(0,0,0)" font-family="sans-serif" font-size="11" font-style="normal" font-weight="normal" text-anchor="middle" textLength="108" x="194.0" y="343">Select a candidate</text>
<text fill="rgb(0,0,0)" font-family="sans-serif" font-size="11" font-style="normal" font-weight="normal" text-anchor="middle" textLength="150" x="219.0" y="405">build_and_run_instances()</text>
<text fill="rgb(0,0,0)" font-family="sans-serif" font-size="11" font-style="normal" font-weight="normal" text-anchor="middle" textLength="174" x="629.0" y="452">POST /v2/accelerator_requests</text>
<text fill="rgb(0,0,0)" font-family="sans-serif" font-size="11" font-style="normal" font-weight="normal" text-anchor="middle" textLength="120" x="604.0" y="498">{"arqs": [$arq, ...]</text>
<text fill="rgb(0,0,0)" font-family="sans-serif" font-size="11" font-style="normal" font-weight="normal" text-anchor="middle" textLength="174" x="629.0" y="538">PATCH /v2/accelerator_request</text>
<text fill="rgb(0,0,0)" font-family="sans-serif" font-size="11" font-style="normal" font-weight="normal" text-anchor="middle" textLength="6" x="713.0" y="551">s</text>
<text fill="rgb(0,0,0)" font-family="sans-serif" font-size="11" font-style="normal" font-weight="normal" text-anchor="middle" textLength="120" x="604.0" y="591">{"arqs": [$arq, ...]</text>
<text fill="rgb(0,0,0)" font-family="sans-serif" font-size="11" font-style="normal" font-weight="normal" text-anchor="middle" textLength="186" x="423.0" y="631">POST /os-server-external-events</text>
<text fill="rgb(0,0,0)" font-family="sans-serif" font-size="11" font-style="normal" font-weight="normal" text-anchor="middle" textLength="96" x="788.0" y="671">Wait for notific</text>
<text fill="rgb(0,0,0)" font-family="sans-serif" font-size="11" font-style="normal" font-weight="normal" text-anchor="middle" textLength="96" x="788.0" y="684">ation from Cybor</text>
<text fill="rgb(0,0,0)" font-family="sans-serif" font-size="11" font-style="normal" font-weight="normal" text-anchor="middle" textLength="6" x="743.0" y="697">g</text>
<text fill="rgb(0,0,0)" font-family="sans-serif" font-size="11" font-style="normal" font-weight="normal" text-anchor="middle" textLength="174" x="629.0" y="760">GET /v2/accelerator_requests?</text>
<text fill="rgb(0,0,0)" font-family="sans-serif" font-size="11" font-style="normal" font-weight="normal" text-anchor="middle" textLength="174" x="629.0" y="773">instance=$uuid&amp;bind_state=res</text>
<text fill="rgb(0,0,0)" font-family="sans-serif" font-size="11" font-style="normal" font-weight="normal" text-anchor="middle" textLength="30" x="701.0" y="786">olved</text>
<text fill="rgb(0,0,0)" font-family="sans-serif" font-size="11" font-style="normal" font-weight="normal" text-anchor="middle" textLength="132" x="610.0" y="832">{"arqs": [$arq, ....]}</text>
</svg>

After

Width:  |  Height:  |  Size: 11 KiB

@@ -0,0 +1,125 @@
<?xml version='1.0' encoding='UTF-8'?>
<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.0//EN" "http://www.w3.org/TR/2001/REC-SVG-20010904/DTD/svg10.dtd">
<svg viewBox="0 0 856 885" xmlns="http://www.w3.org/2000/svg" xmlns:inkspace="http://www.inkscape.org/namespaces/inkscape" xmlns:xlink="http://www.w3.org/1999/xlink">
<defs id="defs_block">
<filter height="1.504" id="filter_blur" inkspace:collect="always" width="1.1575" x="-0.07875" y="-0.252">
<feGaussianBlur id="feGaussianBlur3780" inkspace:collect="always" stdDeviation="4.2" />
</filter>
</defs>
<title>blockdiag</title>
<desc>seqdiag {
edge_length = 200;
span_height = 15;
activation = none;
default_note_color = white;
'Nova Controller'; 'Placement'; 'Cyborg'; 'Nova Compute';
'Nova Controller' -&gt; 'Cyborg' [label =
"GET /v2/device_profiles?name=mydp"];
'Nova Controller' &lt;- 'Cyborg' [label =
'{"device_profiles": $device_profile}'];
'Nova Controller' -&gt; 'Nova Controller' [label=
'Merge request groups into request_spec'];
'Nova Controller' -&gt; 'Placement' [label=
'Get /allocation_candidates'];
'Nova Controller' &lt;- 'Placement' [label=
'allocation candidates with nested RPs'];
'Nova Controller' -&gt; 'Nova Controller' [label=
'Select a candidate'];
'Nova Controller' -&gt; 'Nova Compute' [label=
'build_and_run_instances()'];
'Nova Compute' -&gt; 'Cyborg' [label=
'POST /v2/accelerator_requests'];
'Nova Compute' &lt;- 'Cyborg' [label=
'{"arqs": [$arq, ...]'];
'Nova Compute' -&gt; 'Cyborg' [label=
'PATCH /v2/accelerator_requests'];
'Nova Compute' &lt;- 'Cyborg' [label=
'{"arqs": [$arq, ...]'];
'Cyborg' -&gt; 'Nova Controller' [label=
'POST /os-server-external-events'];
'Nova Compute' -&gt; 'Nova Compute' [label=
'Wait for notification from Cyborg'];
'Nova Compute' -&gt; 'Cyborg' [label=
'GET /v2/accelerator_requests?
instance=$uuid&amp;bind_state=resolved'];
'Nova Compute' &lt;- 'Cyborg' [label=
'{"arqs": [$arq, ....]}'];
}
</desc>
<rect fill="rgb(0,0,0)" height="40" stroke="rgb(0,0,0)" style="filter:url(#filter_blur);opacity:0.7;fill-opacity:1" width="128" x="67" y="21" />
<rect fill="rgb(0,0,0)" height="40" stroke="rgb(0,0,0)" style="filter:url(#filter_blur);opacity:0.7;fill-opacity:1" width="128" x="267" y="21" />
<rect fill="rgb(0,0,0)" height="40" stroke="rgb(0,0,0)" style="filter:url(#filter_blur);opacity:0.7;fill-opacity:1" width="128" x="467" y="21" />
<rect fill="rgb(0,0,0)" height="40" stroke="rgb(0,0,0)" style="filter:url(#filter_blur);opacity:0.7;fill-opacity:1" width="128" x="667" y="21" />
<path d="M 128 55 L 128 885" fill="none" stroke="rgb(0,0,0)" stroke-dasharray="8 4" />
<path d="M 328 55 L 328 885" fill="none" stroke="rgb(0,0,0)" stroke-dasharray="8 4" />
<path d="M 528 55 L 528 885" fill="none" stroke="rgb(0,0,0)" stroke-dasharray="8 4" />
<path d="M 728 55 L 728 885" fill="none" stroke="rgb(0,0,0)" stroke-dasharray="8 4" />
<rect fill="rgb(255,255,255)" height="40" stroke="rgb(0,0,0)" width="128" x="64" y="15" />
<text fill="rgb(0,0,0)" font-family="sans-serif" font-size="11" font-style="normal" font-weight="normal" text-anchor="middle" textLength="90" x="128.0" y="41">Nova Controller</text>
<rect fill="rgb(255,255,255)" height="40" stroke="rgb(0,0,0)" width="128" x="264" y="15" />
<text fill="rgb(0,0,0)" font-family="sans-serif" font-size="11" font-style="normal" font-weight="normal" text-anchor="middle" textLength="54" x="328.0" y="41">Placement</text>
<rect fill="rgb(255,255,255)" height="40" stroke="rgb(0,0,0)" width="128" x="464" y="15" />
<text fill="rgb(0,0,0)" font-family="sans-serif" font-size="11" font-style="normal" font-weight="normal" text-anchor="middle" textLength="36" x="528.0" y="41">Cyborg</text>
<rect fill="rgb(255,255,255)" height="40" stroke="rgb(0,0,0)" width="128" x="664" y="15" />
<text fill="rgb(0,0,0)" font-family="sans-serif" font-size="11" font-style="normal" font-weight="normal" text-anchor="middle" textLength="72" x="728.0" y="41">Nova Compute</text>
<path d="M 136 85 L 520 85" fill="none" stroke="rgb(0,0,0)" />
<polygon fill="rgb(0,0,0)" points="512,81 520,85 512,89" stroke="rgb(0,0,0)" />
<path d="M 136 125 L 520 125" fill="none" stroke="rgb(0,0,0)" />
<polygon fill="rgb(0,0,0)" points="144,121 136,125 144,129" stroke="rgb(0,0,0)" />
<path d="M 136 191 L 224 191" fill="none" stroke="rgb(0,0,0)" />
<path d="M 224 191 L 224 207" fill="none" stroke="rgb(0,0,0)" />
<path d="M 224 207 L 136 207" fill="none" stroke="rgb(0,0,0)" />
<polygon fill="rgb(0,0,0)" points="144,203 136,207 144,211" stroke="rgb(0,0,0)" />
<path d="M 136 247 L 320 247" fill="none" stroke="rgb(0,0,0)" />
<polygon fill="rgb(0,0,0)" points="312,243 320,247 312,251" stroke="rgb(0,0,0)" />
<path d="M 136 300 L 320 300" fill="none" stroke="rgb(0,0,0)" />
<polygon fill="rgb(0,0,0)" points="144,296 136,300 144,304" stroke="rgb(0,0,0)" />
<path d="M 136 353 L 224 353" fill="none" stroke="rgb(0,0,0)" />
<path d="M 224 353 L 224 369" fill="none" stroke="rgb(0,0,0)" />
<path d="M 224 369 L 136 369" fill="none" stroke="rgb(0,0,0)" />
<polygon fill="rgb(0,0,0)" points="144,365 136,369 144,373" stroke="rgb(0,0,0)" />
<path d="M 136 409 L 720 409" fill="none" stroke="rgb(0,0,0)" />
<polygon fill="rgb(0,0,0)" points="712,405 720,409 712,413" stroke="rgb(0,0,0)" />
<path d="M 536 462 L 720 462" fill="none" stroke="rgb(0,0,0)" />
<polygon fill="rgb(0,0,0)" points="544,458 536,462 544,466" stroke="rgb(0,0,0)" />
<path d="M 536 502 L 720 502" fill="none" stroke="rgb(0,0,0)" />
<polygon fill="rgb(0,0,0)" points="712,498 720,502 712,506" stroke="rgb(0,0,0)" />
<path d="M 536 555 L 720 555" fill="none" stroke="rgb(0,0,0)" />
<polygon fill="rgb(0,0,0)" points="544,551 536,555 544,559" stroke="rgb(0,0,0)" />
<path d="M 536 595 L 720 595" fill="none" stroke="rgb(0,0,0)" />
<polygon fill="rgb(0,0,0)" points="712,591 720,595 712,599" stroke="rgb(0,0,0)" />
<path d="M 136 635 L 520 635" fill="none" stroke="rgb(0,0,0)" />
<polygon fill="rgb(0,0,0)" points="144,631 136,635 144,639" stroke="rgb(0,0,0)" />
<path d="M 736 701 L 816 701" fill="none" stroke="rgb(0,0,0)" />
<path d="M 816 701 L 816 717" fill="none" stroke="rgb(0,0,0)" />
<path d="M 816 717 L 736 717" fill="none" stroke="rgb(0,0,0)" />
<polygon fill="rgb(0,0,0)" points="744,713 736,717 744,721" stroke="rgb(0,0,0)" />
<path d="M 536 796 L 720 796" fill="none" stroke="rgb(0,0,0)" />
<polygon fill="rgb(0,0,0)" points="544,792 536,796 544,800" stroke="rgb(0,0,0)" />
<path d="M 536 836 L 720 836" fill="none" stroke="rgb(0,0,0)" />
<polygon fill="rgb(0,0,0)" points="712,832 720,836 712,840" stroke="rgb(0,0,0)" />
<text fill="rgb(0,0,0)" font-family="sans-serif" font-size="11" font-style="normal" font-weight="normal" text-anchor="middle" textLength="198" x="243.0" y="81">GET /v2/device_profiles?name=mydp</text>
<text fill="rgb(0,0,0)" font-family="sans-serif" font-size="11" font-style="normal" font-weight="normal" text-anchor="middle" textLength="216" x="408.0" y="121">{"device_profiles": $device_profile}</text>
<text fill="rgb(0,0,0)" font-family="sans-serif" font-size="11" font-style="normal" font-weight="normal" text-anchor="middle" textLength="108" x="194.0" y="161">Merge request grou</text>
<text fill="rgb(0,0,0)" font-family="sans-serif" font-size="11" font-style="normal" font-weight="normal" text-anchor="middle" textLength="108" x="194.0" y="174">ps into request_sp</text>
<text fill="rgb(0,0,0)" font-family="sans-serif" font-size="11" font-style="normal" font-weight="normal" text-anchor="middle" textLength="12" x="146.0" y="187">ec</text>
<text fill="rgb(0,0,0)" font-family="sans-serif" font-size="11" font-style="normal" font-weight="normal" text-anchor="middle" textLength="156" x="222.0" y="243">Get /allocation_candidates</text>
<text fill="rgb(0,0,0)" font-family="sans-serif" font-size="11" font-style="normal" font-weight="normal" text-anchor="middle" textLength="174" x="229.0" y="283">allocation candidates with ne</text>
<text fill="rgb(0,0,0)" font-family="sans-serif" font-size="11" font-style="normal" font-weight="normal" text-anchor="middle" textLength="48" x="292.0" y="296">sted RPs</text>
<text fill="rgb(0,0,0)" font-family="sans-serif" font-size="11" font-style="normal" font-weight="normal" text-anchor="middle" textLength="108" x="194.0" y="343">Select a candidate</text>
<text fill="rgb(0,0,0)" font-family="sans-serif" font-size="11" font-style="normal" font-weight="normal" text-anchor="middle" textLength="150" x="219.0" y="405">build_and_run_instances()</text>
<text fill="rgb(0,0,0)" font-family="sans-serif" font-size="11" font-style="normal" font-weight="normal" text-anchor="middle" textLength="174" x="629.0" y="452">POST /v2/accelerator_requests</text>
<text fill="rgb(0,0,0)" font-family="sans-serif" font-size="11" font-style="normal" font-weight="normal" text-anchor="middle" textLength="120" x="604.0" y="498">{"arqs": [$arq, ...]</text>
<text fill="rgb(0,0,0)" font-family="sans-serif" font-size="11" font-style="normal" font-weight="normal" text-anchor="middle" textLength="174" x="629.0" y="538">PATCH /v2/accelerator_request</text>
<text fill="rgb(0,0,0)" font-family="sans-serif" font-size="11" font-style="normal" font-weight="normal" text-anchor="middle" textLength="6" x="713.0" y="551">s</text>
<text fill="rgb(0,0,0)" font-family="sans-serif" font-size="11" font-style="normal" font-weight="normal" text-anchor="middle" textLength="120" x="604.0" y="591">{"arqs": [$arq, ...]</text>
<text fill="rgb(0,0,0)" font-family="sans-serif" font-size="11" font-style="normal" font-weight="normal" text-anchor="middle" textLength="186" x="423.0" y="631">POST /os-server-external-events</text>
<text fill="rgb(0,0,0)" font-family="sans-serif" font-size="11" font-style="normal" font-weight="normal" text-anchor="middle" textLength="96" x="788.0" y="671">Wait for notific</text>
<text fill="rgb(0,0,0)" font-family="sans-serif" font-size="11" font-style="normal" font-weight="normal" text-anchor="middle" textLength="96" x="788.0" y="684">ation from Cybor</text>
<text fill="rgb(0,0,0)" font-family="sans-serif" font-size="11" font-style="normal" font-weight="normal" text-anchor="middle" textLength="6" x="743.0" y="697">g</text>
<text fill="rgb(0,0,0)" font-family="sans-serif" font-size="11" font-style="normal" font-weight="normal" text-anchor="middle" textLength="174" x="629.0" y="760">GET /v2/accelerator_requests?</text>
<text fill="rgb(0,0,0)" font-family="sans-serif" font-size="11" font-style="normal" font-weight="normal" text-anchor="middle" textLength="174" x="629.0" y="773">instance=$uuid&amp;bind_state=res</text>
<text fill="rgb(0,0,0)" font-family="sans-serif" font-size="11" font-style="normal" font-weight="normal" text-anchor="middle" textLength="30" x="701.0" y="786">olved</text>
<text fill="rgb(0,0,0)" font-family="sans-serif" font-size="11" font-style="normal" font-weight="normal" text-anchor="middle" textLength="132" x="610.0" y="832">{"arqs": [$arq, ....]}</text>
</svg>

After

Width:  |  Height:  |  Size: 11 KiB

@@ -460,13 +460,13 @@ References
.. [#flavor] `Custom Resource Classes in Flavors <https://specs.openstack.org/openstack/nova-specs/specs/pike/implemented/custom-resource-classes-in-flavors.html>`_
.. [#qspec] `Cyborg Nova Queens Spec <https://github.com/openstack/cyborg/blob/master/doc/specs/queens/approved/cyborg-nova-interaction.rst>`_
* `Cyborg Nova Queens Spec <https://github.com/openstack/cyborg/blob/master/doc/specs/queens/approved/cyborg-nova-interaction.rst>`_
.. [#ptg] `Rocky PTG Etherpad for Cyborg Nova Interaction <https://etherpad.openstack.org/p/cyborg-ptg-rocky-nova-cyborg-interaction>`_
* `Rocky PTG Etherpad for Cyborg Nova Interaction <https://etherpad.openstack.org/p/cyborg-ptg-rocky-nova-cyborg-interaction>`_
.. [#multifn] `Detailed Cyborg/Nova scheduling <https://etherpad.openstack.org/p/Cyborg-Nova-Multifunction>`_
* `Detailed Cyborg/Nova scheduling <https://etherpad.openstack.org/p/Cyborg-Nova-Multifunction>`_
.. [#mails] `Openstack-dev email discussion <https://lists.openstack.org/pipermail/openstack-dev/2018-April/128951.html>`_
* `Openstack-dev email discussion <https://lists.openstack.org/pipermail/openstack-dev/2018-April/128951.html>`_
@@ -269,47 +269,8 @@ Cyborg API calls are routed through that.
This flow is captured by the following sequence diagram, in which the Nova
conductor and scheduler are together represented as the Nova controller.
.. seqdiag::
.. image:: /images/train/nova-cyborg-interaction.svg
seqdiag {
edge_length = 200;
span_height = 15;
activation = none;
default_note_color = white;
'Nova Controller'; 'Placement'; 'Cyborg'; 'Nova Compute';
'Nova Controller' -> 'Cyborg' [label =
"GET /v2/device_profiles?name=mydp"];
'Nova Controller' <- 'Cyborg' [label =
'{"device_profiles": $device_profile}'];
'Nova Controller' -> 'Nova Controller' [label=
'Merge request groups into request_spec'];
'Nova Controller' -> 'Placement' [label=
'Get /allocation_candidates'];
'Nova Controller' <- 'Placement' [label=
'allocation candidates with nested RPs'];
'Nova Controller' -> 'Nova Controller' [label=
'Select a candidate'];
'Nova Controller' -> 'Nova Compute' [label=
'build_and_run_instances()'];
'Nova Compute' -> 'Cyborg' [label=
'POST /v2/accelerator_requests'];
'Nova Compute' <- 'Cyborg' [label=
'{"arqs": [$arq, ...]'];
'Nova Compute' -> 'Cyborg' [label=
'PATCH /v2/accelerator_requests'];
'Nova Compute' <- 'Cyborg' [label=
'{"arqs": [$arq, ...]'];
'Cyborg' -> 'Nova Controller' [label=
'POST /os-server-external-events'];
'Nova Compute' -> 'Nova Compute' [label=
'Wait for notification from Cyborg'];
'Nova Compute' -> 'Cyborg' [label=
'GET /v2/accelerator_requests?
instance=$uuid&bind_state=resolved'];
'Nova Compute' <- 'Cyborg' [label=
'{"arqs": [$arq, ....]}'];
}
Alternatives
@@ -441,8 +402,7 @@ References
.. [#map-rg-to-rp] `Map request groups to resource providers
<https://github.com/openstack/nova/blob/63380a6b494e0f0f220b67b197edec836f1c5a42/nova/objects/request_spec.py#L777>`_
.. [#cy-api] `Specification for Cyborg API Version 2
<https://opendev.org/openstack/cyborg-specs/src/branch/master/specs/train/approved/cyborg-api.rst>`_
* `Specification for Cyborg API Version 2 <https://opendev.org/openstack/cyborg-specs/src/branch/master/specs/train/approved/cyborg-api.rst>`_
History
=======
+3 -3
View File
@@ -394,15 +394,15 @@ Cyborg API documentation needs to be updated.
References
==========
.. [#nova-cyborg] `Nova Cyborg interaction specification
<https://review.openstack.org/#/c/603955/>`_
.. [#version-disc] `Microversions and Version Discovery
<http://specs.openstack.org/openstack/api-wg/guidelines/microversion_specification.html/>`_
.. [#devprof-spec] `Specification for device profiles
<https://review.opendev.org/602978/>`_
* `Nova Cyborg interaction specification <https://review.openstack.org/#/c/603955/>`_
History
=======
@@ -367,8 +367,7 @@ References
.. [#accel-keys] `Device profile accel keys
<https://opendev.org/openstack/cyborg-specs/src/branch/master/specs/train/approved/device-profiles.rst#valid-accel-keys>`_
.. [#nRP] `Enable use of Nested Resource Providers in Nova Scheduler
<https://review.openstack.org/#/q/topic:use-nested-allocation-candidates>`_
* `Enable use of Nested Resource Providers in Nova Scheduler <https://review.openstack.org/#/q/topic:use-nested-allocation-candidates>`_
History
=======
@@ -226,12 +226,10 @@ Documentation Impact
References
==========
.. [#microversion-spec] `Microversion Specification
<http://specs.openstack.org/openstack/api-wg/guidelines/microversion_specification.html>`_
.. [#cinde-mv-spec] `Cinder Microversion Spec
<https://specs.openstack.org/openstack/cinder-specs/specs/mitaka/api-microversions.html>`_
.. [#cyborg-api-doc] `Cyborg API Documentation
<https://docs.openstack.org/api-ref/accelerator/v2/index.html>`_
.. [#cyborg-api-doc] `Cyborg API Documentation <https://docs.openstack.org/api-ref/accelerator/v2/index.html>`_
* `Microversion Specification <http://specs.openstack.org/openstack/api-wg/guidelines/microversion_specification.html>`_
* `Cinder Microversion Spec <https://specs.openstack.org/openstack/cinder-specs/specs/mitaka/api-microversions.html>`_
History
=======
@@ -269,47 +269,8 @@ Cyborg API calls are routed through that.
This flow is captured by the following sequence diagram, in which the Nova
conductor and scheduler are together represented as the Nova controller.
.. seqdiag::
.. image:: /images/ussuri/nova-cyborg-interaction.svg
seqdiag {
edge_length = 200;
span_height = 15;
activation = none;
default_note_color = white;
'Nova Controller'; 'Placement'; 'Cyborg'; 'Nova Compute';
'Nova Controller' -> 'Cyborg' [label =
"GET /v2/device_profiles?name=mydp"];
'Nova Controller' <- 'Cyborg' [label =
'{"device_profiles": $device_profile}'];
'Nova Controller' -> 'Nova Controller' [label=
'Merge request groups into request_spec'];
'Nova Controller' -> 'Placement' [label=
'Get /allocation_candidates'];
'Nova Controller' <- 'Placement' [label=
'allocation candidates with nested RPs'];
'Nova Controller' -> 'Nova Controller' [label=
'Select a candidate'];
'Nova Controller' -> 'Nova Compute' [label=
'build_and_run_instances()'];
'Nova Compute' -> 'Cyborg' [label=
'POST /v2/accelerator_requests'];
'Nova Compute' <- 'Cyborg' [label=
'{"arqs": [$arq, ...]'];
'Nova Compute' -> 'Cyborg' [label=
'PATCH /v2/accelerator_requests'];
'Nova Compute' <- 'Cyborg' [label=
'{"arqs": [$arq, ...]'];
'Cyborg' -> 'Nova Controller' [label=
'POST /os-server-external-events'];
'Nova Compute' -> 'Nova Compute' [label=
'Wait for notification from Cyborg'];
'Nova Compute' -> 'Cyborg' [label=
'GET /v2/accelerator_requests?
instance=$uuid&bind_state=resolved'];
'Nova Compute' <- 'Cyborg' [label=
'{"arqs": [$arq, ....]}'];
}
Alternatives
@@ -441,8 +402,7 @@ References
.. [#map-rg-to-rp] `Map request groups to resource providers
<https://github.com/openstack/nova/blob/63380a6b494e0f0f220b67b197edec836f1c5a42/nova/objects/request_spec.py#L777>`_
.. [#cy-api] `Specification for Cyborg API Version 2
<https://opendev.org/openstack/cyborg-specs/src/branch/master/specs/train/approved/cyborg-api.rst>`_
* `Specification for Cyborg API Version 2 <https://opendev.org/openstack/cyborg-specs/src/branch/master/specs/train/approved/cyborg-api.rst>`_
History
=======