Cleanup docs building

a few cleanups:
- Remove obsolete sections from setup.cfg
- Switch to using sphinx-build
- Remove install_command from tox.ini, the default is fine
- Update pbr requirement
- Fix build problems
- Switch to py38 for testing following Victoria testing platforms

Change-Id: I1ff3853020d69aeceb8b81c21ce608b269015ece
This commit is contained in:
Andreas Jaeger 2020-06-04 09:39:03 +02:00
parent 4d39e01563
commit 64d0a2a0de
8 changed files with 46 additions and 42 deletions

View File

@ -3,7 +3,7 @@
- openstack-specs-jobs - openstack-specs-jobs
check: check:
jobs: jobs:
- openstack-tox-py37 - openstack-tox-py38
gate: gate:
jobs: jobs:
- openstack-tox-py37 - openstack-tox-py38

View File

@ -1,4 +1,4 @@
pbr>=0.6,<1.0 pbr!=2.1.0,>=2.0.0 # Apache-2.0
openstackdocstheme>=2.2.1 # Apache-2.0 openstackdocstheme>=2.2.1 # Apache-2.0
sphinx>=2.0.0,!=2.1.0 # BSD sphinx>=2.0.0,!=2.1.0 # BSD
yasfb>=0.8.0 yasfb>=0.8.0

View File

@ -5,20 +5,9 @@ description-file =
README.rst README.rst
author = OpenStack author = OpenStack
author-email = openstack-dev@lists.openstack.org author-email = openstack-dev@lists.openstack.org
home-page = http://specs.openstack.org/openstack/zaqar-specs/ home-page = https://specs.openstack.org/openstack/zaqar-specs/
classifier = classifier =
Environment :: OpenStack Environment :: OpenStack
Intended Audience :: Developers Intended Audience :: Developers
License :: OSI Approved :: Apache Software License License :: OSI Approved :: Apache Software License
Operating System :: POSIX :: Linux Operating System :: POSIX :: Linux
[build_sphinx]
source-dir = doc/source
build-dir = doc/build
all_files = 1
[pbr]
warnerrors = True
[upload_sphinx]
upload-dir = doc/build/html

View File

@ -17,3 +17,5 @@
queens/index queens/index
rocky/index rocky/index
stein/index stein/index
ussuri/index
victoria/index

View File

@ -38,15 +38,18 @@ return the amount of queues in response body like "count=100".
API Impact API Impact
----------- -----------
Query queue list Query queue list:
GET: /v2/queues?with_count=true
RESPONSE CODE: 200 .. code-block::
RESPONSE BODY:
{ GET: /v2/queues?with_count=true
"count": 100,
"queues": [...] RESPONSE CODE: 200
} RESPONSE BODY:
{
"count": 100,
"queues": [...]
}
Drawbacks Drawbacks
--------- ---------
@ -93,4 +96,4 @@ None
References References
========== ==========
None None

View File

@ -31,7 +31,8 @@ or hacker attack.
Proposed change Proposed change
=============== ===============
1. Add one new metadata in queue object that will indicate how to encrypt messages: 1. Add one new metadata in queue object that will indicate how to
encrypt messages:
#. "_enable_encrypt_messages=true/false" : this will tell Zaqar whether encrypt #. "_enable_encrypt_messages=true/false" : this will tell Zaqar whether encrypt
messages before storing them into backends or not. messages before storing them into backends or not.
@ -46,33 +47,39 @@ Proposed change
encrypt the message by using public key and return the encrypted messages to encrypt the message by using public key and return the encrypted messages to
user. user.
4. About the algorithms, in V cycle, Zaqar will introduce the AES-256 encryption 4. About the algorithms, in V cycle, Zaqar will introduce the AES-256
at first. In next cycles, Zaqar can suppot asymmetric encryption to let user encryption at first. In next cycles, Zaqar can suppot asymmetric
upload public key and keep the private key by their own. encryption to let user upload public key and keep the private key
by their own.
.. note:: .. note::
About the option of encryption algorithms and keys, Zaqar would support About the option of encryption algorithms and keys, Zaqar would support
specify them throught more metadatas of queues, but it will be done in next specify them throught more metadatas of queues, but it will be done in next
serveral cycles. In Victoria, we will choose one algorithm (like AES256) to serveral cycles. In Victoria, we will choose one algorithm (like AES256) to
support and support to storage the keys by Zaqar itself or other service like support and support to storage the keys by Zaqar itself or other
Barbican. service like Barbican.
API Impact API Impact
----------- -----------
Create queue list
POST: /v2/queues/queue_name
RESPONSE CODE: 200 Create queue list:
REQUEST BODY:
{ .. code-block::
"_enable_encrypt_messages": true
} POST: /v2/queues/queue_name
RESPONSE CODE: 200
REQUEST BODY:
{
"_enable_encrypt_messages": true
}
Drawbacks Drawbacks
--------- ---------
The ecryption algorithms will impact the performance of storing messages into backends The ecryption algorithms will impact the performance of storing
messages into backends
and getting the messages from the queue. and getting the messages from the queue.
This depends on which kind of encryption algorithms we choose and support. This depends on which kind of encryption algorithms we choose and support.
@ -118,4 +125,4 @@ None
References References
========== ==========
None None

View File

@ -5,3 +5,5 @@
.. toctree:: .. toctree::
:glob: :glob:
:maxdepth: 2 :maxdepth: 2
encrypted-messages-in-queue

View File

@ -1,12 +1,13 @@
[tox] [tox]
minversion = 1.6 minversion = 3.2.0
envlist = docs,pep8 envlist = docs,pep8
skipsdist = True skipsdist = True
ignore_basepython_conflict = True
[testenv] [testenv]
basepython = python3 basepython = python3
usedevelop = True usedevelop = True
install_command = pip install -U {opts} {packages}
setenv = setenv =
VIRTUAL_ENV={envdir} VIRTUAL_ENV={envdir}
deps = -r{toxinidir}/requirements.txt deps = -r{toxinidir}/requirements.txt
@ -17,7 +18,7 @@ commands = stestr run --slowest {posargs}
commands = {posargs} commands = {posargs}
[testenv:docs] [testenv:docs]
commands = python setup.py build_sphinx commands = sphinx-build -a -W -b html doc/source doc/build/html
[testenv:spelling] [testenv:spelling]
deps = deps =