Red Hat Bugzilla – Bug 1296199
[DOCS] Improve information on Events
Last modified: 2016-09-07 16:07:08 EDT
Document URL: https://docs.openshift.com/enterprise/3.1/dev_guide/events.html Section Number and Name: Events Describe the issue: There is NO information on what events are tracked, or what "actions" are recorded as events. Suggestions for improvement: Provide information on what actions are tracked, and what events are recorded. How can a user / admin trigger an event and then view it with the oc get events command. Additional information:
Doc plan: Add a section "Comprehensive List of Events" to the dev guide "Events" chapter, with a series of tables describing the events, one per API object type. This section is reference material and covers all the events (hence "Comprehensive" in the name). Maintenance implication: This table MUST be updated: - when an API object changes its set of associated events - when an API object that has associated events is added/deleted Paul, could you please point me to specific source code or other resources (in repo ‘openshift/origin’) that i can read to get started piecing together these tables? I am looking to answer the questions: - Which API objects have associated events? - For each event, what is its Name and Description?
discussed in IRC. I think the best way to get all of these events is looking for usages of the event recorder.
The event recorders in question use interface: https://github.com/pweil-/kubernetes/blob/5f9ee58de071515a4c8b439c9ccd048dfd728c85/pkg/client/record/event.go#L54-54
PR: https://github.com/openshift/openshift-docs/pull/2235 Moving status to MODIFIED as the PR is WIP.
Work is continued in https://github.com/openshift/openshift-docs/pull/2756
PR LGTM, will mark verify after the pr merged, thanks.
Commits pushed to master at https://github.com/openshift/openshift-docs https://github.com/openshift/openshift-docs/commit/fa0f675d2d5e71788d118777ddc08d62fa45b0bd Bug 1296199, added Comprehensive List of Events https://github.com/openshift/openshift-docs/commit/072bbea77824be70f1b55204277c4dc7a7f52219 Merge pull request #2756 from ahardin-rh/tnguyen-rh-PR2235 Bug 1296199, added comprehensive list of events
Content is now published: https://access.redhat.com/documentation/en/openshift-enterprise/3.2/single/developer-guide/#events-reference