Browse Source

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
changes/49/413049/7
Dongfeng Huang 5 years ago
parent
commit
7ca32bb3e8
9 changed files with 99 additions and 68 deletions
  1. +3
    -0
      releasenotes/config.yaml
  2. +68
    -0
      releasenotes/notes/initial-release-notes-bd28a4a4bf1f84d2.yaml
  3. +0
    -52
      releasenotes/notes/initial-release-notes.yaml
  4. +22
    -0
      releasenotes/notes/resource-routing-operation-649eb810911312ec.yaml
  5. +2
    -4
      releasenotes/source/index.rst
  6. +0
    -6
      releasenotes/source/mitaka.rst
  7. +0
    -6
      releasenotes/source/newton.rst
  8. +1
    -0
      test-requirements.txt
  9. +3
    -0
      tox.ini

+ 3
- 0
releasenotes/config.yaml View File

@ -0,0 +1,3 @@
---
collapse_pre_releases: true
stop_at_branch_base: false

+ 68
- 0
releasenotes/notes/initial-release-notes-bd28a4a4bf1f84d2.yaml View File

@ -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

+ 0
- 52
releasenotes/notes/initial-release-notes.yaml View File

@ -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

+ 22
- 0
releasenotes/notes/resource-routing-operation-649eb810911312ec.yaml View File

@ -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

+ 2
- 4
releasenotes/source/index.rst View File

@ -1,10 +1,8 @@
======================
========================
Tricircle Release Notes
======================
========================
.. toctree::
:maxdepth: 1
mitaka
newton
unreleased

+ 0
- 6
releasenotes/source/mitaka.rst View File

@ -1,6 +0,0 @@
=============================
Mitaka Series Release Notes
=============================
.. release-notes::
:branch: origin/stable/mitaka

+ 0
- 6
releasenotes/source/newton.rst View File

@ -1,6 +0,0 @@
=============================
Newton Series Release Notes
=============================
.. release-notes::
:branch: origin/stable/newton

+ 1
- 0
test-requirements.txt View File

@ -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

+ 3
- 0
tox.ini View File

@ -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


Loading…
Cancel
Save