From c4a162ab40023884d33ecb3cfe3f47801d6023bc Mon Sep 17 00:00:00 2001 From: Gregory Thiemonge Date: Fri, 6 Oct 2023 09:12:17 +0200 Subject: [PATCH] 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 --- doc/requirements.txt | 1 - doc/source/conf.py | 1 - specs-tests/test_titles.py | 1 - specs/template.rst | 13 ------------- specs/version0.5/tls-data-security.rst | 12 ++++++++++-- zuul.d/projects.yaml | 3 ++- 6 files changed, 12 insertions(+), 19 deletions(-) diff --git a/doc/requirements.txt b/doc/requirements.txt index 89510877e1..c8c508590a 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -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 diff --git a/doc/source/conf.py b/doc/source/conf.py index 3cfe9d93b0..594c01ce6a 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -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', diff --git a/specs-tests/test_titles.py b/specs-tests/test_titles.py index 2a106463a9..64c804c0b1 100644 --- a/specs-tests/test_titles.py +++ b/specs-tests/test_titles.py @@ -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) diff --git a/specs/template.rst b/specs/template.rst index b30fab87dc..fef6f56c01 100644 --- a/specs/template.rst +++ b/specs/template.rst @@ -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:: diff --git a/specs/version0.5/tls-data-security.rst b/specs/version0.5/tls-data-security.rst index 90148308f4..0e9ca1b272 100644 --- a/specs/version0.5/tls-data-security.rst +++ b/specs/version0.5/tls-data-security.rst @@ -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 + `_. + 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 + `_. + 2. Create a CertificateGenerator interface to generate certificates from CSRs. When the controller creates an Amphora, it will generate a private key and a diff --git a/zuul.d/projects.yaml b/zuul.d/projects.yaml index 526586183f..829395ea91 100644 --- a/zuul.d/projects.yaml +++ b/zuul.d/projects.yaml @@ -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: