openstack
/
openstack-ansible-specs
Code Issues Proposed changes

Cleanup py27 support 

Make a few cleanups:
- Remove python 2.7 stanza from setup.py
- Remove obsolete sections from setup.cfg
- Switch to using sphinx-build, fix doc warnings
- Cleanup doc/source/conf.py to remove now obsolete content.
- Use newer openstackdocstheme version
- Remove install_command from tox.ini, the default is fine

Change-Id: I23a2d62a8853f01e8574ef37b5ee1ac2ee09acd0
This commit is contained in:
Andreas Jaeger 2020-04-10 11:10:40 +02:00
parent 3e6eab5fc3
commit a73df5a05f
10 changed files with 30 additions and 65 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
doc/source/conf.py
View File

@ -22,8 +22,6 @@
# All configuration values have a default; values that are commented out # All configuration values have a default; values that are commented out
# serve to show the default. # serve to show the default.
import pbr.version
# If extensions (or modules to document with autodoc) are in another directory, # If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the # add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here. # documentation root, use os.path.abspath to make it absolute, like shown here.
@ -39,7 +37,6 @@ import pbr.version
# ones. # ones.
extensions = [ extensions = [
'openstackdocstheme', 'openstackdocstheme',
'sphinx.ext.autodoc',
] ]
# Add any paths that contain templates here, relative to this directory. # Add any paths that contain templates here, relative to this directory.
@ -66,16 +63,6 @@ role_name = 'specs'
target_name = 'openstack-ansible-' + role_name target_name = 'openstack-ansible-' + role_name
title = 'OpenStack-Ansible ' + role_name + ' Documentation' title = 'OpenStack-Ansible ' + role_name + ' Documentation'
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
version_info = pbr.version.VersionInfo(target_name)
# The full version, including alpha/beta/rc tags.
release = version_info.version_string_with_vcs()
# The short X.Y version.
version = version_info.canonical_version_string()
# openstackdocstheme options # openstackdocstheme options
repository_name = 'openstack/' + target_name repository_name = 'openstack/' + target_name
@ -160,17 +147,13 @@ html_theme = 'openstackdocs'
# Add any paths that contain custom static files (such as style sheets) here, # Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files, # relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css". # so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static'] # html_static_path = ['_static']
# Add any extra paths that contain custom files (such as robots.txt or # Add any extra paths that contain custom files (such as robots.txt or
# .htaccess) here, relative to this directory. These files are copied # .htaccess) here, relative to this directory. These files are copied
# directly to the root of the documentation. # directly to the root of the documentation.
# html_extra_path = [] # html_extra_path = []
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
html_last_updated_fmt = '%Y-%m-%d %H:%M'
# If true, SmartyPants will be used to convert quotes and dashes to # If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities. # typographically correct entities.
# html_use_smartypants = True # html_use_smartypants = True

2
requirements.txt
View File

@ -4,5 +4,5 @@
# this is required for the docs build jobs # this is required for the docs build jobs
sphinx!=1.6.6,!=1.6.7,>=1.6.2 # BSD sphinx!=1.6.6,!=1.6.7,>=1.6.2 # BSD
openstackdocstheme>=1.20.0 # Apache-2.0 openstackdocstheme>=1.32.1 # Apache-2.0
doc8>=0.6.0 # Apache-2.0 doc8>=0.6.0 # Apache-2.0

11
setup.cfg
View File

@ -10,14 +10,3 @@ classifier =
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]
all_files = 1
build-dir = doc/build
source-dir = doc/source
[pbr]
warnerrors = True
[wheel]
universal = 1

9
setup.py
View File

@ -13,17 +13,8 @@
# See the License for the specific language governing permissions and # See the License for the specific language governing permissions and
# limitations under the License. # limitations under the License.
# THIS FILE IS MANAGED BY THE GLOBAL REQUIREMENTS REPO - DO NOT EDIT
import setuptools import setuptools
# In python < 2.7.4, a lazy loading of package `pbr` will break
# setuptools if some other modules registered functions in `atexit`.
# solution from: http://bugs.python.org/issue15881#msg170215
try:
import multiprocessing # noqa
except ImportError:
pass
setuptools.setup( setuptools.setup(
setup_requires=['pbr>=2.0.0'], setup_requires=['pbr>=2.0.0'],
pbr=True) pbr=True)

