Browse Source

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
changes/66/733466/10
Andreas Jaeger 2 years ago
parent
commit
64d0a2a0de
  1. 4
      .zuul.yaml
  2. 2
      requirements.txt
  3. 13
      setup.cfg
  4. 2
      specs/index.rst
  5. 21
      specs/ussuri/query-queues-with-count.rst
  6. 37
      specs/victoria/encrypted-messages-in-queue.rst
  7. 2
      specs/victoria/index.rst
  8. 7
      tox.ini

4
.zuul.yaml

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

2
requirements.txt

@ -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
sphinx>=2.0.0,!=2.1.0 # BSD
yasfb>=0.8.0

13
setup.cfg

@ -5,20 +5,9 @@ description-file =
README.rst
author = OpenStack
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 =
Environment :: OpenStack
Intended Audience :: Developers
License :: OSI Approved :: Apache Software License
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

2
specs/index.rst

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

21
specs/ussuri/query-queues-with-count.rst

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

37
specs/victoria/encrypted-messages-in-queue.rst

@ -31,7 +31,8 @@ or hacker attack.
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
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
user.
4. About the algorithms, in V cycle, Zaqar will introduce the AES-256 encryption
at first. In next cycles, Zaqar can suppot asymmetric encryption to let user
upload public key and keep the private key by their own.
4. About the algorithms, in V cycle, Zaqar will introduce the AES-256
encryption at first. In next cycles, Zaqar can suppot asymmetric
encryption to let user upload public key and keep the private key
by their own.
.. note::
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
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
Barbican.
support and support to storage the keys by Zaqar itself or other
service like Barbican.
API Impact
-----------
Create queue list
POST: /v2/queues/queue_name
RESPONSE CODE: 200
REQUEST BODY:
{
"_enable_encrypt_messages": true
}
Create queue list:
.. code-block::
POST: /v2/queues/queue_name
RESPONSE CODE: 200
REQUEST BODY:
{
"_enable_encrypt_messages": true
}
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.
This depends on which kind of encryption algorithms we choose and support.
@ -118,4 +125,4 @@ None
References
==========
None
None

2
specs/victoria/index.rst

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

7
tox.ini

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

Loading…
Cancel
Save