outdated/missing notification documentation

[Levi Blackstone]

The only notification documentation I could find is very outdated. This wiki page https://wiki.openstack.org/wiki/SystemUsageData was last updated Oct. 2014, and the documentation does not match the current code base.

The Nova code at https://github.com/openstack/nova/blob/6443782510616b2ce249075b5dcf498649da2154/nova/notifications.py#L373 shows 34 notification fields, while wiki page only has about 15 documented.

I did not check notifications for other projects, but this problem is likely the same for volumes, autoscaling, etc.

The documentation should be brought up to date, and a process put in place to maintain it as changes are made to notifications.

[Lana (loquacity)]

This bug can handle bringing the existing docs up to date. A new bug should be raised for the development of a process. Thanks :)

[Sandy Walsh (sandy-walsh)]

This may help:

Here is a scrubbed list of notifications for the most common Nova operations

https://github.com/stackforge/stacktach-notigen/tree/master/templates

The notification schema effort hopes to fix this process-wise. Ideally, docs will be auto-generated from these schemas.

[Tom Fifield (fifieldt)]

Related bugs:

 https://bugs.launchpad.net/openstack-manuals?field.searchtext=notification&search=Search&field.status%3Alist=NEW&field.status%3Alist=INCOMPLETE_WITH_RESPONSE&field.status%3Alist=INCOMPLETE_WITHOUT_RESPONSE&field.status%3Alist=CONFIRMED&field.status%3Alist=TRIAGED&field.status%3Alist=INPROGRESS&field.status%3Alist=FIXCOMMITTED&field.assignee=&field.bug_reporter=&field.omit_dupes=on&field.has_patch=&field.has_no_package=

[Lana (loquacity)]

The codebase has moved on significantly, we can safely close this. Please raise a new bug for any issues you notice going forward.