896eaefd67a975527a0dca276fc8320ca8c3b5ec
[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 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)"
30 echo -e " ..."
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"
37 }
38
39 #Uninstall OSM: remove containers
40 function uninstall(){
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
47 else
48 lxc stop RO && lxc delete RO
49 lxc stop VCA && lxc delete VCA
50 lxc stop SO-ub && lxc delete SO-ub
51 fi
52 }
53
54 #Configure NAT rules, based on the current IP addresses of containers
55 function nat(){
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
62 }
63
64 #Update RO, SO and UI:
65 function update(){
66 echo -e "\nUpdating components"
67
68 echo -e " Updating RO"
69 CONTAINER="RO"
70 MDG="RO"
71 INSTALL_FOLDER="/opt/openmano"
72 echo -e " Fetching the repo"
73 lxc exec $CONTAINER -- git -C $INSTALL_FOLDER fetch --all
74 BRANCH=""
75 BRANCH=`lxc exec $CONTAINER -- git -C $INSTALL_FOLDER status -sb | head -n1 | sed -n 's/^## \(.*\).*/\1/p'|awk '{print $1}' |sed 's/\(.*\)\.\.\..*/\1/'`
76 [ -z "$BRANCH" ] && FATAL "Could not find the current branch in use in the '$MDG'"
77 CURRENT=`lxc exec $CONTAINER -- git -C $INSTALL_FOLDER status |head -n1`
78 CURRENT_COMMIT_ID=`lxc exec $CONTAINER -- git -C $INSTALL_FOLDER rev-parse HEAD`
79 echo " FROM: $CURRENT ($CURRENT_COMMIT_ID)"
80 # COMMIT_ID either was previously set with -b option, or is an empty string
81 CHECKOUT_ID=$COMMIT_ID
82 [ -z "$CHECKOUT_ID" ] && [ "$BRANCH" == "HEAD" ] && CHECKOUT_ID="tags/$LATEST_STABLE_DEVOPS"
83 [ -z "$CHECKOUT_ID" ] && [ "$BRANCH" != "HEAD" ] && CHECKOUT_ID="$BRANCH"
84 if [[ $CHECKOUT_ID == "tags/"* ]]; then
85 REMOTE_COMMIT_ID=`lxc exec $CONTAINER -- git -C $INSTALL_FOLDER rev-list -n 1 $CHECKOUT_ID`
86 else
87 REMOTE_COMMIT_ID=`lxc exec $CONTAINER -- git -C $INSTALL_FOLDER rev-parse origin/$CHECKOUT_ID`
88 fi
89 echo " TO: $CHECKOUT_ID ($REMOTE_COMMIT_ID)"
90 if [ "$CURRENT_COMMIT_ID" == "$REMOTE_COMMIT_ID" ]; then
91 echo " Nothing to be done."
92 else
93 echo " Update required."
94 lxc exec $CONTAINER -- service osm-ro stop
95 lxc exec $CONTAINER -- git -C /opt/openmano stash
96 lxc exec $CONTAINER -- git -C /opt/openmano pull --rebase
97 lxc exec $CONTAINER -- git -C /opt/openmano checkout $CHECKOUT_ID
98 lxc exec $CONTAINER -- git -C /opt/openmano stash pop
99 lxc exec $CONTAINER -- /opt/openmano/database_utils/migrate_mano_db.sh
100 lxc exec $CONTAINER -- service osm-ro start
101 fi
102 echo
103
104 echo -e " Updating SO and UI"
105 CONTAINER="SO-ub"
106 MDG="SO"
107 INSTALL_FOLDER="" # To be filled in
108 echo -e " Fetching the repo"
109 lxc exec $CONTAINER -- git -C $INSTALL_FOLDER fetch --all
110 BRANCH=""
111 BRANCH=`lxc exec $CONTAINER -- git -C $INSTALL_FOLDER status -sb | head -n1 | sed -n 's/^## \(.*\).*/\1/p'|awk '{print $1}' |sed 's/\(.*\)\.\.\..*/\1/'`
112 [ -z "$BRANCH" ] && FATAL "Could not find the current branch in use in the '$MDG'"
113 CURRENT=`lxc exec $CONTAINER -- git -C $INSTALL_FOLDER status |head -n1`
114 CURRENT_COMMIT_ID=`lxc exec $CONTAINER -- git -C $INSTALL_FOLDER rev-parse HEAD`
115 echo " FROM: $CURRENT ($CURRENT_COMMIT_ID)"
116 # COMMIT_ID either was previously set with -b option, or is an empty string
117 CHECKOUT_ID=$COMMIT_ID
118 [ -z "$CHECKOUT_ID" ] && [ "$BRANCH" == "HEAD" ] && CHECKOUT_ID="tags/$LATEST_STABLE_DEVOPS"
119 [ -z "$CHECKOUT_ID" ] && [ "$BRANCH" != "HEAD" ] && CHECKOUT_ID="$BRANCH"
120 if [[ $CHECKOUT_ID == "tags/"* ]]; then
121 REMOTE_COMMIT_ID=`lxc exec $CONTAINER -- git -C $INSTALL_FOLDER rev-list -n 1 $CHECKOUT_ID`
122 else
123 REMOTE_COMMIT_ID=`lxc exec $CONTAINER -- git -C $INSTALL_FOLDER rev-parse origin/$CHECKOUT_ID`
124 fi
125 echo " TO: $CHECKOUT_ID ($REMOTE_COMMIT_ID)"
126 if [ "$CURRENT_COMMIT_ID" == "$REMOTE_COMMIT_ID" ]; then
127 echo " Nothing to be done."
128 else
129 echo " Update required."
130 # Instructions to be added
131 # lxc exec SO-ub -- ...
132 fi
133 echo
134 }
135
136 function so_is_up(){
137 SO_IP=$1
138 time=0
139 step=5
140 timelength=300
141 while [ $time -le $timelength ]
142 do
143 curl -k https://$SO_IP:8008/api/operational/vcs/info \
144 --header 'accept: application/vnd.yang.data+json' \
145 --header 'authorization: Basic YWRtaW46YWRtaW4=' \
146 --header 'cache-control: no-cache' \
147 --header 'content-type: application/vnd.yang.data+json' &> /dev/null
148 RET=$?
149 if [ "$RET" == 0 ]; then
150 break
151 fi
152 sleep $step
153 echo -n "."
154 time=$((time+step))
155 done
156 if [ "$RET" != 0 ]; then
157 FATAL "OSM Failed to startup"
158 fi
159 echo
160 }
161
162 #Configure VCA, SO and RO with the initial configuration:
163 # RO -> tenant:osm, logs to be sent to SO
164 # VCA -> juju-password
165 # SO -> route to Juju Controller, add RO account, add VCA account
166 function configure(){
167 #Configure components
168 echo -e "\nConfiguring components"
169 . $OSM_DEVOPS/installers/export_ips
170
171 echo -e " Configuring RO"
172 lxc exec RO -- sed -i -e "s/^\#\?log_socket_host:.*/log_socket_host: $SO_CONTAINER_IP/g" /etc/osm/openmanod.cfg
173 lxc exec RO -- service osm-ro restart
174
175 time=0; step=2; timelength=20; while [ $time -le $timelength ]; do sleep $step; echo -n "."; time=$((time+step)); done; echo
176
177 lxc exec RO -- openmano tenant-delete -f osm >/dev/null
178 RO_TENANT_ID=`lxc exec RO -- openmano tenant-create osm |awk '{print $1}'`
179 lxc exec RO -- sed -i '/export OPENMANO_TENANT=osm/d' .bashrc
180 lxc exec RO -- sed -i '$ i export OPENMANO_TENANT=osm' .bashrc
181 #lxc exec RO -- sh -c 'echo "export OPENMANO_TENANT=osm" >> .bashrc'
182
183 echo -e " Configuring VCA"
184 JUJU_PASSWD=`date +%s | sha256sum | base64 | head -c 32`
185 echo -e "$JUJU_PASSWD\n$JUJU_PASSWD" | lxc exec VCA -- juju change-user-password
186 JUJU_CONTROLLER_IP=`lxc exec VCA -- lxc list -c 4 |grep eth0 |awk '{print $2}'`
187
188 echo -e " Configuring SO"
189 sudo route add -host $JUJU_CONTROLLER_IP gw $VCA_CONTAINER_IP
190 sudo sed -i "$ i route add -host $JUJU_CONTROLLER_IP gw $VCA_CONTAINER_IP" /etc/rc.local
191 echo RIFT_EXTERNAL_ADDRESS=$DEFAULT_IP | lxc exec SO-ub -- tee -a /usr/rift/etc/default/launchpad
192
193 lxc exec SO-ub -- systemctl restart launchpad
194
195 so_is_up $SO_CONTAINER_IP
196
197 #delete existing config agent (could be there on reconfigure)
198 curl -k --request DELETE \
199 --url https://$SO_CONTAINER_IP:8008/api/config/config-agent/account/osmjuju \
200 --header 'accept: application/vnd.yang.data+json' \
201 --header 'authorization: Basic YWRtaW46YWRtaW4=' \
202 --header 'cache-control: no-cache' \
203 --header 'content-type: application/vnd.yang.data+json' &> /dev/null
204
205 result=$(curl -k --request POST \
206 --url https://$SO_CONTAINER_IP:8008/api/config/config-agent \
207 --header 'accept: application/vnd.yang.data+json' \
208 --header 'authorization: Basic YWRtaW46YWRtaW4=' \
209 --header 'cache-control: no-cache' \
210 --header 'content-type: application/vnd.yang.data+json' \
211 --data '{"account": [ { "name": "osmjuju", "account-type": "juju", "juju": { "ip-address": "'$JUJU_CONTROLLER_IP'", "port": "17070", "user": "admin", "secret": "'$JUJU_PASSWD'" } } ]}')
212 [[ $result =~ .*success.* ]] || FATAL "Failed config-agent configuration: $result"
213
214 #R1/R2 config line
215 #result=$(curl -k --request PUT \
216 # --url https://$SO_CONTAINER_IP:8008/api/config/resource-orchestrator \
217 # --header 'accept: application/vnd.yang.data+json' \
218 # --header 'authorization: Basic YWRtaW46YWRtaW4=' \
219 # --header 'cache-control: no-cache' \
220 # --header 'content-type: application/vnd.yang.data+json' \
221 # --data '{ "openmano": { "host": "'$RO_CONTAINER_IP'", "port": "9090", "tenant-id": "'$RO_TENANT_ID'" }, "name": "osmopenmano", "account-type": "openmano" }')
222
223 result=$(curl -k --request PUT \
224 --url https://$SO_CONTAINER_IP:8008/api/config/project/default/ro-account/account \
225 --header 'accept: application/vnd.yang.data+json' \
226 --header 'authorization: Basic YWRtaW46YWRtaW4=' \
227 --header 'cache-control: no-cache' \
228 --header 'content-type: application/vnd.yang.data+json' \
229 --data '{"rw-ro-account:account": [ { "openmano": { "host": "'$RO_CONTAINER_IP'", "port": "9090", "tenant-id": "'$RO_TENANT_ID'"}, "name": "osmopenmano", "ro-account-type": "openmano" }]}')
230 [[ $result =~ .*success.* ]] || FATAL "Failed resource-orchestrator configuration: $result"
231
232 lxc exec SO-ub -- /usr/rift/rift-shell -- rwcli --username admin --passwd admin <<EOF
233 config
234 openidc-provider-config rw-ui-client redirect-uri https://$DEFAULT_IP:8443/callback post-logout-redirect-uri https://$DEFAULT_IP:8443/
235 EOF
236 lxc exec SO-ub -- tee /etc/network/interfaces.d/60-rift.cfg <<EOF
237 auto lo:1
238 iface lo:1 inet static
239 address $DEFAULT_IP
240 netmask 255.255.255.255
241 EOF
242 lxc exec SO-ub ifup lo:1
243
244 }
245
246 function install_lxd() {
247 lxd init --auto
248 lxd waitready
249 systemctl stop lxd-bridge
250 systemctl --system daemon-reload
251 systemctl enable lxd-bridge
252 systemctl start lxd-bridge
253 }
254
255 function ask_user(){
256 # ask to the user and parse a response among 'y', 'yes', 'n' or 'no'. Case insensitive
257 # Params: $1 text to ask; $2 Action by default, can be 'y' for yes, 'n' for no, other or empty for not allowed
258 # Return: true(0) if user type 'yes'; false (1) if user type 'no'
259 read -e -p "$1" USER_CONFIRMATION
260 while true ; do
261 [ -z "$USER_CONFIRMATION" ] && [ "$2" == 'y' ] && return 0
262 [ -z "$USER_CONFIRMATION" ] && [ "$2" == 'n' ] && return 1
263 [ "${USER_CONFIRMATION,,}" == "yes" ] || [ "${USER_CONFIRMATION,,}" == "y" ] && return 0
264 [ "${USER_CONFIRMATION,,}" == "no" ] || [ "${USER_CONFIRMATION,,}" == "n" ] && return 1
265 read -e -p "Please type 'yes' or 'no': " USER_CONFIRMATION
266 done
267 }
268
269 UNINSTALL=""
270 DEVELOP=""
271 NAT=""
272 UPDATE=""
273 RECONFIGURE=""
274 TEST_INSTALLER=""
275 LXD=""
276 SHOWOPTS=""
277 COMMIT_ID=""
278 ASSUME_YES=""
279 INSTALL_FROM_SOURCE=""
280
281 while getopts ":hy-:b:r:k:u:R:" o; do
282 case "${o}" in
283 h)
284 usage && exit 0
285 ;;
286 b)
287 COMMIT_ID=${OPTARG}
288 ;;
289 r)
290 REPOSITORY="-r ${OPTARG}"
291 ;;
292 R)
293 RELEASE="-R ${OPTARG}"
294 ;;
295 k)
296 REPOSITORY_KEY="-k ${OPTARG}"
297 ;;
298 u)
299 REPOSITORY_BASE="-u ${OPTARG}"
300 ;;
301 -)
302 [ "${OPTARG}" == "help" ] && usage && exit 0
303 [ "${OPTARG}" == "source" ] && INSTALL_FROM_SOURCE="y" && continue
304 [ "${OPTARG}" == "develop" ] && DEVELOP="y" && continue
305 [ "${OPTARG}" == "uninstall" ] && UNINSTALL="y" && continue
306 [ "${OPTARG}" == "nat" ] && NAT="y" && continue
307 [ "${OPTARG}" == "update" ] && UPDATE="y" && continue
308 [ "${OPTARG}" == "reconfigure" ] && RECONFIGURE="y" && continue
309 [ "${OPTARG}" == "test" ] && TEST_INSTALLER="y" && continue
310 [ "${OPTARG}" == "lxd" ] && LXD="y" && continue
311 [ "${OPTARG}" == "showopts" ] && SHOWOPTS="y" && continue
312 echo -e "Invalid option: '--$OPTARG'\n" >&2
313 usage && exit 1
314 ;;
315 \?)
316 echo -e "Invalid option: '-$OPTARG'\n" >&2
317 usage && exit 1
318 ;;
319 y)
320 ASSUME_YES="y"
321 ;;
322 *)
323 usage && exit 1
324 ;;
325 esac
326 done
327
328 if [ -n "$SHOWOPTS" ]; then
329 echo "DEVELOP=$DEVELOP"
330 echo "INSTALL_FROM_SOURCE=$INSTALL_FROM_SOURCE"
331 echo "UNINSTALL=$UNINSTALL"
332 echo "NAT=$NAT"
333 echo "UPDATE=$UPDATE"
334 echo "RECONFIGURE=$RECONFIGURE"
335 echo "TEST_INSTALLER=$TEST_INSTALLER"
336 echo "LXD=$LXD"
337 echo "SHOWOPTS=$SHOWOPTS"
338 echo "Install from specific refspec (-b): $COMMIT_ID"
339 exit 0
340 fi
341
342 # if develop, we force master
343 [ -z "$COMMIT_ID" ] && [ -n "$DEVELOP" ] && COMMIT_ID="master"
344
345 # forcing source from master removed. Now only install from source when explicit
346 # [ -n "$COMMIT_ID" ] && [ "$COMMIT_ID" == "master" ] && INSTALL_FROM_SOURCE="y"
347
348 if [ -n "$TEST_INSTALLER" ]; then
349 echo -e "\nUsing local devops repo for OSM installation"
350 TEMPDIR="$(dirname $(realpath $(dirname $0)))"
351 else
352 echo -e "\nCreating temporary dir for OSM installation"
353 TEMPDIR="$(mktemp -d -q --tmpdir "installosm.XXXXXX")"
354 trap 'rm -rf "$TEMPDIR"' EXIT
355 fi
356
357 echo -e "Checking required packages: git"
358 dpkg -l git &>/dev/null || ! echo -e " git not installed.\nInstalling git requires root privileges" || sudo apt-get install -y git
359 if [ -z "$TEST_INSTALLER" ]; then
360 echo -e "\nCloning devops repo temporarily"
361 git clone https://osm.etsi.org/gerrit/osm/devops.git $TEMPDIR
362 RC_CLONE=$?
363 fi
364
365 echo -e "\nGuessing the current stable release"
366 LATEST_STABLE_DEVOPS=`git -C $TEMPDIR tag -l v[0-9].* | tail -n1`
367 [ -z "$COMMIT_ID" ] && [ -z "$LATEST_STABLE_DEVOPS" ] && echo "Could not find the current latest stable release" && exit 0
368 echo "Latest tag in devops repo: $LATEST_STABLE_DEVOPS"
369 [ -z "$COMMIT_ID" ] && [ -n "$LATEST_STABLE_DEVOPS" ] && COMMIT_ID="tags/$LATEST_STABLE_DEVOPS"
370 [ -z "$TEST_INSTALLER" ] && git -C $TEMPDIR checkout tags/$LATEST_STABLE_DEVOPS
371
372 OSM_DEVOPS=$TEMPDIR
373 OSM_JENKINS="$TEMPDIR/jenkins"
374 . $OSM_JENKINS/common/all_funcs
375
376 [ -n "$UNINSTALL" ] && uninstall && echo -e "\nDONE" && exit 0
377 [ -n "$NAT" ] && nat && echo -e "\nDONE" && exit 0
378 [ -n "$UPDATE" ] && update && echo -e "\nDONE" && exit 0
379 [ -n "$RECONFIGURE" ] && configure && echo -e "\nDONE" && exit 0
380
381 #Installation starts here
382 echo -e "\nInstalling OSM from refspec: $COMMIT_ID"
383 if [ -n "$INSTALL_FROM_SOURCE" ] && [ -z "$ASSUME_YES" ]; then
384 ! ask_user "The installation will take about 75-90 minutes. Continue (Y/n)? " y && echo "Cancelled!" && exit 1
385 fi
386
387 echo -e "\nChecking required packages: wget, curl, tar"
388 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
389
390 echo -e "Checking required packages: lxd"
391 lxd --version &>/dev/null || FATAL "lxd not present, exiting."
392 [ -n "$LXD" ] && echo -e "\nConfiguring lxd" && install_lxd
393
394 wget -q -O- https://osm-download.etsi.org/ftp/osm-2.0-two/README.txt &> /dev/null
395
396 # use local devops for containers
397 export OSM_USE_LOCAL_DEVOPS=true
398 if [ -z "$INSTALL_FROM_SOURCE" ]; then
399 echo -e "\nCreating the containers and installing from binaries ..."
400 $OSM_DEVOPS/jenkins/host/install RO $REPOSITORY $RELEASE $REPOSITORY_KEY $REPOSITORY_BASE || FATAL "RO install failed"
401 $OSM_DEVOPS/jenkins/host/start_build VCA || FATAL "VCA install failed"
402 $OSM_DEVOPS/jenkins/host/install SO $REPOSITORY $RELEASE $REPOSITORY_KEY $REPOSITORY_BASE || FATAL "SO install failed"
403 $OSM_DEVOPS/jenkins/host/install UI $REPOSITORY $RELEASE $REPOSITORY_KEY $REPOSITORY_BASE || FATAL "UI install failed"
404 else #install from source
405 echo -e "\nCreating the containers and building from source ..."
406 $OSM_DEVOPS/jenkins/host/start_build RO --notest checkout $COMMIT_ID || FATAL "RO container build failed (refspec: '$COMMIT_ID')"
407 $OSM_DEVOPS/jenkins/host/start_build VCA || FATAL "VCA container build failed"
408 $OSM_DEVOPS/jenkins/host/start_build SO checkout $COMMIT_ID || FATAL "SO container build failed (refspec: '$COMMIT_ID')"
409 $OSM_DEVOPS/jenkins/host/start_build UI checkout $COMMIT_ID || FATAL "UI container build failed (refspec: '$COMMIT_ID')"
410 fi
411
412 #Install iptables-persistent and configure NAT rules
413 nat
414
415 #Configure components
416 configure
417
418 wget -q -O- https://osm-download.etsi.org/ftp/osm-2.0-two/README2.txt &> /dev/null
419 echo -e "\nDONE"