5120d0e05e952066bc132bc634da7084dece0876
[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 ###Start the second Domino Client:
17     ./DominoClient.py -p 9092
18
19 ##CLI at the Domino Client:
20
21 ###send heartbeat
22     heartbeat
23
24 ###subscribe for policy labels
25     subscribe -l/--label <policytype>:properties:key:value
26     
27 Example:
28 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:
29
30     subscribe --label tosca.policies.Placement.Geolocation:properties:region:us-west-1
31  
32 ###publish default template file under tosca-templates
33     publish --tosca-file <path_to_toscafile>
34
35 Example:
36 Run the following command from any Domino Client:
37
38     publish --tosca-file ./tosca-templates/tosca_helloworld_nfv.yaml
39
40 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)
41
42 ##NOTES
43   If accidentally you start DominoClient before DominoServer, don't panic. First start the DominoServer and then input the command on the DominoClient side:
44
45     register