From 87f5f39c519863dcca4951a06b317e50dc0bbcd1 Mon Sep 17 00:00:00 2001 From: Steve Martinelli Date: Sat, 7 Mar 2015 14:19:33 -0500 Subject: Add a section for audit maps the docs had no reference to the audit mapping files that pycadf provides. Change-Id: I18aeac07735211acb3dcf0044321b9a6cb9c1040 --- doc/source/audit_maps.rst | 42 ++++++++++++++++++++++++++++++++++++++++++ doc/source/index.rst | 1 + 2 files changed, 43 insertions(+) create mode 100644 doc/source/audit_maps.rst (limited to 'doc') diff --git a/doc/source/audit_maps.rst b/doc/source/audit_maps.rst new file mode 100644 index 0000000..e567a4e --- /dev/null +++ b/doc/source/audit_maps.rst @@ -0,0 +1,42 @@ +.. + Copyright 2014 IBM Corp. + + Licensed under the Apache License, Version 2.0 (the "License"); you may + not use this file except in compliance with the License. You may obtain + a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, WITHOUT + WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the + License for the specific language governing permissions and limitations + under the License. + +.. _audit_maps: + +============ + Audit maps +============ + +The pyCADF library maintains a set of audit mapping files for OpenStack +services. Currently, pyCADF supplies the following audit mapping files: + +* `cinder_api_audit_map.conf`_ +* `glance_api_audit_map.conf`_ +* `neutron_api_audit_map.conf`_ +* `nova_api_audit_map.conf`_ +* `trove_api_audit_map.conf`_ + +These files are hosted under the `etc/pycadf`_ directory of pyCADF. For more +information on how to use these mapping files, refer to the `Audit middleware`_ +section of the `keystonemiddleware`_ project. + +.. _Audit middleware: http://docs.openstack.org/developer/keystonemiddleware/audit.html +.. _keystonemiddleware: http://docs.openstack.org/developer/keystonemiddleware +.. _`etc/pycadf`: https://github.com/openstack/pycadf/tree/master/etc/pycadf +.. _`cinder_api_audit_map.conf`: https://github.com/openstack/pycadf/blob/master/etc/pycadf/cinder_api_audit_map.conf +.. _`glance_api_audit_map.conf`: https://github.com/openstack/pycadf/blob/master/etc/pycadf/glance_api_audit_map.conf +.. _`neutron_api_audit_map.conf`: https://github.com/openstack/pycadf/blob/master/etc/pycadf/neutron_api_audit_map.conf +.. _`nova_api_audit_map.conf`: https://github.com/openstack/pycadf/blob/master/etc/pycadf/nova_api_audit_map.conf +.. _`trove_api_audit_map.conf`: https://github.com/openstack/pycadf/blob/master/etc/pycadf/trove_api_audit_map.conf diff --git a/doc/source/index.rst b/doc/source/index.rst index d27630b..3a2ec6a 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -42,6 +42,7 @@ Getting Started event_concept specification/index middleware + audit_maps Contributing ============ -- cgit v1.2.1