Merge "docs: Include information about the list of supported projects"
This commit is contained in:
commit
cb4c749be7
17
HACKING.rst
17
HACKING.rst
@ -43,6 +43,23 @@ The following are Patrole's specific Commandments:
|
|||||||
|
|
||||||
.. _extension test class: https://github.com/openstack/patrole/tree/master/patrole_tempest_plugin/tests/api/network#neutron-extension-rbac-tests
|
.. _extension test class: https://github.com/openstack/patrole/tree/master/patrole_tempest_plugin/tests/api/network#neutron-extension-rbac-tests
|
||||||
|
|
||||||
|
Supported OpenStack Components
|
||||||
|
------------------------------
|
||||||
|
|
||||||
|
Patrole only offers **in-tree** integration testing coverage for the following
|
||||||
|
components:
|
||||||
|
|
||||||
|
* Cinder
|
||||||
|
* Glance
|
||||||
|
* Keystone
|
||||||
|
* Neutron
|
||||||
|
* Nova
|
||||||
|
|
||||||
|
Patrole currently has no stable library, so reliance upon Patrole's framework
|
||||||
|
for external RBAC testing should be done with caution. Nonetheless, even when
|
||||||
|
Patrole has a stable library, it will only offer in-tree RBAC testing for
|
||||||
|
the components listed above.
|
||||||
|
|
||||||
Role Overriding
|
Role Overriding
|
||||||
---------------
|
---------------
|
||||||
|
|
||||||
|
@ -18,9 +18,6 @@ cloud. It runs `Tempest`_-based API tests using specified RBAC roles, thus
|
|||||||
allowing deployments to verify that only intended roles have access to those
|
allowing deployments to verify that only intended roles have access to those
|
||||||
APIs.
|
APIs.
|
||||||
|
|
||||||
Patrole currently offers testing for the following OpenStack services: Nova,
|
|
||||||
Neutron, Glance, Cinder and Keystone.
|
|
||||||
|
|
||||||
Patrole is currently undergoing heavy development. As more projects move
|
Patrole is currently undergoing heavy development. As more projects move
|
||||||
toward policy in code, Patrole will align its testing with the appropriate
|
toward policy in code, Patrole will align its testing with the appropriate
|
||||||
documentation.
|
documentation.
|
||||||
@ -205,7 +202,11 @@ To change the roles that the patrole tests are being run as, edit
|
|||||||
For more information about RBAC, reference the `rbac-overview`_
|
For more information about RBAC, reference the `rbac-overview`_
|
||||||
documentation page.
|
documentation page.
|
||||||
|
|
||||||
|
For information regarding which projects Patrole offers RBAC testing for,
|
||||||
|
reference the `HACKING`_ documentation page.
|
||||||
|
|
||||||
.. _rbac-overview: https://docs.openstack.org/patrole/latest/rbac-overview.html
|
.. _rbac-overview: https://docs.openstack.org/patrole/latest/rbac-overview.html
|
||||||
|
.. _HACKING: https://docs.openstack.org/patrole/latest/HACKING.html#supported-openstack-components
|
||||||
|
|
||||||
Unit Tests
|
Unit Tests
|
||||||
----------
|
----------
|
||||||
|
Loading…
Reference in New Issue
Block a user