blob: d24f517ff3d76085080ecfcf3e8d68091b3053ae [file] [log] [blame]
Felipe Monteiro8a5f69a2017-07-14 20:12:33 +01001========================================
2Patrole: Tempest Plugin for RBAC Testing
3========================================
DavidPurcell663aedf2017-01-03 10:01:14 -05004
Felipe Monteiro543f7b92018-06-10 13:38:31 -04005Overview
6========
7
8.. toctree::
9 :maxdepth: 2
10
11 overview
12
Felipe Monteiroe9176552018-07-16 14:39:55 -040013RBAC Overview
14-------------
15
16.. toctree::
17 :maxdepth: 2
18
19 rbac-overview
Felipe Monteiro42f7e1c2018-06-10 20:09:26 -040020 multi-policy-validation
Felipe Monteiroe9176552018-07-16 14:39:55 -040021
Felipe Monteiro8a5f69a2017-07-14 20:12:33 +010022User's Guide
23============
DavidPurcell663aedf2017-01-03 10:01:14 -050024
Felipe Monteiro8a5f69a2017-07-14 20:12:33 +010025Patrole Configuration Guide
26---------------------------
DavidPurcell663aedf2017-01-03 10:01:14 -050027
28.. toctree::
29 :maxdepth: 2
30
Felipe Monteiro8a5f69a2017-07-14 20:12:33 +010031 configuration
Felipe Monteiro8a5f69a2017-07-14 20:12:33 +010032
Felipe Monteiro443d39c2018-04-08 17:05:33 -040033Patrole Installation Guide
34--------------------------
35
36.. toctree::
37 :maxdepth: 2
38
39 installation
40
41Field Guides
42============
43
44.. toctree::
45 :maxdepth: 1
46
47 field_guide/index
48 field_guide/rbac
49
Ghanshyam Manna1f02452020-04-19 17:45:19 -050050For Contributors
51================
52
53* If you are a new contributor to Patrole please refer: :doc:`contributor/contributing`
54
55.. toctree::
56 :hidden:
57
58 contributor/contributing
59
Felipe Monteiro8a5f69a2017-07-14 20:12:33 +010060Developer's Guide
61=================
62
63.. toctree::
Felipe Monteiro88a5bab2017-08-31 04:00:32 +010064 :maxdepth: 1
65
66 HACKING
Felipe Monteiroeb197db2018-06-10 12:21:49 -040067 REVIEWING
Felipe Monteiro26b7e092018-07-27 22:15:27 +010068 test_writing_guide
Felipe Monteiro88a5bab2017-08-31 04:00:32 +010069
70Framework
71---------
72
73.. toctree::
Felipe Monteiro47c43cb2018-11-05 17:15:30 +000074 :maxdepth: 3
Felipe Monteiro8a5f69a2017-07-14 20:12:33 +010075
Felipe Monteiroc8ec1f62017-11-15 08:32:56 +000076 framework/overview
77 framework/rbac_validation
Felipe Monteiro66d54a92018-05-31 20:08:35 +010078 framework/rbac_authority
Felipe Monteiroc8ec1f62017-11-15 08:32:56 +000079 framework/policy_authority
Felipe Monteiro66d54a92018-05-31 20:08:35 +010080 framework/requirements_authority
Felipe Monteiroc8ec1f62017-11-15 08:32:56 +000081 framework/rbac_utils
Felipe Monteiro47c43cb2018-11-05 17:15:30 +000082 framework/code/modules
DavidPurcell663aedf2017-01-03 10:01:14 -050083
Masayuki Igawa94e6b182019-09-18 15:08:56 +090084Search
85======
DavidPurcell663aedf2017-01-03 10:01:14 -050086
Masayuki Igawa94e6b182019-09-18 15:08:56 +090087.. only:: html
88
89 * :ref:`Patrole document search <search>`: Search the contents of this document.
90
91* `OpenStack wide search <https://docs.openstack.org>`_: Search the wider
92 set of OpenStack documentation, including forums.