bb8b4bf5a5
While we should not start using this for cloning things in the gate yet, the opendev.org links provide for a nicer browsing experience already even though the service is in beta. Go ahead and swap our browsing links. While in there, remove some masakari references to github links to the source code. Masakari now publishes api docs to developer.openstack.org so there is no need to point people to source code for api docs. Change-Id: I14afa3476f9832ef433ec744e888348fc9a359e3
2.7 KiB
Managing Receivers
Receivers are the event sinks associated to senlin clusters. When certain events (or alarms) are seen by a monitoring software, the software can notify the senlin clusters of those events (or alarms). When senlin receives those notifications, it can automatically trigger some predefined operations with preset parameter values.
List Receivers
To examine the list of receivers:
../../examples/clustering/receiver.py
When listing receivers, you can specify the sorting option using the
sort parameter and you can do pagination using the
limit and marker parameters.
Full example: manage receiver
Create Receiver
When creating a receiver, you will provide a dictionary with keys and values according to the receiver type referenced.
../../examples/clustering/receiver.py
Optionally, you can specify a metadata keyword argument
that contains some key-value pairs to be associated with the
receiver.
Full example: manage receiver
Get Receiver
To get a receiver based on its name or ID:
../../examples/clustering/receiver.py
Full example: manage receiver
Find Receiver
To find a receiver based on its name or ID:
../../examples/clustering/receiver.py
Full example: manage receiver
Update Receiver
After a receiver is created, most of its properties are immutable.
Still, you can update a receiver's name and/or
params.
../../examples/clustering/receiver.py
Full example: manage receiver
Delete Receiver
A receiver can be deleted after creation, provided that it is not referenced by any active clusters. If you attempt to delete a receiver that is still in use, you will get an error message.
../../examples/clustering/receiver.py