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 packages"
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 " --develop: (deprecated, use '-b master') install OSM from source code using the master branch"
32 echo -e " --nat: install only NAT rules"
33 # echo -e " --update: update to the latest stable release or to the latest commit if using a specific branch"
34 echo -e " --showopts: print chosen options and exit (only for debugging)"
35 echo -e " -y: do not prompt for confirmation, assumes yes"
36 echo -e " -h / --help: print this help"
39 #Uninstall OSM: remove containers
41 echo -e "\nUninstalling OSM"
42 if [ $RC_CLONE ] ||
[ -n "$TEST_INSTALLER" ]; then
43 $OSM_DEVOPS/jenkins
/host
/clean_container RO
44 $OSM_DEVOPS/jenkins
/host
/clean_container VCA
45 $OSM_DEVOPS/jenkins
/host
/clean_container SO
46 #$OSM_DEVOPS/jenkins/host/clean_container UI
48 lxc stop RO
&& lxc delete RO
49 lxc stop VCA
&& lxc delete VCA
50 lxc stop SO-ub
&& lxc delete SO-ub
54 #Configure NAT rules, based on the current IP addresses of containers
56 echo -e "\nChecking required packages: iptables-persistent"
57 dpkg
-l iptables-persistent
&>/dev
/null ||
! echo -e " Not installed.\nInstalling iptables-persistent requires root privileges" || \
58 sudo DEBIAN_FRONTEND
=noninteractive apt-get
-yq install iptables-persistent
59 echo -e "\nConfiguring NAT rules"
60 echo -e " Required root privileges"
61 sudo
$OSM_DEVOPS/installers
/nat_osm
65 echo "FATAL error: Cannot install OSM due to \"$1\""
69 #Update RO, SO and UI:
71 echo -e "\nUpdating components"
73 echo -e " Updating RO"
76 INSTALL_FOLDER
="/opt/openmano"
77 echo -e " Fetching the repo"
78 lxc
exec $CONTAINER -- git
-C $INSTALL_FOLDER fetch
--all
80 BRANCH
=`lxc exec $CONTAINER -- git -C $INSTALL_FOLDER status -sb | head -n1 | sed -n 's/^## \(.*\).*/\1/p'|awk '{print $1}' |sed 's/\(.*\)\.\.\..*/\1/'`
81 [ -z "$BRANCH" ] && FATAL
"Could not find the current branch in use in the '$MDG'"
82 CURRENT
=`lxc exec $CONTAINER -- git -C $INSTALL_FOLDER status |head -n1`
83 CURRENT_COMMIT_ID
=`lxc exec $CONTAINER -- git -C $INSTALL_FOLDER rev-parse HEAD`
84 echo " FROM: $CURRENT ($CURRENT_COMMIT_ID)"
85 # COMMIT_ID either was previously set with -b option, or is an empty string
86 CHECKOUT_ID
=$COMMIT_ID
87 [ -z "$CHECKOUT_ID" ] && [ "$BRANCH" == "HEAD" ] && CHECKOUT_ID
="tags/$LATEST_STABLE_DEVOPS"
88 [ -z "$CHECKOUT_ID" ] && [ "$BRANCH" != "HEAD" ] && CHECKOUT_ID
="$BRANCH"
89 if [[ $CHECKOUT_ID == "tags/"* ]]; then
90 REMOTE_COMMIT_ID
=`lxc exec $CONTAINER -- git -C $INSTALL_FOLDER rev-list -n 1 $CHECKOUT_ID`
92 REMOTE_COMMIT_ID
=`lxc exec $CONTAINER -- git -C $INSTALL_FOLDER rev-parse origin/$CHECKOUT_ID`
94 echo " TO: $CHECKOUT_ID ($REMOTE_COMMIT_ID)"
95 if [ "$CURRENT_COMMIT_ID" == "$REMOTE_COMMIT_ID" ]; then
96 echo " Nothing to be done."
98 echo " Update required."
99 lxc
exec $CONTAINER -- service osm-ro stop
100 lxc
exec $CONTAINER -- git
-C /opt
/openmano stash
101 lxc
exec $CONTAINER -- git
-C /opt
/openmano pull
--rebase
102 lxc
exec $CONTAINER -- git
-C /opt
/openmano checkout
$CHECKOUT_ID
103 lxc
exec $CONTAINER -- git
-C /opt
/openmano stash pop
104 lxc
exec $CONTAINER -- /opt
/openmano
/database_utils
/migrate_mano_db.sh
105 lxc
exec $CONTAINER -- service osm-ro start
109 echo -e " Updating SO and UI"
112 INSTALL_FOLDER
="" # To be filled in
113 echo -e " Fetching the repo"
114 lxc
exec $CONTAINER -- git
-C $INSTALL_FOLDER fetch
--all
116 BRANCH
=`lxc exec $CONTAINER -- git -C $INSTALL_FOLDER status -sb | head -n1 | sed -n 's/^## \(.*\).*/\1/p'|awk '{print $1}' |sed 's/\(.*\)\.\.\..*/\1/'`
117 [ -z "$BRANCH" ] && FATAL
"Could not find the current branch in use in the '$MDG'"
118 CURRENT
=`lxc exec $CONTAINER -- git -C $INSTALL_FOLDER status |head -n1`
119 CURRENT_COMMIT_ID
=`lxc exec $CONTAINER -- git -C $INSTALL_FOLDER rev-parse HEAD`
120 echo " FROM: $CURRENT ($CURRENT_COMMIT_ID)"
121 # COMMIT_ID either was previously set with -b option, or is an empty string
122 CHECKOUT_ID
=$COMMIT_ID
123 [ -z "$CHECKOUT_ID" ] && [ "$BRANCH" == "HEAD" ] && CHECKOUT_ID
="tags/$LATEST_STABLE_DEVOPS"
124 [ -z "$CHECKOUT_ID" ] && [ "$BRANCH" != "HEAD" ] && CHECKOUT_ID
="$BRANCH"
125 if [[ $CHECKOUT_ID == "tags/"* ]]; then
126 REMOTE_COMMIT_ID
=`lxc exec $CONTAINER -- git -C $INSTALL_FOLDER rev-list -n 1 $CHECKOUT_ID`
128 REMOTE_COMMIT_ID
=`lxc exec $CONTAINER -- git -C $INSTALL_FOLDER rev-parse origin/$CHECKOUT_ID`
130 echo " TO: $CHECKOUT_ID ($REMOTE_COMMIT_ID)"
131 if [ "$CURRENT_COMMIT_ID" == "$REMOTE_COMMIT_ID" ]; then
132 echo " Nothing to be done."
134 echo " Update required."
135 # Instructions to be added
136 # lxc exec SO-ub -- ...
141 function so_is_up
() {
146 while [ $time -le $timelength ]
148 if [[ `curl -k -X GET https://$SO_IP:8008/api/operational/vcs/info \
149 -H 'accept: application/vnd.yang.data+json' \
150 -H 'authorization: Basic YWRtaW46YWRtaW4=' \
151 -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 ]]
153 echo "RW.Restconf running....SO is up"
162 FATAL
"OSM Failed to startup"
165 #Configure VCA, SO and RO with the initial configuration:
166 # RO -> tenant:osm, logs to be sent to SO
167 # VCA -> juju-password
168 # SO -> route to Juju Controller, add RO account, add VCA account
169 function configure
(){
170 #Configure components
171 echo -e "\nConfiguring components"
172 .
$OSM_DEVOPS/installers
/export_ips
174 echo -e " Configuring RO"
175 lxc
exec RO
-- sed -i -e "s/^\#\?log_socket_host:.*/log_socket_host: $SO_CONTAINER_IP/g" /etc
/osm
/openmanod.cfg
176 lxc
exec RO
-- service osm-ro restart
178 time=0; step
=2; timelength
=20; while [ $time -le $timelength ]; do sleep $step; echo -n "."; time=$
((time+step
)); done; echo
180 lxc
exec RO
-- openmano tenant-delete
-f osm
>/dev
/null
181 RO_TENANT_ID
=`lxc exec RO -- openmano tenant-create osm |awk '{print $1}'`
182 lxc
exec RO
-- sed -i '/export OPENMANO_TENANT=osm/d' .bashrc
183 lxc
exec RO
-- sed -i '$ i export OPENMANO_TENANT=osm' .bashrc
184 #lxc exec RO -- sh -c 'echo "export OPENMANO_TENANT=osm" >> .bashrc'
186 echo -e " Configuring VCA"
187 JUJU_PASSWD
=`date +%s | sha256sum | base64 | head -c 32`
188 echo -e "$JUJU_PASSWD\n$JUJU_PASSWD" | lxc
exec VCA
-- juju change-user-password
189 JUJU_CONTROLLER_IP
=`lxc exec VCA -- lxc list -c 4 |grep eth0 |awk '{print $2}'`
191 echo -e " Configuring SO"
192 sudo route add
-host $JUJU_CONTROLLER_IP gw
$VCA_CONTAINER_IP
193 sudo
sed -i "$ i route add -host $JUJU_CONTROLLER_IP gw $VCA_CONTAINER_IP" /etc
/rc.
local
195 # make journaling persistent
196 lxc
exec SO-ub
-- mkdir
-p /var
/log
/journal
197 lxc
exec SO-ub
-- systemd-tmpfiles
--create --prefix /var
/log
/journal
198 lxc
exec SO-ub
-- systemctl restart systemd-journald
200 echo RIFT_EXTERNAL_ADDRESS
=$DEFAULT_IP | lxc
exec SO-ub
-- tee -a /usr
/rift
/etc
/default
/launchpad
202 lxc
exec SO-ub
-- systemctl restart launchpad
204 so_is_up
$SO_CONTAINER_IP
206 #delete existing config agent (could be there on reconfigure)
207 curl
-k --request DELETE \
208 --url https
://$SO_CONTAINER_IP:8008/api
/config
/config-agent
/account
/osmjuju \
209 --header 'accept: application/vnd.yang.data+json' \
210 --header 'authorization: Basic YWRtaW46YWRtaW4=' \
211 --header 'cache-control: no-cache' \
212 --header 'content-type: application/vnd.yang.data+json' &> /dev
/null
214 result
=$
(curl
-k --request POST \
215 --url https
://$SO_CONTAINER_IP:8008/api
/config
/config-agent \
216 --header 'accept: application/vnd.yang.data+json' \
217 --header 'authorization: Basic YWRtaW46YWRtaW4=' \
218 --header 'cache-control: no-cache' \
219 --header 'content-type: application/vnd.yang.data+json' \
220 --data '{"account": [ { "name": "osmjuju", "account-type": "juju", "juju": { "ip-address": "'$JUJU_CONTROLLER_IP'", "port": "17070", "user": "admin", "secret": "'$JUJU_PASSWD'" } } ]}')
221 [[ $result =~ .
*success.
* ]] || FATAL
"Failed config-agent configuration: $result"
224 #result=$(curl -k --request PUT \
225 # --url https://$SO_CONTAINER_IP:8008/api/config/resource-orchestrator \
226 # --header 'accept: application/vnd.yang.data+json' \
227 # --header 'authorization: Basic YWRtaW46YWRtaW4=' \
228 # --header 'cache-control: no-cache' \
229 # --header 'content-type: application/vnd.yang.data+json' \
230 # --data '{ "openmano": { "host": "'$RO_CONTAINER_IP'", "port": "9090", "tenant-id": "'$RO_TENANT_ID'" }, "name": "osmopenmano", "account-type": "openmano" }')
232 result
=$
(curl
-k --request PUT \
233 --url https
://$SO_CONTAINER_IP:8008/api
/config
/project
/default
/ro-account
/account \
234 --header 'accept: application/vnd.yang.data+json' \
235 --header 'authorization: Basic YWRtaW46YWRtaW4=' \
236 --header 'cache-control: no-cache' \
237 --header 'content-type: application/vnd.yang.data+json' \
238 --data '{"rw-ro-account:account": [ { "openmano": { "host": "'$RO_CONTAINER_IP'", "port": "9090", "tenant-id": "'$RO_TENANT_ID'"}, "name": "osmopenmano", "ro-account-type": "openmano" }]}')
239 [[ $result =~ .
*success.
* ]] || FATAL
"Failed resource-orchestrator configuration: $result"
241 result
=$
(curl
-k --request PATCH \
242 --url https
://$SO_CONTAINER_IP:8008/v
2/api
/config
/openidc-provider-config
/rw-ui-client
/redirect-uri \
243 --header 'accept: application/vnd.yang.data+json' \
244 --header 'authorization: Basic YWRtaW46YWRtaW4=' \
245 --header 'cache-control: no-cache' \
246 --header 'content-type: application/vnd.yang.data+json' \
247 --data '{"redirect-uri": "https://'$DEFAULT_IP':8443/callback" }')
248 [[ $result =~ .
*success.
* ]] || FATAL
"Failed redirect-uri configuration: $result"
250 result
=$
(curl
-k --request PATCH \
251 --url https
://$SO_CONTAINER_IP:8008/v
2/api
/config
/openidc-provider-config
/rw-ui-client
/post-logout-redirect-uri \
252 --header 'accept: application/vnd.yang.data+json' \
253 --header 'authorization: Basic YWRtaW46YWRtaW4=' \
254 --header 'cache-control: no-cache' \
255 --header 'content-type: application/vnd.yang.data+json' \
256 --data '{"post-logout-redirect-uri": "https://'$DEFAULT_IP':8443/?api_server=https://'$DEFAULT_IP'" }')
257 [[ $result =~ .
*success.
* ]] || FATAL
"Failed post-logout-redirect-uri configuration: $result"
259 lxc
exec SO-ub
-- tee /etc
/network
/interfaces.d
/60-rift.cfg
<<EOF
261 iface lo:1 inet static
263 netmask 255.255.255.255
265 lxc
exec SO-ub ifup lo
:1
269 function install_lxd
() {
272 systemctl stop lxd-bridge
273 systemctl
--system daemon-reload
274 systemctl
enable lxd-bridge
275 systemctl start lxd-bridge
279 # ask to the user and parse a response among 'y', 'yes', 'n' or 'no'. Case insensitive
280 # Params: $1 text to ask; $2 Action by default, can be 'y' for yes, 'n' for no, other or empty for not allowed
281 # Return: true(0) if user type 'yes'; false (1) if user type 'no'
282 read -e -p "$1" USER_CONFIRMATION
284 [ -z "$USER_CONFIRMATION" ] && [ "$2" == 'y' ] && return 0
285 [ -z "$USER_CONFIRMATION" ] && [ "$2" == 'n' ] && return 1
286 [ "${USER_CONFIRMATION,,}" == "yes" ] ||
[ "${USER_CONFIRMATION,,}" == "y" ] && return 0
287 [ "${USER_CONFIRMATION,,}" == "no" ] ||
[ "${USER_CONFIRMATION,,}" == "n" ] && return 1
288 read -e -p "Please type 'yes' or 'no': " USER_CONFIRMATION
302 INSTALL_FROM_SOURCE
=""
304 while getopts ":hy-:b:r:k:u:R:" o
; do
313 REPOSITORY
="-r ${OPTARG}"
316 RELEASE
="-R ${OPTARG}"
319 REPOSITORY_KEY
="-k ${OPTARG}"
322 REPOSITORY_BASE
="-u ${OPTARG}"
325 [ "${OPTARG}" == "help" ] && usage
&& exit 0
326 [ "${OPTARG}" == "source" ] && INSTALL_FROM_SOURCE
="y" && continue
327 [ "${OPTARG}" == "develop" ] && DEVELOP
="y" && continue
328 [ "${OPTARG}" == "uninstall" ] && UNINSTALL
="y" && continue
329 [ "${OPTARG}" == "nat" ] && NAT
="y" && continue
330 [ "${OPTARG}" == "update" ] && UPDATE
="y" && continue
331 [ "${OPTARG}" == "reconfigure" ] && RECONFIGURE
="y" && continue
332 [ "${OPTARG}" == "test" ] && TEST_INSTALLER
="y" && continue
333 [ "${OPTARG}" == "lxd" ] && LXD
="y" && continue
334 [ "${OPTARG}" == "showopts" ] && SHOWOPTS
="y" && continue
335 echo -e "Invalid option: '--$OPTARG'\n" >&2
339 echo -e "Invalid option: '-$OPTARG'\n" >&2
351 if [ -n "$SHOWOPTS" ]; then
352 echo "DEVELOP=$DEVELOP"
353 echo "INSTALL_FROM_SOURCE=$INSTALL_FROM_SOURCE"
354 echo "UNINSTALL=$UNINSTALL"
356 echo "UPDATE=$UPDATE"
357 echo "RECONFIGURE=$RECONFIGURE"
358 echo "TEST_INSTALLER=$TEST_INSTALLER"
360 echo "SHOWOPTS=$SHOWOPTS"
361 echo "Install from specific refspec (-b): $COMMIT_ID"
365 # if develop, we force master
366 [ -z "$COMMIT_ID" ] && [ -n "$DEVELOP" ] && COMMIT_ID
="master"
368 # forcing source from master removed. Now only install from source when explicit
369 # [ -n "$COMMIT_ID" ] && [ "$COMMIT_ID" == "master" ] && INSTALL_FROM_SOURCE="y"
371 if [ -n "$TEST_INSTALLER" ]; then
372 echo -e "\nUsing local devops repo for OSM installation"
373 TEMPDIR
="$(dirname $(realpath $(dirname $0)))"
375 echo -e "\nCreating temporary dir for OSM installation"
376 TEMPDIR
="$(mktemp -d -q --tmpdir "installosm.XXXXXX
")"
377 trap 'rm -rf "$TEMPDIR"' EXIT
380 need_packages
="git jq"
381 for package
in $need_packages; do
382 echo -e "Checking required packages: $package"
383 dpkg
-l $package &>/dev
/null \
384 ||
! echo -e " $package not installed.\nInstalling $package requires root privileges" \
385 || sudo apt-get
install -y $package \
386 || FATAL
"failed to install $package"
389 if [ -z "$TEST_INSTALLER" ]; then
390 echo -e "\nCloning devops repo temporarily"
391 git clone https
://osm.etsi.org
/gerrit
/osm
/devops.git
$TEMPDIR
395 echo -e "\nGuessing the current stable release"
396 LATEST_STABLE_DEVOPS
=`git -C $TEMPDIR tag -l v[0-9].* | sort -V | tail -n1`
397 [ -z "$COMMIT_ID" ] && [ -z "$LATEST_STABLE_DEVOPS" ] && echo "Could not find the current latest stable release" && exit 0
398 echo "Latest tag in devops repo: $LATEST_STABLE_DEVOPS"
399 [ -z "$COMMIT_ID" ] && [ -n "$LATEST_STABLE_DEVOPS" ] && COMMIT_ID
="tags/$LATEST_STABLE_DEVOPS"
400 [ -z "$TEST_INSTALLER" ] && git
-C $TEMPDIR checkout tags
/$LATEST_STABLE_DEVOPS
403 OSM_JENKINS
="$TEMPDIR/jenkins"
404 .
$OSM_JENKINS/common
/all_funcs
406 [ -n "$UNINSTALL" ] && uninstall
&& echo -e "\nDONE" && exit 0
407 [ -n "$NAT" ] && nat
&& echo -e "\nDONE" && exit 0
408 [ -n "$UPDATE" ] && update
&& echo -e "\nDONE" && exit 0
409 [ -n "$RECONFIGURE" ] && configure
&& echo -e "\nDONE" && exit 0
411 #Installation starts here
412 echo -e "\nInstalling OSM from refspec: $COMMIT_ID"
413 if [ -n "$INSTALL_FROM_SOURCE" ] && [ -z "$ASSUME_YES" ]; then
414 ! ask_user
"The installation will take about 75-90 minutes. Continue (Y/n)? " y
&& echo "Cancelled!" && exit 1
417 echo -e "\nChecking required packages: wget, curl, tar"
418 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
420 echo -e "Checking required packages: lxd"
421 lxd
--version &>/dev
/null || FATAL
"lxd not present, exiting."
422 [ -n "$LXD" ] && echo -e "\nConfiguring lxd" && install_lxd
424 wget
-q -O- https
://osm-download.etsi.org
/ftp
/osm-3.0
-three/README.txt
&> /dev
/null
426 # use local devops for containers
427 export OSM_USE_LOCAL_DEVOPS
=true
428 if [ -z "$INSTALL_FROM_SOURCE" ]; then
429 echo -e "\nCreating the containers and installing from binaries ..."
430 $OSM_DEVOPS/jenkins
/host
/install RO
$REPOSITORY $RELEASE $REPOSITORY_KEY $REPOSITORY_BASE || FATAL
"RO install failed"
431 $OSM_DEVOPS/jenkins
/host
/start_build VCA || FATAL
"VCA install failed"
432 $OSM_DEVOPS/jenkins
/host
/install SO
$REPOSITORY $RELEASE $REPOSITORY_KEY $REPOSITORY_BASE || FATAL
"SO install failed"
433 $OSM_DEVOPS/jenkins
/host
/install UI
$REPOSITORY $RELEASE $REPOSITORY_KEY $REPOSITORY_BASE || FATAL
"UI install failed"
434 else #install from source
435 echo -e "\nCreating the containers and building from source ..."
436 $OSM_DEVOPS/jenkins
/host
/start_build RO
--notest checkout
$COMMIT_ID || FATAL
"RO container build failed (refspec: '$COMMIT_ID')"
437 $OSM_DEVOPS/jenkins
/host
/start_build VCA || FATAL
"VCA container build failed"
438 $OSM_DEVOPS/jenkins
/host
/start_build SO checkout
$COMMIT_ID || FATAL
"SO container build failed (refspec: '$COMMIT_ID')"
439 $OSM_DEVOPS/jenkins
/host
/start_build UI checkout
$COMMIT_ID || FATAL
"UI container build failed (refspec: '$COMMIT_ID')"
442 #Install iptables-persistent and configure NAT rules
445 #Configure components
448 wget
-q -O- https
://osm-download.etsi.org
/ftp
/osm-3.0
-three/README2.txt
&> /dev
/null