From d72355c25b456ac5660bf0ebb15f7265e1e634cf Mon Sep 17 00:00:00 2001
From: xudan <xudan16@huawei.com>
Date: Wed, 5 Dec 2018 02:03:52 -0500
Subject: Update the docs of patrole

JIRA: DOVETAIL-756

Change-Id: Iad2bd02f3991aa3b551b8065ee25cf7b3213c423
Signed-off-by: xudan <xudan16@huawei.com>
---
 docs/testing/user/testspecification/index.rst      |  1 +
 .../testspecification/security_patrole/index.rst   |  2 -
 .../security_patrole_vxlan_dependent/index.rst     | 52 ++++++++++++++++++++++
 3 files changed, 53 insertions(+), 2 deletions(-)
 create mode 100644 docs/testing/user/testspecification/security_patrole_vxlan_dependent/index.rst

(limited to 'docs')

diff --git a/docs/testing/user/testspecification/index.rst b/docs/testing/user/testspecification/index.rst
index 9fff4689..b4232b68 100644
--- a/docs/testing/user/testspecification/index.rst
+++ b/docs/testing/user/testspecification/index.rst
@@ -29,6 +29,7 @@ specification documents.
 
    highavailability/index
    security_patrole/index
+   security_patrole_vxlan_dependent/index
    snaps_smoke/index
    stress/index
    tempest_compute/index
diff --git a/docs/testing/user/testspecification/security_patrole/index.rst b/docs/testing/user/testspecification/security_patrole/index.rst
index 189c248d..610b7f0d 100644
--- a/docs/testing/user/testspecification/security_patrole/index.rst
+++ b/docs/testing/user/testspecification/security_patrole/index.rst
@@ -176,8 +176,6 @@ Implementation:
 `NetworksRbacTest <https://github.com/openstack/patrole/blob/0.2.0/patrole_tempest_plugin/tests/api/network/test_networks_rbac.py>`_
 
 - patrole_tempest_plugin.tests.api.network.test_networks_rbac.NetworksRbacTest.test_create_network
-- patrole_tempest_plugin.tests.api.network.test_networks_rbac.NetworksRbacTest.test_create_network_provider_network_type
-- patrole_tempest_plugin.tests.api.network.test_networks_rbac.NetworksRbacTest.test_create_network_provider_segmentation_id
 - patrole_tempest_plugin.tests.api.network.test_networks_rbac.NetworksRbacTest.test_create_network_router_external
 - patrole_tempest_plugin.tests.api.network.test_networks_rbac.NetworksRbacTest.test_create_network_shared
 - patrole_tempest_plugin.tests.api.network.test_networks_rbac.NetworksRbacTest.test_create_subnet
diff --git a/docs/testing/user/testspecification/security_patrole_vxlan_dependent/index.rst b/docs/testing/user/testspecification/security_patrole_vxlan_dependent/index.rst
new file mode 100644
index 00000000..3ff48aa6
--- /dev/null
+++ b/docs/testing/user/testspecification/security_patrole_vxlan_dependent/index.rst
@@ -0,0 +1,52 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) OPNFV
+
+=====================================
+Patrole Tempest Tests Depend on Vxlan
+=====================================
+
+Scope
+=====
+
+This test area includes some tempest role-based access control (RBAC) tests
+which depend on vxlan physical networks.
+
+
+References
+================
+
+- `OpenStack image service API reference <https://developer.openstack.org/api-ref/image/v2/index.html>`_
+- `OpenStack metadata definitions service API reference <https://developer.openstack.org/api-ref/image/v2/metadefs-index.html>`_
+- `OpenStack layer 2 networking service API reference <https://developer.openstack.org/api-ref/network/v2/index.html#layer-2-networking>`_
+- `OpenStack layer 3 networking service API reference <https://developer.openstack.org/api-ref/network/v2/index.html#layer-3-networking>`_
+- `OpenStack network security API reference <https://developer.openstack.org/api-ref/network/v2/index.html#security>`_
+- `OpenStack resource management API reference <https://developer.openstack.org/api-ref/network/v2/index.html#resource-management>`_
+- `OpenStack networking agents API reference <https://developer.openstack.org/api-ref/network/v2/index.html#networking-agents>`_
+
+
+System Under Test (SUT)
+=======================
+
+The system under test is assumed to be the NFVI and VIM deployed on a Pharos
+compliant infrastructure.
+
+
+Test Area Structure
+====================
+
+The test area is structured in individual tests as listed below. Each test case
+is able to run independently, i.e. irrelevant of the state created by a previous
+test. For detailed information on the individual steps and assertions performed
+by the tests, review the Python source code accessible via the following links.
+
+
+**Network basic RBAC test:**
+
+These tests cover the RBAC tests of network basic operations by creating a vxlan provider network.
+
+Implementation:
+`NetworksRbacTest <https://github.com/openstack/patrole/blob/0.2.0/patrole_tempest_plugin/tests/api/network/test_networks_rbac.py>`_
+
+- patrole_tempest_plugin.tests.api.network.test_networks_rbac.NetworksRbacTest.test_create_network_provider_network_type
+- patrole_tempest_plugin.tests.api.network.test_networks_rbac.NetworksRbacTest.test_create_network_provider_segmentation_id
-- 
cgit 1.2.3-korg