Generate RST Guidelines from JSON source

As per the process, we want to use generated RST
instead of hand created files.

In generating the files, I found a comma error in 2015.03
and removed spaces from 2015.04 so there are minor
changes to those files.

Because 2015.next is still in process, it does not make
sense to generate the RST file at this time.  We do
NOT want to have to maintain multiple files for each
change.  I've removed the 2015.next.rst file.

Also added check to make sure we're using the
correct JSON source using the hardcoded DefCore
repo path as an extra check.

Change-Id: I443f4c1cb84eb2c42ad9e6914cee0ce6d498a9bb
This commit is contained in:
Rob Hirschfeld 2015-04-10 16:50:31 -05:00
parent cd4f68f862
commit f42240d5a9
6 changed files with 137 additions and 261 deletions

View File

@ -244,7 +244,7 @@
"flagged": [
"tempest.api.compute.servers.test_list_server_filters.ListServerFiltersTestJSON.test_list_servers_filtered_by_ip_regex",
"tempest.api.compute.servers.test_server_actions.ServerActionsTestJSON.test_change_server_password",
"tempest.api.compute.servers.test_server_actions.ServerActionsTestJSON.test_reboot_server_soft"
"tempest.api.compute.servers.test_server_actions.ServerActionsTestJSON.test_reboot_server_soft",
"tempest.api.compute.servers.test_create_server.ServersTestJSON.test_host_name_is_same_as_server_name",
"tempest.api.compute.servers.test_create_server.ServersTestJSON.test_verify_created_server_vcpus",
"tempest.api.compute.servers.test_create_server.ServersTestManualDisk.test_host_name_is_same_as_server_name",

View File

@ -1,117 +1,105 @@
=================================
=========================
OpenStack DefCore 2015.03
=================================
=========================
Status: Approved
Replaces: 2014.07
:Status: approved
:Replaces: 2014.07
This document outlines the mandatory and advisory capabilities
required to exist in a software installation in order to be
eligible to use marks controlled by the OpenStack Foundation.
This document supersedes the companion JSON version.
This document outlines the mandatory capabilities and designated
sections required to exist in a software installation in order to
be eligible to use marks controlled by the OpenStack Foundation.
This document was generated from the master JSON version.
Releases Covered
==============================
Applies to Havana, Icehouse
Platform Components
==============================
Required: Compute and Object
:Required: Compute, Object
:Advisory: None
:Deprecated: None
:Removed: None
Advisory: None
Deprecated: None
Removed: None
Compute Component Capabilities
==============================
Required Capabilities
-----------------------
* Compute-auth (nova)
* Compute-flavors (nova)
* Compute-images (nova)
* Compute-instance-actions (nova)
* Compute-keypairs (nova)
* Compute-quotas (nova)
* Compute-servers (nova)
* Compute-volume (nova)
* Images-v2 (glance)
======================== ====================
Capability Name Associated Project
------------------------ --------------------
compute-auth Nova
compute-flavors Nova
compute-images Nova
compute-instance-actions Nova
compute-keypairs Nova
compute-quotas Nova
compute-servers Nova
compute-volume Nova
images-v2 Glance
======================== ====================
Advisory Capabilities
-----------------------
* Auth-token (keystone)
* Compute-servers-metadata (nova)
Advisory Capabilities
------------------------------
Deprecated Capabilities
-------------------------
None
======================== ====================
Capability Name Associated Project
------------------------ --------------------
auth-token Keystone
compute-servers-metadata Nova
======================== ====================
Removed Capabilities
----------------------
* Compute floating ips (None)
* Images-v1 (None)
* Volume (None)
Deprecated Capabilities
------------------------------
None.
Removed Capabilities
------------------------------
======================== ====================
Capability Name Associated Project
------------------------ --------------------
compute-floating-ips Nova
images-v1 Glance
volume Nova
======================== ====================
Object Component Capabilities
==============================
=============================
Required Capabilities
-----------------------
* Objectstore-object (swift)
======================== ====================
Capability Name Associated Project
------------------------ --------------------
objectstore-object Swift
======================== ====================
Advisory Capabilities
-----------------------
None
Advisory Capabilities
------------------------------
None.
Deprecated Capabilities
-------------------------
None
Deprecated Capabilities
------------------------------
None.
Removed Capabilities
------------------------------
None.
Removed Capabilities
----------------------
None
Designated Sections
==============================
=====================================
The following designated sections apply to the same releases as
this specification.
* Nova is by default designated except scheduler, filter, drivers, API
extensions and networking.
* Glance designated sections are the API implementation code and domain model.
* Swift designated sections are proxy server, object server, container server,
account server and select middleware (complete list provided by community in
linked json document).
Required Designated Sections
----------------------------
* Cinder : Designated sections are the API implementation code
* Glance : Designated sections are the API implementation code and domain model.
* Nova : By default, designated except scheduler, filter, drivers, API extensions and networking.
* Swift : Designated sections are proxy server, object server, container server, account server and select middleware
Advisory Designated Sections
------------------------------------
----------------------------
* Keystone : Update pending from PTL
None.
Deprecated Designated Sections
------------------------------
None
Functional Information
======================
:Format: RestructuredText
:Layout: 1.0
Removed Designated Sections
---------------------------
None

View File

@ -465,7 +465,7 @@
"name": "volume",
"tests": []
}
},
},
"designated-sections" : {
"required" : {
"nova" : {

View File

@ -1,110 +1,103 @@
=================================
=========================
OpenStack DefCore 2015.04
=================================
=========================
Status: Draft
Replaces: 2015.03
:Status: draft
:Replaces: 2015.03
This document outlines the mandatory and advisory capabilities
required to exist in a software installation in order to be
eligible to use marks controlled by the OpenStack Foundation.
This document outlines the mandatory capabilities and designated
sections required to exist in a software installation in order to
be eligible to use marks controlled by the OpenStack Foundation.
This document supersedes the companion JSON version.
This document was generated from the master JSON version.
Releases Covered
==============================
Applies to Havana, Icehouse, Juno
Platform Components
==============================
Required: Compute and Object
:Required: Compute, Object
:Advisory: None
:Deprecated: None
:Removed: None
Advisory: None
Deprecated: None
Removed: None
Compute Component Capabilities
==============================
Required Capabilities
-----------------------
* Compute-auth (nova)
* Compute-flavors (nova)
* Compute-images (nova)
* Compute-instance-actions (nova)
* Compute-keypairs (nova)
* Compute-quotas (nova)
* Compute-servers (nova)
* Compute-volume (nova)
* Images-v2 (glance)
======================== ====================
Capability Name Associated Project
------------------------ --------------------
compute-auth Nova
compute-flavors Nova
compute-images Nova
compute-instance-actions Nova
compute-keypairs Nova
compute-quotas Nova
compute-servers Nova
compute-volume Nova
images-v2 Glance
======================== ====================
Advisory Capabilities
-----------------------
* Auth-token (keystone)
* Compute-servers-metadata (nova)
Advisory Capabilities
------------------------------
Deprecated Capabilities
-------------------------
None
======================== ====================
Capability Name Associated Project
------------------------ --------------------
auth-token Keystone
compute-servers-metadata Nova
======================== ====================
Removed Capabilities
----------------------
None
Deprecated Capabilities
------------------------------
None.
Removed Capabilities
------------------------------
None.
Object Component Capabilities
==============================
=============================
Required Capabilities
-----------------------
* Objectstore-object (swift)
======================== ====================
Capability Name Associated Project
------------------------ --------------------
objectstore-object Swift
======================== ====================
Advisory Capabilities
-----------------------
None
Advisory Capabilities
------------------------------
None.
Deprecated Capabilities
-------------------------
None
Deprecated Capabilities
------------------------------
None.
Removed Capabilities
------------------------------
None.
Removed Capabilities
----------------------
None
Designated Sections
==============================
=====================================
The following designated sections apply to the same releases as
this specification.
* Nova is by default designated except scheduler, filter, drivers, API
extensions and networking.
* Glance designated sections are the API implementation code and domain model.
* Swift designated sections are proxy server, object server, container server,
account server and select middleware (complete list provided by community in
linked json document).
Required Designated Sections
----------------------------
* Cinder : Designated sections are the API implementation code
* Glance : Designated sections are the API implementation code and domain model.
* Nova : By default, designated except scheduler, filter, drivers, API extensions and networking.
* Swift : Designated sections are proxy server, object server, container server, account server and select middleware
Advisory Designated Sections
------------------------------------
----------------------------
* Keystone : Update pending from PTL
None.
Deprecated Designated Sections
------------------------------
None
Functional Information
======================
:Format: RestructuredText
:Layout: 1.0
Removed Designated Sections
---------------------------
None

View File

@ -1,110 +0,0 @@
=================================
OpenStack DefCore 2015.next
=================================
Status: Draft
Replaces: 2015.04
This document outlines the mandatory and advisory capabilities
required to exist in a software installation in order to be
eligible to use marks controlled by the OpenStack Foundation.
This document supersedes the companion JSON version.
Releases Covered
==============================
Applies to Havana, Icehouse, Juno
Platform Components
==============================
Required: Compute and Object
Advisory: None
Deprecated: None
Removed: None
Compute Component Capabilities
==============================
======================== ====================
Capability Name Associated Project
------------------------ --------------------
compute-auth Nova
compute-flavors Nova
compute-images Nova
compute-instance-actions Nova
compute-keypairs Nova
compute-quotas Nova
compute-servers Nova
compute-volume Nova
images-v2 Glance
======================== ====================
Advisory Capabilities
------------------------------
======================== ====================
Capability Name Associated Project
------------------------ --------------------
auth-token Keystone
compute-servers-metadata Nova
======================== ====================
Deprecated Capabilities
------------------------------
None.
Removed Capabilities
------------------------------
None.
Object Component Capabilities
==============================
======================== ====================
Capability Name Associated Project
------------------------ --------------------
objectstore-object Swift
======================== ====================
Advisory Capabilities
------------------------------
None.
Deprecated Capabilities
------------------------------
None.
Removed Capabilities
------------------------------
None.
Designated Sections
==============================
The following designated sections apply to the same releases as
this specification.
* Nova is by default designated except scheduler, filter, drivers, API
extensions and networking.
* Glance designated sections are the API implementation code and domain model.
* Swift designated sections are proxy server, object server, container server,
account server and select middleware (complete list provided by community in
linked json document).
Advisory Designated Sections
------------------------------------
None.
Functional Information
======================
:Format: RestructuredText
:Layout: 1.0

View File

@ -72,6 +72,11 @@ with open(outFileName, "w") as outFile:
print "The platform section is not found"
sys.exit(1)
# Correct Source
if data.get('source') != 'http://git.openstack.org/cgit/openstack/defcore/':
print "The expected DefCore source not found"
sys.exit(1)
outFile.write("""
:Status: {status}
:Replaces: {replaces}