1
specs/queens/docs-improvements.rst
View File

@ -95,6 +95,7 @@ the priorities change.
For improving the reading experience, ensure that each page has For improving the reading experience, ensure that each page has
a proper structure: a proper structure:
- Only content should appear in the content part of the page - Only content should appear in the content part of the page
- The chapters should only be in the upper-left section of - The chapters should only be in the upper-left section of
the page ToC, and pointing to this guide chapters, not the whole the page ToC, and pointing to this guide chapters, not the whole

23
specs/queens/elk-stack.rst
View File

@ -11,7 +11,7 @@ Log file analysis is an important part of maintaining and troubleshooting
OpenStack clouds, but using traditional single server methodology to analyze OpenStack clouds, but using traditional single server methodology to analyze
the logs on clouds with tens, hundreds or thousands of servers can become the logs on clouds with tens, hundreds or thousands of servers can become
problematic and unwieldy. By leveraging the search, collation and analysis problematic and unwieldy. By leveraging the search, collation and analysis
features of the ELK (Elasticsearch`[1]`_, Logstash`[2]`_ and Kibana`[3]`_) stack features of the ELK (Elasticsearch [1]_, Logstash [2]_ and Kibana [3]_) stack
we can provide a cloud level view of all of the log files. The ELK stack also we can provide a cloud level view of all of the log files. The ELK stack also
provides the ability to correlate log messages across various services, perform provides the ability to correlate log messages across various services, perform
detailed log analysis and do trending based on metrics derived from log detailed log analysis and do trending based on metrics derived from log
@ -61,7 +61,7 @@ Playbook/Role impact
The changes required are located in stand alone playbooks. Additional roles The changes required are located in stand alone playbooks. Additional roles
will need to be created for Logstash, Kibana and Filebeat, the will need to be created for Logstash, Kibana and Filebeat, the
`ansible-elasticsearch``[4]`_ maintained by elastic.co provides Elasticsearch. `ansible-elasticsearch`` [4]_ maintained by elastic.co provides Elasticsearch.
Configuration can be stand-alone or integrated into the `user-variables.yml` and Configuration can be stand-alone or integrated into the `user-variables.yml` and
`user-secrets.yml` files. `user-secrets.yml` files.
@ -181,20 +181,21 @@ Documentation impact
Along with the general installation procedures and configuration the key points Along with the general installation procedures and configuration the key points
of documentation will be: of documentation will be:
* Filebeats parsing rules
* Logstash parsing rules * Filebeats parsing rules
* Kibana dashboard configuration * Logstash parsing rules
* The default Kibana dashboard * Kibana dashboard configuration
* Performance impact and tuning of the ELK stack * The default Kibana dashboard
* Performance impact and tuning of the ELK stack
References References
========== ==========
[1] https://elastic.co/products/elasticearch .. [1] https://elastic.co/products/elasticearch
[2] https://elastic.co/products/logstash .. [2] https://elastic.co/products/logstash
[3] https://elastic.co/products/kibana .. [3] https://elastic.co/products/kibana
[4] https://github.com/elastic/ansible-elasticsearch .. [4] https://github.com/elastic/ansible-elasticsearch

22
specs/queens/python-build-install-simplification.rst
View File

@ -235,7 +235,7 @@ Proposed change
.. _pypiserver: https://pypiserver.readthedocs.io .. _pypiserver: https://pypiserver.readthedocs.io
Alternatives Alternatives
------------ ~~~~~~~~~~~~
* The build process can remain as-is, continuing to confuse deployers and * The build process can remain as-is, continuing to confuse deployers and
difficult to maintain. difficult to maintain.
@ -245,7 +245,7 @@ Alternatives
venvs for distribution. venvs for distribution.
Playbook/Role impact Playbook/Role impact
-------------------- ~~~~~~~~~~~~~~~~~~~~
Playbooks will be added to cater for the build process and the staging Playbooks will be added to cater for the build process and the staging
process. The roles will be adjusted to properly separate out the build process. The roles will be adjusted to properly separate out the build
@ -253,32 +253,32 @@ tasks and the distro packages to install for the build (versus those
required when using pre-built wheels). required when using pre-built wheels).
Upgrade impact Upgrade impact
-------------- ~~~~~~~~~~~~~~
Care will be taken to ensure that upgrades happen as they do today. Care will be taken to ensure that upgrades happen as they do today.
Security impact Security impact
--------------- ~~~~~~~~~~~~~~~
The security posture should be improved by the reduction of packages installed The security posture should be improved by the reduction of packages installed
onto hosts and containers when a full set of artifacts are built. onto hosts and containers when a full set of artifacts are built.
Performance impact Performance impact
------------------ ~~~~~~~~~~~~~~~~~~
The performance of the deployment should be improved due to the reduction in The performance of the deployment should be improved due to the reduction in
time taken to deploy with pre-built packages if a full set of artifacts are time taken to deploy with pre-built packages if a full set of artifacts are
built. built.
End user impact End user impact
--------------- ~~~~~~~~~~~~~~~
There is no end-user impact for consumers of an OpenStack cloud, except There is no end-user impact for consumers of an OpenStack cloud, except
perhaps that upgrades will be quicker to execute, thus resulting in reduced perhaps that upgrades will be quicker to execute, thus resulting in reduced
maintenance slot requirements. maintenance slot requirements.
Deployer impact Deployer impact
--------------- ~~~~~~~~~~~~~~~
* As deployments and upgrades will be quicker to execute, deployers will be * As deployments and upgrades will be quicker to execute, deployers will be
able to execute them in shorter maintenance slots. able to execute them in shorter maintenance slots.
@ -287,13 +287,13 @@ Deployer impact
prepare the required artifacts to speed up deployments. prepare the required artifacts to speed up deployments.
Developer impact Developer impact
---------------- ~~~~~~~~~~~~~~~~
As the build process will be integrated into the roles, it will be easier to As the build process will be integrated into the roles, it will be easier to
understand how it works and what it does. understand how it works and what it does.
Dependencies Dependencies
------------ ~~~~~~~~~~~~
This spec will be implemented in partnership with This spec will be implemented in partnership with
https://blueprints.launchpad.net/openstack-ansible/+spec/deployment-stages https://blueprints.launchpad.net/openstack-ansible/+spec/deployment-stages
@ -302,13 +302,13 @@ Implementation
============== ==============
Assignee(s) Assignee(s)
----------- ~~~~~~~~~~~
Primary assignee: Primary assignee:
jesse-pretorius (odyssey4me) jesse-pretorius (odyssey4me)
Work items Work items
---------- ~~~~~~~~~~
Each of the roles implemented in the default AIO will be worked through in Each of the roles implemented in the default AIO will be worked through in
sequence to re-arrange and optimise based on this workflow. The work items sequence to re-arrange and optimise based on this workflow. The work items

2
specs/rocky/masakari.rst
View File

@ -1,5 +1,5 @@
Integration of Masakari with OpenStack-Ansible Integration of Masakari with OpenStack-Ansible
################################# ##############################################
:date: 2018-03-22 14:00 :date: 2018-03-22 14:00
:tags: openstack, masakari, masakari-monitors :tags: openstack, masakari, masakari-monitors

1
specs/rocky/refactor-inventory.rst
View File

@ -270,6 +270,7 @@ So I propose the following path:
group vars group vars
Drawbacks: Drawbacks:
* More static files to maintain by the deployer. * More static files to maintain by the deployer.
If we change a host var, we could change the If we change a host var, we could change the
inventory and it was applied everywhere. inventory and it was applied everywhere.

5
tox.ini
View File

@ -7,9 +7,8 @@ ignore_basepython_conflict = True
[testenv] [testenv]
basepython = python3 basepython = python3
usedevelop = True usedevelop = True
install_command =
pip install -c{env:UPPER_CONSTRAINTS_FILE:https://git.openstack.org/cgit/openstack/requirements/plain/upper-constraints.txt} {opts} {packages}
deps = deps =
-c{env:UPPER_CONSTRAINTS_FILE:https://releases.openstack.org/constraints/upper/master}
-r{toxinidir}/requirements.txt -r{toxinidir}/requirements.txt
commands = commands =
/usr/bin/find . -type f -name "*.pyc" -delete /usr/bin/find . -type f -name "*.pyc" -delete
@ -32,7 +31,7 @@ setenv =
commands= commands=
bash -c "rm -rf doc/build" bash -c "rm -rf doc/build"
doc8 doc doc8 doc
python setup.py build_sphinx sphinx-build -W -b html doc/source doc/build/html
[doc8] [doc8]
# Settings for doc8: # Settings for doc8: