2 # Copyright 2016 Telefónica Investigación y Desarrollo S.A.U.
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
8 # http://www.apache.org/licenses/LICENSE-2.0
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.
17 echo -e "usage: $0 [OPTIONS]"
18 echo -e "Install OSM from binaries or source code (by default, from binaries)"
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)"
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 " --lightweight: install lightweight build of OSM (default installation)"
35 echo -e " --soui: install classic build of OSM (based on LXD containers, with SO and UI)"
36 echo -e " --vimemu: additionally fetch, build, and deploy the VIM emulator as a docker container"
37 echo -e " --develop: (deprecated, use '-b master') install OSM from source code using the master branch"
38 # echo -e " --reconfigure: reconfigure the modules (DO NOT change NAT rules)"
39 echo -e " --nat: install only NAT rules"
40 echo -e " --noconfigure: DO NOT install osmclient, DO NOT install NAT rules, DO NOT configure modules"
41 # echo -e " --update: update to the latest stable release or to the latest commit if using a specific branch"
42 echo -e " --showopts: print chosen options and exit (only for debugging)"
43 echo -e " -y: do not prompt for confirmation, assumes yes"
44 echo -e " -D <devops path> use local devops installation path"
45 echo -e " -h / --help: print this help"
48 #Uninstall OSM: remove containers
50 echo -e "\nUninstalling OSM"
51 if [ $RC_CLONE ] ||
[ -n "$TEST_INSTALLER" ]; then
52 $OSM_DEVOPS/jenkins
/host
/clean_container RO
53 $OSM_DEVOPS/jenkins
/host
/clean_container VCA
54 $OSM_DEVOPS/jenkins
/host
/clean_container MON
55 $OSM_DEVOPS/jenkins
/host
/clean_container SO
56 #$OSM_DEVOPS/jenkins/host/clean_container UI
58 lxc stop RO
&& lxc delete RO
59 lxc stop VCA
&& lxc delete VCA
60 lxc stop MON
&& lxc delete MON
61 lxc stop SO-ub
&& lxc delete SO-ub
63 echo -e "\nDeleting imported lxd images if they exist"
64 lxc image show osm-ro
&>/dev
/null
&& lxc image delete osm-ro
65 lxc image show osm-vca
&>/dev
/null
&& lxc image delete osm-vca
66 lxc image show osm-soui
&>/dev
/null
&& lxc image delete osm-soui
70 #Uninstall lightweight OSM: remove dockers
71 function uninstall_lightweight
(){
72 echo -e "\nUninstalling lightweight OSM"
76 while [ ${COUNTER} -lt 30 ]; do
78 result
=$
(docker stack ps osm |
wc -l)
79 #echo "Dockers running: $result"
80 if [ "${result}" == "0" ]; then
85 if [ "${result}" == "0" ]; then
86 echo "All dockers of the stack osm were removed"
88 FATAL
"Some dockers of the stack osm could not be removed. Could not uninstall OSM in single shot. Try to uninstall again"
91 docker image
rm osm
/ro
92 docker image
rm osm
/lcm
93 docker image
rm osm
/light-ui
94 docker image
rm osm
/nbi
95 docker image
rm osm
/mon
96 docker image
rm osm
/pm
100 #Configure NAT rules, based on the current IP addresses of containers
102 echo -e "\nChecking required packages: iptables-persistent"
103 dpkg
-l iptables-persistent
&>/dev
/null ||
! echo -e " Not installed.\nInstalling iptables-persistent requires root privileges" || \
104 sudo DEBIAN_FRONTEND
=noninteractive apt-get
-yq install iptables-persistent
105 echo -e "\nConfiguring NAT rules"
106 echo -e " Required root privileges"
107 sudo
$OSM_DEVOPS/installers
/nat_osm
111 echo "FATAL error: Cannot install OSM due to \"$1\""
115 #Update RO, SO and UI:
117 echo -e "\nUpdating components"
119 echo -e " Updating RO"
122 INSTALL_FOLDER
="/opt/openmano"
123 echo -e " Fetching the repo"
124 lxc
exec $CONTAINER -- git
-C $INSTALL_FOLDER fetch
--all
126 BRANCH
=`lxc exec $CONTAINER -- git -C $INSTALL_FOLDER status -sb | head -n1 | sed -n 's/^## \(.*\).*/\1/p'|awk '{print $1}' |sed 's/\(.*\)\.\.\..*/\1/'`
127 [ -z "$BRANCH" ] && FATAL
"Could not find the current branch in use in the '$MDG'"
128 CURRENT
=`lxc exec $CONTAINER -- git -C $INSTALL_FOLDER status |head -n1`
129 CURRENT_COMMIT_ID
=`lxc exec $CONTAINER -- git -C $INSTALL_FOLDER rev-parse HEAD`
130 echo " FROM: $CURRENT ($CURRENT_COMMIT_ID)"
131 # COMMIT_ID either was previously set with -b option, or is an empty string
132 CHECKOUT_ID
=$COMMIT_ID
133 [ -z "$CHECKOUT_ID" ] && [ "$BRANCH" == "HEAD" ] && CHECKOUT_ID
="tags/$LATEST_STABLE_DEVOPS"
134 [ -z "$CHECKOUT_ID" ] && [ "$BRANCH" != "HEAD" ] && CHECKOUT_ID
="$BRANCH"
135 if [[ $CHECKOUT_ID == "tags/"* ]]; then
136 REMOTE_COMMIT_ID
=`lxc exec $CONTAINER -- git -C $INSTALL_FOLDER rev-list -n 1 $CHECKOUT_ID`
138 REMOTE_COMMIT_ID
=`lxc exec $CONTAINER -- git -C $INSTALL_FOLDER rev-parse origin/$CHECKOUT_ID`
140 echo " TO: $CHECKOUT_ID ($REMOTE_COMMIT_ID)"
141 if [ "$CURRENT_COMMIT_ID" == "$REMOTE_COMMIT_ID" ]; then
142 echo " Nothing to be done."
144 echo " Update required."
145 lxc
exec $CONTAINER -- service osm-ro stop
146 lxc
exec $CONTAINER -- git
-C /opt
/openmano stash
147 lxc
exec $CONTAINER -- git
-C /opt
/openmano pull
--rebase
148 lxc
exec $CONTAINER -- git
-C /opt
/openmano checkout
$CHECKOUT_ID
149 lxc
exec $CONTAINER -- git
-C /opt
/openmano stash pop
150 lxc
exec $CONTAINER -- /opt
/openmano
/database_utils
/migrate_mano_db.sh
151 lxc
exec $CONTAINER -- service osm-ro start
155 echo -e " Updating SO and UI"
158 INSTALL_FOLDER
="" # To be filled in
159 echo -e " Fetching the repo"
160 lxc
exec $CONTAINER -- git
-C $INSTALL_FOLDER fetch
--all
162 BRANCH
=`lxc exec $CONTAINER -- git -C $INSTALL_FOLDER status -sb | head -n1 | sed -n 's/^## \(.*\).*/\1/p'|awk '{print $1}' |sed 's/\(.*\)\.\.\..*/\1/'`
163 [ -z "$BRANCH" ] && FATAL
"Could not find the current branch in use in the '$MDG'"
164 CURRENT
=`lxc exec $CONTAINER -- git -C $INSTALL_FOLDER status |head -n1`
165 CURRENT_COMMIT_ID
=`lxc exec $CONTAINER -- git -C $INSTALL_FOLDER rev-parse HEAD`
166 echo " FROM: $CURRENT ($CURRENT_COMMIT_ID)"
167 # COMMIT_ID either was previously set with -b option, or is an empty string
168 CHECKOUT_ID
=$COMMIT_ID
169 [ -z "$CHECKOUT_ID" ] && [ "$BRANCH" == "HEAD" ] && CHECKOUT_ID
="tags/$LATEST_STABLE_DEVOPS"
170 [ -z "$CHECKOUT_ID" ] && [ "$BRANCH" != "HEAD" ] && CHECKOUT_ID
="$BRANCH"
171 if [[ $CHECKOUT_ID == "tags/"* ]]; then
172 REMOTE_COMMIT_ID
=`lxc exec $CONTAINER -- git -C $INSTALL_FOLDER rev-list -n 1 $CHECKOUT_ID`
174 REMOTE_COMMIT_ID
=`lxc exec $CONTAINER -- git -C $INSTALL_FOLDER rev-parse origin/$CHECKOUT_ID`
176 echo " TO: $CHECKOUT_ID ($REMOTE_COMMIT_ID)"
177 if [ "$CURRENT_COMMIT_ID" == "$REMOTE_COMMIT_ID" ]; then
178 echo " Nothing to be done."
180 echo " Update required."
181 # Instructions to be added
182 # lxc exec SO-ub -- ...
185 echo -e "Updating MON Container"
188 INSTALL_FOLDER
="/root/MON"
189 echo -e " Fetching the repo"
190 lxc
exec $CONTAINER -- git
-C $INSTALL_FOLDER fetch
--all
192 BRANCH
=`lxc exec $CONTAINER -- git -C $INSTALL_FOLDER status -sb | head -n1 | sed -n 's/^## \(.*\).*/\1/p'|awk '{print $1}' |sed 's/\(.*\)\.\.\..*/\1/'`
193 [ -z "$BRANCH" ] && FATAL
"Could not find the current branch in use in the '$MDG'"
194 CURRENT
=`lxc exec $CONTAINER -- git -C $INSTALL_FOLDER status |head -n1`
195 CURRENT_COMMIT_ID
=`lxc exec $CONTAINER -- git -C $INSTALL_FOLDER rev-parse HEAD`
196 echo " FROM: $CURRENT ($CURRENT_COMMIT_ID)"
197 # COMMIT_ID either was previously set with -b option, or is an empty string
198 CHECKOUT_ID
=$COMMIT_ID
199 [ -z "$CHECKOUT_ID" ] && [ "$BRANCH" == "HEAD" ] && CHECKOUT_ID
="tags/$LATEST_STABLE_DEVOPS"
200 [ -z "$CHECKOUT_ID" ] && [ "$BRANCH" != "HEAD" ] && CHECKOUT_ID
="$BRANCH"
201 if [[ $CHECKOUT_ID == "tags/"* ]]; then
202 REMOTE_COMMIT_ID
=`lxc exec $CONTAINER -- git -C $INSTALL_FOLDER rev-list -n 1 $CHECKOUT_ID`
204 REMOTE_COMMIT_ID
=`lxc exec $CONTAINER -- git -C $INSTALL_FOLDER rev-parse origin/$CHECKOUT_ID`
206 echo " TO: $CHECKOUT_ID ($REMOTE_COMMIT_ID)"
207 if [ "$CURRENT_COMMIT_ID" == "$REMOTE_COMMIT_ID" ]; then
208 echo " Nothing to be done."
210 echo " Update required."
215 function so_is_up
() {
219 SO_IP
=`lxc list SO-ub -c 4|grep eth0 |awk '{print $2}'`
224 while [ $time -le $timelength ]
226 if [[ `curl -k -X GET https://$SO_IP:8008/api/operational/vcs/info \
227 -H 'accept: application/vnd.yang.data+json' \
228 -H 'authorization: Basic YWRtaW46YWRtaW4=' \
229 -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 ]]
231 echo "RW.Restconf running....SO is up"
240 FATAL
"OSM Failed to startup. SO failed to startup"
243 function vca_is_up
() {
244 if [[ `lxc exec VCA -- juju status | grep "osm" | wc -l` -eq 1 ]]; then
245 echo "VCA is up and running"
249 FATAL
"OSM Failed to startup. VCA failed to startup"
252 function mon_is_up
() {
253 if [[ `curl http://$RO_IP:9090/openmano/ | grep "works" | wc -l` -eq 1 ]]; then
254 echo "MON is up and running"
258 FATAL
"OSM Failed to startup. MON failed to startup"
261 function ro_is_up
() {
265 RO_IP
=`lxc list RO -c 4|grep eth0 |awk '{print $2}'`
270 while [ $time -le $timelength ]; do
271 if [[ `curl http://$RO_IP:9090/openmano/ | grep "works" | wc -l` -eq 1 ]]; then
272 echo "RO is up and running"
280 FATAL
"OSM Failed to startup. RO failed to startup"
284 function configure_RO
(){
285 .
$OSM_DEVOPS/installers
/export_ips
286 echo -e " Configuring RO"
287 lxc
exec RO
-- sed -i -e "s/^\#\?log_socket_host:.*/log_socket_host: $SO_CONTAINER_IP/g" /etc
/osm
/openmanod.cfg
288 lxc
exec RO
-- service osm-ro restart
292 lxc
exec RO
-- openmano tenant-delete
-f osm
>/dev
/null
293 lxc
exec RO
-- openmano tenant-create osm
> /dev
/null
294 lxc
exec RO
-- sed -i '/export OPENMANO_TENANT=osm/d' .bashrc
295 lxc
exec RO
-- sed -i '$ i export OPENMANO_TENANT=osm' .bashrc
296 lxc
exec RO
-- sh
-c 'echo "export OPENMANO_TENANT=osm" >> .bashrc'
299 function configure_VCA
(){
300 echo -e " Configuring VCA"
301 JUJU_PASSWD
=`date +%s | sha256sum | base64 | head -c 32`
302 echo -e "$JUJU_PASSWD\n$JUJU_PASSWD" | lxc
exec VCA
-- juju change-user-password
305 function configure_SOUI
(){
306 .
$OSM_DEVOPS/installers
/export_ips
307 JUJU_CONTROLLER_IP
=`lxc exec VCA -- lxc list -c 4 |grep eth0 |awk '{print $2}'`
308 RO_TENANT_ID
=`lxc exec RO -- openmano tenant-list osm |awk '{print $1}'`
310 echo -e " Configuring MON"
311 #Information to be added about SO socket for logging
313 echo -e " Configuring SO"
314 sudo route add
-host $JUJU_CONTROLLER_IP gw
$VCA_CONTAINER_IP
315 sudo
sed -i "$ i route add -host $JUJU_CONTROLLER_IP gw $VCA_CONTAINER_IP" /etc
/rc.
local
316 # make journaling persistent
317 lxc
exec SO-ub
-- mkdir
-p /var
/log
/journal
318 lxc
exec SO-ub
-- systemd-tmpfiles
--create --prefix /var
/log
/journal
319 lxc
exec SO-ub
-- systemctl restart systemd-journald
321 echo RIFT_EXTERNAL_ADDRESS
=$DEFAULT_IP | lxc
exec SO-ub
-- tee -a /usr
/rift
/etc
/default
/launchpad
323 lxc
exec SO-ub
-- systemctl restart launchpad
325 so_is_up
$SO_CONTAINER_IP
327 #delete existing config agent (could be there on reconfigure)
328 curl
-k --request DELETE \
329 --url https
://$SO_CONTAINER_IP:8008/api
/config
/config-agent
/account
/osmjuju \
330 --header 'accept: application/vnd.yang.data+json' \
331 --header 'authorization: Basic YWRtaW46YWRtaW4=' \
332 --header 'cache-control: no-cache' \
333 --header 'content-type: application/vnd.yang.data+json' &> /dev
/null
335 result
=$
(curl
-k --request POST \
336 --url https
://$SO_CONTAINER_IP:8008/api
/config
/config-agent \
337 --header 'accept: application/vnd.yang.data+json' \
338 --header 'authorization: Basic YWRtaW46YWRtaW4=' \
339 --header 'cache-control: no-cache' \
340 --header 'content-type: application/vnd.yang.data+json' \
341 --data '{"account": [ { "name": "osmjuju", "account-type": "juju", "juju": { "ip-address": "'$JUJU_CONTROLLER_IP'", "port": "17070", "user": "admin", "secret": "'$JUJU_PASSWD'" } } ]}')
342 [[ $result =~ .
*success.
* ]] || FATAL
"Failed config-agent configuration: $result"
345 #result=$(curl -k --request PUT \
346 # --url https://$SO_CONTAINER_IP:8008/api/config/resource-orchestrator \
347 # --header 'accept: application/vnd.yang.data+json' \
348 # --header 'authorization: Basic YWRtaW46YWRtaW4=' \
349 # --header 'cache-control: no-cache' \
350 # --header 'content-type: application/vnd.yang.data+json' \
351 # --data '{ "openmano": { "host": "'$RO_CONTAINER_IP'", "port": "9090", "tenant-id": "'$RO_TENANT_ID'" }, "name": "osmopenmano", "account-type": "openmano" }')
353 result
=$
(curl
-k --request PUT \
354 --url https
://$SO_CONTAINER_IP:8008/api
/config
/project
/default
/ro-account
/account \
355 --header 'accept: application/vnd.yang.data+json' \
356 --header 'authorization: Basic YWRtaW46YWRtaW4=' \
357 --header 'cache-control: no-cache' \
358 --header 'content-type: application/vnd.yang.data+json' \
359 --data '{"rw-ro-account:account": [ { "openmano": { "host": "'$RO_CONTAINER_IP'", "port": "9090", "tenant-id": "'$RO_TENANT_ID'"}, "name": "osmopenmano", "ro-account-type": "openmano" }]}')
360 [[ $result =~ .
*success.
* ]] || FATAL
"Failed resource-orchestrator configuration: $result"
362 result
=$
(curl
-k --request PATCH \
363 --url https
://$SO_CONTAINER_IP:8008/v
2/api
/config
/openidc-provider-config
/rw-ui-client
/redirect-uri \
364 --header 'accept: application/vnd.yang.data+json' \
365 --header 'authorization: Basic YWRtaW46YWRtaW4=' \
366 --header 'cache-control: no-cache' \
367 --header 'content-type: application/vnd.yang.data+json' \
368 --data '{"redirect-uri": "https://'$DEFAULT_IP':8443/callback" }')
369 [[ $result =~ .
*success.
* ]] || FATAL
"Failed redirect-uri configuration: $result"
371 result
=$
(curl
-k --request PATCH \
372 --url https
://$SO_CONTAINER_IP:8008/v
2/api
/config
/openidc-provider-config
/rw-ui-client
/post-logout-redirect-uri \
373 --header 'accept: application/vnd.yang.data+json' \
374 --header 'authorization: Basic YWRtaW46YWRtaW4=' \
375 --header 'cache-control: no-cache' \
376 --header 'content-type: application/vnd.yang.data+json' \
377 --data '{"post-logout-redirect-uri": "https://'$DEFAULT_IP':8443/?api_server=https://'$DEFAULT_IP'" }')
378 [[ $result =~ .
*success.
* ]] || FATAL
"Failed post-logout-redirect-uri configuration: $result"
380 lxc
exec SO-ub
-- tee /etc
/network
/interfaces.d
/60-rift.cfg
<<EOF
382 iface lo:1 inet static
384 netmask 255.255.255.255
386 lxc
exec SO-ub ifup lo
:1
389 #Configure RO, VCA, and SO with the initial configuration:
390 # RO -> tenant:osm, logs to be sent to SO
391 # VCA -> juju-password
392 # SO -> route to Juju Controller, add RO account, add VCA account
393 function configure
(){
394 #Configure components
395 echo -e "\nConfiguring components"
401 function install_lxd
() {
403 sudo apt-get
install -y lxd
407 lxc network create lxdbr0 ipv4.address
=auto ipv4.nat
=true ipv6.address
=none ipv6.nat
=false
408 DEFAULT_INTERFACE
=$
(route
-n |
awk '$1~/^0.0.0.0/ {print $8}')
409 DEFAULT_MTU
=$
(ip addr show
$DEFAULT_INTERFACE | perl
-ne 'if (/mtu\s(\d+)/) {print $1;}')
410 lxc profile device
set default eth0 mtu
$DEFAULT_MTU
411 #sudo systemctl stop lxd-bridge
412 #sudo systemctl --system daemon-reload
413 #sudo systemctl enable lxd-bridge
414 #sudo systemctl start lxd-bridge
418 # ask to the user and parse a response among 'y', 'yes', 'n' or 'no'. Case insensitive
419 # Params: $1 text to ask; $2 Action by default, can be 'y' for yes, 'n' for no, other or empty for not allowed
420 # Return: true(0) if user type 'yes'; false (1) if user type 'no'
421 read -e -p "$1" USER_CONFIRMATION
423 [ -z "$USER_CONFIRMATION" ] && [ "$2" == 'y' ] && return 0
424 [ -z "$USER_CONFIRMATION" ] && [ "$2" == 'n' ] && return 1
425 [ "${USER_CONFIRMATION,,}" == "yes" ] ||
[ "${USER_CONFIRMATION,,}" == "y" ] && return 0
426 [ "${USER_CONFIRMATION,,}" == "no" ] ||
[ "${USER_CONFIRMATION,,}" == "n" ] && return 1
427 read -e -p "Please type 'yes' or 'no': " USER_CONFIRMATION
431 function launch_container_from_lxd
(){
434 export OSM_BASE_IMAGE
=$2
435 if ! container_exists
$OSM_BUILD_CONTAINER; then
437 [[ "$OSM_BUILD_CONTAINER_PRIVILEGED" == yes ]] && CONTAINER_OPTS
="$CONTAINER_OPTS -c security.privileged=true"
438 [[ "$OSM_BUILD_CONTAINER_ALLOW_NESTED" == yes ]] && CONTAINER_OPTS
="$CONTAINER_OPTS -c security.nesting=true"
439 create_container
$OSM_BASE_IMAGE $OSM_BUILD_CONTAINER $CONTAINER_OPTS
440 wait_container_up
$OSM_BUILD_CONTAINER
444 function install_osmclient
(){
445 CLIENT_RELEASE
=${RELEASE#"-R "}
446 CLIENT_REPOSITORY_KEY
="OSM%20ETSI%20Release%20Key.gpg"
447 CLIENT_REPOSITORY
=${REPOSITORY#"-r "}
448 [ -z "$REPOSITORY_BASE" ] && REPOSITORY_BASE
="-u https://osm-download.etsi.org/repository/osm/debian"
449 CLIENT_REPOSITORY_BASE
=${REPOSITORY_BASE#"-u "}
450 key_location
=$CLIENT_REPOSITORY_BASE/$CLIENT_RELEASE/$CLIENT_REPOSITORY_KEY
451 curl
$key_location | sudo apt-key add
-
452 sudo add-apt-repository
-y "deb [arch=amd64] $CLIENT_REPOSITORY_BASE/$CLIENT_RELEASE $CLIENT_REPOSITORY osmclient"
454 sudo apt-get
install -y python-pip
455 sudo
-H pip
install pip
==9.0.3
456 sudo
-H pip
install python-magic
457 sudo apt-get
install -y python-osmclient
458 #sed 's,OSM_SOL005=[^$]*,OSM_SOL005=True,' -i ${HOME}/.bashrc
459 #echo 'export OSM_HOSTNAME=localhost' >> ${HOME}/.bashrc
460 #echo 'export OSM_SOL005=True' >> ${HOME}/.bashrc
461 [ -z "$INSTALL_LIGHTWEIGHT" ] && export OSM_HOSTNAME
=`lxc list | awk '($2=="SO-ub"){print $6}'`
462 [ -z "$INSTALL_LIGHTWEIGHT" ] && export OSM_RO_HOSTNAME
=`lxc list | awk '($2=="RO"){print $6}'`
463 [ -n "$INSTALL_LIGHTWEIGHT" ] && export OSM_HOSTNAME
=localhost
464 echo -e "\nOSM client installed"
465 echo -e "You might be interested in adding the following OSM client env variables to your .bashrc file:"
466 echo " export OSM_HOSTNAME=${OSM_HOSTNAME}"
467 [ -n "$INSTALL_LIGHTWEIGHT" ] && echo " export OSM_SOL005=True"
468 [ -z "$INSTALL_LIGHTWEIGHT" ] && echo " export OSM_RO_HOSTNAME=${OSM_RO_HOSTNAME}"
472 function install_from_lxdimages
(){
473 LXD_RELEASE
=${RELEASE#"-R "}
474 if [ -n "$LXD_REPOSITORY_PATH" ]; then
475 LXD_IMAGE_DIR
="$LXD_REPOSITORY_PATH"
477 LXD_IMAGE_DIR
="$(mktemp -d -q --tmpdir "osmimages.XXXXXX
")"
478 trap 'rm -rf "$LXD_IMAGE_DIR"' EXIT
480 echo -e "\nDeleting previous lxd images if they exist"
481 lxc image show osm-ro
&>/dev
/null
&& lxc image delete osm-ro
482 lxc image show osm-vca
&>/dev
/null
&& lxc image delete osm-vca
483 lxc image show osm-soui
&>/dev
/null
&& lxc image delete osm-soui
484 echo -e "\nImporting osm-ro"
485 [ -z "$LXD_REPOSITORY_PATH" ] && wget
-O $LXD_IMAGE_DIR/osm-ro.
tar.gz
$LXD_REPOSITORY_BASE/$LXD_RELEASE/osm-ro.
tar.gz
486 lxc image import
$LXD_IMAGE_DIR/osm-ro.
tar.gz
--alias osm-ro
487 rm -f $LXD_IMAGE_DIR/osm-ro.
tar.gz
488 echo -e "\nImporting osm-vca"
489 [ -z "$LXD_REPOSITORY_PATH" ] && wget
-O $LXD_IMAGE_DIR/osm-vca.
tar.gz
$LXD_REPOSITORY_BASE/$LXD_RELEASE/osm-vca.
tar.gz
490 lxc image import
$LXD_IMAGE_DIR/osm-vca.
tar.gz
--alias osm-vca
491 rm -f $LXD_IMAGE_DIR/osm-vca.
tar.gz
492 echo -e "\nImporting osm-soui"
493 [ -z "$LXD_REPOSITORY_PATH" ] && wget
-O $LXD_IMAGE_DIR/osm-soui.
tar.gz
$LXD_REPOSITORY_BASE/$LXD_RELEASE/osm-soui.
tar.gz
494 lxc image import
$LXD_IMAGE_DIR/osm-soui.
tar.gz
--alias osm-soui
495 rm -f $LXD_IMAGE_DIR/osm-soui.
tar.gz
496 launch_container_from_lxd RO osm-ro
498 launch_container_from_lxd VCA osm-vca
499 vca_is_up
&& track VCA
500 launch_container_from_lxd MON osm-mon
501 mon_is_up
&& track MON
502 launch_container_from_lxd SO osm-soui
503 #so_is_up && track SOUI
507 function install_docker_ce
() {
508 # installs and configures Docker CE
509 echo "Installing Docker CE ..."
510 sudo apt-get
-qq update
511 sudo apt-get
install -y apt-transport-https ca-certificates software-properties-common
512 curl
-fsSL https
://download.docker.com
/linux
/ubuntu
/gpg | sudo apt-key add
-
513 sudo add-apt-repository
"deb [arch=amd64] https://download.docker.com/linux/ubuntu $(lsb_release -cs) stable"
514 sudo apt-get
-qq update
515 sudo apt-get
install -y docker-ce
516 echo "Adding user to group 'docker'"
517 sudo groupadd
-f docker
518 sudo usermod
-aG docker
$USER
519 echo "... Docker CE installation done"
521 sudo service docker restart
522 echo "... restarted Docker service"
525 function install_docker_compose
() {
526 # installs and configures docker-compose
527 echo "Installing Docker Compose ..."
528 sudo curl
-L https
://github.com
/docker
/compose
/releases
/download
/1.18.0/docker-compose-
`uname -s`-`uname -m` -o /usr
/local
/bin
/docker-compose
529 sudo
chmod +x
/usr
/local
/bin
/docker-compose
530 echo "... Docker Compose installation done"
533 function install_juju
() {
534 echo "Installing juju"
535 sudo snap
install juju
--classic
536 sudo dpkg-reconfigure
-p medium lxd
537 sg lxd
-c "juju bootstrap localhost osm"
538 echo "Finished installation of juju"
541 function generate_docker_images
() {
542 echo "Pulling and generating docker images"
543 newgrp docker
<< EONG
544 docker pull wurstmeister/kafka
545 docker pull wurstmeister/zookeeper
548 git -C ${LWTEMPDIR} clone https://osm.etsi.org/gerrit/osm/MON
549 docker build ${LWTEMPDIR}/MON -f ${LWTEMPDIR}/MON/docker/Dockerfile -t osm/mon || ! echo "cannot build MON docker image" >&2
550 docker build ${LWTEMPDIR}/MON/policy_module -f ${LWTEMPDIR}/MON/policy_module/Dockerfile -t osm/pm || ! echo "cannot build PM docker image" >&2
551 git -C ${LWTEMPDIR} clone https://osm.etsi.org/gerrit/osm/NBI
552 docker build ${LWTEMPDIR}/NBI -f ${LWTEMPDIR}/NBI/Dockerfile.local -t osm/nbi || ! echo "cannot build NBI docker image" >&2
553 git -C ${LWTEMPDIR} clone https://osm.etsi.org/gerrit/osm/RO
554 docker build ${LWTEMPDIR}/RO -f ${LWTEMPDIR}/RO/docker/Dockerfile-local -t osm/ro || ! echo "cannot build RO docker image" >&2
555 docker build ${LWTEMPDIR}/RO/lcm -t osm/lcm || ! echo "cannot build LCM docker image" >&2
556 # git -C ${LWTEMPDIR} clone https://github.com/superfluidity/osm-light-ui.git
557 # docker build ${LWTEMPDIR}/osm-light-ui -t osm/light-ui -f ${LWTEMPDIR}/osm-light-ui/code/docker/Dockerfile
558 git -C ${LWTEMPDIR} clone https://osm.etsi.org/gerrit/osm/LW-UI
559 docker build ${LWTEMPDIR}/LW-UI -t osm/light-ui -f ${LWTEMPDIR}/LW-UI/Dockerfile
561 echo "Finished generation of docker images"
564 function generate_docker_env_files
() {
565 echo "Generating docker env files"
566 OSMLCM_VCA_HOST
=`juju show-controller|grep api-endpoints|awk -F\' '{print $2}'|awk -F\: '{print $1}'`
567 OSMLCM_VCA_SECRET
=`grep password ${HOME}/.local/share/juju/accounts.yaml |awk '{print $2}'`
568 MYSQL_ROOT_PASSWORD
=`date +%s | sha256sum | base64 | head -c 32`
569 echo "OSMLCM_VCA_HOST=${OSMLCM_VCA_HOST}" |sudo
tee ${OSM_DEVOPS}/installers
/docker
/lcm.env
570 echo "OSMLCM_VCA_SECRET=${OSMLCM_VCA_SECRET}" |sudo
tee -a ${OSM_DEVOPS}/installers
/docker
/lcm.env
571 echo "MYSQL_ROOT_PASSWORD=${MYSQL_ROOT_PASSWORD}" |sudo
tee ${OSM_DEVOPS}/installers
/docker
/ro-db.env
572 echo "RO_DB_ROOT_PASSWORD=${MYSQL_ROOT_PASSWORD}" |sudo
tee ${OSM_DEVOPS}/installers
/docker
/ro.env
573 echo "OS_NOTIFIER_URI=http://${DEFAULT_IP}:8662" |sudo
tee ${OSM_DEVOPS}/installers
/docker
/mon.env
574 echo "Finished generation of docker env files"
577 function deploy_lightweight
() {
578 echo "Deploying lightweight build"
579 if [ "${DEFAULT_MTU}" != "1500" ]; then
580 DOCKER_NETS
=`sg docker -c "docker network list" | awk '{print $2}' | egrep -v "^ID$" | paste -d " " -s`
581 DOCKER_GW_NET
=`sg docker -c "docker network inspect ${DOCKER_NETS}" | grep Subnet | awk -F\" '{print $4}' | egrep "^172" | sort -u | tail -1 | awk -F\. '{if ($2 != 255) print $1"."$2+1"."$3"."$4; else print "-1";}'`
582 sg docker
-c "docker network create --subnet ${DOCKER_GW_NET} --opt com.docker.network.bridge.name=docker_gwbridge --opt com.docker.network.bridge.enable_icc=false --opt com.docker.network.bridge.enable_ip_masquerade=true --opt com.docker.network.driver.mtu=${DEFAULT_MTU} docker_gwbridge"
584 newgrp docker
<< EONG
585 docker swarm init --advertise-addr ${DEFAULT_IP}
586 docker network create --driver=overlay --attachable --opt com.docker.network.driver.mtu=${DEFAULT_MTU} netOSM
587 docker stack deploy -c ${OSM_DEVOPS}/installers/docker/docker-compose.yaml osm
588 #docker-compose -f /usr/share/osm-devops/installers/docker/docker-compose.yaml up -d
590 echo "Finished deployment of lightweight build"
593 function install_lightweight
() {
594 echo "Installing lightweight build of OSM"
595 LWTEMPDIR
="$(mktemp -d -q --tmpdir "installosmlight.XXXXXX
")"
596 trap 'rm -rf "${LWTEMPDIR}"' EXIT
597 DEFAULT_IF
=`route -n |awk '$1~/^0.0.0.0/ {print $8}'`
598 DEFAULT_IP
=`ip -o -4 a |grep ${DEFAULT_IF}|awk '{split($4,a,"/"); print a[1]}'`
599 DEFAULT_MTU
=$
(ip addr show
${DEFAULT_IF} | perl
-ne 'if (/mtu\s(\d+)/) {print $1;}')
600 need_packages_lw
="lxd"
601 echo -e "Checking required packages: $need_packages_lw"
602 dpkg
-l $need_packages_lw &>/dev
/null \
603 ||
! echo -e "One or several required packages are not installed. Updating apt cache requires root privileges." \
604 || sudo apt-get update \
605 || FATAL
"failed to run apt-get update"
606 dpkg
-l $need_packages_lw &>/dev
/null \
607 ||
! echo -e "Installing $need_packages_lw requires root privileges." \
608 || sudo apt-get
install -y $need_packages_lw \
609 || FATAL
"failed to install $need_packages_lw"
612 #install_docker_compose
613 generate_docker_images
614 generate_docker_env_files
616 [ -n "$INSTALL_VIMEMU" ] && install_vimemu
621 function install_vimemu
() {
622 echo "\nInstalling vim-emu"
623 EMUTEMPDIR
="$(mktemp -d -q --tmpdir "installosmvimemu.XXXXXX
")"
624 trap 'rm -rf "${EMUTEMPDIR}"' EXIT
625 # clone vim-emu repository (attention: branch is currently master only)
626 echo "Cloning vim-emu repository ..."
627 git clone https
://osm.etsi.org
/gerrit
/osm
/vim-emu.git
$EMUTEMPDIR
628 # build vim-emu docker
629 echo "Building vim-emu Docker container..."
630 sudo docker build
-t vim-emu-img
-f $EMUTEMPDIR/Dockerfile
$EMUTEMPDIR/
631 # start vim-emu container as daemon
632 echo "Starting vim-emu Docker container 'vim-emu' ..."
633 if [ -n "$INSTALL_LIGHTWEIGHT" ]; then
634 # in lightweight mode, the emulator needs to be attached to netOSM
635 sudo docker run
--name vim-emu
-t -d --rm --privileged --pid='host' --network=netOSM
-v /var
/run
/docker.sock
:/var
/run
/docker.sock vim-emu-img python examples
/osm_default_daemon_topology_2_pop.py
638 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
640 echo "Waiting for 'vim-emu' container to start ..."
642 export VIMEMU_HOSTNAME
=$
(sudo docker inspect
-f '{{range .NetworkSettings.Networks}}{{.IPAddress}}{{end}}' vim-emu
)
643 echo "vim-emu running at ${VIMEMU_HOSTNAME} ..."
644 # print vim-emu connection info
645 echo -e "\nYou might be interested in adding the following vim-emu env variables to your .bashrc file:"
646 echo " export VIMEMU_HOSTNAME=${VIMEMU_HOSTNAME}"
647 echo -e "To add the emulated VIM to OSM you should do:"
648 echo " osm vim-create --name emu-vim1 --user username --password password --auth_url http://${VIMEMU_HOSTNAME}:6001/v2.0 --tenant tenantName --account_type openstack"
651 function dump_vars
(){
652 echo "DEVELOP=$DEVELOP"
653 echo "INSTALL_FROM_SOURCE=$INSTALL_FROM_SOURCE"
654 echo "UNINSTALL=$UNINSTALL"
656 echo "UPDATE=$UPDATE"
657 echo "RECONFIGURE=$RECONFIGURE"
658 echo "TEST_INSTALLER=$TEST_INSTALLER"
659 echo "INSTALL_VIMEMU=$INSTALL_VIMEMU"
660 echo "INSTALL_LXD=$INSTALL_LXD"
661 echo "INSTALL_FROM_LXDIMAGES=$INSTALL_FROM_LXDIMAGES"
662 echo "LXD_REPOSITORY_BASE=$LXD_REPOSITORY_BASE"
663 echo "LXD_REPOSITORY_PATH=$LXD_REPOSITORY_PATH"
664 echo "INSTALL_LIGHTWEIGHT=$INSTALL_LIGHTWEIGHT"
665 echo "RELEASE=$RELEASE"
666 echo "REPOSITORY=$REPOSITORY"
667 echo "REPOSITORY_BASE=$REPOSITORY_BASE"
668 echo "REPOSITORY_KEY=$REPOSITORY_KEY"
669 echo "NOCONFIGURE=$NOCONFIGURE"
670 echo "SHOWOPTS=$SHOWOPTS"
671 echo "Install from specific refspec (-b): $COMMIT_ID"
676 duration
=$
((ctime
- SESSION_ID
))
677 url
="http://www.woopra.com/track/ce?project=osm.etsi.org&cookie=${SESSION_ID}"
678 #url="${url}&ce_campaign_name=${CAMPAIGN_NAME}"
680 [ -n "$INSTALL_FROM_SOURCE" ] && event_name
="src"
681 [ -n "$INSTALL_FROM_LXDIMAGES" ] && event_name
="lxd"
682 event_name
="${event_name}_$1"
683 url
="${url}&event=${event_name}&ce_duration=${duration}"
684 wget
-q -O /dev
/null
$url
697 INSTALL_FROM_SOURCE
=""
698 RELEASE
="-R ReleaseTHREE"
699 REPOSITORY
="-r stable"
701 INSTALL_FROM_LXDIMAGES
=""
702 LXD_REPOSITORY_BASE
="https://osm-download.etsi.org/repository/osm/lxd"
703 LXD_REPOSITORY_PATH
=""
704 INSTALL_LIGHTWEIGHT
="y"
707 SESSION_ID
=`date +%s`
710 while getopts ":hy-:b:r:k:u:R:l:p:D:" o
; do
719 REPOSITORY
="-r ${OPTARG}"
722 RELEASE
="-R ${OPTARG}"
725 REPOSITORY_KEY
="-k ${OPTARG}"
728 REPOSITORY_BASE
="-u ${OPTARG}"
731 LXD_REPOSITORY_BASE
="${OPTARG}"
734 LXD_REPOSITORY_PATH
="${OPTARG}"
737 OSM_DEVOPS
="${OPTARG}"
740 [ "${OPTARG}" == "help" ] && usage
&& exit 0
741 [ "${OPTARG}" == "source" ] && INSTALL_FROM_SOURCE
="y" && continue
742 [ "${OPTARG}" == "develop" ] && DEVELOP
="y" && continue
743 [ "${OPTARG}" == "uninstall" ] && UNINSTALL
="y" && continue
744 [ "${OPTARG}" == "nat" ] && NAT
="y" && continue
745 [ "${OPTARG}" == "update" ] && UPDATE
="y" && continue
746 [ "${OPTARG}" == "reconfigure" ] && RECONFIGURE
="y" && continue
747 [ "${OPTARG}" == "test" ] && TEST_INSTALLER
="y" && continue
748 [ "${OPTARG}" == "lxdinstall" ] && INSTALL_LXD
="y" && continue
749 [ "${OPTARG}" == "lxdimages" ] && INSTALL_FROM_LXDIMAGES
="y" && continue
750 [ "${OPTARG}" == "lightweight" ] && INSTALL_LIGHTWEIGHT
="y" && continue
751 [ "${OPTARG}" == "soui" ] && INSTALL_LIGHTWEIGHT
="" && continue
752 [ "${OPTARG}" == "vimemu" ] && INSTALL_VIMEMU
="y" && continue
753 [ "${OPTARG}" == "noconfigure" ] && NOCONFIGURE
="y" && continue
754 [ "${OPTARG}" == "showopts" ] && SHOWOPTS
="y" && continue
755 [ "${OPTARG}" == "daily" ] && RELEASE_DAILY
="y" && continue
756 echo -e "Invalid option: '--$OPTARG'\n" >&2
760 echo -e "Invalid option: '-$OPTARG'\n" >&2
772 if [ -n "$SHOWOPTS" ]; then
777 [ -n "$RELEASE_DAILY" ] && echo -e "\nInstalling from daily build repo" && RELEASE
="-R ReleaseTHREE-daily" && REPOSITORY
="-r testing" && COMMIT_ID
="master"
779 # if develop, we force master
780 [ -z "$COMMIT_ID" ] && [ -n "$DEVELOP" ] && COMMIT_ID
="master"
782 # forcing source from master removed. Now only install from source when explicit
783 # [ -n "$COMMIT_ID" ] && [ "$COMMIT_ID" == "master" ] && INSTALL_FROM_SOURCE="y"
785 if [ -z "$OSM_DEVOPS" ]; then
786 if [ -n "$TEST_INSTALLER" ]; then
787 echo -e "\nUsing local devops repo for OSM installation"
788 TEMPDIR
="$(dirname $(realpath $(dirname $0)))"
790 echo -e "\nCreating temporary dir for OSM installation"
791 TEMPDIR
="$(mktemp -d -q --tmpdir "installosm.XXXXXX
")"
792 trap 'rm -rf "$TEMPDIR"' EXIT
796 need_packages
="git jq wget curl tar"
797 echo -e "Checking required packages: $need_packages"
798 dpkg
-l $need_packages &>/dev
/null \
799 ||
! echo -e "One or several required packages are not installed. Updating apt cache requires root privileges." \
800 || sudo apt-get update \
801 || FATAL
"failed to run apt-get update"
802 dpkg
-l $need_packages &>/dev
/null \
803 ||
! echo -e "Installing $need_packages requires root privileges." \
804 || sudo apt-get
install -y $need_packages \
805 || FATAL
"failed to install $need_packages"
807 if [ -z "$OSM_DEVOPS" ]; then
808 if [ -z "$TEST_INSTALLER" ]; then
809 echo -e "\nCloning devops repo temporarily"
810 git clone https
://osm.etsi.org
/gerrit
/osm
/devops.git
$TEMPDIR
814 echo -e "\nGuessing the current stable release"
815 LATEST_STABLE_DEVOPS
=`git -C $TEMPDIR tag -l v[0-9].* | sort -V | tail -n1`
816 [ -z "$COMMIT_ID" ] && [ -z "$LATEST_STABLE_DEVOPS" ] && echo "Could not find the current latest stable release" && exit 0
817 echo "Latest tag in devops repo: $LATEST_STABLE_DEVOPS"
818 [ -z "$COMMIT_ID" ] && [ -n "$LATEST_STABLE_DEVOPS" ] && COMMIT_ID
="tags/$LATEST_STABLE_DEVOPS"
820 if [ -n "$RELEASE_DAILY" ]; then
821 echo "Using master/HEAD devops"
822 git
-C $TEMPDIR checkout master
823 elif [ -z "$TEST_INSTALLER" ]; then
824 git
-C $TEMPDIR checkout tags
/$LATEST_STABLE_DEVOPS
829 OSM_JENKINS
="$OSM_DEVOPS/jenkins"
830 .
$OSM_JENKINS/common
/all_funcs
832 [ -n "$INSTALL_LIGHTWEIGHT" ] && [ -n "$UNINSTALL" ] && uninstall_lightweight
&& echo -e "\nDONE" && exit 0
833 [ -n "$UNINSTALL" ] && uninstall
&& echo -e "\nDONE" && exit 0
834 [ -n "$NAT" ] && nat
&& echo -e "\nDONE" && exit 0
835 [ -n "$UPDATE" ] && update
&& echo -e "\nDONE" && exit 0
836 [ -n "$RECONFIGURE" ] && configure
&& echo -e "\nDONE" && exit 0
838 #Installation starts here
839 [ -n "$INSTALL_LIGHTWEIGHT" ] && install_lightweight
&& echo -e "\nDONE" && exit 0
840 echo -e "\nInstalling OSM from refspec: $COMMIT_ID"
841 if [ -n "$INSTALL_FROM_SOURCE" ] && [ -z "$ASSUME_YES" ]; then
842 ! ask_user
"The installation will take about 75-90 minutes. Continue (Y/n)? " y
&& echo "Cancelled!" && exit 1
845 echo -e "Checking required packages: lxd"
846 lxd
--version &>/dev
/null || FATAL
"lxd not present, exiting."
847 [ -n "$INSTALL_LXD" ] && echo -e "\nInstalling and configuring lxd" && install_lxd
849 wget
-q -O- https
://osm-download.etsi.org
/ftp
/osm-4.0
-four/README.txt
&> /dev
/null
852 # use local devops for containers
853 export OSM_USE_LOCAL_DEVOPS
=true
854 if [ -n "$INSTALL_FROM_SOURCE" ]; then #install from source
855 echo -e "\nCreating the containers and building from source ..."
856 $OSM_DEVOPS/jenkins
/host
/start_build RO
--notest checkout
$COMMIT_ID || FATAL
"RO container build failed (refspec: '$COMMIT_ID')"
858 $OSM_DEVOPS/jenkins
/host
/start_build VCA || FATAL
"VCA container build failed"
859 vca_is_up
&& track VCA
860 $OSM_DEVOPS/jenkins
/host
/start_build MON || FATAL
"MON install failed"
861 mon_is_up
&& track MON
862 $OSM_DEVOPS/jenkins
/host
/start_build SO checkout
$COMMIT_ID || FATAL
"SO container build failed (refspec: '$COMMIT_ID')"
863 $OSM_DEVOPS/jenkins
/host
/start_build UI checkout
$COMMIT_ID || FATAL
"UI container build failed (refspec: '$COMMIT_ID')"
864 #so_is_up && track SOUI
866 elif [ -n "$INSTALL_FROM_LXDIMAGES" ]; then #install from LXD images stored in OSM repo
867 echo -e "\nInstalling from lxd images ..."
868 install_from_lxdimages
869 else #install from binaries
870 echo -e "\nCreating the containers and installing from binaries ..."
871 $OSM_DEVOPS/jenkins
/host
/install RO
$REPOSITORY $RELEASE $REPOSITORY_KEY $REPOSITORY_BASE || FATAL
"RO install failed"
873 $OSM_DEVOPS/jenkins
/host
/start_build VCA || FATAL
"VCA install failed"
874 vca_is_up
&& track VCA
875 $OSM_DEVOPS/jenkins
/host
/install MON || FATAL
"MON build failed"
876 mon_is_up
&& track MON
877 $OSM_DEVOPS/jenkins
/host
/install SO
$REPOSITORY $RELEASE $REPOSITORY_KEY $REPOSITORY_BASE || FATAL
"SO install failed"
878 $OSM_DEVOPS/jenkins
/host
/install UI
$REPOSITORY $RELEASE $REPOSITORY_KEY $REPOSITORY_BASE || FATAL
"UI install failed"
879 #so_is_up && track SOUI
883 #Install iptables-persistent and configure NAT rules
884 [ -z "$NOCONFIGURE" ] && nat
886 #Configure components
887 [ -z "$NOCONFIGURE" ] && configure
890 [ -z "$NOCONFIGURE" ] && install_osmclient
892 #Install vim-emu (optional)
893 [ -n "$INSTALL_VIMEMU" ] && install_docker_ce
&& install_vimemu
895 wget
-q -O- https
://osm-download.etsi.org
/ftp
/osm-4.0
-four/README2.txt
&> /dev
/null