← Back to branch summary

~smoser/curtin/yakkety.lp1666986

« back to all changes in this revision

Viewing changes to doc/topics/reporting.rst

  • Committer: Ryan Harper
  • Date: 2016-09-29 18:31:02 UTC
  • mto: (58.1.1 pkg)
  • mto: This revision was merged to the branch mainline in revision 59.
  • Revision ID: ryan.harper@canonical.com-20160929183102-qwcn73t5h6o0ag3k
Tags: upstream-0.1.0~bzr425
Import upstream version 0.1.0~bzr425

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/topics/reporting.rst
7
7
 
8
8
Events
9
9
------
10
 
Reporting consists of notifcation of a series of 'events.  Each event has:
 
10
Reporting consists of notification of a series of 'events.  Each event has:
11
11
 - **event_type**: 'start' or 'finish'
12
12
 - **description**: human readable text
13
13
 - **name**: and id for this event
48
48
Each entry must have a 'type'.  The currently supported values are:
49
49
 - **log**: logs via python logger
50
50
 - **print**: prints messages to stdout (for debugging)
51
 
 - **webhook**: posts json formated data to a remote url.  Supports Oauth.
 
51
 - **webhook**: posts json formatted data to a remote url.  Supports Oauth.
52
52
 
53
53
 
54
54
Additionally, the webhook reporter will post files on finish of curtin.  The user can declare which files should be posted in the ``install`` item via ``post_files`` as shown above.  If post_files is not present, it will default to the value of log_file.
154
154
Legacy Reporter
155
155
---------------
156
156
The legacy 'reporter' config entry is still supported.  This was utilized by
157
 
MAAS for start/end and posting of the install log at the end of isntallation.
 
157
MAAS for start/end and posting of the install log at the end of installation.
158
158
 
159
159
Its configuration looks like this:
160
160