From b49bcd3d3d2454a9a3bd05e2ce58140fbed76be9 Mon Sep 17 00:00:00 2001 From: Ulas Kozat Date: Wed, 29 Mar 2017 14:13:53 -0700 Subject: JIRA DOMINO-23: Documentation update Change-Id: Iec15412cc4cda3de87c80f1319b922a8a436d56e Signed-off-by: Ulas Kozat --- docs/development/overview/feature.overview.rst | 1 + docs/development/overview/index.rst | 1 + docs/release/configguide/featureconfig.rst | 1 + docs/release/configguide/index.rst | 1 + docs/release/index.rst | 2 +- docs/release/installation/index.rst | 1 + .../installation/installation.instructions.rst | 3 +- docs/release/userguide/feature.userguide.rst | 1 + docs/release/userguide/index.rst | 1 + tests/run_on_remotenodes.sh | 168 +++++++++++++++++++++ 10 files changed, 178 insertions(+), 2 deletions(-) create mode 100755 tests/run_on_remotenodes.sh diff --git a/docs/development/overview/feature.overview.rst b/docs/development/overview/feature.overview.rst index 4ef8d16..7980459 100644 --- a/docs/development/overview/feature.overview.rst +++ b/docs/development/overview/feature.overview.rst @@ -1,5 +1,6 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. http://creativecommons.org/licenses/by/4.0 +.. (c) 2017 OPNFV ================== Domino Description diff --git a/docs/development/overview/index.rst b/docs/development/overview/index.rst index aeb8ed6..6790b6c 100644 --- a/docs/development/overview/index.rst +++ b/docs/development/overview/index.rst @@ -1,5 +1,6 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. http://creativecommons.org/licenses/by/4.0 +.. (c) 2017 OPNFV .. _domino-overview: diff --git a/docs/release/configguide/featureconfig.rst b/docs/release/configguide/featureconfig.rst index acbe6ba..6d2056c 100644 --- a/docs/release/configguide/featureconfig.rst +++ b/docs/release/configguide/featureconfig.rst @@ -1,5 +1,6 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. http://creativecommons.org/licenses/by/4.0 +.. (c) 2017 OPNFV Domino Configuration ==================== diff --git a/docs/release/configguide/index.rst b/docs/release/configguide/index.rst index 9cc5c6c..11ae47f 100644 --- a/docs/release/configguide/index.rst +++ b/docs/release/configguide/index.rst @@ -1,5 +1,6 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. http://creativecommons.org/licenses/by/4.0 +.. (c) 2017 OPNFV .. _domino-configguide: diff --git a/docs/release/index.rst b/docs/release/index.rst index c0b1b56..eb21134 100644 --- a/docs/release/index.rst +++ b/docs/release/index.rst @@ -1,6 +1,6 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. http://creativecommons.org/licenses/by/4.0 -.. (c) 2017 OPNFV. +.. (c) 2017 OPNFV ====== diff --git a/docs/release/installation/index.rst b/docs/release/installation/index.rst index 72b2d51..99da004 100644 --- a/docs/release/installation/index.rst +++ b/docs/release/installation/index.rst @@ -1,5 +1,6 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. http://creativecommons.org/licenses/by/4.0 +.. (c) 2017 OPNFV .. _domino-installation: diff --git a/docs/release/installation/installation.instructions.rst b/docs/release/installation/installation.instructions.rst index 4e18491..f008954 100644 --- a/docs/release/installation/installation.instructions.rst +++ b/docs/release/installation/installation.instructions.rst @@ -1,5 +1,6 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. http://creativecommons.org/licenses/by/4.0 +.. (c) 2017 OPNFV =================== Domino Installation @@ -44,7 +45,7 @@ Installation Steps (Multiple Node) ---------------------------------- Repeat the installation steps for single node on each node. The script -run_multinode.sh under ./domino/tests directory deploys the Domino Code on three +run_on_remotenodes.sh under ./domino/tests directory deploys the Domino Code on three hosts from a deployment node and tests RPC calls. The private key location and remote host IP addresses must be manually entered and IS_IPandKEY_CONFIGURED=false must be changed to IS_IPandKEY_CONFIGURED=true. diff --git a/docs/release/userguide/feature.userguide.rst b/docs/release/userguide/feature.userguide.rst index 6187a22..8705a77 100644 --- a/docs/release/userguide/feature.userguide.rst +++ b/docs/release/userguide/feature.userguide.rst @@ -1,5 +1,6 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. http://creativecommons.org/licenses/by/4.0 +.. (c) 2017 OPNFV ======================================== Domino API Usage Guidelines and Examples diff --git a/docs/release/userguide/index.rst b/docs/release/userguide/index.rst index a37fc09..7372cb3 100644 --- a/docs/release/userguide/index.rst +++ b/docs/release/userguide/index.rst @@ -1,5 +1,6 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. http://creativecommons.org/licenses/by/4.0 +.. (c) 2017 OPNFV .. _domino-userguide: diff --git a/tests/run_on_remotenodes.sh b/tests/run_on_remotenodes.sh new file mode 100755 index 0000000..f60f469 --- /dev/null +++ b/tests/run_on_remotenodes.sh @@ -0,0 +1,168 @@ +#!/bin/bash -ex + +#Copyright 2016 Open Platform for NFV Project, Inc. and its contributors +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# http://www.apache.org/licenses/LICENSE-2.0 +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +IS_IPandKEY_CONFIGURED=true +USERNAME=ubuntu +#SSH_KEY_PATH=/home/opnfv/repos/domino/tests/testkeys/id_rsa +#DOMINO_CODE_PATH=/home/opnfv/repos/domino +SSH_KEY_PATH=./tests/testkeys/id_rsa +DOMINO_CODE_PATH=../domino +CONTROLLER_NODE_1=192.168.2.165 +CONTROLLER_NODE_2=192.168.2.180 +CONTROLLER_NODE_3=192.168.2.181 + +CLIENT1_PORT=9091 +CLIENT2_PORT=9092 +CLIENT1_CLIPORT=9100 +CLIENT2_CLIPORT=9200 +LOGLEVEL=DEBUG + +toscafile_test1=./tosca-templates/tosca_helloworld_nfv.yaml +test1_reffile1=./tests/refdata/test1_client1.ref +test1_reffile2=./tests/refdata/test1_client2.ref +client1_log=./tests/logdata/client1.log +client2_log=./tests/logdata/client2.log +server_log=./tests/logdata/server.log +ssh_opts="-o UserKnownHostsFile=/dev/null -o StrictHostKeyChecking=no" + +install_dependency() { + ssh $ssh_opts -i "$SSH_KEY_PATH" "$USERNAME"@"$CONTROLLER_NODE_1" 'sudo pip install tosca-parser' + ssh $ssh_opts -i "$SSH_KEY_PATH" "$USERNAME"@"$CONTROLLER_NODE_1" 'sudo pip install heat-translator' + ssh $ssh_opts -i "$SSH_KEY_PATH" "$USERNAME"@"$CONTROLLER_NODE_2" 'sudo pip install tosca-parser' + ssh $ssh_opts -i "$SSH_KEY_PATH" "$USERNAME"@"$CONTROLLER_NODE_2" 'sudo pip install heat-translator' + ssh $ssh_opts -i "$SSH_KEY_PATH" "$USERNAME"@"$CONTROLLER_NODE_3" 'sudo pip install tosca-parser' + ssh $ssh_opts -i "$SSH_KEY_PATH" "$USERNAME"@"$CONTROLLER_NODE_3" 'sudo pip install heat-translator' +} + +remove_codes(){ + ssh $ssh_opts -i "$SSH_KEY_PATH" "$USERNAME"@"$CONTROLLER_NODE_1" 'rm -rf domino' + ssh $ssh_opts -i "$SSH_KEY_PATH" "$USERNAME"@"$CONTROLLER_NODE_2" 'rm -rf domino' + ssh $ssh_opts -i "$SSH_KEY_PATH" "$USERNAME"@"$CONTROLLER_NODE_3" 'rm -rf domino' +} + +deploy_codes(){ + scp $ssh_opts -i "$SSH_KEY_PATH" -r "$DOMINO_CODE_PATH" "$USERNAME"@"$CONTROLLER_NODE_1":. + scp $ssh_opts -i "$SSH_KEY_PATH" -r "$DOMINO_CODE_PATH" "$USERNAME"@"$CONTROLLER_NODE_2":. + scp $ssh_opts -i "$SSH_KEY_PATH" -r "$DOMINO_CODE_PATH" "$USERNAME"@"$CONTROLLER_NODE_3":. +} + +start_server() { + ssh $ssh_opts -i "$SSH_KEY_PATH" "$USERNAME"@"$CONTROLLER_NODE_1" 'pgrep -f "python DominoServer.py"' && return 0 + ssh $ssh_opts -f -i "$SSH_KEY_PATH" "$USERNAME"@"$CONTROLLER_NODE_1" "sh -c 'cd ./domino; nohup python DominoServer.py --log "$LOGLEVEL" > "$server_log" > /dev/null 2>&1 &'" +} + +start_client1() { + ssh $ssh_opts -i "$SSH_KEY_PATH" "$USERNAME"@"$CONTROLLER_NODE_2" 'pgrep -f "python DominoClient.py"' && return 0 + ssh $ssh_opts -f -i "$SSH_KEY_PATH" "$USERNAME"@"$CONTROLLER_NODE_2" "sh -c 'cd ./domino; nohup python DominoClient.py -p $CLIENT1_PORT --cliport $CLIENT1_CLIPORT --ipaddr $CONTROLLER_NODE_1 --log "$LOGLEVEL" > "$client1_log" > /dev/null 2>&1 &'" +} + +start_client2() { + ssh $ssh_opts -i "$SSH_KEY_PATH" "$USERNAME"@"$CONTROLLER_NODE_3" 'pgrep -f "python DominoClient.py"' && return 0 + ssh $ssh_opts -f -i "$SSH_KEY_PATH" "$USERNAME"@"$CONTROLLER_NODE_3" "sh -c 'cd ./domino; nohup python DominoClient.py -p $CLIENT2_PORT --cliport $CLIENT2_CLIPORT --ipaddr $CONTROLLER_NODE_1 --log "$LOGLEVEL" > "$client2_log" > /dev/null 2>&1 &'" +} + +stop_server() { + ssh $ssh_opts -i "$SSH_KEY_PATH" "$USERNAME"@"$CONTROLLER_NODE_1" 'pgrep -f "python DominoServer.py"' || return 0 + ssh $ssh_opts -i "$SSH_KEY_PATH" "$USERNAME"@"$CONTROLLER_NODE_1" 'kill $(pgrep -f "python DominoServer.py")' +} + +stop_client1() { + ssh $ssh_opts -i "$SSH_KEY_PATH" "$USERNAME"@"$CONTROLLER_NODE_2" 'pgrep -f "python DominoClient.py"' || return 0 + ssh $ssh_opts -i "$SSH_KEY_PATH" "$USERNAME"@"$CONTROLLER_NODE_2" 'kill $(pgrep -f "python DominoClient.py")' +} + +stop_client2() { + ssh $ssh_opts -i "$SSH_KEY_PATH" "$USERNAME"@"$CONTROLLER_NODE_3" 'pgrep -f "python DominoClient.py"' || return 0 + ssh $ssh_opts -i "$SSH_KEY_PATH" "$USERNAME"@"$CONTROLLER_NODE_3" 'kill $(pgrep -f "python DominoClient.py")' +} + +cleanup() { + chmod 600 "$SSH_KEY_PATH" + set +e + echo "cleanup..." + + echo "Stopping Domino Clients..." + stop_client1 + sleep 1 + stop_client2 + sleep 1 + + echo "Stopping Domino Server..." + stop_server + sleep 1 +} + +prepare_testenv() { + chmod 600 "$SSH_KEY_PATH" + install_dependency + remove_codes + deploy_codes +} + +launch_domino() { + echo "Launching Domino Server..." + start_server + sleep 1 + echo "Launching Domino Client 1..." + start_client1 + sleep 1 + echo "Launching Domino Client 2..." + start_client2 + sleep 1 +} + +echo "domino/tests/run_multinode.sh has been executed." + +if [ "$IS_IPandKEY_CONFIGURED" = "true" ]; then + trap cleanup EXIT + + cleanup + prepare_testenv + launch_domino + + + echo "Test Heartbeat" + ssh $ssh_opts -i "$SSH_KEY_PATH" "$USERNAME"@"$CONTROLLER_NODE_2" "sh -c 'cd domino; python domino-cli.py $CLIENT1_CLIPORT heartbeat'" + sleep 1 + + echo "Test Subscribe API" + ssh $ssh_opts -i "$SSH_KEY_PATH" "$USERNAME"@"$CONTROLLER_NODE_2" "sh -c 'cd domino; python domino-cli.py $CLIENT1_CLIPORT subscribe -t hot -l tosca.policies.Placement:properties:region:nova-1'" + sleep 1 + ssh $ssh_opts -i "$SSH_KEY_PATH" "$USERNAME"@"$CONTROLLER_NODE_2" "sh -c 'cd domino; python domino-cli.py $CLIENT1_CLIPORT subscribe -t dummy1,dummy2 --top OVERWRITE'" + sleep 1 + ssh $ssh_opts -i "$SSH_KEY_PATH" "$USERNAME"@"$CONTROLLER_NODE_2" "sh -c 'cd domino; python domino-cli.py $CLIENT1_CLIPORT subscribe -t dummy1,dummy2 --top DELETE'" + sleep 1 + ssh $ssh_opts -i "$SSH_KEY_PATH" "$USERNAME"@"$CONTROLLER_NODE_2" "sh -c 'cd domino; python domino-cli.py $CLIENT1_CLIPORT subscribe -l tosca.policies.Placement:properties:region:nova-2'" + sleep 1 + ssh $ssh_opts -i "$SSH_KEY_PATH" "$USERNAME"@"$CONTROLLER_NODE_2" "sh -c 'cd domino; python domino-cli.py $CLIENT1_CLIPORT subscribe -l tosca.policies.Placement:properties:region:nova-3 --lop OVERWRITE'" + sleep 1 + ssh $ssh_opts -i "$SSH_KEY_PATH" "$USERNAME"@"$CONTROLLER_NODE_2" "sh -c 'cd domino; python domino-cli.py $CLIENT1_CLIPORT subscribe -l tosca.policies.Placement:properties:region:nova-3 --lop DELETE'" + sleep 1 + + echo "Test Publish API" + ssh $ssh_opts -i "$SSH_KEY_PATH" "$USERNAME"@"$CONTROLLER_NODE_3" "sh -c 'cd domino; python domino-cli.py $CLIENT2_CLIPORT publish -t "$toscafile_test1"'" + + sleep 1 + ssh $ssh_opts -i "$SSH_KEY_PATH" "$USERNAME"@"$CONTROLLER_NODE_2" "sh -c 'cd domino; python domino-cli.py $CLIENT1_CLIPORT subscribe -l tosca.policies.Placement.Geolocation:properties:region:us-west-1'" + sleep 1 + ssh $ssh_opts -i "$SSH_KEY_PATH" "$USERNAME"@"$CONTROLLER_NODE_3" "sh -c 'cd domino; python domino-cli.py $CLIENT2_CLIPORT publish -t "$toscafile_test1"'" + + echo "done" + +else + + echo "set IS_IPandKEY_CONFIGURED as true to run the test" + +fi + + -- cgit 1.2.3-korg