Update documentation for Colorado Release
[domino.git] / README.md
1 # Domino
2
3 ##Quick Start on the same machine:
4
5 Tested on Ubuntu 14.04 and OS X El Capitan
6
7 ###Prerequisite:
8     sudo pip install tosca-parser
9
10 ###Start Domino Server:
11     ./DominoServer.py --log=DEBUG
12
13 ###Start the first Domino Client:
14     ./DominoClient.py -p 9091 --log=DEBUG
15
16 Note: if --log option is ommitted, the default logging level is Warning messages
17
18 ###Start the second Domino Client:
19     ./DominoClient.py -p 9092 --log=DEBUG
20
21 ##CLI at the Domino Client:
22
23 ###send heartbeat
24     heartbeat
25
26 ###subscribe for policy labels
27     subscribe -l/--label <policytype>:properties:key:value
28     
29 Example:
30 First checkout the tosca file "./tosca-templates/tosca_helloworld_nfv.yaml" and see how policy types and rules are defined. Then, from any Domino Client, use subscribe command as:
31
32     subscribe --label tosca.policies.Placement.Geolocation:properties:region:us-west-1
33  
34 ###publish default template file under tosca-templates
35     publish --tosca-file <path_to_toscafile>
36
37 Example:
38 Run the following command from any Domino Client:
39
40     publish --tosca-file ./tosca-templates/tosca_helloworld_nfv.yaml
41
42 Now, inspect the files generated under ./toscafiles, where the original file as well as parts sent to each Domino Client are shown (each part identified by UDID assigned to that client)
43
44 ##NOTES
45   If accidentally you start DominoClient before DominoServer, don't panic. First start the DominoServer and then input the command on the DominoClient side:
46
47     register