aboutsummaryrefslogtreecommitdiffstats
path: root/keystone-moon/doc/source/event_notifications.rst
diff options
context:
space:
mode:
Diffstat (limited to 'keystone-moon/doc/source/event_notifications.rst')
-rw-r--r--keystone-moon/doc/source/event_notifications.rst27
1 files changed, 25 insertions, 2 deletions
diff --git a/keystone-moon/doc/source/event_notifications.rst b/keystone-moon/doc/source/event_notifications.rst
index 740986b1..d9225c56 100644
--- a/keystone-moon/doc/source/event_notifications.rst
+++ b/keystone-moon/doc/source/event_notifications.rst
@@ -28,7 +28,7 @@ The supported operations between the two types of notification formats are
documented below.
Common Notification Structure
-==============================
+=============================
Notifications generated by Keystone are generated in JSON format. An external
application can format them into ATOM format and publish them as a feed.
@@ -365,7 +365,7 @@ the unique identifier of the resource type.
.. code-block:: javascript
{
- "event_type": "identity.created.role_assignment",
+ "event_type": "identity.role_assignment.created",
"message_id": "a5901371-d5fd-b3bb-448f-a14dead6f4cb",
"payload": {
"typeURI": "http://schemas.dmtf.org/cloud/audit/1.0/event",
@@ -414,3 +414,26 @@ ensures this has an immediate impact on the accessibility of the project's
resources by revoking tokens with authorization on the project, but should
**not** have a direct impact on the projects resources (in other words, virtual
machines should **not** be deleted).
+
+Opting out of certain notifications
+===================================
+
+There are many notifications that Keystone emits and some deployers may only
+care about certain events. In Keystone there is a way to opt-out of certain
+notifications. In ``/etc/keystone/keystone.conf`` you can set ``opt_out`` to
+the event you wish to opt-out of. It is possible to opt-out of multiple events.
+
+Example:
+
+.. code-block:: ini
+
+ [DEFAULT]
+ notification_opt_out = identity.user.created
+ notification_opt_out = identity.role_assignment.created
+ notification_opt_out = identity.authenticate.pending
+
+This will opt-out notifications for user creation, role assignment creation and
+successful authentications. For a list of event types that can be used, refer
+to: `Telemetry Measurements`_.
+
+.. _Telemetry Measurements: http://docs.openstack.org/admin-guide-cloud/telemetry-measurements.html#openstack-identity