"Fossies" - the Fresh Open Source Software Archive  

Source code changes of the file "doc/source/notifications.rst" between
masakari-8.0.0.tar.gz and masakari-9.0.0.tar.gz

About: OpenStack Masakari provides "Instances High Availability Service" for OpenStack clouds by automatically recovering failed Instances (currently for KVM-based Virtual Machine(VM)s).
The "Ussuri" series (latest release).

notifications.rst  (masakari-8.0.0):notifications.rst  (masakari-9.0.0)
skipping to change at line 17 skipping to change at line 17
Unless required by applicable law or agreed to in writing, software Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS, WITHOUT distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
License for the specific language governing permissions and limitations License for the specific language governing permissions and limitations
under the License. under the License.
Notifications in Masakari Notifications in Masakari
========================== ==========================
Similarly to other OpenStack services Masakari emits notifications to the messag e Similar to other OpenStack services Masakari emits notifications to the message
bus with the Notifier class provided by `oslo.messaging-doc`_. From the notifica tion bus with the Notifier class provided by `oslo.messaging-doc`_. From the notifica tion
consumer point of view a notification consists of two parts: an envelope with a fixed consumer point of view a notification consists of two parts: an envelope with a fixed
structure defined by oslo.messaging and a payload defined by the service emittin g the structure defined by oslo.messaging and a payload defined by the service emittin g the
notification. The envelope format is the following:: notification. The envelope format is the following::
{ {
"priority": <string, selected from a predefined list by the sender>, "priority": <string, selected from a predefined list by the sender>,
"event_type": <string, defined by the sender>, "event_type": <string, defined by the sender>,
"timestamp": <string, the isotime of when the notification emitted>, "timestamp": <string, the isotime of when the notification emitted>,
"publisher_id": <string, defined by the sender>, "publisher_id": <string, defined by the sender>,
skipping to change at line 97 skipping to change at line 97
"publisher_id": "masakari-api:test-virtualbox", "publisher_id": "masakari-api:test-virtualbox",
"message_id": "e6322900-025d-4dd6-a3a1-3e0e1e9badeb" "message_id": "e6322900-025d-4dd6-a3a1-3e0e1e9badeb"
} }
The serialized oslo versionedobject as a payload provides a version number to The serialized oslo versionedobject as a payload provides a version number to
the consumer so the consumer can detect if the structure of the payload is the consumer so the consumer can detect if the structure of the payload is
changed. Masakari provides the following contract regarding the versioned changed. Masakari provides the following contract regarding the versioned
notification payload: notification payload:
* the payload version defined by the ``masakari_object.version`` field of the * the payload version defined by the ``masakari_object.version`` field of the
payload will be increased if and only if the syntax or the semantics of the payload will be increased only if the syntax or the semantics of the
``masakari_object.data`` field of the payload is changed. ``masakari_object.data`` field of the payload is changed.
* a minor version bump indicates a backward compatible change which means that * a minor version bump indicates a backward compatible change which means that
only new fields are added to the payload so a well written consumer can still only new fields are added to the payload so a well written consumer can still
consume the new payload without any change. consume the new payload without any change.
* a major version bump indicates a backward incompatible change of the payload * a major version bump indicates a backward incompatible change of the payload
which can mean removed fields, type change, etc in the payload. which can mean removed fields, type change, etc in the payload.
* there is an additional field 'masakari_object.name' for every payload besides * there is an additional field 'masakari_object.name' for every payload besides
'masakari_object.data' and 'masakari_object.version'. This field contains the name of 'masakari_object.data' and 'masakari_object.version'. This field contains the name of
the Masakari internal representation of the payload type. Client code should n ot the Masakari internal representation of the payload type. Client code should n ot
depend on this name. depend on this name.
 End of changes. 2 change blocks. 
2 lines changed or deleted 2 lines changed or added

Home  |  About  |  Features  |  All  |  Newest  |  Dox  |  Diffs  |  RSS Feeds  |  Screenshots  |  Comments  |  Imprint  |  Privacy  |  HTTP(S)