Ubuntu CI Engine

Merge lp://staging/~canonical-ci-engineering/uci-engine/doc-msging into lp://staging/uci-engine

  1. doc-msging
  2. Merge into trunk
Proposed by Francis Ginther
Status: Needs review
Proposed branch: lp://staging/~canonical-ci-engineering/uci-engine/doc-msging
Merge into: lp://staging/uci-engine
Diff against target: 293 lines (+251/-1)
4 files modified
docs/conf.py (+2/-1)
docs/index.rst (+2/-0)
docs/messaging.rst (+34/-0)
docs/snappy.rst (+213/-0)
To merge this branch: bzr merge lp://staging/~canonical-ci-engineering/uci-engine/doc-msging
Reviewer Review Type Date Requested Status
Francis Ginther Needs Fixing
Paul Larson Needs Fixing
Review via email: mp+246366@code.staging.launchpad.net

Commit message

Add documentation for the snappy testing service workflow and message API.

Description of the change

A proposed solution for a multi-service workflow and message handling for the snappy image testing project.

Note:
 - This proposal requires modification to the AMQPWorker class and/or creation of a similar worker class.

To generate docs (requires graphviz package):
$ (cd docs; make html)
$ firefox docs/_build/html/messaging.html
$ firefox docs/_build/html/snappy.html

To post a comment you must log in.
Revision history for this message
Paul Larson (pwlars) wrote :

Great improvements here! a couple of comments below.

review: Needs Fixing
Reply
Revision history for this message
Vincent Ladeuil (vila) wrote :

Some answers inline while I'm preparing to push a new revision.

Reply
Revision history for this message
Ursula Junque (ursinha) wrote :

I thought we decided not to be snappy specific. So s/snappy/ubuntucore/, is there a reason to be using snappy?

Reply
Revision history for this message
Francis Ginther (fginther) wrote :

I'm working on an update to this. So as not to delay, here is the summary:

There is no need to define a workflow up front. So the snappy image watcher need not be concerned with this. Instead each service will send its output message to a default queue. For the snappy image watcher, we can begin by calling this 'snappy.images'. So the watcher would output a message on this queue that has the information on the image to test and the test branch to use (the one with the snappy dep8 tests). It may need to add other data, but we'll have to figure that out later

The snappy image watcher and every other service will be deployed to send their output messages to a default queue. However, to facilitate writing tests, the output queue can be changed by specifying a specific queue in the received message via the 'output_queue' key. This doesn't directly apply to the snappy image watcher as it has no input queue. However, it make sense to have some similar mechanism to override the output queue for writing tests (will try to put some thought into this)

review: Needs Fixing
Reply

Unmerged revisions

933. By Francis Ginther

Remove 'Workflow Definition' and replace with description using default queue names.

932. By Vincent Ladeuil

Clarify progress queue role.

931. By Vincent Ladeuil

s/test_source/test_source_branch/

930. By Vincent Ladeuil

Use the already existing uci/ namespace for glance images.

929. By Vincent Ladeuil

s/image_version/image_revision/ as it's the established word.

928. By Vincent Ladeuil

Rename image.builds queue to snappy.images.
Define snappy request.
Mention that reduced workflow can be defined.

927. By Vincent Ladeuil

Fix formatting.

926. By Francis Ginther

Add workflow definition and message examples for snappy workflow.

925. By Vincent Ladeuil

Fix typo.

924. By Vincent Ladeuil

Describes snappy components and their queues at a high level.

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
The diff is not available at this time. You can reload the page or download it.

Subscribers

People subscribed via source and target branches

to all changes: