summaryrefslogtreecommitdiffstats
path: root/README.md
blob: 53394613fa92f979bb976b473e949b039f2b8f0f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
# Domino

##Quick Start on the same machine:

Tested on Ubuntu 14.04 and OS X El Capitan

###Prerequisite:
    git clone https://gerrit.opnfv.org/gerrit/domino
    sudo apt-get install python-pip
    sudo pip install tosca-parser
    sudo pip install heat-translator

###Testing:    
Proceed to the domino folder and run a smoke test that checks APIs
 
    cd domino    
    ./tests/run.sh

###Common Errors
If "internal error" message is received, a python library is missing

Clean the server side database:

    rm -r dominoserver.db

Make sure that all the existing domino server and client processes are killed.

    kill $(pgrep -f "DominoServer.py")
    kill $(pgrep -f "DominoClient.py") 

###Start Domino Server:
    ./DominoServer.py --log=DEBUG

###Start the first Domino Client:
    ./DominoClient.py -p 9091 --cliport 9100 --log=DEBUG

Note: if --log option is ommitted, the default logging level is Warning messages

###Start the second Domino Client:
    ./DominoClient.py -p 9092 --cliport 9200 --log=DEBUG

##CLI at the Domino Client:

###Send heartbeat
    python domino-cli.py <cliport> heartbeat

###Subscribe for policy labels
    python domino-cli.py <cliport> subscribe -l/--label <policytype>:properties:key:value
    
Example:
First checkout the tosca file "./tosca-templates/tosca_helloworld_nfv.yaml" and see how policy types and rules are defined. Then, for the first Domino Client, use subscribe command as:

    python domino-cli.py 9100 subscribe --label tosca.policies.Placement.Geolocation:properties:region:us-west-1
 
###Publish default template file under tosca-templates
    python domino-cli.py <cliport> publish --tosca-file <path_to_toscafile>

Example:
Run the following command for the second Domino Client:

    python domino-cli.py 9200 publish --tosca-file ./tosca-templates/tosca_helloworld_nfv.yaml

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)

###Query published tosca-templates for each client
    python domino-cli.py <cliport> list-tuids

Example:
Run the following command for the second Domino Client:

    python domino-cli.py 9200 list-tuids

###Change the published template for a specific Template Unique ID (TUID)
    python domino-cli.py <cliport> publish -t ./tosca-templates/tosca_helloworld_nfv.yaml -k <TUID>

Example:
Run the following command for the second Domino Client:

    TUID=$(python domino-cli.py 9200 list-tuids | cut -c3-34)
    python domino-cli.py 9200 publish -t ./tosca-templates/tosca_helloworld_nfv.yaml -k "$TUID"

##NOTES
  If accidentally you start DominoClient before DominoServer, don't panic. First start the DominoServer and then input the command on the DominoClient side:

    register