From c219708d87a850bf8397fccd79fff72aa082ba46 Mon Sep 17 00:00:00 2001 From: CR_hui Date: Tue, 18 Oct 2016 16:48:29 +0800 Subject: [PATCH] Add release notes for the master branch 1. What is the problem? There is no release notes in master branch, then the user of Tricircle don't know what features supported, what features not supported. 2. What is the solution to the problem? Add release notes to outline what features supported for the Tricircle project. 3. What the features need to be implemented to the Tricircle to realize the solution? No new features. Change-Id: I4270730bd5def464b9814f7b457a0316a6dd1a0e --- README.rst | 1 + releasenotes/notes/initial-release-notes.yaml | 52 +++++++++++++++++++ releasenotes/source/index.rst | 3 +- releasenotes/source/newton.rst | 6 +++ 4 files changed, 61 insertions(+), 1 deletion(-) create mode 100644 releasenotes/notes/initial-release-notes.yaml create mode 100644 releasenotes/source/newton.rst diff --git a/README.rst b/README.rst index 58c8209b..ba1fb86c 100644 --- a/README.rst +++ b/README.rst @@ -42,3 +42,4 @@ detailed in the LICENSE file. * Source: https://github.com/openstack/tricircle * Bugs: http://bugs.launchpad.net/tricircle * Blueprints: https://launchpad.net/tricircle +* Release notes: https://github.com/openstack/tricircle/tree/master/releasenotes/notes \ No newline at end of file diff --git a/releasenotes/notes/initial-release-notes.yaml b/releasenotes/notes/initial-release-notes.yaml new file mode 100644 index 00000000..2c30eecc --- /dev/null +++ b/releasenotes/notes/initial-release-notes.yaml @@ -0,0 +1,52 @@ +--- +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/source/index.rst b/releasenotes/source/index.rst index a219e763..fe9df7ef 100644 --- a/releasenotes/source/index.rst +++ b/releasenotes/source/index.rst @@ -1,9 +1,10 @@ ====================== - Cinder Release Notes + Tricircle Release Notes ====================== .. toctree:: :maxdepth: 1 mitaka + newton unreleased diff --git a/releasenotes/source/newton.rst b/releasenotes/source/newton.rst new file mode 100644 index 00000000..564d6d98 --- /dev/null +++ b/releasenotes/source/newton.rst @@ -0,0 +1,6 @@ +============================= + Newton Series Release Notes +============================= + +.. release-notes:: + :branch: origin/stable/newton \ No newline at end of file