update README to point to rel4
[osm/devops.git] / installers / install_osm.sh
1 #!/bin/bash
2 # Copyright 2016 Telefónica Investigación y Desarrollo S.A.U.
3 #
4 # Licensed under the Apache License, Version 2.0 (the "License");
5 # you may not use this file except in compliance with the License.
6 # You may obtain a copy of the License at
7 #
8 # http://www.apache.org/licenses/LICENSE-2.0
9 #
10 # Unless required by applicable law or agreed to in writing, software
11 # distributed under the License is distributed on an "AS IS" BASIS,
12 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 # See the License for the specific language governing permissions and
14 # limitations under the License.
15
16 function usage(){
17 echo -e "usage: $0 [OPTIONS]"
18 echo -e "Install OSM from binaries or source code (by default, from binaries)"
19 echo -e " OPTIONS"
20 echo -e " --uninstall: uninstall OSM: remove the containers and delete NAT rules"
21 echo -e " --source: install OSM from source code using the latest stable tag"
22 echo -e " -r <repo>: use specified repository name for osm packages"
23 echo -e " -R <release>: use specified release for osm binaries (deb packages, lxd images, ...)"
24 echo -e " -u <repo base>: use specified repository url for osm packages"
25 echo -e " -k <repo key>: use specified repository public key url"
26 echo -e " -b <refspec>: install OSM from source code using a specific branch (master, v2.0, ...) or tag"
27 echo -e " -b master (main dev branch)"
28 echo -e " -b v2.0 (v2.0 branch)"
29 echo -e " -b tags/v1.1.0 (a specific tag)"
30 echo -e " ..."
31 echo -e " --lxdimages: download lxd images from OSM repository instead of creating them from scratch"
32 echo -e " -l <lxd_repo>: use specified repository url for lxd images"
33 echo -e " -p <path>: use specified repository path for lxd images"
34 echo -e " --vimemu: additionally fetch, build, and deploy the VIM emulator as a docker container"
35 echo -e " --develop: (deprecated, use '-b master') install OSM from source code using the master branch"
36 # echo -e " --reconfigure: reconfigure the modules (DO NOT change NAT rules)"
37 echo -e " --nat: install only NAT rules"
38 echo -e " --noconfigure: DO NOT install osmclient, DO NOT install NAT rules, DO NOT configure modules"
39 # echo -e " --update: update to the latest stable release or to the latest commit if using a specific branch"
40 echo -e " --showopts: print chosen options and exit (only for debugging)"
41 echo -e " -y: do not prompt for confirmation, assumes yes"
42 echo -e " -D <devops path> use local devops installation path"
43 echo -e " -h / --help: print this help"
44 }
45
46 #Uninstall OSM: remove containers
47 function uninstall(){
48 echo -e "\nUninstalling OSM"
49 if [ $RC_CLONE ] || [ -n "$TEST_INSTALLER" ]; then
50 $OSM_DEVOPS/jenkins/host/clean_container RO
51 $OSM_DEVOPS/jenkins/host/clean_container VCA
52 $OSM_DEVOPS/jenkins/host/clean_container MON
53 $OSM_DEVOPS/jenkins/host/clean_container SO
54 #$OSM_DEVOPS/jenkins/host/clean_container UI
55 else
56 lxc stop RO && lxc delete RO
57 lxc stop VCA && lxc delete VCA
58 lxc stop MON && lxc delete MON
59 lxc stop SO-ub && lxc delete SO-ub
60 fi
61 echo -e "\nDeleting imported lxd images if they exist"
62 lxc image show osm-ro &>/dev/null && lxc image delete osm-ro
63 lxc image show osm-vca &>/dev/null && lxc image delete osm-vca
64 lxc image show osm-soui &>/dev/null && lxc image delete osm-soui
65 return 0
66 }
67
68 #Configure NAT rules, based on the current IP addresses of containers
69 function nat(){
70 echo -e "\nChecking required packages: iptables-persistent"
71 dpkg -l iptables-persistent &>/dev/null || ! echo -e " Not installed.\nInstalling iptables-persistent requires root privileges" || \
72 sudo DEBIAN_FRONTEND=noninteractive apt-get -yq install iptables-persistent
73 echo -e "\nConfiguring NAT rules"
74 echo -e " Required root privileges"
75 sudo $OSM_DEVOPS/installers/nat_osm
76 }
77
78 function FATAL(){
79 echo "FATAL error: Cannot install OSM due to \"$1\""
80 exit 1
81 }
82
83 #Update RO, SO and UI:
84 function update(){
85 echo -e "\nUpdating components"
86
87 echo -e " Updating RO"
88 CONTAINER="RO"
89 MDG="RO"
90 INSTALL_FOLDER="/opt/openmano"
91 echo -e " Fetching the repo"
92 lxc exec $CONTAINER -- git -C $INSTALL_FOLDER fetch --all
93 BRANCH=""
94 BRANCH=`lxc exec $CONTAINER -- git -C $INSTALL_FOLDER status -sb | head -n1 | sed -n 's/^## \(.*\).*/\1/p'|awk '{print $1}' |sed 's/\(.*\)\.\.\..*/\1/'`
95 [ -z "$BRANCH" ] && FATAL "Could not find the current branch in use in the '$MDG'"
96 CURRENT=`lxc exec $CONTAINER -- git -C $INSTALL_FOLDER status |head -n1`
97 CURRENT_COMMIT_ID=`lxc exec $CONTAINER -- git -C $INSTALL_FOLDER rev-parse HEAD`
98 echo " FROM: $CURRENT ($CURRENT_COMMIT_ID)"
99 # COMMIT_ID either was previously set with -b option, or is an empty string
100 CHECKOUT_ID=$COMMIT_ID
101 [ -z "$CHECKOUT_ID" ] && [ "$BRANCH" == "HEAD" ] && CHECKOUT_ID="tags/$LATEST_STABLE_DEVOPS"
102 [ -z "$CHECKOUT_ID" ] && [ "$BRANCH" != "HEAD" ] && CHECKOUT_ID="$BRANCH"
103 if [[ $CHECKOUT_ID == "tags/"* ]]; then
104 REMOTE_COMMIT_ID=`lxc exec $CONTAINER -- git -C $INSTALL_FOLDER rev-list -n 1 $CHECKOUT_ID`
105 else
106 REMOTE_COMMIT_ID=`lxc exec $CONTAINER -- git -C $INSTALL_FOLDER rev-parse origin/$CHECKOUT_ID`
107 fi
108 echo " TO: $CHECKOUT_ID ($REMOTE_COMMIT_ID)"
109 if [ "$CURRENT_COMMIT_ID" == "$REMOTE_COMMIT_ID" ]; then
110 echo " Nothing to be done."
111 else
112 echo " Update required."
113 lxc exec $CONTAINER -- service osm-ro stop
114 lxc exec $CONTAINER -- git -C /opt/openmano stash
115 lxc exec $CONTAINER -- git -C /opt/openmano pull --rebase
116 lxc exec $CONTAINER -- git -C /opt/openmano checkout $CHECKOUT_ID
117 lxc exec $CONTAINER -- git -C /opt/openmano stash pop
118 lxc exec $CONTAINER -- /opt/openmano/database_utils/migrate_mano_db.sh
119 lxc exec $CONTAINER -- service osm-ro start
120 fi
121 echo
122
123 echo -e " Updating SO and UI"
124 CONTAINER="SO-ub"
125 MDG="SO"
126 INSTALL_FOLDER="" # To be filled in
127 echo -e " Fetching the repo"
128 lxc exec $CONTAINER -- git -C $INSTALL_FOLDER fetch --all
129 BRANCH=""
130 BRANCH=`lxc exec $CONTAINER -- git -C $INSTALL_FOLDER status -sb | head -n1 | sed -n 's/^## \(.*\).*/\1/p'|awk '{print $1}' |sed 's/\(.*\)\.\.\..*/\1/'`
131 [ -z "$BRANCH" ] && FATAL "Could not find the current branch in use in the '$MDG'"
132 CURRENT=`lxc exec $CONTAINER -- git -C $INSTALL_FOLDER status |head -n1`
133 CURRENT_COMMIT_ID=`lxc exec $CONTAINER -- git -C $INSTALL_FOLDER rev-parse HEAD`
134 echo " FROM: $CURRENT ($CURRENT_COMMIT_ID)"
135 # COMMIT_ID either was previously set with -b option, or is an empty string
136 CHECKOUT_ID=$COMMIT_ID
137 [ -z "$CHECKOUT_ID" ] && [ "$BRANCH" == "HEAD" ] && CHECKOUT_ID="tags/$LATEST_STABLE_DEVOPS"
138 [ -z "$CHECKOUT_ID" ] && [ "$BRANCH" != "HEAD" ] && CHECKOUT_ID="$BRANCH"
139 if [[ $CHECKOUT_ID == "tags/"* ]]; then
140 REMOTE_COMMIT_ID=`lxc exec $CONTAINER -- git -C $INSTALL_FOLDER rev-list -n 1 $CHECKOUT_ID`
141 else
142 REMOTE_COMMIT_ID=`lxc exec $CONTAINER -- git -C $INSTALL_FOLDER rev-parse origin/$CHECKOUT_ID`
143 fi
144 echo " TO: $CHECKOUT_ID ($REMOTE_COMMIT_ID)"
145 if [ "$CURRENT_COMMIT_ID" == "$REMOTE_COMMIT_ID" ]; then
146 echo " Nothing to be done."
147 else
148 echo " Update required."
149 # Instructions to be added
150 # lxc exec SO-ub -- ...
151 fi
152 echo
153 echo -e "Updating MON Container"
154 CONTAINER="MON"
155 MDG="MON"
156 INSTALL_FOLDER="/root/MON"
157 echo -e " Fetching the repo"
158 lxc exec $CONTAINER -- git -C $INSTALL_FOLDER fetch --all
159 BRANCH=""
160 BRANCH=`lxc exec $CONTAINER -- git -C $INSTALL_FOLDER status -sb | head -n1 | sed -n 's/^## \(.*\).*/\1/p'|awk '{print $1}' |sed 's/\(.*\)\.\.\..*/\1/'`
161 [ -z "$BRANCH" ] && FATAL "Could not find the current branch in use in the '$MDG'"
162 CURRENT=`lxc exec $CONTAINER -- git -C $INSTALL_FOLDER status |head -n1`
163 CURRENT_COMMIT_ID=`lxc exec $CONTAINER -- git -C $INSTALL_FOLDER rev-parse HEAD`
164 echo " FROM: $CURRENT ($CURRENT_COMMIT_ID)"
165 # COMMIT_ID either was previously set with -b option, or is an empty string
166 CHECKOUT_ID=$COMMIT_ID
167 [ -z "$CHECKOUT_ID" ] && [ "$BRANCH" == "HEAD" ] && CHECKOUT_ID="tags/$LATEST_STABLE_DEVOPS"
168 [ -z "$CHECKOUT_ID" ] && [ "$BRANCH" != "HEAD" ] && CHECKOUT_ID="$BRANCH"
169 if [[ $CHECKOUT_ID == "tags/"* ]]; then
170 REMOTE_COMMIT_ID=`lxc exec $CONTAINER -- git -C $INSTALL_FOLDER rev-list -n 1 $CHECKOUT_ID`
171 else
172 REMOTE_COMMIT_ID=`lxc exec $CONTAINER -- git -C $INSTALL_FOLDER rev-parse origin/$CHECKOUT_ID`
173 fi
174 echo " TO: $CHECKOUT_ID ($REMOTE_COMMIT_ID)"
175 if [ "$CURRENT_COMMIT_ID" == "$REMOTE_COMMIT_ID" ]; then
176 echo " Nothing to be done."
177 else
178 echo " Update required."
179 fi
180 echo
181 }
182
183 function so_is_up() {
184 if [ -n "$1" ]; then
185 SO_IP=$1
186 else
187 SO_IP=`lxc list SO-ub -c 4|grep eth0 |awk '{print $2}'`
188 fi
189 time=0
190 step=5
191 timelength=300
192 while [ $time -le $timelength ]
193 do
194 if [[ `curl -k -X GET https://$SO_IP:8008/api/operational/vcs/info \
195 -H 'accept: application/vnd.yang.data+json' \
196 -H 'authorization: Basic YWRtaW46YWRtaW4=' \
197 -H 'cache-control: no-cache' 2> /dev/null | jq '.[].components.component_info[] | select(.component_name=="RW.Restconf")' 2>/dev/null | grep "RUNNING" | wc -l` -eq 1 ]]
198 then
199 echo "RW.Restconf running....SO is up"
200 return 0
201 fi
202
203 sleep $step
204 echo -n "."
205 time=$((time+step))
206 done
207
208 FATAL "OSM Failed to startup. SO failed to startup"
209 }
210
211 function vca_is_up() {
212 if [[ `lxc exec VCA -- juju status | grep "osm" | wc -l` -eq 1 ]]; then
213 echo "VCA is up and running"
214 return 0
215 fi
216
217 FATAL "OSM Failed to startup. VCA failed to startup"
218 }
219
220 function mon_is_up() {
221 if [[ `curl http://$RO_IP:9090/openmano/ | grep "works" | wc -l` -eq 1 ]]; then
222 echo "MON is up and running"
223 return 0
224 fi
225
226 FATAL "OSM Failed to startup. MON failed to startup"
227 }
228
229 function ro_is_up() {
230 if [ -n "$1" ]; then
231 RO_IP=$1
232 else
233 RO_IP=`lxc list RO -c 4|grep eth0 |awk '{print $2}'`
234 fi
235 time=0
236 step=2
237 timelength=20
238 while [ $time -le $timelength ]; do
239 if [[ `curl http://$RO_IP:9090/openmano/ | grep "works" | wc -l` -eq 1 ]]; then
240 echo "RO is up and running"
241 return 0
242 fi
243 sleep $step
244 echo -n "."
245 time=$((time+step))
246 done
247
248 FATAL "OSM Failed to startup. RO failed to startup"
249 }
250
251
252 function configure_RO(){
253 . $OSM_DEVOPS/installers/export_ips
254 echo -e " Configuring RO"
255 lxc exec RO -- sed -i -e "s/^\#\?log_socket_host:.*/log_socket_host: $SO_CONTAINER_IP/g" /etc/osm/openmanod.cfg
256 lxc exec RO -- service osm-ro restart
257
258 ro_is_up
259
260 lxc exec RO -- openmano tenant-delete -f osm >/dev/null
261 lxc exec RO -- openmano tenant-create osm > /dev/null
262 lxc exec RO -- sed -i '/export OPENMANO_TENANT=osm/d' .bashrc
263 lxc exec RO -- sed -i '$ i export OPENMANO_TENANT=osm' .bashrc
264 lxc exec RO -- sh -c 'echo "export OPENMANO_TENANT=osm" >> .bashrc'
265 }
266
267 function configure_VCA(){
268 echo -e " Configuring VCA"
269 JUJU_PASSWD=`date +%s | sha256sum | base64 | head -c 32`
270 echo -e "$JUJU_PASSWD\n$JUJU_PASSWD" | lxc exec VCA -- juju change-user-password
271 }
272
273 function configure_SOUI(){
274 . $OSM_DEVOPS/installers/export_ips
275 JUJU_CONTROLLER_IP=`lxc exec VCA -- lxc list -c 4 |grep eth0 |awk '{print $2}'`
276 RO_TENANT_ID=`lxc exec RO -- openmano tenant-list osm |awk '{print $1}'`
277
278 echo -e " Configuring MON"
279 #Information to be added about SO socket for logging
280
281 echo -e " Configuring SO"
282 sudo route add -host $JUJU_CONTROLLER_IP gw $VCA_CONTAINER_IP
283 sudo sed -i "$ i route add -host $JUJU_CONTROLLER_IP gw $VCA_CONTAINER_IP" /etc/rc.local
284 # make journaling persistent
285 lxc exec SO-ub -- mkdir -p /var/log/journal
286 lxc exec SO-ub -- systemd-tmpfiles --create --prefix /var/log/journal
287 lxc exec SO-ub -- systemctl restart systemd-journald
288
289 echo RIFT_EXTERNAL_ADDRESS=$DEFAULT_IP | lxc exec SO-ub -- tee -a /usr/rift/etc/default/launchpad
290
291 lxc exec SO-ub -- systemctl restart launchpad
292
293 so_is_up $SO_CONTAINER_IP
294
295 #delete existing config agent (could be there on reconfigure)
296 curl -k --request DELETE \
297 --url https://$SO_CONTAINER_IP:8008/api/config/config-agent/account/osmjuju \
298 --header 'accept: application/vnd.yang.data+json' \
299 --header 'authorization: Basic YWRtaW46YWRtaW4=' \
300 --header 'cache-control: no-cache' \
301 --header 'content-type: application/vnd.yang.data+json' &> /dev/null
302
303 result=$(curl -k --request POST \
304 --url https://$SO_CONTAINER_IP:8008/api/config/config-agent \
305 --header 'accept: application/vnd.yang.data+json' \
306 --header 'authorization: Basic YWRtaW46YWRtaW4=' \
307 --header 'cache-control: no-cache' \
308 --header 'content-type: application/vnd.yang.data+json' \
309 --data '{"account": [ { "name": "osmjuju", "account-type": "juju", "juju": { "ip-address": "'$JUJU_CONTROLLER_IP'", "port": "17070", "user": "admin", "secret": "'$JUJU_PASSWD'" } } ]}')
310 [[ $result =~ .*success.* ]] || FATAL "Failed config-agent configuration: $result"
311
312 #R1/R2 config line
313 #result=$(curl -k --request PUT \
314 # --url https://$SO_CONTAINER_IP:8008/api/config/resource-orchestrator \
315 # --header 'accept: application/vnd.yang.data+json' \
316 # --header 'authorization: Basic YWRtaW46YWRtaW4=' \
317 # --header 'cache-control: no-cache' \
318 # --header 'content-type: application/vnd.yang.data+json' \
319 # --data '{ "openmano": { "host": "'$RO_CONTAINER_IP'", "port": "9090", "tenant-id": "'$RO_TENANT_ID'" }, "name": "osmopenmano", "account-type": "openmano" }')
320
321 result=$(curl -k --request PUT \
322 --url https://$SO_CONTAINER_IP:8008/api/config/project/default/ro-account/account \
323 --header 'accept: application/vnd.yang.data+json' \
324 --header 'authorization: Basic YWRtaW46YWRtaW4=' \
325 --header 'cache-control: no-cache' \
326 --header 'content-type: application/vnd.yang.data+json' \
327 --data '{"rw-ro-account:account": [ { "openmano": { "host": "'$RO_CONTAINER_IP'", "port": "9090", "tenant-id": "'$RO_TENANT_ID'"}, "name": "osmopenmano", "ro-account-type": "openmano" }]}')
328 [[ $result =~ .*success.* ]] || FATAL "Failed resource-orchestrator configuration: $result"
329
330 result=$(curl -k --request PATCH \
331 --url https://$SO_CONTAINER_IP:8008/v2/api/config/openidc-provider-config/rw-ui-client/redirect-uri \
332 --header 'accept: application/vnd.yang.data+json' \
333 --header 'authorization: Basic YWRtaW46YWRtaW4=' \
334 --header 'cache-control: no-cache' \
335 --header 'content-type: application/vnd.yang.data+json' \
336 --data '{"redirect-uri": "https://'$DEFAULT_IP':8443/callback" }')
337 [[ $result =~ .*success.* ]] || FATAL "Failed redirect-uri configuration: $result"
338
339 result=$(curl -k --request PATCH \
340 --url https://$SO_CONTAINER_IP:8008/v2/api/config/openidc-provider-config/rw-ui-client/post-logout-redirect-uri \
341 --header 'accept: application/vnd.yang.data+json' \
342 --header 'authorization: Basic YWRtaW46YWRtaW4=' \
343 --header 'cache-control: no-cache' \
344 --header 'content-type: application/vnd.yang.data+json' \
345 --data '{"post-logout-redirect-uri": "https://'$DEFAULT_IP':8443/?api_server=https://'$DEFAULT_IP'" }')
346 [[ $result =~ .*success.* ]] || FATAL "Failed post-logout-redirect-uri configuration: $result"
347
348 lxc exec SO-ub -- tee /etc/network/interfaces.d/60-rift.cfg <<EOF
349 auto lo:1
350 iface lo:1 inet static
351 address $DEFAULT_IP
352 netmask 255.255.255.255
353 EOF
354 lxc exec SO-ub ifup lo:1
355 }
356
357 #Configure RO, VCA, and SO with the initial configuration:
358 # RO -> tenant:osm, logs to be sent to SO
359 # VCA -> juju-password
360 # SO -> route to Juju Controller, add RO account, add VCA account
361 function configure(){
362 #Configure components
363 echo -e "\nConfiguring components"
364 configure_RO
365 configure_VCA
366 configure_SOUI
367 }
368
369 function install_lxd() {
370 sudo apt-get update
371 sudo apt-get install -y lxd
372 newgrp lxd
373 lxd init --auto
374 lxd waitready
375 lxc network create lxdbr0 ipv4.address=auto ipv4.nat=true ipv6.address=none ipv6.nat=false
376 DEFAULT_INTERFACE=$(route -n | awk '$1~/^0.0.0.0/ {print $8}')
377 DEFAULT_MTU=$( ip addr show $DEFAULT_INTERFACE | perl -ne 'if (/mtu\s(\d+)/) {print $1;}')
378 lxc profile device set default eth0 mtu $DEFAULT_MTU
379 #sudo systemctl stop lxd-bridge
380 #sudo systemctl --system daemon-reload
381 #sudo systemctl enable lxd-bridge
382 #sudo systemctl start lxd-bridge
383 }
384
385 function ask_user(){
386 # ask to the user and parse a response among 'y', 'yes', 'n' or 'no'. Case insensitive
387 # Params: $1 text to ask; $2 Action by default, can be 'y' for yes, 'n' for no, other or empty for not allowed
388 # Return: true(0) if user type 'yes'; false (1) if user type 'no'
389 read -e -p "$1" USER_CONFIRMATION
390 while true ; do
391 [ -z "$USER_CONFIRMATION" ] && [ "$2" == 'y' ] && return 0
392 [ -z "$USER_CONFIRMATION" ] && [ "$2" == 'n' ] && return 1
393 [ "${USER_CONFIRMATION,,}" == "yes" ] || [ "${USER_CONFIRMATION,,}" == "y" ] && return 0
394 [ "${USER_CONFIRMATION,,}" == "no" ] || [ "${USER_CONFIRMATION,,}" == "n" ] && return 1
395 read -e -p "Please type 'yes' or 'no': " USER_CONFIRMATION
396 done
397 }
398
399 function launch_container_from_lxd(){
400 export OSM_MDG=$1
401 OSM_load_config
402 export OSM_BASE_IMAGE=$2
403 if ! container_exists $OSM_BUILD_CONTAINER; then
404 CONTAINER_OPTS=""
405 [[ "$OSM_BUILD_CONTAINER_PRIVILEGED" == yes ]] && CONTAINER_OPTS="$CONTAINER_OPTS -c security.privileged=true"
406 [[ "$OSM_BUILD_CONTAINER_ALLOW_NESTED" == yes ]] && CONTAINER_OPTS="$CONTAINER_OPTS -c security.nesting=true"
407 create_container $OSM_BASE_IMAGE $OSM_BUILD_CONTAINER $CONTAINER_OPTS
408 wait_container_up $OSM_BUILD_CONTAINER
409 fi
410 }
411
412 function install_osmclient(){
413 CLIENT_RELEASE=${RELEASE#"-R "}
414 CLIENT_REPOSITORY_KEY="OSM%20ETSI%20Release%20Key.gpg"
415 CLIENT_REPOSITORY="stable"
416 [ -z "$REPOSITORY_BASE" ] && REPOSITORY_BASE="-u https://osm-download.etsi.org/repository/osm/debian"
417 CLIENT_REPOSITORY_BASE=${REPOSITORY_BASE#"-u "}
418 key_location=$CLIENT_REPOSITORY_BASE/$CLIENT_RELEASE/$CLIENT_REPOSITORY_KEY
419 curl $key_location | sudo apt-key add -
420 sudo add-apt-repository -y "deb [arch=amd64] $CLIENT_REPOSITORY_BASE/$CLIENT_RELEASE $CLIENT_REPOSITORY osmclient"
421 sudo apt-get update
422 sudo apt-get install -y python-osmclient
423 export OSM_HOSTNAME=`lxc list | awk '($2=="SO-ub"){print $6}'`
424 export OSM_RO_HOSTNAME=`lxc list | awk '($2=="RO"){print $6}'`
425 echo -e "\nOSM client installed"
426 echo -e "You might be interested in adding the following OSM client env variables to your .bashrc file:"
427 echo " export OSM_HOSTNAME=${OSM_HOSTNAME}"
428 echo " export OSM_RO_HOSTNAME=${OSM_RO_HOSTNAME}"
429 }
430
431 function install_from_lxdimages(){
432 LXD_RELEASE=${RELEASE#"-R "}
433 if [ -n "$LXD_REPOSITORY_PATH" ]; then
434 LXD_IMAGE_DIR="$LXD_REPOSITORY_PATH"
435 else
436 LXD_IMAGE_DIR="$(mktemp -d -q --tmpdir "osmimages.XXXXXX")"
437 trap 'rm -rf "$LXD_IMAGE_DIR"' EXIT
438 fi
439 echo -e "\nDeleting previous lxd images if they exist"
440 lxc image show osm-ro &>/dev/null && lxc image delete osm-ro
441 lxc image show osm-vca &>/dev/null && lxc image delete osm-vca
442 lxc image show osm-soui &>/dev/null && lxc image delete osm-soui
443 echo -e "\nImporting osm-ro"
444 [ -z "$LXD_REPOSITORY_PATH" ] && wget -O $LXD_IMAGE_DIR/osm-ro.tar.gz $LXD_REPOSITORY_BASE/$LXD_RELEASE/osm-ro.tar.gz
445 lxc image import $LXD_IMAGE_DIR/osm-ro.tar.gz --alias osm-ro
446 rm -f $LXD_IMAGE_DIR/osm-ro.tar.gz
447 echo -e "\nImporting osm-vca"
448 [ -z "$LXD_REPOSITORY_PATH" ] && wget -O $LXD_IMAGE_DIR/osm-vca.tar.gz $LXD_REPOSITORY_BASE/$LXD_RELEASE/osm-vca.tar.gz
449 lxc image import $LXD_IMAGE_DIR/osm-vca.tar.gz --alias osm-vca
450 rm -f $LXD_IMAGE_DIR/osm-vca.tar.gz
451 echo -e "\nImporting osm-soui"
452 [ -z "$LXD_REPOSITORY_PATH" ] && wget -O $LXD_IMAGE_DIR/osm-soui.tar.gz $LXD_REPOSITORY_BASE/$LXD_RELEASE/osm-soui.tar.gz
453 lxc image import $LXD_IMAGE_DIR/osm-soui.tar.gz --alias osm-soui
454 rm -f $LXD_IMAGE_DIR/osm-soui.tar.gz
455 launch_container_from_lxd RO osm-ro
456 ro_is_up && track RO
457 launch_container_from_lxd VCA osm-vca
458 vca_is_up && track VCA
459 launch_container_from_lxd MON osm-mon
460 mon_is_up && track MON
461 launch_container_from_lxd SO osm-soui
462 #so_is_up && track SOUI
463 track SOUI
464 }
465
466 function install_docker_ce() {
467 # installs and configures Docker CE
468 echo "Installing Docker CE ..."
469 sudo apt-get -qq update
470 sudo apt-get install -y apt-transport-https ca-certificates software-properties-common
471 curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo apt-key add -
472 sudo add-apt-repository "deb [arch=amd64] https://download.docker.com/linux/ubuntu $(lsb_release -cs) stable"
473 sudo apt-get -qq update
474 sudo apt-get install -y docker-ce
475 echo "Adding user to group 'docker'"
476 sudo groupadd -f docker
477 sudo usermod -aG docker $USER
478 echo "... Docker CE installation done"
479 sleep 2
480 sudo service docker restart
481 echo "... restarted Docker service"
482 }
483
484 function install_vimemu() {
485 # install Docker
486 install_docker_ce
487 # clone vim-emu repository (attention: branch is currently master only)
488 echo "Cloning vim-emu repository ..."
489 git clone https://osm.etsi.org/gerrit/osm/vim-emu.git
490 # build vim-emu docker
491 echo "Building vim-emu Docker container..."
492 sudo docker build -t vim-emu-img -f vim-emu/Dockerfile vim-emu/
493 # start vim-emu container as daemon
494 echo "Starting vim-emu Docker container 'vim-emu' ..."
495 sudo docker run --name vim-emu -t -d --rm --privileged --pid='host' -v /var/run/docker.sock:/var/run/docker.sock vim-emu-img python examples/osm_default_daemon_topology_2_pop.py
496 echo "Waiting for 'vim-emu' container to start ..."
497 sleep 5
498 export VIMEMU_HOSTNAME=$(sudo docker inspect -f '{{range .NetworkSettings.Networks}}{{.IPAddress}}{{end}}' vim-emu)
499 echo "vim-emu running at $VIMEMU_HOSTNAME ..."
500 echo -e "You might be interested in adding the following OSM client env variables to your .bashrc file:"
501 echo " export OSM_HOSTNAME=${OSM_HOSTNAME}"
502 echo " export OSM_RO_HOSTNAME=${OSM_RO_HOSTNAME}"
503 echo -e "You might be interested in adding the following vim-emu env variables to your .bashrc file:"
504 echo " export VIMEMU_HOSTNAME=${VIMEMU_HOSTNAME}"
505 echo -e "\nTo add the emulated VIM to OSM you should do:"
506 echo " osm vim-create --name emu-vim1 --user username --password password --auth_url http://$VIMEMU_HOSTNAME:6001/v2.0 --tenant tenantName --account_type openstack"
507 }
508
509 function dump_vars(){
510 echo "DEVELOP=$DEVELOP"
511 echo "INSTALL_FROM_SOURCE=$INSTALL_FROM_SOURCE"
512 echo "UNINSTALL=$UNINSTALL"
513 echo "NAT=$NAT"
514 echo "UPDATE=$UPDATE"
515 echo "RECONFIGURE=$RECONFIGURE"
516 echo "TEST_INSTALLER=$TEST_INSTALLER"
517 echo "INSTALL_VIMEMU=$INSTALL_VIMEMU"
518 echo "INSTALL_LXD=$INSTALL_LXD"
519 echo "INSTALL_FROM_LXDIMAGES=$INSTALL_FROM_LXDIMAGES"
520 echo "LXD_REPOSITORY_BASE=$LXD_REPOSITORY_BASE"
521 echo "LXD_REPOSITORY_PATH=$LXD_REPOSITORY_PATH"
522 echo "RELEASE=$RELEASE"
523 echo "REPOSITORY=$REPOSITORY"
524 echo "REPOSITORY_BASE=$REPOSITORY_BASE"
525 echo "REPOSITORY_KEY=$REPOSITORY_KEY"
526 echo "NOCONFIGURE=$NOCONFIGURE"
527 echo "SHOWOPTS=$SHOWOPTS"
528 echo "Install from specific refspec (-b): $COMMIT_ID"
529 }
530
531 function track(){
532 ctime=`date +%s`
533 duration=$((ctime - SESSION_ID))
534 url="http://www.woopra.com/track/ce?project=osm.etsi.org&cookie=${SESSION_ID}"
535 #url="${url}&ce_campaign_name=${CAMPAIGN_NAME}"
536 event_name="bin"
537 [ -n "$INSTALL_FROM_SOURCE" ] && event_name="src"
538 [ -n "$INSTALL_FROM_LXDIMAGES" ] && event_name="lxd"
539 event_name="${event_name}_$1"
540 url="${url}&event=${event_name}&ce_duration=${duration}"
541 wget -q -O /dev/null $url
542 }
543
544 UNINSTALL=""
545 DEVELOP=""
546 NAT=""
547 UPDATE=""
548 RECONFIGURE=""
549 TEST_INSTALLER=""
550 INSTALL_LXD=""
551 SHOWOPTS=""
552 COMMIT_ID=""
553 ASSUME_YES=""
554 INSTALL_FROM_SOURCE=""
555 RELEASE="-R ReleaseTHREE"
556 INSTALL_VIMEMU=""
557 INSTALL_FROM_LXDIMAGES=""
558 LXD_REPOSITORY_BASE="https://osm-download.etsi.org/repository/osm/lxd"
559 LXD_REPOSITORY_PATH=""
560 NOCONFIGURE=""
561 RELEASE_DAILY=""
562 SESSION_ID=`date +%s`
563 OSM_DEVOPS=
564
565 while getopts ":hy-:b:r:k:u:R:l:p:D:" o; do
566 case "${o}" in
567 h)
568 usage && exit 0
569 ;;
570 b)
571 COMMIT_ID=${OPTARG}
572 ;;
573 r)
574 REPOSITORY="-r ${OPTARG}"
575 ;;
576 R)
577 RELEASE="-R ${OPTARG}"
578 ;;
579 k)
580 REPOSITORY_KEY="-k ${OPTARG}"
581 ;;
582 u)
583 REPOSITORY_BASE="-u ${OPTARG}"
584 ;;
585 l)
586 LXD_REPOSITORY_BASE="${OPTARG}"
587 ;;
588 p)
589 LXD_REPOSITORY_PATH="${OPTARG}"
590 ;;
591 D)
592 OSM_DEVOPS="${OPTARG}"
593 ;;
594 -)
595 [ "${OPTARG}" == "help" ] && usage && exit 0
596 [ "${OPTARG}" == "source" ] && INSTALL_FROM_SOURCE="y" && continue
597 [ "${OPTARG}" == "develop" ] && DEVELOP="y" && continue
598 [ "${OPTARG}" == "uninstall" ] && UNINSTALL="y" && continue
599 [ "${OPTARG}" == "nat" ] && NAT="y" && continue
600 [ "${OPTARG}" == "update" ] && UPDATE="y" && continue
601 [ "${OPTARG}" == "reconfigure" ] && RECONFIGURE="y" && continue
602 [ "${OPTARG}" == "test" ] && TEST_INSTALLER="y" && continue
603 [ "${OPTARG}" == "lxdinstall" ] && INSTALL_LXD="y" && continue
604 [ "${OPTARG}" == "lxdimages" ] && INSTALL_FROM_LXDIMAGES="y" && continue
605 [ "${OPTARG}" == "vimemu" ] && INSTALL_VIMEMU="y" && continue
606 [ "${OPTARG}" == "noconfigure" ] && NOCONFIGURE="y" && continue
607 [ "${OPTARG}" == "showopts" ] && SHOWOPTS="y" && continue
608 [ "${OPTARG}" == "daily" ] && RELEASE_DAILY="y" && continue
609 echo -e "Invalid option: '--$OPTARG'\n" >&2
610 usage && exit 1
611 ;;
612 \?)
613 echo -e "Invalid option: '-$OPTARG'\n" >&2
614 usage && exit 1
615 ;;
616 y)
617 ASSUME_YES="y"
618 ;;
619 *)
620 usage && exit 1
621 ;;
622 esac
623 done
624
625 if [ -n "$SHOWOPTS" ]; then
626 dump_vars
627 exit 0
628 fi
629
630 [ -n "$RELEASE_DAILY" ] && echo -e "\nInstalling from daily build repo" && RELEASE="-R ReleaseTHREE-daily" && REPOSITORY="-r testing" && COMMIT_ID="master"
631
632 # if develop, we force master
633 [ -z "$COMMIT_ID" ] && [ -n "$DEVELOP" ] && COMMIT_ID="master"
634
635 # forcing source from master removed. Now only install from source when explicit
636 # [ -n "$COMMIT_ID" ] && [ "$COMMIT_ID" == "master" ] && INSTALL_FROM_SOURCE="y"
637
638 if [ -z "$OSM_DEVOPS" ]; then
639 if [ -n "$TEST_INSTALLER" ]; then
640 echo -e "\nUsing local devops repo for OSM installation"
641 TEMPDIR="$(dirname $(realpath $(dirname $0)))"
642 else
643 echo -e "\nCreating temporary dir for OSM installation"
644 TEMPDIR="$(mktemp -d -q --tmpdir "installosm.XXXXXX")"
645 trap 'rm -rf "$TEMPDIR"' EXIT
646 fi
647 fi
648
649 need_packages="git jq"
650 for package in $need_packages; do
651 echo -e "Checking required packages: $package"
652 dpkg -l $package &>/dev/null \
653 || ! echo -e " $package not installed.\nInstalling $package requires root privileges" \
654 || sudo apt-get install -y $package \
655 || FATAL "failed to install $package"
656 done
657
658 if [ -z "$OSM_DEVOPS" ]; then
659 if [ -z "$TEST_INSTALLER" ]; then
660 echo -e "\nCloning devops repo temporarily"
661 git clone https://osm.etsi.org/gerrit/osm/devops.git $TEMPDIR
662 RC_CLONE=$?
663 fi
664
665 echo -e "\nGuessing the current stable release"
666 LATEST_STABLE_DEVOPS=`git -C $TEMPDIR tag -l v[0-9].* | sort -V | tail -n1`
667 [ -z "$COMMIT_ID" ] && [ -z "$LATEST_STABLE_DEVOPS" ] && echo "Could not find the current latest stable release" && exit 0
668 echo "Latest tag in devops repo: $LATEST_STABLE_DEVOPS"
669 [ -z "$COMMIT_ID" ] && [ -n "$LATEST_STABLE_DEVOPS" ] && COMMIT_ID="tags/$LATEST_STABLE_DEVOPS"
670
671 if [ -n "$RELEASE_DAILY" ]; then
672 echo "Using master/HEAD devops"
673 git -C $TEMPDIR checkout master
674 elif [ -z "$TEST_INSTALLER" ]; then
675 git -C $TEMPDIR checkout tags/$LATEST_STABLE_DEVOPS
676 fi
677 OSM_DEVOPS=$TEMPDIR
678 fi
679
680 OSM_JENKINS="$OSM_DEVOPS/jenkins"
681 . $OSM_JENKINS/common/all_funcs
682
683 [ -n "$UNINSTALL" ] && uninstall && echo -e "\nDONE" && exit 0
684 [ -n "$NAT" ] && nat && echo -e "\nDONE" && exit 0
685 [ -n "$UPDATE" ] && update && echo -e "\nDONE" && exit 0
686 [ -n "$RECONFIGURE" ] && configure && echo -e "\nDONE" && exit 0
687
688 #Installation starts here
689 echo -e "\nInstalling OSM from refspec: $COMMIT_ID"
690 if [ -n "$INSTALL_FROM_SOURCE" ] && [ -z "$ASSUME_YES" ]; then
691 ! ask_user "The installation will take about 75-90 minutes. Continue (Y/n)? " y && echo "Cancelled!" && exit 1
692 fi
693
694 echo -e "\nChecking required packages: wget, curl, tar"
695 dpkg -l wget curl tar &>/dev/null || ! echo -e " One or several packages are not installed.\nInstalling required packages\n Root privileges are required" || sudo apt-get install -y wget curl tar
696
697 echo -e "Checking required packages: lxd"
698 lxd --version &>/dev/null || FATAL "lxd not present, exiting."
699 [ -n "$INSTALL_LXD" ] && echo -e "\nInstalling and configuring lxd" && install_lxd
700
701 wget -q -O- https://osm-download.etsi.org/ftp/osm-4.0-four/README.txt &> /dev/null
702 track start
703
704 # use local devops for containers
705 export OSM_USE_LOCAL_DEVOPS=true
706 if [ -n "$INSTALL_FROM_SOURCE" ]; then #install from source
707 echo -e "\nCreating the containers and building from source ..."
708 $OSM_DEVOPS/jenkins/host/start_build RO --notest checkout $COMMIT_ID || FATAL "RO container build failed (refspec: '$COMMIT_ID')"
709 ro_is_up && track RO
710 $OSM_DEVOPS/jenkins/host/start_build VCA || FATAL "VCA container build failed"
711 vca_is_up && track VCA
712 $OSM_DEVOPS/jenkins/host/start_build MON || FATAL "MON install failed"
713 mon_is_up && track MON
714 $OSM_DEVOPS/jenkins/host/start_build SO checkout $COMMIT_ID || FATAL "SO container build failed (refspec: '$COMMIT_ID')"
715 $OSM_DEVOPS/jenkins/host/start_build UI checkout $COMMIT_ID || FATAL "UI container build failed (refspec: '$COMMIT_ID')"
716 #so_is_up && track SOUI
717 track SOUI
718 elif [ -n "$INSTALL_FROM_LXDIMAGES" ]; then #install from LXD images stored in OSM repo
719 echo -e "\nInstalling from lxd images ..."
720 install_from_lxdimages
721 else #install from binaries
722 echo -e "\nCreating the containers and installing from binaries ..."
723 $OSM_DEVOPS/jenkins/host/install RO $REPOSITORY $RELEASE $REPOSITORY_KEY $REPOSITORY_BASE || FATAL "RO install failed"
724 ro_is_up && track RO
725 $OSM_DEVOPS/jenkins/host/start_build VCA || FATAL "VCA install failed"
726 vca_is_up && track VCA
727 $OSM_DEVOPS/jenkins/host/install MON || FATAL "MON build failed"
728 mon_is_up && track MON
729 $OSM_DEVOPS/jenkins/host/install SO $REPOSITORY $RELEASE $REPOSITORY_KEY $REPOSITORY_BASE || FATAL "SO install failed"
730 $OSM_DEVOPS/jenkins/host/install UI $REPOSITORY $RELEASE $REPOSITORY_KEY $REPOSITORY_BASE || FATAL "UI install failed"
731 #so_is_up && track SOUI
732 track SOUI
733 fi
734
735 #Install iptables-persistent and configure NAT rules
736 [ -z "$NOCONFIGURE" ] && nat
737
738 #Configure components
739 [ -z "$NOCONFIGURE" ] && configure
740
741 #Install osmclient
742 [ -z "$NOCONFIGURE" ] && install_osmclient
743
744 #Install vim-emu (optional)
745 if [ -n "$INSTALL_VIMEMU" ]; then
746 echo -e "\nInstalling vim-emu ..."
747 install_vimemu
748 fi
749
750 wget -q -O- https://osm-download.etsi.org/ftp/osm-4.0-four/README2.txt &> /dev/null
751 track end
752 echo -e "\nDONE"
753