docs: Add Patrole RBAC field guide
This documentation update adds a README.rst to
patrole_tempest_plugin/tests/api which explains the RBAC field
guide. It is modeled after Tempest's API field guide [0][1]. The
README.rst is then referenced in a new field_guide section
under doc/source/field_guide.
[0] https://github.com/openstack/tempest/tree/28b252f7f61a2dfc585089265cdb3118defbcfff/tempest/api
[1] https://docs.openstack.org/tempest/latest/field_guide/api.html#api-field-guide
Change-Id: I877ce4a1f681bd483c7f71b02fd7bb2b4d3b3e2a
diff --git a/README.rst b/README.rst
index f4ab65c..0c786b9 100644
--- a/README.rst
+++ b/README.rst
@@ -9,9 +9,9 @@
=========================================
Patrole is a security validation tool for verifying that Role-Based Access
-Control is correctly configured and enforced in a system. It runs Tempest-based
-API tests using specified RBAC roles, thus allowing deployments to verify that
-only intended roles have access to those APIs.
+Control is correctly configured and enforced in a system. It runs
+`Tempest`_-based API tests using specified RBAC roles, thus allowing
+deployments to verify that only intended roles have access to those APIs.
Patrole currently offers testing for the following OpenStack services: Nova,
Neutron, Glance, Cinder and Keystone.
@@ -20,6 +20,8 @@
toward policy in code, Patrole will align its testing with the appropriate
documentation.
+.. _Tempest: https://docs.openstack.org/tempest/latest/
+
Design Principles
-----------------