4 # Copyright 2015 Telefónica Investigación 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 $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 " --develop: install last version for developers, and do not configure as a service"
38 echo -e " --forcedb: reinstall mano_db DB, deleting previous database if exists and creating a new one"
39 echo -e " --force: makes idenpotent, delete previous installations folders if needed"
40 echo -e " --noclone: assumes that openmano was cloned previously and that this script is run from the local repo"
41 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"
44 function install_packages
(){
45 [ -x /usr
/bin
/apt-get
] && apt-get
install -y $
*
46 [ -x /usr
/bin
/yum
] && yum
install -y $
*
48 #check properly installed
51 PACKAGE_INSTALLED
="no"
52 [ -x /usr
/bin
/apt-get
] && dpkg
-l $PACKAGE &>> /dev
/null
&& PACKAGE_INSTALLED
="yes"
53 [ -x /usr
/bin
/yum
] && yum list installed
$PACKAGE &>> /dev
/null
&& PACKAGE_INSTALLED
="yes"
54 if [ "$PACKAGE_INSTALLED" = "no" ]
56 echo "failed to install package '$PACKAGE'. Revise network connectivity and try again" >&2
62 function db_exists
() {
63 RESULT
=`mysqlshow --defaults-extra-file="$2" | grep -v Wildcard | grep -o $1`
64 if [ "$RESULT" == "$1" ]; then
68 echo " DB $1 does not exist"
72 GIT_URL
=https
://osm.etsi.org
/gerrit
/osm
/RO.git
73 GIT_OVIM_URL
=https
://osm.etsi.org
/gerrit
/osm
/openvim.git
83 while getopts ":u:p:hiq-:" o
; do
86 export DBUSER
="$OPTARG"
89 export DBPASSWD
="$OPTARG"
90 export DBPASSWD_PARAM
="-p$OPTARG"
94 export DEBIAN_FRONTEND
=noninteractive
100 [ "${OPTARG}" == "help" ] && usage
&& exit 0
101 [ "${OPTARG}" == "develop" ] && DEVELOP
="y" && continue
102 [ "${OPTARG}" == "forcedb" ] && FORCEDB
="y" && continue
103 [ "${OPTARG}" == "force" ] && FORCEDB
="y" && FORCE
="y" && continue
104 [ "${OPTARG}" == "noclone" ] && NOCLONE
="y" && continue
105 [ "${OPTARG}" == "quiet" ] && export QUIET_MODE
=yes && export DEBIAN_FRONTEND
=noninteractive
&& continue
106 [ "${OPTARG}" == "no-install-packages" ] && export NO_PACKAGES
=yes && continue
107 echo -e "Invalid option: '--$OPTARG'\nTry $0 --help for more information" >&2
111 echo -e "Invalid option: '-$OPTARG'\nTry $0 --help for more information" >&2
115 echo -e "Option '-$OPTARG' requires an argument\nTry $0 --help for more information" >&2
125 #check root privileges and non a root user behind
126 [ "$USER" != "root" ] && echo "Needed root privileges" >&2 && exit 1
127 if [[ -z "$SUDO_USER" ]] ||
[[ "$SUDO_USER" = "root" ]]
129 [[ -z $QUIET_MODE ]] && read -e -p "Install in the root user (y/N)?" KK
130 [[ -z $QUIET_MODE ]] && [[ "$KK" != "y" ]] && [[ "$KK" != "yes" ]] && echo "Cancelled" && exit 1
131 export SUDO_USER
=root
134 #Discover Linux distribution
136 [ -f /etc
/redhat-release
] && _DISTRO
=$
(cat /etc
/redhat-release
2>/dev
/null | cut
-d" " -f1)
137 #if not assuming ubuntu type
138 [ -f /etc
/redhat-release
] || _DISTRO
=$
(lsb_release
-is 2>/dev
/null
)
139 if [ "$_DISTRO" == "Ubuntu" ]
141 _RELEASE
=$
(lsb_release
-rs)
142 if [[ ${_RELEASE%%.*} != 14 ]] && [[ ${_RELEASE%%.*} != 16 ]]
144 [[ -z $QUIET_MODE ]] && read -e -p "WARNING! Not tested Ubuntu version. Continue assuming a trusty (14.XX)'? (y/N)" KK
145 [[ -z $QUIET_MODE ]] && [[ "$KK" != "y" ]] && [[ "$KK" != "yes" ]] && echo "Cancelled" && exit 1
148 elif [ "$_DISTRO" == "CentOS" ]
151 if ! cat /etc
/redhat-release |
grep -q "7."
153 [[ -z $QUIET_MODE ]] && read -e -p "WARNING! Not tested CentOS version. Continue assuming a '_RELEASE' type? (y/N)" KK
154 [[ -z $QUIET_MODE ]] && [[ "$KK" != "y" ]] && [[ "$KK" != "yes" ]] && echo "Cancelled" && exit 1
156 elif [ "$_DISTRO" == "Red" ]
159 if ! cat /etc
/redhat-release |
grep -q "7."
161 [[ -z $QUIET_MODE ]] && read -e -p "WARNING! Not tested Red Hat OS version. Continue assuming a '_RELEASE' type? (y/N)" KK
162 [[ -z $QUIET_MODE ]] && [[ "$KK" != "y" ]] && [[ "$KK" != "yes" ]] && echo "Cancelled" && exit 1
164 else #[ "$_DISTRO" != "Ubuntu" -a "$_DISTRO" != "CentOS" -a "$_DISTRO" != "Red" ]
165 _DISTRO_DISCOVER
=$_DISTRO
166 [ -x /usr
/bin
/apt-get
] && _DISTRO
="Ubuntu" && _RELEASE
="14"
167 [ -x /usr
/bin
/yum
] && _DISTRO
="CentOS" && _RELEASE
="7"
168 [[ -z $QUIET_MODE ]] && read -e -p "WARNING! Not tested Linux distribution '$_DISTRO_DISCOVER '. Continue assuming a '$_DISTRO $_RELEASE' type? (y/N)" KK
169 [[ -z $QUIET_MODE ]] && [[ "$KK" != "y" ]] && [[ "$KK" != "yes" ]] && echo "Cancelled" && exit 1
172 #check if installed as a service
173 INSTALL_AS_A_SERVICE
=""
174 [[ "$_DISTRO" == "Ubuntu" ]] && [[ ${_RELEASE%%.*} == 16 ]] && [[ -z $DEVELOP ]] && INSTALL_AS_A_SERVICE
="y"
175 #Next operations require knowing OPENMANO_BASEFOLDER
176 if [[ -z "$NOCLONE" ]]; then
177 if [[ -n "$INSTALL_AS_A_SERVICE" ]] ; then
178 OPENMANO_BASEFOLDER
=__openmano__
${RANDOM}
180 OPENMANO_BASEFOLDER
="${PWD}/openmano"
182 [[ -n "$FORCE" ]] && rm -rf $OPENMANO_BASEFOLDER #make idempotent
184 HERE
=$
(realpath $
(dirname $0))
185 OPENMANO_BASEFOLDER
=$
(dirname $HERE)
189 if [[ -z "$NO_PACKAGES" ]]
192 #################################################################
193 ##### UPDATE REPOSITORIES #####
194 #################################################################'
195 [ "$_DISTRO" == "Ubuntu" ] && apt-get update
-y
197 [ "$_DISTRO" == "CentOS" -o "$_DISTRO" == "Red" ] && yum check-update
-y
198 [ "$_DISTRO" == "CentOS" ] && sudo yum
install -y epel-release
199 [ "$_DISTRO" == "Red" ] && wget http
://dl.fedoraproject.org
/pub
/epel
/7/x86_64
/e
/epel-release-7-5.noarch.rpm \
200 && sudo rpm
-ivh epel-release-7-5.noarch.rpm
&& sudo yum
install -y epel-release
&& rm -f epel-release-7-5.noarch.rpm
201 [ "$_DISTRO" == "CentOS" -o "$_DISTRO" == "Red" ] && sudo yum repolist
205 if [[ -z "$NO_PACKAGES" ]]
208 #################################################################
209 ##### INSTALL REQUIRED PACKAGES #####
210 #################################################################'
211 [ "$_DISTRO" == "Ubuntu" ] && install_packages
"git make screen wget mysql-server"
212 [ "$_DISTRO" == "CentOS" -o "$_DISTRO" == "Red" ] && install_packages
"git make screen wget mariadb mariadb-server"
214 if [[ "$_DISTRO" == "Ubuntu" ]]
216 #start services. By default CentOS does not start services
217 service mysql start
>> /dev
/null
218 # try to set admin password, ignore if fails
219 [[ -n $DBPASSWD ]] && mysqladmin
-u $DBUSER -s password
$DBPASSWD
222 if [ "$_DISTRO" == "CentOS" -o "$_DISTRO" == "Red" ]
224 #start services. By default CentOS does not start services
225 service mariadb start
227 systemctl
enable mariadb
228 systemctl
enable httpd
229 read -e -p "Do you want to configure mariadb (recommended if not done before) (Y/n)" KK
230 [ "$KK" != "n" -a "$KK" != "no" ] && mysql_secure_installation
232 read -e -p "Do you want to set firewall to grant web access port 80,443 (Y/n)" KK
233 [ "$KK" != "n" -a "$KK" != "no" ] &&
234 firewall-cmd
--permanent --zone=public
--add-service=http
&&
235 firewall-cmd
--permanent --zone=public
--add-service=https
&&
236 firewall-cmd
--reload
238 fi #[[ -z "$NO_PACKAGES" ]]
240 #check and ask for database user password. Must be done after database installation
241 if [[ -n $QUIET_MODE ]]
243 echo -e "\nCheking database connection and ask for credentials"
244 while ! mysqladmin
-s -u$DBUSER $DBPASSWD_PARAM status
>/dev
/null
246 [ -n "$logintry" ] && echo -e "\nInvalid database credentials!!!. Try again (Ctrl+c to abort)"
247 [ -z "$logintry" ] && echo -e "\nProvide database credentials"
248 read -e -p "database user? ($DBUSER) " DBUSER_
249 [ -n "$DBUSER_" ] && DBUSER
=$DBUSER_
250 read -e -s -p "database password? (Enter for not using password) " DBPASSWD_
251 [ -n "$DBPASSWD_" ] && DBPASSWD
="$DBPASSWD_" && DBPASSWD_PARAM
="-p$DBPASSWD_"
252 [ -z "$DBPASSWD_" ] && DBPASSWD
="" && DBPASSWD_PARAM
=""
257 if [[ -z "$NO_PACKAGES" ]]
260 #################################################################
261 ##### INSTALL PYTHON PACKAGES #####
262 #################################################################'
263 [ "$_DISTRO" == "Ubuntu" ] && install_packages
"python-yaml python-bottle python-mysqldb python-jsonschema python-paramiko python-argcomplete python-requests python-logutils libxml2-dev libxslt-dev python-dev python-pip"
264 [ "$_DISTRO" == "CentOS" -o "$_DISTRO" == "Red" ] && install_packages
"PyYAML MySQL-python python-jsonschema python-paramiko python-argcomplete python-requests python-logutils libxslt-devel libxml2-devel python-devel python-pip"
265 #The only way to install python-bottle on Centos7 is with easy_install or pip
266 [ "$_DISTRO" == "CentOS" -o "$_DISTRO" == "Red" ] && easy_install
-U bottle
268 #required for vmware connector TODO move that to separete opt in install script
269 sudo pip
install --upgrade pip
270 sudo pip
install pyvcloud
271 sudo pip
install progressbar
272 sudo pip
install prettytable
273 sudo pip
install pyvmomi
275 #requiered for AWS connector
276 [ "$_DISTRO" == "Ubuntu" ] && install_packages
"python-boto"
277 [ "$_DISTRO" == "CentOS" -o "$_DISTRO" == "Red" ] && install_packages
"python-boto" #TODO check if at Centos it exist with this name, or PIP should be used
279 #install openstack client needed for using openstack as a VIM
280 [ "$_DISTRO" == "Ubuntu" ] && install_packages
"python-novaclient python-keystoneclient python-glanceclient python-neutronclient python-cinderclient"
281 [ "$_DISTRO" == "CentOS" -o "$_DISTRO" == "Red" ] && install_packages
"python-devel" && easy_install python-novaclient python-keystoneclient python-glanceclient python-neutronclient python-cinderclient
#TODO revise if gcc python-pip is needed
282 fi #[[ -z "$NO_PACKAGES" ]]
284 if [[ -z $NOCLONE ]]; then
286 #################################################################
287 ##### DOWNLOAD SOURCE #####
288 #################################################################'
289 su
$SUDO_USER -c "git clone ${GIT_URL} ${OPENMANO_BASEFOLDER}"
290 su
$SUDO_USER -c "cp ${OPENMANO_BASEFOLDER}/.gitignore-common ${OPENMANO_BASEFOLDER}/.gitignore"
291 [[ -z $DEVELOP ]] && su
$SUDO_USER -c "git -C ${OPENMANO_BASEFOLDER} checkout tags/v1.1.0"
295 #################################################################
296 ##### INSTALLING OVIM LIBRARY #####
297 #################################################################'
298 su
$SUDO_USER -c "git -C ${OPENMANO_BASEFOLDER} clone ${GIT_OVIM_URL} openvim"
299 [[ -z $DEVELOP ]] && su
$SUDO_USER -c "git -C ${OPENMANO_BASEFOLDER}/openvim checkout master"
300 # Install debian dependencies before setup.py
301 #[ "$_DISTRO" == "Ubuntu" ] && install_packages "git"
302 #[ "$_DISTRO" == "CentOS" -o "$_DISTRO" == "Red" ] && install_packages "git"
303 make -C ${OPENMANO_BASEFOLDER}/openvim lite
306 #################################################################
307 ##### CREATE DATABASE #####
308 #################################################################'
309 echo -e "\nCreating temporary file form MYSQL installation and initialization"
310 TEMPFILE
="$(mktemp -q --tmpdir "installopenmano.XXXXXX
")"
311 trap 'rm -f "$TEMPFILE"' EXIT
312 chmod 0600 "$TEMPFILE"
313 echo -e "[client]\n user='$DBUSER'\n password='$DBPASSWD'">"$TEMPFILE"
315 if db_exists
"mano_db" $TEMPFILE ; then
316 if [[ -n $FORCEDB ]]; then
317 echo " Deleting previous database mano_db"
319 [[ -n $QUIET_MODE ]] && DBDELETEPARAM
="-f"
320 mysqladmin
--defaults-extra-file=$TEMPFILE -s drop mano_db
$DBDELETEPARAM ||
! echo "Could not delete mano_db database" ||
exit 1
321 #echo "REVOKE ALL PRIVILEGES ON mano_db.* FROM 'mano'@'localhost';" | mysql --defaults-extra-file=$TEMPFILE -s || ! echo "Failed while creating user mano at database" || exit 1
322 #echo "DELETE USER 'mano'@'localhost';" | mysql --defaults-extra-file=$TEMPFILE -s || ! echo "Failed while creating user mano at database" || exit 1
323 mysqladmin
--defaults-extra-file=$TEMPFILE -s create mano_db ||
! echo "Error creating mano_db database" ||
exit 1
324 echo "DROP USER 'mano'@'localhost';" | mysql
--defaults-extra-file=$TEMPFILE -s ||
! echo "Failed while creating user mano at database" ||
exit 1
325 echo "CREATE USER 'mano'@'localhost' identified by 'manopw';" | mysql
--defaults-extra-file=$TEMPFILE -s ||
! echo "Failed while creating user mano at database" ||
exit 1
326 echo "GRANT ALL PRIVILEGES ON mano_db.* TO 'mano'@'localhost';" | mysql
--defaults-extra-file=$TEMPFILE -s ||
! echo "Failed while creating user mano at database" ||
exit 1
327 echo " Database 'mano_db' created, user 'mano' password 'manopw'"
329 echo "Database exists. Use option '--forcedb' to force the deletion of the existing one" && exit 1
332 mysqladmin
-u$DBUSER $DBPASSWD_PARAM -s create mano_db ||
! echo "Error creating mano_db database" ||
exit 1
333 echo "CREATE USER 'mano'@'localhost' identified by 'manopw';" | mysql
--defaults-extra-file=$TEMPFILE -s ||
! echo "Failed while creating user mano at database" ||
exit 1
334 echo "GRANT ALL PRIVILEGES ON mano_db.* TO 'mano'@'localhost';" | mysql
--defaults-extra-file=$TEMPFILE -s ||
! echo "Failed while creating user mano at database" ||
exit 1
335 echo " Database 'mano_db' created, user 'mano' password 'manopw'"
340 #################################################################
341 ##### INIT DATABASE #####
342 #################################################################'
343 su
$SUDO_USER -c "${OPENMANO_BASEFOLDER}/database_utils/init_mano_db.sh -u mano -p manopw -d mano_db" ||
! echo "Failed while initializing main database" ||
exit 1
346 #################################################################
347 ##### CREATE AND INIT MANO_VIM DATABASE #####
348 #################################################################'
349 # Install mano_vim_db after setup
350 su
$SUDO_USER -c "${OPENMANO_BASEFOLDER}/openvim/database_utils/install-db-server.sh -U $DBUSER ${DBPASSWD_PARAM/p/P} -u mano -p manopw -d mano_vim_db" ||
! echo "Failed while installing ovim database" ||
exit 1
352 if [ "$_DISTRO" == "CentOS" -o "$_DISTRO" == "Red" ]
355 #################################################################
356 ##### CONFIGURE firewalld #####
357 #################################################################'
359 [[ -z $QUIET_MODE ]] && read -e -p "Configure firewalld for openmanod port 9090? (Y/n)" KK
360 if [ "$KK" != "n" -a "$KK" != "no" ]
362 #Creates a service file for openmano
363 echo '<?xml version="1.0" encoding="utf-8"?>
365 <short>openmanod</short>
366 <description>openmanod service</description>
367 <port protocol="tcp" port="9090"/>
368 </service>' > /etc
/firewalld
/services
/openmanod.xml
369 #put proper permissions
370 pushd /etc
/firewalld
/services
> /dev
/null
371 restorecon openmanod.xml
372 chmod 640 openmanod.xml
374 #Add the openmanod service to the default zone permanently and reload the firewall configuration
375 firewall-cmd
--permanent --add-service=openmanod
> /dev
/null
376 firewall-cmd
--reload > /dev
/null
384 #################################################################
385 ##### CONFIGURE OPENMANO CLIENT #####
386 #################################################################'
387 #creates a link at ~/bin if not configured as a service
388 if [[ -z "$INSTALL_AS_A_SERVICE" ]]
390 su
$SUDO_USER -c 'mkdir -p ${HOME}/bin'
391 su
$SUDO_USER -c 'rm -f ${HOME}/bin/openmano'
392 su
$SUDO_USER -c 'rm -f ${HOME}/bin/openmano-report'
393 su
$SUDO_USER -c 'rm -f ${HOME}/bin/service-openmano'
394 su
$SUDO_USER -c "ln -s '${OPENMANO_BASEFOLDER}/openmano' "'${HOME}/bin/openmano'
395 su
$SUDO_USER -c "ln -s '${OPENMANO_BASEFOLDER}/scripts/openmano-report.sh' "'${HOME}/bin/openmano-report'
396 su
$SUDO_USER -c "ln -s '${OPENMANO_BASEFOLDER}/scripts/service-openmano.sh' "'${HOME}/bin/service-openmano'
398 #insert /home/<user>/bin in the PATH
399 #skiped because normally this is done authomatically when ~/bin exist
400 #if ! su $SUDO_USER -c 'echo $PATH' | grep -q "${HOME}/bin"
402 # echo " inserting /home/$SUDO_USER/bin in the PATH at .bashrc"
403 # su $SUDO_USER -c 'echo "PATH=\$PATH:\${HOME}/bin" >> ~/.bashrc'
405 if [[ $SUDO_USER == root
]]
407 if ! echo $PATH |
grep -q "${HOME}/bin"
409 echo "PATH=\$PATH:\${HOME}/bin" >> ${HOME}/.bashrc
414 #configure arg-autocomplete for this user
415 #in case of minimal instalation this package is not installed by default
416 [[ "$_DISTRO" == "CentOS" ||
"$_DISTRO" == "Red" ]] && yum
install -y bash-completion
417 #su $SUDO_USER -c 'mkdir -p ~/.bash_completion.d'
418 su
$SUDO_USER -c 'activate-global-python-argcomplete --user'
419 if ! su
$SUDO_USER -c 'grep -q bash_completion.d/python-argcomplete.sh ${HOME}/.bashrc'
421 echo " inserting .bash_completion.d/python-argcomplete.sh execution at .bashrc"
422 su
$SUDO_USER -c 'echo ". ${HOME}/.bash_completion.d/python-argcomplete.sh" >> ~/.bashrc'
428 if [[ -n "$INSTALL_AS_A_SERVICE" ]]
431 #################################################################
432 ##### CONFIGURE OPENMANO SERVICE #####
433 #################################################################'
435 ${OPENMANO_BASEFOLDER}/scripts
/install-openmano-service.sh
-f ${OPENMANO_BASEFOLDER} `[[ -z "$NOCLONE" ]] && echo "-d"`
436 # rm -rf ${OPENMANO_BASEFOLDER}
437 # alias service-openmano="service openmano"
438 # echo 'alias service-openmano="service openmano"' >> ${HOME}/.bashrc
441 echo "Done! installed at /opt/openmano"
442 echo " Manage server with 'sudo service openmano start|stop|status|...' "
448 echo "Done! you may need to logout and login again for loading client configuration"
449 echo " Run './${OPENMANO_BASEFOLDER}/scripts/service-openmano.sh start' for starting openmano in a screen"