← Back to branch summary

~canonical-ci-engineering/core-image-watcher/trunk

« back to all changes in this revision

Viewing changes to README.rst

  • Committer: Ubuntu CI Bot
  • Author(s): Parameswaran Sivatharman
  • Date: 2015-03-27 01:33:16 UTC
  • mfrom: (4.1.12 core-image-watcher)
  • Revision ID: ubuntu_ci_bot-20150327013316-ldaukzomlp80lheu
Image watcher component to publish messages to a rabbit queue when there is a new image present in the core image server. [r=Celso Providelo, Thomi Richards]

Show diffs side-by-side

added added

removed removed

Lines of Context:
README.rst
2
2
##################
3
3
 
4
4
A micro-service that watches for new Ubuntu Core images.
 
5
 
 
6
Get the Source
 
7
==============
 
8
 
 
9
Branch the code::
 
10
 
 
11
  $ bzr branch lp:core-image-watcher
 
12
 
 
13
Install the Service
 
14
========================
 
15
 
 
16
Install system dependencies::
 
17
 
 
18
  $ sudo apt-get install python3-dev
 
19
 
 
20
Build and activate a virtualenv with python3::
 
21
 
 
22
  $ virtualenv -p python3 --system-site-packages ve
 
23
  $ . ve/bin/activate
 
24
 
 
25
Install dependencies from pypi::
 
26
 
 
27
  $ pip install -r requirements.txt
 
28
 
 
29
...and install some dependencies from phablet-tools PPA::
 
30
 
 
31
  $ sudo add-apt-repository ppa:phablet-team/tools
 
32
  $ sudo apt-get update
 
33
  $ sudo apt-get install ubuntu-device-flash
 
34
 
 
35
Install the service itself::
 
36
 
 
37
  $ python setup.py install
 
38
 
 
39
...you may want to install it in 'development mode', which symlinks files, 
 
40
so you can edit/re-run without having to re-install the service. In that 
 
41
case, run::
 
42
 
 
43
  $ python setup.py develop
 
44
 
 
45
Run the tests!
 
46
==============
 
47
 
 
48
Install dependencies::
 
49
 
 
50
  $ pip install -r test_requirements.txt
 
51
 
 
52
Run those tests - with vigour!::
 
53
 
 
54
  $ python setup.py test
 
55
 
 
56
The config file
 
57
===============
 
58
 
 
59
The sample configuration file in 'core-service.conf'::
 
60
 
 
61
   [amqp]
 
62
   uris = amqp://guest:guest@localhost:5672//
 
63
 
 
64
   [image]
 
65
   channel = devel-proposed
 
66
   device = generic_amd64
 
67
   location = /tmp/latest-core-image-version
 
68
   poll_period = 60