Merge "doc: Add policy reference"
This commit is contained in:
commit
d2adcdec83
|
@ -7,6 +7,7 @@ covhtml/
|
||||||
dist/
|
dist/
|
||||||
doc/build
|
doc/build
|
||||||
doc/source/_static/config_samples/*.sample
|
doc/source/_static/config_samples/*.sample
|
||||||
|
doc/source/_static/*.policy.yaml.sample
|
||||||
doc/source/contributor/api/
|
doc/source/contributor/api/
|
||||||
etc/*.sample
|
etc/*.sample
|
||||||
*.DS_Store
|
*.DS_Store
|
||||||
|
|
|
@ -48,6 +48,8 @@ extensions = ['sphinxcontrib.apidoc',
|
||||||
'sphinx.ext.todo',
|
'sphinx.ext.todo',
|
||||||
'oslo_config.sphinxext',
|
'oslo_config.sphinxext',
|
||||||
'oslo_config.sphinxconfiggen',
|
'oslo_config.sphinxconfiggen',
|
||||||
|
'oslo_policy.sphinxext',
|
||||||
|
'oslo_policy.sphinxpolicygen',
|
||||||
'openstackdocstheme',]
|
'openstackdocstheme',]
|
||||||
|
|
||||||
try:
|
try:
|
||||||
|
@ -290,3 +292,8 @@ config_generator_config_file = [
|
||||||
_get_config_generator_config_definition(conf)
|
_get_config_generator_config_definition(conf)
|
||||||
for conf in _config_generator_config_files
|
for conf in _config_generator_config_files
|
||||||
]
|
]
|
||||||
|
|
||||||
|
# -- Options for oslo_policy.sphinxpolicygen ---------------------------------
|
||||||
|
|
||||||
|
policy_generator_config_file = '../../etc/oslo-policy-generator/policy.conf'
|
||||||
|
sample_policy_basename = '_static/neutron-fwaas'
|
||||||
|
|
|
@ -1,32 +1,41 @@
|
||||||
.. _configuring:
|
.. _configuring:
|
||||||
|
|
||||||
=============================
|
=================================
|
||||||
Neutron Configuration Options
|
Neutron FWaaS Configuration Guide
|
||||||
=============================
|
=================================
|
||||||
|
|
||||||
This section provides a list of all possible options for each
|
This section provides a list of all possible options for each
|
||||||
configuration file.
|
configuration file.
|
||||||
|
|
||||||
Configuration Reference
|
Configuration
|
||||||
-----------------------
|
-------------
|
||||||
|
|
||||||
Neutron uses the following configuration files for its various services.
|
Neutron FWaaS uses the following configuration files for its various services.
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:glob:
|
|
||||||
:maxdepth: 1
|
:maxdepth: 1
|
||||||
|
|
||||||
*
|
neutron_fwaas
|
||||||
|
fwaas_driver
|
||||||
|
|
||||||
Sample Configuration Files
|
The following are sample configuration files for Neutron FWaaS and utilities.
|
||||||
--------------------------
|
These are generated from code and reflect the current state of code
|
||||||
|
in the neutron-fwaas repository.
|
||||||
The following are sample configuration files for all Neutron services and
|
|
||||||
utilities. These are generated from code and reflect the current state of code
|
|
||||||
in the Neutron repository.
|
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:glob:
|
:glob:
|
||||||
:maxdepth: 1
|
:maxdepth: 1
|
||||||
|
|
||||||
samples/*
|
samples/*
|
||||||
|
|
||||||
|
Policy
|
||||||
|
------
|
||||||
|
|
||||||
|
Neutron FWaaS, like most OpenStack projects, uses a policy language to restrict
|
||||||
|
permissions on REST API actions.
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 1
|
||||||
|
|
||||||
|
Policy Reference <policy>
|
||||||
|
Sample Policy File <policy-sample>
|
||||||
|
|
|
@ -0,0 +1,16 @@
|
||||||
|
================================
|
||||||
|
Sample Neutron FWaaS Policy File
|
||||||
|
================================
|
||||||
|
|
||||||
|
The following is a sample neutron-fwaas policy file for adaptation and use.
|
||||||
|
|
||||||
|
The sample policy can also be viewed in :download:`file form
|
||||||
|
</_static/neutron-fwaas.policy.yaml.sample>`.
|
||||||
|
|
||||||
|
.. important::
|
||||||
|
|
||||||
|
The sample policy file is auto-generated from neutron-fwaas when this
|
||||||
|
documentation is built. You must ensure your version of neutron-fwaas
|
||||||
|
matches the version of this documentation.
|
||||||
|
|
||||||
|
.. literalinclude:: /_static/neutron-fwaas.policy.yaml.sample
|
|
@ -0,0 +1,9 @@
|
||||||
|
======================
|
||||||
|
neutron-fwaas policies
|
||||||
|
======================
|
||||||
|
|
||||||
|
The following is an overview of all available policies in neutron-fwaas.
|
||||||
|
For a sample configuration file, refer to :doc:`/configuration/policy-sample`.
|
||||||
|
|
||||||
|
.. show-policy::
|
||||||
|
:config-file: etc/oslo-policy-generator/policy.conf
|
Loading…
Reference in New Issue