← Back to branch summary

~psivaa/ubuntu-ci-services-itself/speedup-imagebuild-tr

« back to all changes in this revision

Viewing changes to docs/components/image-builder.rst

  • Committer: Chris Johnston
  • Author(s): Andy Doan
  • Date: 2014-03-11 19:25:30 UTC
  • mfrom: (341.1.5 cancel-url)
  • Revision ID: chris_johnston-20140311192530-czr8bc86hyk9wenj
[r=PS Jenkins bot, Evan Dandrea, Vincent Ladeuil] lander: pass a "cancel_url" to the workers

This passes a new "cancel_url" down to each worker. Currently,
the URL is a link to the jenkins JSON API for the job. Which
includes a "building" attribute so a worker could determine if
a job has been cancelled or not.

In the future this URL could be to the ticket (or maybe not needed
at all).

NOTE: The workers do nothing with this parameter. Its just adding
the hook for them to do so if they choose.  from Andy Doan

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/components/image-builder.rst
49
49
 
50
50
    * Ticket ID from the ticket system
51
51
 
 
52
  * cancel_url(can be null): a link to json url return {'building': true|false}
 
53
 
52
54
  * base_image : {"image_type": IMAGE_TYPE, "url_list": [...], "series": SERIES}
53
55
 
54
56
    * A json object containing the image_type (cloud for now), list of
55
57
      URLs pointing to the image artifact(s), and the Ubuntu series
56
58
      name.
57
 
      
 
59
 
58
60
  * ppa_list : [...]
59
 
    
 
61
 
60
62
    * A list of PPAs to add to the image.
61
 
      
 
63
 
62
64
  * package_list : [...]
63
 
    
 
65
 
64
66
    * A list of additional packages to install in the image.
65
 
      
 
67
 
66
68
  * progress_trigger : STRING
67
 
    
 
69
 
68
70
    * The amqp exchange to use for sending progress events.
69
71
 
70
72
*Example* ::
71
73
 
72
 
   curl --dump-header - -H "Content-Type: application/json" -X POST --data '{"base_image": {"image_type": "cloud", "url_list": ["http://cloud-images.ubuntu.com/trusty/current/trusty-server-cloudimg-amd64-disk1.img"], "series": "trusty"}, "ppa_list": ["ppa:project/ppaname"], "package_list": ["libfoo", "baz-utils"], "progress_trigger": "testbuild-1-imagebuilder", "ticket_id": "1"}' http://localhost:8000/api/v1/build_image/
 
74
   curl --dump-header - -H "Content-Type: application/json" -X POST --data '{"base_image": {"image_type": "cloud", "url_list": ["http://cloud-images.ubuntu.com/trusty/current/trusty-server-cloudimg-amd64-disk1.img"], "series": "trusty"}, "ppa_list": ["ppa:project/ppaname"], "package_list": ["libfoo", "baz-utils"], "progress_trigger": "testbuild-1-imagebuilder", "ticket_id": "1", "cancel_url": null}' http://localhost:8000/api/v1/build_image/
73
75
 
74
76
Development Plan
75
77
----------------