summaryrefslogtreecommitdiffstats
path: root/docs/requirements
diff options
context:
space:
mode:
authorGeorg Kunz <georg.kunz@ericsson.com>2016-11-01 00:56:10 +0100
committerGeorg Kunz <georg.kunz@ericsson.com>2016-11-11 09:14:52 +0000
commit01b644db5e301278aa4ab8863f8d439eb5a75b90 (patch)
tree6b71400a2abca36a44ee6cf8ad2649cbee662326 /docs/requirements
parent39d5de2b814b2ec038da973b82ee62f11a266b96 (diff)
Retiring the "provisioning of provider networks" use case
The gap identified along with this use case has been addressed ini the upstream community. Hence, moving to this use case to a separate section of the requirements document. Change-Id: I9cd95f1128a9845cda4ec42fe1692f22cdc03a9d Signed-off-by: Georg Kunz <georg.kunz@ericsson.com> (cherry picked from commit f29faf9e0f22dccfe0e4ad32ccff733341d43e4d)
Diffstat (limited to 'docs/requirements')
-rw-r--r--docs/requirements/index.rst1
-rw-r--r--docs/requirements/retired_use_cases.rst12
-rw-r--r--docs/requirements/retired_use_cases/images/api-users.png (renamed from docs/requirements/use_cases/images/api-users.png)bin21271 -> 21271 bytes
-rw-r--r--docs/requirements/retired_use_cases/programmable_provisioning.rst (renamed from docs/requirements/use_cases/programmable_provisioning.rst)32
-rw-r--r--docs/requirements/use_cases.rst3
5 files changed, 43 insertions, 5 deletions
diff --git a/docs/requirements/index.rst b/docs/requirements/index.rst
index a72ad99..21147bd 100644
--- a/docs/requirements/index.rst
+++ b/docs/requirements/index.rst
@@ -50,5 +50,6 @@ NetReady: Network Readiness
introduction.rst
use_cases.rst
+ retired_use_cases.rst
summary.rst
references.rst
diff --git a/docs/requirements/retired_use_cases.rst b/docs/requirements/retired_use_cases.rst
new file mode 100644
index 0000000..60df07b
--- /dev/null
+++ b/docs/requirements/retired_use_cases.rst
@@ -0,0 +1,12 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+Retired Use Cases
+=================
+
+The following use cases have previously been analyzed in terms of gaps. Since
+then, the identified gaps have been addressed and/or closed in the upstream
+community.
+
+.. toctree::
+ retired_use_cases/programmable_provisioning.rst
diff --git a/docs/requirements/use_cases/images/api-users.png b/docs/requirements/retired_use_cases/images/api-users.png
index 1f08812..1f08812 100644
--- a/docs/requirements/use_cases/images/api-users.png
+++ b/docs/requirements/retired_use_cases/images/api-users.png
Binary files differ
diff --git a/docs/requirements/use_cases/programmable_provisioning.rst b/docs/requirements/retired_use_cases/programmable_provisioning.rst
index 963451d..7cb2e00 100644
--- a/docs/requirements/use_cases/programmable_provisioning.rst
+++ b/docs/requirements/retired_use_cases/programmable_provisioning.rst
@@ -24,10 +24,12 @@ OpenStack components.
:name: api-users
:width: 50%
-Derived Requirements
-~~~~~~~~~~~~~~~~~~~~~
+
+Requirements
+~~~~~~~~~~~~
- Authorize the possibility of provider network creation based on policy
- - There should be a new entry in :code:`policy.json` which controls the provider network creation
+ - There should be a new entry in :code:`policy.json` which controls the
+ provider network creation
- Default policy of this new entry should be :code:`rule:admin_or_owner`.
- This policy should be respected by the Neutron API
@@ -39,10 +41,12 @@ Data model objects
++++++++++++++++++
- No changes in the data model
+
Current implementation
~~~~~~~~~~~~~~~~~~~~~~
Only admin users can manage provider networks [OS-NETWORKING-GUIDE-ML2]_.
+
Potential implementation
~~~~~~~~~~~~~~~~~~~~~~~~
- Policy engine shall be able to handle a new provider network creation and
@@ -50,3 +54,25 @@ Potential implementation
- When a provider network is created or modified neutron should check the
authority with the policy engine instead of requesting administrative
rights.
+
+
+Solution in upstream community
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+A bug report has been submitted to the upstream OpenStack community to highlight
+this gap:
+https://bugs.launchpad.net/neutron/+bug/1630880
+
+This bug report revealed that this use case has already been addressed in the
+upstream community. Specifically, it is possible to specify the roles (e.g.,
+admin, regular user) in the Neutron policy.json file which are able to create
+and update provider networks.
+
+However, the OpenStack user guide wrongly stated that **only** administrators
+can create and update provider type networks. Hence, a correction has been
+submitted to the OpenStack documentation repository, clarifying the possibility
+to change this behavior based on policies:
+https://review.openstack.org/#/c/390359/
+
+In conclusion, this use case has been retired as the corresponding gaps have been
+closed in the upstream community.
diff --git a/docs/requirements/use_cases.rst b/docs/requirements/use_cases.rst
index d31bbd3..b323593 100644
--- a/docs/requirements/use_cases.rst
+++ b/docs/requirements/use_cases.rst
@@ -1,7 +1,7 @@
.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. http://creativecommons.org/licenses/by/4.0
-Use cases
+Use Cases
=========
The following sections address networking use cases that have been identified to be relevant in the scope of NFV and NetReady.
@@ -10,5 +10,4 @@ The following sections address networking use cases that have been identified to
use_cases/multiple_backends.rst
use_cases/l3vpn.rst
use_cases/service_binding_pattern.rst
- use_cases/programmable_provisioning.rst
use_cases/georedundancy.rst