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
82 while getopts ":u:p:hiq-:" o
; do
85 export DBUSER
="$OPTARG"
88 export DBPASSWD
="$OPTARG"
89 export DBPASSWD_PARAM
="-p$OPTARG"
93 export DEBIAN_FRONTEND
=noninteractive
99 [ "${OPTARG}" == "help" ] && usage
&& exit 0
100 [ "${OPTARG}" == "develop" ] && DEVELOP
="y" && continue
101 [ "${OPTARG}" == "forcedb" ] && FORCEDB
="y" && continue
102 [ "${OPTARG}" == "force" ] && FORCEDB
="y" && FORCE
="y" && continue
103 [ "${OPTARG}" == "noclone" ] && NOCLONE
="y" && continue
104 [ "${OPTARG}" == "quiet" ] && export QUIET_MODE
=yes && export DEBIAN_FRONTEND
=noninteractive
&& continue
105 [ "${OPTARG}" == "no-install-packages" ] && export NO_PACKAGES
=yes && continue
106 echo -e "Invalid option: '--$OPTARG'\nTry $0 --help for more information" >&2
110 echo -e "Invalid option: '-$OPTARG'\nTry $0 --help for more information" >&2
114 echo -e "Option '-$OPTARG' requires an argument\nTry $0 --help for more information" >&2
124 #check root privileges and non a root user behind
125 [ "$USER" != "root" ] && echo "Needed root privileges" >&2 && exit 1
126 if [[ -z "$SUDO_USER" ]] ||
[[ "$SUDO_USER" = "root" ]]
128 [[ -z $QUIET_MODE ]] && read -e -p "Install in the root user (y/N)?" KK
129 [[ -z $QUIET_MODE ]] && [[ "$KK" != "y" ]] && [[ "$KK" != "yes" ]] && echo "Cancelled" && exit 1
130 export SUDO_USER
=root
133 #Discover Linux distribution
135 [ -f /etc
/redhat-release
] && _DISTRO
=$
(cat /etc
/redhat-release
2>/dev
/null | cut
-d" " -f1)
136 #if not assuming ubuntu type
137 [ -f /etc
/redhat-release
] || _DISTRO
=$
(lsb_release
-is 2>/dev
/null
)
138 if [ "$_DISTRO" == "Ubuntu" ]
140 _RELEASE
=$
(lsb_release
-rs)
141 if [[ ${_RELEASE%%.*} != 14 ]] && [[ ${_RELEASE%%.*} != 16 ]]
143 [[ -z $QUIET_MODE ]] && read -e -p "WARNING! Not tested Ubuntu version. Continue assuming a trusty (14.XX)'? (y/N)" KK
144 [[ -z $QUIET_MODE ]] && [[ "$KK" != "y" ]] && [[ "$KK" != "yes" ]] && echo "Cancelled" && exit 1
147 elif [ "$_DISTRO" == "CentOS" ]
150 if ! cat /etc
/redhat-release |
grep -q "7."
152 [[ -z $QUIET_MODE ]] && read -e -p "WARNING! Not tested CentOS version. Continue assuming a '_RELEASE' type? (y/N)" KK
153 [[ -z $QUIET_MODE ]] && [[ "$KK" != "y" ]] && [[ "$KK" != "yes" ]] && echo "Cancelled" && exit 1
155 elif [ "$_DISTRO" == "Red" ]
158 if ! cat /etc
/redhat-release |
grep -q "7."
160 [[ -z $QUIET_MODE ]] && read -e -p "WARNING! Not tested Red Hat OS version. Continue assuming a '_RELEASE' type? (y/N)" KK
161 [[ -z $QUIET_MODE ]] && [[ "$KK" != "y" ]] && [[ "$KK" != "yes" ]] && echo "Cancelled" && exit 1
163 else #[ "$_DISTRO" != "Ubuntu" -a "$_DISTRO" != "CentOS" -a "$_DISTRO" != "Red" ]
164 _DISTRO_DISCOVER
=$_DISTRO
165 [ -x /usr
/bin
/apt-get
] && _DISTRO
="Ubuntu" && _RELEASE
="14"
166 [ -x /usr
/bin
/yum
] && _DISTRO
="CentOS" && _RELEASE
="7"
167 [[ -z $QUIET_MODE ]] && read -e -p "WARNING! Not tested Linux distribution '$_DISTRO_DISCOVER '. Continue assuming a '$_DISTRO $_RELEASE' type? (y/N)" KK
168 [[ -z $QUIET_MODE ]] && [[ "$KK" != "y" ]] && [[ "$KK" != "yes" ]] && echo "Cancelled" && exit 1
171 #check if installed as a service
172 INSTALL_AS_A_SERVICE
=""
173 [[ "$_DISTRO" == "Ubuntu" ]] && [[ ${_RELEASE%%.*} == 16 ]] && [[ -z $DEVELOP ]] && INSTALL_AS_A_SERVICE
="y"
174 #Next operations require knowing OPENMANO_BASEFOLDER
175 if [[ -z "$NOCLONE" ]]; then
176 if [[ -n "$INSTALL_AS_A_SERVICE" ]] ; then
177 OPENMANO_BASEFOLDER
=__openmano__
${RANDOM}
179 OPENMANO_BASEFOLDER
="${PWD}/openmano"
181 [[ -n "$FORCE" ]] && rm -rf $OPENMANO_BASEFOLDER #make idempotent
183 HERE
=$
(realpath $
(dirname $0))
184 OPENMANO_BASEFOLDER
=$
(dirname $HERE)
188 if [[ -z "$NO_PACKAGES" ]]
191 #################################################################
192 ##### UPDATE REPOSITORIES #####
193 #################################################################'
194 [ "$_DISTRO" == "Ubuntu" ] && apt-get update
-y
196 [ "$_DISTRO" == "CentOS" -o "$_DISTRO" == "Red" ] && yum check-update
-y
197 [ "$_DISTRO" == "CentOS" ] && sudo yum
install -y epel-release
198 [ "$_DISTRO" == "Red" ] && wget http
://dl.fedoraproject.org
/pub
/epel
/7/x86_64
/e
/epel-release-7-5.noarch.rpm \
199 && sudo rpm
-ivh epel-release-7-5.noarch.rpm
&& sudo yum
install -y epel-release
&& rm -f epel-release-7-5.noarch.rpm
200 [ "$_DISTRO" == "CentOS" -o "$_DISTRO" == "Red" ] && sudo yum repolist
204 if [[ -z "$NO_PACKAGES" ]]
207 #################################################################
208 ##### INSTALL REQUIRED PACKAGES #####
209 #################################################################'
210 [ "$_DISTRO" == "Ubuntu" ] && install_packages
"git screen wget mysql-server"
211 [ "$_DISTRO" == "CentOS" -o "$_DISTRO" == "Red" ] && install_packages
"git screen wget mariadb mariadb-server"
213 if [[ "$_DISTRO" == "Ubuntu" ]]
215 #start services. By default CentOS does not start services
216 service mysql start
>> /dev
/null
217 # try to set admin password, ignore if fails
218 [[ -n $DBPASSWD ]] && mysqladmin
-u $DBUSER -s password
$DBPASSWD
221 if [ "$_DISTRO" == "CentOS" -o "$_DISTRO" == "Red" ]
223 #start services. By default CentOS does not start services
224 service mariadb start
226 systemctl
enable mariadb
227 systemctl
enable httpd
228 read -e -p "Do you want to configure mariadb (recommended if not done before) (Y/n)" KK
229 [ "$KK" != "n" -a "$KK" != "no" ] && mysql_secure_installation
231 read -e -p "Do you want to set firewall to grant web access port 80,443 (Y/n)" KK
232 [ "$KK" != "n" -a "$KK" != "no" ] &&
233 firewall-cmd
--permanent --zone=public
--add-service=http
&&
234 firewall-cmd
--permanent --zone=public
--add-service=https
&&
235 firewall-cmd
--reload
237 fi #[[ -z "$NO_PACKAGES" ]]
239 #check and ask for database user password. Must be done after database installation
240 if [[ -n $QUIET_MODE ]]
242 echo -e "\nCheking database connection and ask for credentials"
243 while ! mysqladmin
-s -u$DBUSER $DBPASSWD_PARAM status
>/dev
/null
245 [ -n "$logintry" ] && echo -e "\nInvalid database credentials!!!. Try again (Ctrl+c to abort)"
246 [ -z "$logintry" ] && echo -e "\nProvide database credentials"
247 read -e -p "database user? ($DBUSER) " DBUSER_
248 [ -n "$DBUSER_" ] && DBUSER
=$DBUSER_
249 read -e -s -p "database password? (Enter for not using password) " DBPASSWD_
250 [ -n "$DBPASSWD_" ] && DBPASSWD
="$DBPASSWD_" && DBPASSWD_PARAM
="-p$DBPASSWD_"
251 [ -z "$DBPASSWD_" ] && DBPASSWD
="" && DBPASSWD_PARAM
=""
256 if [[ -z "$NO_PACKAGES" ]]
259 #################################################################
260 ##### INSTALL PYTHON PACKAGES #####
261 #################################################################'
262 [ "$_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"
263 [ "$_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"
264 #The only way to install python-bottle on Centos7 is with easy_install or pip
265 [ "$_DISTRO" == "CentOS" -o "$_DISTRO" == "Red" ] && easy_install
-U bottle
267 #required for vmware connector TODO move that to separete opt in install script
268 sudo pip
install --upgrade pip
269 sudo pip
install pyvcloud
270 sudo pip
install progressbar
271 sudo pip
install prettytable
272 sudo pip
install pyvmomi
274 #requiered for AWS connector
275 [ "$_DISTRO" == "Ubuntu" ] && install_packages
"python-boto"
276 [ "$_DISTRO" == "CentOS" -o "$_DISTRO" == "Red" ] && install_packages
"python-boto" #TODO check if at Centos it exist with this name, or PIP should be used
278 #install openstack client needed for using openstack as a VIM
279 [ "$_DISTRO" == "Ubuntu" ] && install_packages
"python-novaclient python-keystoneclient python-glanceclient python-neutronclient python-cinderclient"
280 [ "$_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
281 fi #[[ -z "$NO_PACKAGES" ]]
283 if [[ -z $NOCLONE ]]; then
285 #################################################################
286 ##### DOWNLOAD SOURCE #####
287 #################################################################'
288 su
$SUDO_USER -c "git clone ${GIT_URL} ${OPENMANO_BASEFOLDER}"
289 su
$SUDO_USER -c "cp ${OPENMANO_BASEFOLDER}/.gitignore-common ${OPENMANO_BASEFOLDER}/.gitignore"
290 [[ -z $DEVELOP ]] && su
$SUDO_USER -c "git -C ${OPENMANO_BASEFOLDER} checkout tags/v1.0.2"
294 #################################################################
295 ##### CREATE DATABASE #####
296 #################################################################'
297 echo -e "\nCreating temporary file form MYSQL installation and initialization"
298 TEMPFILE
="$(mktemp -q --tmpdir "installopenmano.XXXXXX
")"
299 trap 'rm -f "$TEMPFILE"' EXIT
300 chmod 0600 "$TEMPFILE"
301 echo -e "[client]\n user='$DBUSER'\n password='$DBPASSWD'">"$TEMPFILE"
303 if db_exists
"mano_db" $TEMPFILE ; then
304 if [[ -n $FORCEDB ]]; then
305 echo " Deleting previous database mano_db"
307 [[ -n $QUIET_MODE ]] && DBDELETEPARAM
="-f"
308 mysqladmin
--defaults-extra-file=$TEMPFILE -s drop mano_db
$DBDELETEPARAM ||
! echo "Could not delete mano_db database" ||
exit 1
309 #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
310 #echo "DELETE USER 'mano'@'localhost';" | mysql --defaults-extra-file=$TEMPFILE -s || ! echo "Failed while creating user mano at database" || exit 1
311 mysqladmin
--defaults-extra-file=$TEMPFILE -s create mano_db ||
! echo "Error creating mano_db database" ||
exit 1
312 echo "DROP USER 'mano'@'localhost';" | mysql
--defaults-extra-file=$TEMPFILE -s ||
! echo "Failed while creating user mano at database" ||
exit 1
313 echo "CREATE USER 'mano'@'localhost' identified by 'manopw';" | mysql
--defaults-extra-file=$TEMPFILE -s ||
! echo "Failed while creating user mano at database" ||
exit 1
314 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
315 echo " Database 'mano_db' created, user 'mano' password 'manopw'"
317 echo "Database exists. Use option '--forcedb' to force the deletion of the existing one" && exit 1
320 mysqladmin
-u$DBUSER $DBPASSWD_PARAM -s create mano_db ||
! echo "Error creating mano_db database" ||
exit 1
321 echo "CREATE USER 'mano'@'localhost' identified by 'manopw';" | mysql
--defaults-extra-file=$TEMPFILE -s ||
! echo "Failed while creating user mano at database" ||
exit 1
322 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
323 echo " Database 'mano_db' created, user 'mano' password 'manopw'"
328 #################################################################
329 ##### INIT DATABASE #####
330 #################################################################'
331 su
$SUDO_USER -c "${OPENMANO_BASEFOLDER}/database_utils/init_mano_db.sh -u mano -p manopw -d mano_db" ||
! echo "Failed while initializing database" ||
exit 1
334 if [ "$_DISTRO" == "CentOS" -o "$_DISTRO" == "Red" ]
337 #################################################################
338 ##### CONFIGURE firewalld #####
339 #################################################################'
341 [[ -z $QUIET_MODE ]] && read -e -p "Configure firewalld for openmanod port 9090? (Y/n)" KK
342 if [ "$KK" != "n" -a "$KK" != "no" ]
344 #Creates a service file for openmano
345 echo '<?xml version="1.0" encoding="utf-8"?>
347 <short>openmanod</short>
348 <description>openmanod service</description>
349 <port protocol="tcp" port="9090"/>
350 </service>' > /etc
/firewalld
/services
/openmanod.xml
351 #put proper permissions
352 pushd /etc
/firewalld
/services
> /dev
/null
353 restorecon openmanod.xml
354 chmod 640 openmanod.xml
356 #Add the openmanod service to the default zone permanently and reload the firewall configuration
357 firewall-cmd
--permanent --add-service=openmanod
> /dev
/null
358 firewall-cmd
--reload > /dev
/null
366 #################################################################
367 ##### CONFIGURE OPENMANO CLIENT #####
368 #################################################################'
369 #creates a link at ~/bin if not configured as a service
370 if [[ -z "$INSTALL_AS_A_SERVICE" ]]
372 su
$SUDO_USER -c 'mkdir -p ${HOME}/bin'
373 su
$SUDO_USER -c 'rm -f ${HOME}/bin/openmano'
374 su
$SUDO_USER -c 'rm -f ${HOME}/bin/openmano-report'
375 su
$SUDO_USER -c 'rm -f ${HOME}/bin/service-openmano'
376 su
$SUDO_USER -c "ln -s '${OPENMANO_BASEFOLDER}/openmano' "'${HOME}/bin/openmano'
377 su
$SUDO_USER -c "ln -s '${OPENMANO_BASEFOLDER}/scripts/openmano-report.sh' "'${HOME}/bin/openmano-report'
378 su
$SUDO_USER -c "ln -s '${OPENMANO_BASEFOLDER}/scripts/service-openmano.sh' "'${HOME}/bin/service-openmano'
380 #insert /home/<user>/bin in the PATH
381 #skiped because normally this is done authomatically when ~/bin exist
382 #if ! su $SUDO_USER -c 'echo $PATH' | grep -q "${HOME}/bin"
384 # echo " inserting /home/$SUDO_USER/bin in the PATH at .bashrc"
385 # su $SUDO_USER -c 'echo "PATH=\$PATH:\${HOME}/bin" >> ~/.bashrc'
387 if [[ $SUDO_USER == root
]]
389 if ! echo $PATH |
grep -q "${HOME}/bin"
391 echo "PATH=\$PATH:\${HOME}/bin" >> ${HOME}/.bashrc
396 #configure arg-autocomplete for this user
397 #in case of minimal instalation this package is not installed by default
398 [[ "$_DISTRO" == "CentOS" ||
"$_DISTRO" == "Red" ]] && yum
install -y bash-completion
399 #su $SUDO_USER -c 'mkdir -p ~/.bash_completion.d'
400 su
$SUDO_USER -c 'activate-global-python-argcomplete --user'
401 if ! su
$SUDO_USER -c 'grep -q bash_completion.d/python-argcomplete.sh ${HOME}/.bashrc'
403 echo " inserting .bash_completion.d/python-argcomplete.sh execution at .bashrc"
404 su
$SUDO_USER -c 'echo ". ${HOME}/.bash_completion.d/python-argcomplete.sh" >> ~/.bashrc'
410 if [[ -n "$INSTALL_AS_A_SERVICE" ]]
413 #################################################################
414 ##### CONFIGURE OPENMANO SERVICE #####
415 #################################################################'
417 ${OPENMANO_BASEFOLDER}/scripts
/install-openmano-service.sh
-f ${OPENMANO_BASEFOLDER} `[[ -z "$NOCLONE" ]] && echo "-d"`
418 # rm -rf ${OPENMANO_BASEFOLDER}
419 # alias service-openmano="service openmano"
420 # echo 'alias service-openmano="service openmano"' >> ${HOME}/.bashrc
423 echo "Done! installed at /opt/openmano"
424 echo " Manage server with 'sudo service openmano start|stop|status|...' "
430 echo "Done! you may need to logout and login again for loading client configuration"
431 echo " Run './${OPENMANO_BASEFOLDER}/scripts/service-openmano.sh start' for starting openmano in a screen"