OLD | NEW |
---|---|
(Empty) | |
1 # Appengine Frontend for Clovis | |
2 | |
3 [TOC] | |
4 | |
5 ## Usage | |
6 | |
7 Visit the application URL in your browser, and upload a JSON dictionary with the | |
8 following keys: | |
9 | |
10 - `action` (string): the action to perform. Only `trace` is supported. | |
11 - `params` (dictionary): the parameters associated to the action. See below | |
12 for more details. | |
13 - `taskqueue_tag` (string, optional): the [TaskQueue][2] tag internally used | |
14 to send the work from AppEngine to ComputeEngine. If this parameter is not | |
15 specified, a unique tag will be created. | |
16 | |
17 ### Parameters for the `trace` action. | |
18 | |
19 - `urls` (list of strings): the list of URLs to process. | |
20 - `repeat_count` (integer, optional): the number of traces to be generated | |
21 for each URL. Defaults to 1. | |
22 - `emulate_device` (string, optional): the device to emulate (e.g. `Nexus 4`). | |
23 - `emulate_network` (string, optional): the network to emulate. | |
24 | |
25 ## Development | |
26 | |
27 ### Prerequisites | |
28 | |
29 - Install the gcloud [tool][1] | |
30 | |
31 - Add a `queue.yaml` file defining a `clovis-queue` pull queue that can be | |
blundell
2016/04/19 11:05:25
Where should this be added?
droger
2016/04/19 11:38:29
Added some more comments.
| |
32 accessed by the ComputeEngine service worker associated to the project. | |
33 Example: | |
34 | |
35 ``` | |
36 # queue.yaml | |
blundell
2016/04/19 11:05:25
What exactly does this do?
droger
2016/04/19 11:38:29
Added some more comments.
| |
37 - name: clovis-queue | |
38 mode: pull | |
39 acl: | |
40 - user_email: me@address.com | |
41 - user_email: 123456789-compute@developer.gserviceaccount.com | |
42 ``` | |
43 | |
44 ### Run Locally | |
45 | |
46 ```shell | |
47 # Install dependencies in the lib/ directory. | |
blundell
2016/04/19 11:05:25
Will this pollute the local Chromium checkout?
droger
2016/04/19 11:38:29
Yes. In particular this will make `git cl upload`
| |
48 pip install -r requirements.txt -t lib | |
49 # Start the local server. | |
50 dev_appserver.py . | |
51 ``` | |
52 | |
53 Visit the application [http://localhost:8080](http://localhost:8080). | |
54 | |
55 ### Deploy | |
blundell
2016/04/19 11:05:25
Add a section documenting the high-level organizat
droger
2016/04/19 11:38:29
Done.
| |
56 | |
57 ````shell | |
58 # Install dependencies in the lib/ directory. | |
59 pip install -r requirements.txt -t lib | |
60 # Deploy. | |
61 gcloud preview app deploy app.yaml | |
62 ``` | |
63 | |
64 [1]: https://cloud.google.com/sdk | |
65 [2]: https://cloud.google.com/appengine/docs/python/taskqueue | |
OLD | NEW |