From 7ca32bb3e8e96a93a8dbb9e1ef2f312c39d8b8f2 Mon Sep 17 00:00:00 2001 From: Dongfeng Huang Date: Tue, 20 Dec 2016 19:29:43 +0800 Subject: [PATCH] Add release notes for resource routing api 1. What is the problem? Both the blueprint and implementation of the resource routing API have been completed, so release notes are required for these new features. This patch adds the release notes for them. Moreover, the releasenotes test environment should be added to the tox.ini. The reno version should be given in test-requirements.txt. 2. What is the solution to the problem? Add release notes for the resource routing API in the new file releasenotes/notes/resource-routing-operation.yaml. Add the releasenotes test environment to file tox.ini and reno version to the test-requirements.txt. 3. What the features need to be implemented to the Tricircle to realize the solution? No new features. Change-Id: I23c9b3fb97b33f15a877eb2dbcabbb823c825d6d --- releasenotes/config.yaml | 3 + ...nitial-release-notes-bd28a4a4bf1f84d2.yaml | 68 +++++++++++++++++++ releasenotes/notes/initial-release-notes.yaml | 52 -------------- ...ce-routing-operation-649eb810911312ec.yaml | 22 ++++++ releasenotes/source/index.rst | 6 +- releasenotes/source/mitaka.rst | 6 -- releasenotes/source/newton.rst | 6 -- test-requirements.txt | 1 + tox.ini | 3 + 9 files changed, 99 insertions(+), 68 deletions(-) create mode 100644 releasenotes/config.yaml create mode 100644 releasenotes/notes/initial-release-notes-bd28a4a4bf1f84d2.yaml delete mode 100644 releasenotes/notes/initial-release-notes.yaml create mode 100644 releasenotes/notes/resource-routing-operation-649eb810911312ec.yaml delete mode 100644 releasenotes/source/mitaka.rst delete mode 100644 releasenotes/source/newton.rst diff --git a/releasenotes/config.yaml b/releasenotes/config.yaml new file mode 100644 index 00000000..1db075c3 --- /dev/null +++ b/releasenotes/config.yaml @@ -0,0 +1,3 @@ +--- +collapse_pre_releases: true +stop_at_branch_base: false diff --git a/releasenotes/notes/initial-release-notes-bd28a4a4bf1f84d2.yaml b/releasenotes/notes/initial-release-notes-bd28a4a4bf1f84d2.yaml new file mode 100644 index 00000000..163692f2 --- /dev/null +++ b/releasenotes/notes/initial-release-notes-bd28a4a4bf1f84d2.yaml @@ -0,0 +1,68 @@ +--- +prelude: > + The Tricircle is a dedicated project for networking automation across + Neutron in OpenStack multi-region deployment. +features: + - | + Network + + * List networks + * Create network + * Show network details + * Delete network + + - | + Subnet + + * List subnets + * Create subnet + * Show subnet details + * Delete subnet + + - | + Port + + * List ports + * Create port + * Show port details + * Delete port + + - | + Router + + * List routers + * Create router + * Show router details + * Delete router + * Add interface to router + * Delete interface from router + * List floating IPs + * Create floating IP + * Show floating IP details + * Update floating IP + * Delete floating IP + + - | + Security Group + + * List security groups + * Create security group + * Show security group details + * List security group rules + * Create security group rule + + - | + Note for Networking + + * Only Local Network and Shared VLAN network supported. Shared + VLAN is the only L2 network type which supports cross + Neutron L2 networking and the bridge network for L3 networking. + * Pagination and sort are not supported at the same time for list + operation. + * For security group rule, remote group not supported yet. Use IP + prefix to create security group rule. + * Need to specify the region name as the availability zone hint for + external network creation, that means the external network will + be located in the specified region. +issues: + - refer to https://bugs.launchpad.net/tricircle diff --git a/releasenotes/notes/initial-release-notes.yaml b/releasenotes/notes/initial-release-notes.yaml deleted file mode 100644 index 2c30eecc..00000000 --- a/releasenotes/notes/initial-release-notes.yaml +++ /dev/null @@ -1,52 +0,0 @@ ---- -prelude: > - - The Tricircle is a dedicated project for networking automation across - Neutron in OpenStack multi-region deployment. -features: - - Network: - - List networks - - Create network - - Show network details - - Delete network - - Subnet: - - List subnets - - Create subnet - - Show subnet details - - Delete subnet - - Port: - - List ports - - Create port - - Show port details - - Delete port - - Router: - - List routers - - Create router - - Show router details - - Delete router - - Add interface to router - - Delete interface from router - - List floating IPs - - Create floating IP - - Show floating IP details - - Update floating IP - - Delete floating IP - - Security Group: - - List security groups - - Create security group - - Show security group details - - List security group rules - - Create security group rule - - Show security group rule - - Note for networking: - - Only Local Network and Shared VLAN network supported. Shared - VLAN is the only L2 network type which supports cross - Neutron L2 networking and the bridge network for L3 networking. - - Pagination and sort are not supported at the same time for list - operation. - - For security group rule, remote group not supported yet. Use IP - prefix to create security group rule. - - Need to specify the region name as the availability zone hint for - external network creation, that means the external network will - be located in the specified region. -issues: - - refer to https://bugs.launchpad.net/tricircle diff --git a/releasenotes/notes/resource-routing-operation-649eb810911312ec.yaml b/releasenotes/notes/resource-routing-operation-649eb810911312ec.yaml new file mode 100644 index 00000000..164c240a --- /dev/null +++ b/releasenotes/notes/resource-routing-operation-649eb810911312ec.yaml @@ -0,0 +1,22 @@ +--- +features: + - | + Resource routing APIs add operations on resource routing + table. This makes it possible to create, show, delete + and update the resource routing entry in the resource + routing by cloud administrator for the maintenance and + emergency fix need. But the update and delete operations + on the entry generated by the Tricircle itself is not + proposed, because central Neutron may make wrong + judgement on whether the resource exists or not + without this routing entry. Moreover, related request + can not be forwarded to the proper local Neutron + either. So even though the update and delete operations + are provided, they are better not to be used in case of + causing unexpected problems. + + * List resource routings + * Create resource routing + * Show resource routing details + * Delete resource routing + * Update resource routing diff --git a/releasenotes/source/index.rst b/releasenotes/source/index.rst index fe9df7ef..f346b281 100644 --- a/releasenotes/source/index.rst +++ b/releasenotes/source/index.rst @@ -1,10 +1,8 @@ -====================== +======================== Tricircle Release Notes -====================== +======================== .. toctree:: :maxdepth: 1 - mitaka - newton unreleased diff --git a/releasenotes/source/mitaka.rst b/releasenotes/source/mitaka.rst deleted file mode 100644 index 0dc585c8..00000000 --- a/releasenotes/source/mitaka.rst +++ /dev/null @@ -1,6 +0,0 @@ -============================= - Mitaka Series Release Notes -============================= - -.. release-notes:: - :branch: origin/stable/mitaka diff --git a/releasenotes/source/newton.rst b/releasenotes/source/newton.rst deleted file mode 100644 index 564d6d98..00000000 --- a/releasenotes/source/newton.rst +++ /dev/null @@ -1,6 +0,0 @@ -============================= - Newton Series Release Notes -============================= - -.. release-notes:: - :branch: origin/stable/newton \ No newline at end of file diff --git a/test-requirements.txt b/test-requirements.txt index d19aa002..70aaff31 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -22,3 +22,4 @@ os-testr>=0.8.0 # Apache-2.0 tempest-lib>=0.14.0 # Apache-2.0 ddt>=1.0.1 # MIT pylint==1.4.5 # GPLv2 +reno>=1.8.0 # Apache-2.0 diff --git a/tox.ini b/tox.ini index ddfc2db9..925e62c1 100644 --- a/tox.ini +++ b/tox.ini @@ -17,6 +17,9 @@ deps = commands = python setup.py testr --slowest --testr-args='{posargs}' whitelist_externals = rm +[testenv:releasenotes] +commands = sphinx-build -a -W -E -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html + [testenv:pep8] deps = -r{toxinidir}/test-requirements.txt