4 # Copyright 2015 Telefonica Investigacion y Desarrollo, S.A.U.
5 # This file is part of openmano
8 # Licensed under the Apache License, Version 2.0 (the "License"); you may
9 # not use this file except in compliance with the License. You may obtain
10 # a copy of the License at
12 # http://www.apache.org/licenses/LICENSE-2.0
14 # Unless required by applicable law or agreed to in writing, software
15 # distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
16 # WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
17 # License for the specific language governing permissions and limitations
20 # For those usages not covered by the Apache License, Version 2.0 please
21 # contact with: nfvlabs@tid.es
24 #ONLY TESTED in Ubuntu 16.04 partially tested in Ubuntu 14.10 14.04 16.04, CentOS7 and RHEL7
25 #Get needed packages, source code and configure to run openmano
26 #Ask for database user and password if not provided
29 echo -e "usage: sudo -E $0 [OPTIONS]"
30 echo -e "Install last stable source code in ./openmano and the needed packages"
31 echo -e "On a Ubuntu 16.04 it configures openmano as a service"
33 echo -e " -u USER: database admin user. 'root' by default. Prompts if needed"
34 echo -e " -p PASS: database admin password to be used or installed. Prompts if needed"
35 echo -e " -q --quiet: install in unattended mode"
36 echo -e " -h --help: show this help"
37 echo -e " -b REFSPEC: install from source code using a specific branch (master, v2.0, ...) or tag"
38 echo -e " -b master (main RO branch)"
39 echo -e " -b v2.0 (v2.0 branch)"
40 echo -e " -b tags/v1.1.0 (a specific tag)"
42 echo -e " --develop: install last version for developers, and do not configure as a service"
43 echo -e " --forcedb: reinstall mano_db DB, deleting previous database if exists and creating a new one"
44 echo -e " --updatedb: do not reinstall mano_db DB if it exists, just update database"
45 echo -e " --force: makes idenpotent, delete previous installations folders if needed. It assumes --updatedb if --forcedb option is not provided"
46 echo -e " --noclone: assumes that openmano was cloned previously and that this script is run from the local repo"
47 echo -e " --no-install-packages: use this option to skip updating and installing the requires packages. This avoid wasting time if you are sure requires packages are present e.g. because of a previous installation"
48 echo -e " --no-db: do not install mysql server"
51 function install_packages
(){
52 [ -x /usr
/bin
/apt-get
] && apt-get
install -y $
*
53 [ -x /usr
/bin
/yum
] && yum
install -y $
*
55 #check properly installed
58 PACKAGE_INSTALLED
="no"
59 [ -x /usr
/bin
/apt-get
] && dpkg
-l $PACKAGE &>> /dev
/null
&& PACKAGE_INSTALLED
="yes"
60 [ -x /usr
/bin
/yum
] && yum list installed
$PACKAGE &>> /dev
/null
&& PACKAGE_INSTALLED
="yes"
61 if [ "$PACKAGE_INSTALLED" = "no" ]
63 echo "failed to install package '$PACKAGE'. Revise network connectivity and try again" >&2
70 # ask to the user and parse a response among 'y', 'yes', 'n' or 'no'. Case insensitive
71 # Params: $1 text to ask; $2 Action by default, can be 'y' for yes, 'n' for no, other or empty for not allowed
72 # Return: true(0) if user type 'yes'; false (1) if user type 'no'
73 read -e -p "$1" USER_CONFIRMATION
75 [ -z "$USER_CONFIRMATION" ] && [ "$2" == 'y' ] && return 0
76 [ -z "$USER_CONFIRMATION" ] && [ "$2" == 'n' ] && return 1
77 [ "${USER_CONFIRMATION,,}" == "yes" ] ||
[ "${USER_CONFIRMATION,,}" == "y" ] && return 0
78 [ "${USER_CONFIRMATION,,}" == "no" ] ||
[ "${USER_CONFIRMATION,,}" == "n" ] && return 1
79 read -e -p "Please type 'yes' or 'no': " USER_CONFIRMATION
83 GIT_URL
=https
://osm.etsi.org
/gerrit
/osm
/RO.git
84 export GIT_OVIM_URL
=https
://osm.etsi.org
/gerrit
/osm
/openvim.git
85 export GIT_OSMIM_URL
=https
://osm.etsi.org
/gerrit
/osm
/IM.git
99 while getopts ":u:p:b:hiq-:" o
; do
102 export DBUSER
="$OPTARG"
105 export DBPASSWD
="$OPTARG"
106 export DBPASSWD_PARAM
="-p$OPTARG"
109 export COMMIT_ID
=${OPTARG}
112 export QUIET_MODE
=yes
113 export DEBIAN_FRONTEND
=noninteractive
119 [ "${OPTARG}" == "help" ] && usage
&& exit 0
120 [ "${OPTARG}" == "develop" ] && export DEVELOP
="y" && continue
121 [ "${OPTARG}" == "forcedb" ] && DB_FORCE_UPDATE
="${DB_FORCE_UPDATE}--forcedb" && continue
122 [ "${OPTARG}" == "updatedb" ] && DB_FORCE_UPDATE
="${DB_FORCE_UPDATE}--updatedb" && continue
123 [ "${OPTARG}" == "force" ] && FORCE
="y" && continue
124 [ "${OPTARG}" == "noclone" ] && NOCLONE
="y" && continue
125 [ "${OPTARG}" == "quiet" ] && export QUIET_MODE
=yes && export DEBIAN_FRONTEND
=noninteractive
&& continue
126 [ "${OPTARG}" == "no-install-packages" ] && export NO_PACKAGES
=yes && continue
127 [ "${OPTARG}" == "no-db" ] && NO_DB
="y" && continue
128 echo -e "Invalid option: '--$OPTARG'\nTry $0 --help for more information" >&2
132 echo -e "Invalid option: '-$OPTARG'\nTry $0 --help for more information" >&2
136 echo -e "Option '-$OPTARG' requires an argument\nTry $0 --help for more information" >&2
146 if [ "$DB_FORCE_UPDATE" == "--forcedb--updatedb" ] ||
[ "$DB_FORCE_UPDATE" == "--updatedb--forcedb" ] ; then
147 echo "Error: options --forcedb and --updatedb are mutually exclusive" >&2
149 elif [ -n "$FORCE" ] && [ -z "$DB_FORCE_UPDATE" ] ; then
150 DB_FORCE_UPDATE
="--updatedb"
153 #check root privileges and non a root user behind
154 [ "$USER" != "root" ] && echo "Needed root privileges" >&2 && exit 1
155 if [[ -z "$SUDO_USER" ]] ||
[[ "$SUDO_USER" = "root" ]]
157 [[ -z $QUIET_MODE ]] && ! ask_user
"Install in the root user (y/N)? " n
&& echo "Cancelled" && exit 1
158 export SUDO_USER
=root
161 # Discover Linux distribution
163 [ -f /etc
/redhat-release
] && _DISTRO
=$
(cat /etc
/redhat-release
2>/dev
/null | cut
-d" " -f1)
164 # if not assuming ubuntu type
165 [ -f /etc
/redhat-release
] || _DISTRO
=$
(lsb_release
-is 2>/dev
/null
)
166 if [ "$_DISTRO" == "Ubuntu" ]
168 _RELEASE
=$
(lsb_release
-rs)
169 if [[ ${_RELEASE%%.*} != 14 ]] && [[ ${_RELEASE%%.*} != 16 ]]
171 [[ -z $QUIET_MODE ]] &&
172 ! ask_user
"WARNING! Not tested Ubuntu version. Continue assuming a trusty (14.XX)' (y/N)? " n
&&
173 echo "Cancelled" && exit 1
176 elif [ "$_DISTRO" == "CentOS" ]
179 if ! cat /etc
/redhat-release |
grep -q "7."
181 [[ -z $QUIET_MODE ]] &&
182 ! ask_user
"WARNING! Not tested CentOS version. Continue assuming a '$_RELEASE' type (y/N)? " n
&&
183 echo "Cancelled" && exit 1
185 elif [ "$_DISTRO" == "Red" ]
188 if ! cat /etc
/redhat-release |
grep -q "7."
190 [[ -z $QUIET_MODE ]] &&
191 ! ask_user
"WARNING! Not tested Red Hat OS version. Continue assuming a '$_RELEASE' type (y/N)? " n
&&
192 echo "Cancelled" && exit 1
194 else #[ "$_DISTRO" != "Ubuntu" -a "$_DISTRO" != "CentOS" -a "$_DISTRO" != "Red" ]
195 _DISTRO_DISCOVER
=$_DISTRO
196 [ -x /usr
/bin
/apt-get
] && _DISTRO
="Ubuntu" && _RELEASE
="14"
197 [ -x /usr
/bin
/yum
] && _DISTRO
="CentOS" && _RELEASE
="7"
198 [[ -z $QUIET_MODE ]] &&
199 ! ask_user
"WARNING! Not tested Linux distribution '$_DISTRO_DISCOVER '. Continue assuming a '$_DISTRO $_RELEASE' type (y/N)? " n
&&
200 echo "Cancelled" && exit 1
203 export _DISTRO
="$_DISTRO"
204 #check if installed as a service
205 INSTALL_AS_A_SERVICE
=""
206 [[ "$_DISTRO" == "Ubuntu" ]] && [[ ${_RELEASE%%.*} == 16 ]] && [[ -z $DEVELOP ]] && INSTALL_AS_A_SERVICE
="y"
208 # Next operations require knowing BASEFOLDER
209 if [[ -z "$NOCLONE" ]]; then
210 if [[ -n "$INSTALL_AS_A_SERVICE" ]] ; then
211 export BASEFOLDER
=__openmano__
${RANDOM}
213 export BASEFOLDER
="${PWD}/openmano"
215 [[ -n "$FORCE" ]] && rm -rf $BASEFOLDER #make idempotent
217 HERE
=$
(dirname $
(readlink
-f ${BASH_SOURCE[0]}))
218 export BASEFOLDER
=$
(dirname $HERE)
221 if [[ -z "$NO_PACKAGES" ]]
224 "#################################################################\n"\
225 "##### UPDATE REPOSITORIES #####\n"\
226 "#################################################################"
227 [ "$_DISTRO" == "Ubuntu" ] && apt-get update
-y &&
228 add-apt-repository
-y cloud-archive
:queens
&& apt-get update
-y
230 [ "$_DISTRO" == "CentOS" -o "$_DISTRO" == "Red" ] && yum check-update
-y
231 [ "$_DISTRO" == "CentOS" ] && yum
install -y epel-release
232 [ "$_DISTRO" == "Red" ] && wget http
://dl.fedoraproject.org
/pub
/epel
/7/x86_64
/e
/epel-release-7-5.noarch.rpm \
233 && rpm
-ivh epel-release-7-5.noarch.rpm
&& yum
install -y epel-release
&& rm -f epel-release-7-5.noarch.rpm
234 [ "$_DISTRO" == "CentOS" -o "$_DISTRO" == "Red" ] && yum repolist
237 "#################################################################\n"\
238 "##### INSTALL REQUIRED PACKAGES #####\n"\
239 "#################################################################"
240 [ "$_DISTRO" == "Ubuntu" ] && install_packages
"git make screen wget mysql-client"
241 [ "$_DISTRO" == "CentOS" -o "$_DISTRO" == "Red" ] && install_packages
"git make screen wget mariadb-client"
244 "#################################################################\n"\
245 "##### INSTALL PYTHON PACKAGES #####\n"\
246 "#################################################################"
247 [ "$_DISTRO" == "Ubuntu" ] && install_packages
"python-yaml python-bottle python-mysqldb python-jsonschema "\
248 "python-paramiko python-argcomplete python-requests python-logutils libxml2-dev libxslt-dev python-dev "\
249 "python-pip python-crypto python-networkx"
250 [ "$_DISTRO" == "CentOS" -o "$_DISTRO" == "Red" ] && install_packages
"PyYAML MySQL-python python-jsonschema "\
251 "python-paramiko python-argcomplete python-requests python-logutils libxslt-devel libxml2-devel python-devel "\
252 "python-pip python-crypto python-networkx"
253 # The only way to install python-bottle on Centos7 is with easy_install or pip
254 [ "$_DISTRO" == "CentOS" -o "$_DISTRO" == "Red" ] && easy_install
-U bottle
256 # required for vmware connector TODO move that to separete opt in install script
257 pip2
install pip
==9.0.3 ||
exit 1 # --upgrade pip install pip 10 that does not work
258 pip2
install pyvcloud
==19.1.1 ||
exit 1
259 pip2
install progressbar ||
exit 1
260 pip2
install prettytable ||
exit 1
261 pip2
install pyvmomi ||
exit 1
262 [ "$_DISTRO" == "Ubuntu" ] && install_packages
"genisoimage"
263 [ "$_DISTRO" == "CentOS" -o "$_DISTRO" == "Red" ] && install_packages
"genisoimage"
265 # required for fog connector
266 pip2
install fog05rest ||
exit 1
268 # required for OpenNebula connector
269 pip2
install untangle ||
exit 1
270 pip2
install pyone ||
exit 1
271 pip2
install -e git
+https
://github.com
/python-oca
/python-oca
#egg=oca || exit 1
273 # required for AWS connector
274 [ "$_DISTRO" == "Ubuntu" ] && install_packages
"python-boto"
275 [ "$_DISTRO" == "CentOS" -o "$_DISTRO" == "Red" ] && install_packages
"python-boto" #TODO check if at Centos it exists with this name, or PIP should be used
277 # install openstack client needed for using openstack as a VIM
278 [ "$_DISTRO" == "Ubuntu" ] && install_packages
"python-novaclient python-keystoneclient python-glanceclient "\
279 "python-neutronclient python-cinderclient python-openstackclient "\
280 "python-networking-l2gw"
281 [ "$_DISTRO" == "CentOS" -o "$_DISTRO" == "Red" ] && install_packages
"python-devel" && easy_install \
282 python-novaclient python-keystoneclient python-glanceclient python-neutronclient python-cinderclient \
283 python-openstackclient python-networking-l2gw
#TODO revise if gcc python-pip is needed
288 fi # [[ -z "$NO_PACKAGES" ]]
290 if [[ -z $NOCLONE ]]; then
292 "#################################################################\n"\
293 "##### DOWNLOAD SOURCE #####\n"\
294 "#################################################################"
295 if [[ -d "${BASEFOLDER}" ]] ; then
296 if [[ -n "$FORCE" ]] ; then
297 echo "deleting '${BASEFOLDER}' folder"
298 rm -rf "$BASEFOLDER" #make idempotent
299 elif [[ -z "$QUIET_MODE" ]] ; then
300 ! ask_user
"folder '${BASEFOLDER}' exists, overwrite (y/N)? " n
&& echo "Cancelled!" && exit 1
303 echo "'${BASEFOLDER}' folder exists. Use "--force" to overwrite" >&2 && exit 1
306 su
$SUDO_USER -c "git clone ${GIT_URL} ${BASEFOLDER}" ||
! echo "Error cannot clone from '$GIT_URL'" >&2 ||
exit 1
307 if [[ -n $COMMIT_ID ]] ; then
308 echo -e "Installing osm-RO from refspec: $COMMIT_ID"
309 su
$SUDO_USER -c "git -C ${BASEFOLDER} checkout $COMMIT_ID" ||
310 ! echo "Error cannot checkout '$COMMIT_ID' from '$GIT_URL'" >&2 ||
exit 1
311 elif [[ -z $DEVELOP ]]; then
312 LATEST_STABLE_TAG
=`git -C "${BASEFOLDER}" tag -l "v[0-9]*" | sort -V | tail -n1`
313 echo -e "Installing osm-RO from refspec: tags/${LATEST_STABLE_TAG}"
314 su
$SUDO_USER -c "git -C ${BASEFOLDER} checkout tags/${LATEST_STABLE_TAG}" ||
315 ! echo "Error cannot checkout 'tags/${LATEST_STABLE_TAG}' from '$GIT_URL'" >&2 ||
exit 1
317 echo -e "Installing osm-RO from refspec: master"
319 su
$SUDO_USER -c "cp ${BASEFOLDER}/.gitignore-common ${BASEFOLDER}/.gitignore"
323 "#################################################################\n"\
324 "##### INSTALLING OSM-IM LIBRARY #####\n"\
325 "#################################################################"
326 ${BASEFOLDER}/scripts
/install-osm-im.sh
327 OSM_IM_PATH
=`python -c 'import osm_im; print osm_im.__path__[0]'` ||
328 ! echo "ERROR installing python-osm-im library!!!" >&2 ||
exit 1
331 "#################################################################\n"\
332 "##### INSTALLING OVIM LIBRARY #####\n"\
333 "#################################################################"
334 ${BASEFOLDER}/scripts
/install-lib-osm-openvim.sh
335 OSMLIBOVIM_PATH
=`python -c 'import lib_osm_openvim; print lib_osm_openvim.__path__[0]'` ||
336 ! echo "ERROR installing python-lib-osm-openvim library!!!" >&2 ||
exit 1
338 if [ "$_DISTRO" == "CentOS" -o "$_DISTRO" == "Red" ]
341 "#################################################################\n"\
342 "##### CONFIGURE firewalld #####\n"\
343 "#################################################################"
344 if [[ -z $QUIET_MODE ]] || ask_user
"Configure firewalld for openmanod port 9090 (Y/n)? " y
346 #Creates a service file for openmano
347 echo '<?xml version="1.0" encoding="utf-8"?>
349 <short>openmanod</short>
350 <description>openmanod service</description>
351 <port protocol="tcp" port="9090"/>
352 </service>' > /etc
/firewalld
/services
/openmanod.xml
353 #put proper permissions
354 pushd /etc
/firewalld
/services
> /dev
/null
355 restorecon openmanod.xml
356 chmod 640 openmanod.xml
358 #Add the openmanod service to the default zone permanently and reload the firewall configuration
359 firewall-cmd
--permanent --add-service=openmanod
> /dev
/null
360 firewall-cmd
--reload > /dev
/null
368 "#################################################################\n"\
369 "##### CONFIGURE OPENMANO CLIENT #####\n"\
370 "#################################################################"
371 #creates a link at ~/bin if not configured as a service
372 if [[ -z "$INSTALL_AS_A_SERVICE" ]]
374 su
$SUDO_USER -c 'mkdir -p ${HOME}/bin'
375 su
$SUDO_USER -c 'rm -f ${HOME}/bin/openmano'
376 su
$SUDO_USER -c 'rm -f ${HOME}/bin/openmano-report'
377 su
$SUDO_USER -c 'rm -f ${HOME}/bin/service-openmano'
378 su
$SUDO_USER -c "ln -s '${BASEFOLDER}/openmano' "'${HOME}/bin/openmano'
379 su
$SUDO_USER -c "ln -s '${BASEFOLDER}/scripts/openmano-report.sh' "'${HOME}/bin/openmano-report'
380 su
$SUDO_USER -c "ln -s '${BASEFOLDER}/scripts/service-openmano' "'${HOME}/bin/service-openmano'
382 #insert /home/<user>/bin in the PATH
383 #skiped because normally this is done authomatically when ~/bin exists
384 #if ! su $SUDO_USER -c 'echo $PATH' | grep -q "${HOME}/bin"
386 # echo " inserting /home/$SUDO_USER/bin in the PATH at .bashrc"
387 # su $SUDO_USER -c 'echo "PATH=\$PATH:\${HOME}/bin" >> ~/.bashrc'
390 if [[ $SUDO_USER == root
]]
392 if ! echo $PATH |
grep -q "${HOME}/bin"
394 echo "PATH=\$PATH:\${HOME}/bin" >> ${HOME}/.bashrc
399 #configure arg-autocomplete for this user
400 #in case of minimal instalation this package is not installed by default
401 [[ "$_DISTRO" == "CentOS" ||
"$_DISTRO" == "Red" ]] && yum
install -y bash-completion
402 #su $SUDO_USER -c 'mkdir -p ~/.bash_completion.d'
403 su
$SUDO_USER -c 'activate-global-python-argcomplete --user'
404 if ! su
$SUDO_USER -c 'grep -q bash_completion.d/python-argcomplete.sh ${HOME}/.bashrc'
406 echo " inserting .bash_completion.d/python-argcomplete.sh execution at .bashrc"
407 su
$SUDO_USER -c 'echo ". ${HOME}/.bash_completion.d/python-argcomplete.sh" >> ~/.bashrc'
410 if [ -z "$NO_DB" ]; then
412 "#################################################################\n"\
413 "##### INSTALL DATABASE SERVER #####\n"\
414 "#################################################################"
416 if [ -n "$QUIET_MODE" ]; then
419 ${BASEFOLDER}/database_utils
/install-db-server.sh
-U $DBUSER ${DBPASSWD_PARAM/p/P} $DB_QUIET $DB_FORCE_UPDATE ||
exit 1
421 "#################################################################\n"\
422 "##### CREATE AND INIT MANO_VIM DATABASE #####\n"\
423 "#################################################################"
424 # Install mano_vim_db after setup
425 ${OSMLIBOVIM_PATH}/database_utils
/install-db-server.sh
-U $DBUSER ${DBPASSWD_PARAM/p/P} -u mano
-p manopw
-d mano_vim_db
--no-install-packages $DB_QUIET $DB_FORCE_UPDATE ||
exit 1
428 if [[ -n "$INSTALL_AS_A_SERVICE" ]]
431 "#################################################################\n"\
432 "##### CONFIGURE OPENMANO SERVICE #####\n"\
433 "#################################################################"
435 ${BASEFOLDER}/scripts
/install-openmano-service.sh
-f ${BASEFOLDER} `[[ -z "$NOCLONE" ]] && echo "-d"`
436 # rm -rf ${BASEFOLDER}
437 # alias service-openmano="service openmano"
438 # echo 'alias service-openmano="service openmano"' >> ${HOME}/.bashrc
440 echo "Done! installed at /opt/openmano"
441 echo " Manage server with 'sudo -E service osm-ro start|stop|status|...' "
444 echo "Done! you may need to logout and login again for loading client configuration"
445 echo " Run './${BASEFOLDER}/scripts/service-openmano start' for starting openmano in a screen"