Fix build problems

This repo did never publish the specs properly, fix all problems found
and enable py36 test as well.

Change-Id: Ifc0b9db1667352fc2c73d9c55495285ca4da2d85
This commit is contained in:
Andreas Jaeger 2020-02-02 14:25:05 +01:00
parent 37b99ecd30
commit ce69e4f314
31 changed files with 108 additions and 134 deletions

@ -1,3 +1,9 @@
- project:
templates:
- openstack-specs-jobs
check:
jobs:
- openstack-tox-py36
gate:
jobs:
- openstack-tox-py36

@ -4,16 +4,15 @@ Team and repository tags
.. image:: https://governance.openstack.org/tc/badges/freezer-specs.svg
:target: https://governance.openstack.org/tc/reference/tags/index.html
:remote:
.. Change things from this point on
=======
======
README
=======
======
OpenStack Freezer Specifications
=============================
================================
This git repository is used to hold approved design specifications for
@ -28,8 +27,8 @@ The layout of this repository is::
Where there are two sub-directories:
specs/<release>/approved: specifications approved but not yet implemented
specs/<release>/implemented: implemented specifications
* ``specs/<release>/approved``: specifications approved but not yet implemented
* ``specs/<release>/implemented``: implemented specifications
The lifecycle of a specification
--------------------------------
@ -84,7 +83,7 @@ from this directory to the next active release. Please set yourself as the new
list.
Design documents for releases prior to Newton
-------------------------------------------
---------------------------------------------
Prior to the Juno development cycle, this repository was not used for spec
reviews. Reviews prior to Juno were completed entirely through `Launchpad

@ -1,8 +1,8 @@
.. freezer-specs documentation master file
============================
===============================
OpenStack Freezer Project Plans
============================
===============================
Priorities
==========
@ -14,6 +14,9 @@ on for the upcoming release. This is the output of those discussions:
:glob:
:maxdepth: 1
priorities/stein-priorities
priorities/pike-priorities
priorities/ocata-priorities
priorities/newton-priorities
Specifications
@ -25,15 +28,9 @@ Here you can find the specs, and spec template, for each release:
:glob:
:maxdepth: 1
specs/train/index
There are also some approved backlog specifications that are looking for owners:
.. toctree::
:glob:
:maxdepth: 1
specs/backlog/index
specs/stein/index
specs/pike/index
specs/ocata/index
Process
=======

@ -1 +0,0 @@
../../../../specs/backlog/approved/

@ -1,31 +0,0 @@
===========================
Nova Backlog Specifications
===========================
The Nova spec backlog is a place for the team to record decisions
about technical problems and proposed solutions. A backlog spec should
contain at least a clear problem description, as well as a general
description of the proposed or desired solution. This serves as a
marker to record the team's acceptance of a problem as in-scope for
the project, as well as a reasonable direction for solving the problem.
A spec that exists here is something that either needs a driver or
implementor, or something that can't be done currently. If you would
like to implement one of these specifications, fill out the missing
sections and follow the standard process of submitting it to a release
(See :doc:`../../readme`).
Template:
.. toctree::
:maxdepth: 1
Specification Template <template>
Approved (but not implemented) backlog specs:
.. toctree::
:glob:
:maxdepth: 1
approved/*

@ -1 +0,0 @@
../../../../specs/backlog-template.rst

@ -1 +0,0 @@
../../../../specs/newton/approved/

@ -1 +0,0 @@
../../../../specs/newton/implemented/

@ -1,26 +0,0 @@
==========================
Nova Newton Specifications
==========================
Template:
.. toctree::
:maxdepth: 1
Specification Template (Newton release) <template>
Newton implemented specs:
.. toctree::
:glob:
:maxdepth: 1
implemented/*
Newton approved (but not implemented) specs:
.. toctree::
:glob:
:maxdepth: 1
approved/*

@ -1 +0,0 @@
../../../../specs/newton/redirects

@ -1 +0,0 @@
../../../../specs/newton-template.rst

@ -0,0 +1 @@
../../../../specs/ocata/approved

@ -0,0 +1,18 @@
============================
Freezer Ocata Specifications
============================
Template:
.. toctree::
:maxdepth: 1
Specification Template (Ocata release) <template>
Ocata approved (but not implemented) specs:
.. toctree::
:glob:
:maxdepth: 1
approved/*

@ -0,0 +1 @@
../../../../specs/ocata/redirects

@ -0,0 +1 @@
../../../../specs/ocata-template.rst

@ -0,0 +1 @@
../../../../specs/pike/approved

@ -0,0 +1,18 @@
============================
Freezer Pike Specifications
============================
Template:
.. toctree::
:maxdepth: 1
Specification Template (Pike release) <template>
Pike approved (but not implemented) specs:
.. toctree::
:glob:
:maxdepth: 1
approved/*

@ -0,0 +1 @@
../../../../specs/pike/redirects

@ -0,0 +1 @@
../../../../specs/pike-template.rst

@ -0,0 +1 @@
../../../../specs/stein/approved

@ -0,0 +1,18 @@
============================
Freezer Stein Specifications
============================
Template:
.. toctree::
:maxdepth: 1
Specification Template (Stein release) <template>
Stein approved (but not implemented) specs:
.. toctree::
:glob:
:maxdepth: 1
approved/*

@ -0,0 +1 @@
../../../../specs/stein-template.rst

@ -26,14 +26,14 @@ prioritize in Newton.
Hardening and testing
--------
---------------------
In Newton, we want to increase as much as possible the test coverage for
Freezer.
This include better and more unit tests and tempest tests.
Agent refactoring
---------
-----------------
In Newton, we want to make our freezer-agent pluggable for four of its core
internal parts:
@ -46,13 +46,13 @@ internal parts:
* Pluggable engine: In order to support other ways of processing data.
Disaster recovery
----------------
-----------------
In Newton we will kick off freezer-dr in order to provide tooling to support
disaster recovery cases where backup/restore is not able to provide a good enough RTO.
Documentation improvement
------------------
-------------------------
In Newton, we will refactor our documentation. This includes mooving it away
from the READMEs, refactoring and updating the content as well as improving the

@ -49,9 +49,9 @@ Proposed change
Implementing the new engine classes for rsync (as well as for tar).
Providing new engine (-e) choice in config.
For this type of backup will be created following metadata structure:
For this type of backup will be created following metadata structure::
files_meta = {
files_meta = {
'files': {},
'directories': {},
'meta': {
@ -69,7 +69,7 @@ files_meta = {
'rsync_block_size': RSYNC_BLOCK_SIZE}
file_meta = {'inode': {
file_meta = {'inode': {
'inumber': os_stat.st_ino,
'nlink': os_stat.st_nlink,
'mode': file_mode,
@ -89,7 +89,7 @@ file_meta = {'inode': {
}
}
Current version of implementation you always can find here [1].
Current version of implementation you always can find here [1]_.
Alternatives
------------
@ -200,9 +200,9 @@ Work Items
Dependencies
============
* This spec depends on Freezer oslo.db migration [2].
* This spec depends on Freezer oslo.db migration [2]_.
* Pluggable engines described here [3].
* Pluggable engines described here [3]_.
* There are no additional library dependencies.

@ -49,9 +49,9 @@ Proposed change
Implementing the new engine classes for rsync (as well as for tar).
Providing new engine (-e) choice in config.
For this type of backup will be created following metadata structure:
For this type of backup will be created following metadata structure::
files_meta = {
files_meta = {
'files': {},
'directories': {},
'meta': {
@ -69,7 +69,7 @@ files_meta = {
'rsync_block_size': RSYNC_BLOCK_SIZE}
file_meta = {'inode': {
file_meta = {'inode': {
'inumber': os_stat.st_ino,
'nlink': os_stat.st_nlink,
'mode': file_mode,
@ -89,7 +89,7 @@ file_meta = {'inode': {
}
}
Current version of implementation you always can find here [1].
Current version of implementation you always can find here [1]_.
Alternatives
------------
@ -200,9 +200,9 @@ Work Items
Dependencies
============
* This spec depends on Freezer oslo.db migration [2].
* This spec depends on Freezer oslo.db migration [2]_.
* Pluggable engines described here [3].
* Pluggable engines described here [3]_.
* There are no additional library dependencies.

@ -86,7 +86,7 @@ Questions which need to be addressed by this section include:
existing data describe how that will work.
As there will be a brand new relational database schema [MIG1]_:
As there will be a brand new relational database schema [MIGR1]_:
Clients
@ -299,7 +299,7 @@ TBD.
References
==========
.. [MIG1] https://etherpad.openstack.org/p/freezer_mysql_migration
.. [MIGR1] https://etherpad.openstack.org/p/freezer_mysql_migration
.. https://etherpad.openstack.org/p/freezer_db_switch

@ -89,7 +89,7 @@ Other deployer impact
* A new storage type called 's3' will be added.
* When specify 's3' type, 'access-key', 'secret-key' and 'endpoint' should be
required.
required.
Developer impact
----------------
@ -139,4 +139,4 @@ None
History
=======
None
None

@ -221,7 +221,7 @@ Work Items
* Implementing sftp storage in freezer
* Adding these parameters ftp_host, ftp_username, ftp_password, ftp_port in
freezer-agent
freezer-agent
Dependencies
============

@ -1,31 +0,0 @@
..
This work is licensed under a Creative Commons Attribution 3.0 Unported
License.
http://creativecommons.org/licenses/by/3.0/legalcode
==================
(Placeholder Spec)
==================
This file is just a placeholder for the specs directory.
It will be removed soon after some spec is merged.
The latest spec template is found at ``specs/template.rst``
in the ``freezer-specs`` repository.
Problem Description
===================
Sphinx toctree complains if no file exists in a directory
specified in toctree glob.
Proposed Change
===============
Add this file.
References
==========
None.

@ -20,9 +20,13 @@ commands = {posargs}
[testenv:docs]
deps = -r{toxinidir}/doc/requirements.txt
whitelist_externals =
find
rm
commands =
rm -rf doc/build/html doc/build/doctrees
find . -type f -name "*.pyc" -delete
sphinx-build -b html doc/source doc/build/html
sphinx-build -W -b html doc/source doc/build/html
[testenv:pep8]
deps = -r{toxinidir}/test-requirements.txt