Disable seqdiag in the spec docs

The tls-data-security specs use seqdiag to describe communication between
some components.
seqdiag is unmaintained and doesn't work with recent Pillow releases (10.0.1).
Disable the generation of those diagrams as they are part of old specs.

Also remove the dependency on seqdiag

Disable octavia-grenade-skip-level which will be fixed in another commit

Partial-Bug: #2026345

Change-Id: I6b5c5d6c651dac223a205409c49085faf78cff15
This commit is contained in:
Gregory Thiemonge 2023-10-06 09:12:17 +02:00
parent 8b275c9703
commit c4a162ab40
6 changed files with 12 additions and 19 deletions

View File

@ -7,7 +7,6 @@ os-api-ref>=1.4.0 # Apache-2.0
sphinxcontrib-actdiag>=0.8.5 # BSD
sphinxcontrib-apidoc>=0.2.1 # BSD
sphinxcontrib-nwdiag>=0.9.5 # BSD
sphinxcontrib-seqdiag>=0.8.4 # BSD
docutils>=0.11 # OSI-Approved Open Source, Public Domain
sphinx>=2.0.0,!=2.1.0 # BSD
graphviz!=0.5.0,>=0.4 # MIT License

View File

@ -58,7 +58,6 @@ extensions = [
'sphinx.ext.todo',
'sphinx.ext.viewcode',
'sphinxcontrib.actdiag',
'sphinxcontrib.seqdiag',
'sphinxcontrib.nwdiag',
'sphinx.ext.graphviz',
'sphinx_feature_classification.support_matrix',

View File

@ -31,7 +31,6 @@ def fake_role(name, rawtext, text, lineno, inliner,
return [], []
directives.register_directive('seqdiag', FakeDirective)
directives.register_directive('nwdiag', FakeDirective)
directives.register_directive('actdiag', FakeDirective)
directives.register_directive('graphviz', FakeDirective)

View File

@ -88,19 +88,6 @@ nwdiag
}
}
seqdiag
.. seqdiag::
seqdiag {
browser -> webserver [label = "GET /index.html"];
browser <-- webserver;
browser -> webserver [label = "POST /blog/comment"];
webserver -> database [label = "INSERT comment"];
webserver <-- database;
browser <-- webserver;
}
graphviz
.. graphviz::

View File

@ -31,7 +31,11 @@ The initial supported implementation for TLS related functions will be
Barbican, but the interface will be generic such that other implementations
could be created later.
.. seqdiag:: tls-data-security-1.diag
.. Note:: a sequence diagram describing the communication between the User,
Octavia, Barbican and the Amphora API was removed, the diagram is
still available in the `documentation of older stable branches
<https://docs.openstack.org/octavia/latest/contributor/specs/version0.5/tls-data-security.html>`_.
1. Create a CertificateManager interface for storing and retrieving certificate
and private key pairs (and intermediate certs / private key passphrase).
@ -50,7 +54,11 @@ case of invalid TLS data, we will reject the request with a 400 (if it is an
initial create) or else put the LB into ERROR status (if it is on a failover
event or during some other non-interactive scenario).
.. seqdiag:: tls-data-security-2.diag
.. Note:: a sequence diagram describing the communication between the Octavia
components was removed, the diagram is still available in the
`documentation of older stable branches
<https://docs.openstack.org/octavia/latest/contributor/specs/version0.5/tls-data-security.html>`_.
2. Create a CertificateGenerator interface to generate certificates from CSRs.
When the controller creates an Amphora, it will generate a private key and a

View File

@ -75,6 +75,7 @@
- ^tox.ini$
- octavia-grenade-skip-level:
irrelevant-files: *grenade-irrelevant-files
voting: false
- octavia-v2-dsvm-tls-barbican-fips:
irrelevant-files: *irrelevant-files
voting: false
@ -118,7 +119,7 @@
- octavia-v2-dsvm-scenario-non-traffic-ops
- octavia-v2-dsvm-tls-barbican
- octavia-grenade
- octavia-grenade-skip-level
#- octavia-grenade-skip-level
periodic:
jobs:
- publish-openstack-octavia-amphora-image-focal: