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 and creating a new one"
39 echo -e " --noclone: assumes that openmano was cloned previously and that this script is run from the local repo"
40 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"
43 function install_packages
(){
44 [ -x /usr
/bin
/apt-get
] && apt-get
install -y $
*
45 [ -x /usr
/bin
/yum
] && yum
install -y $
*
47 #check properly installed
50 PACKAGE_INSTALLED
="no"
51 [ -x /usr
/bin
/apt-get
] && dpkg
-l $PACKAGE &>> /dev
/null
&& PACKAGE_INSTALLED
="yes"
52 [ -x /usr
/bin
/yum
] && yum list installed
$PACKAGE &>> /dev
/null
&& PACKAGE_INSTALLED
="yes"
53 if [ "$PACKAGE_INSTALLED" = "no" ]
55 echo "failed to install package '$PACKAGE'. Revise network connectivity and try again" >&2
61 function db_exists
() {
62 RESULT
=`mysqlshow --defaults-extra-file="$2" | grep -v Wildcard | grep -o $1`
63 if [ "$RESULT" == "$1" ]; then
67 echo " DB $1 does not exist"
71 GIT_URL
=https
://osm.etsi.org
/gerrit
/osm
/RO.git
80 while getopts ":u:p:hiq-:" o
; do
83 export DBUSER
="$OPTARG"
86 export DBPASSWD
="$OPTARG"
87 export DBPASSWD_PARAM
="-p$OPTARG"
91 export DEBIAN_FRONTEND
=noninteractive
97 [ "${OPTARG}" == "help" ] && usage
&& exit 0
98 [ "${OPTARG}" == "develop" ] && DEVELOP
="y" && continue
99 [ "${OPTARG}" == "forcedb" ] && FORCEDB
="y" && continue
100 [ "${OPTARG}" == "noclone" ] && NOCLONE
="y" && continue
101 [ "${OPTARG}" == "quiet" ] && export QUIET_MODE
=yes && export DEBIAN_FRONTEND
=noninteractive
&& continue
102 [ "${OPTARG}" == "no-install-packages" ] && export NO_PACKAGES
=yes && continue
103 echo -e "Invalid option: '--$OPTARG'\nTry $0 --help for more information" >&2
107 echo -e "Invalid option: '-$OPTARG'\nTry $0 --help for more information" >&2
111 echo -e "Option '-$OPTARG' requires an argument\nTry $0 --help for more information" >&2
121 #check root privileges and non a root user behind
122 [ "$USER" != "root" ] && echo "Needed root privileges" >&2 && exit 1
123 if [[ -z "$SUDO_USER" ]] ||
[[ "$SUDO_USER" = "root" ]]
125 [[ -z $QUIET_MODE ]] && read -e -p "Install in the root user (y/N)?" KK
126 [[ -z $QUIET_MODE ]] && [[ "$KK" != "y" ]] && [[ "$KK" != "yes" ]] && echo "Cancelled" && exit 1
127 export SUDO_USER
=root
130 #Discover Linux distribution
132 [ -f /etc
/redhat-release
] && _DISTRO
=$
(cat /etc
/redhat-release
2>/dev
/null | cut
-d" " -f1)
133 #if not assuming ubuntu type
134 [ -f /etc
/redhat-release
] || _DISTRO
=$
(lsb_release
-is 2>/dev
/null
)
135 if [ "$_DISTRO" == "Ubuntu" ]
137 _RELEASE
=$
(lsb_release
-rs)
138 if [[ ${_RELEASE%%.*} != 14 ]] && [[ ${_RELEASE%%.*} != 16 ]]
140 [[ -z $QUIET_MODE ]] && read -e -p "WARNING! Not tested Ubuntu version. Continue assuming a trusty (14.XX)'? (y/N)" KK
141 [[ -z $QUIET_MODE ]] && [[ "$KK" != "y" ]] && [[ "$KK" != "yes" ]] && echo "Cancelled" && exit 1
144 elif [ "$_DISTRO" == "CentOS" ]
147 if ! cat /etc
/redhat-release |
grep -q "7."
149 [[ -z $QUIET_MODE ]] && read -e -p "WARNING! Not tested CentOS version. Continue assuming a '_RELEASE' type? (y/N)" KK
150 [[ -z $QUIET_MODE ]] && [[ "$KK" != "y" ]] && [[ "$KK" != "yes" ]] && echo "Cancelled" && exit 1
152 elif [ "$_DISTRO" == "Red" ]
155 if ! cat /etc
/redhat-release |
grep -q "7."
157 [[ -z $QUIET_MODE ]] && read -e -p "WARNING! Not tested Red Hat OS version. Continue assuming a '_RELEASE' type? (y/N)" KK
158 [[ -z $QUIET_MODE ]] && [[ "$KK" != "y" ]] && [[ "$KK" != "yes" ]] && echo "Cancelled" && exit 1
160 else #[ "$_DISTRO" != "Ubuntu" -a "$_DISTRO" != "CentOS" -a "$_DISTRO" != "Red" ]
161 _DISTRO_DISCOVER
=$_DISTRO
162 [ -x /usr
/bin
/apt-get
] && _DISTRO
="Ubuntu" && _RELEASE
="14"
163 [ -x /usr
/bin
/yum
] && _DISTRO
="CentOS" && _RELEASE
="7"
164 [[ -z $QUIET_MODE ]] && read -e -p "WARNING! Not tested Linux distribution '$_DISTRO_DISCOVER '. Continue assuming a '$_DISTRO $_RELEASE' type? (y/N)" KK
165 [[ -z $QUIET_MODE ]] && [[ "$KK" != "y" ]] && [[ "$KK" != "yes" ]] && echo "Cancelled" && exit 1
170 if [[ -z "$NO_PACKAGES" ]]
173 #################################################################
174 ##### UPDATE REPOSITORIES #####
175 #################################################################'
176 [ "$_DISTRO" == "Ubuntu" ] && apt-get update
-y
178 [ "$_DISTRO" == "CentOS" -o "$_DISTRO" == "Red" ] && yum check-update
-y
179 [ "$_DISTRO" == "CentOS" ] && sudo yum
install -y epel-release
180 [ "$_DISTRO" == "Red" ] && wget http
://dl.fedoraproject.org
/pub
/epel
/7/x86_64
/e
/epel-release-7-5.noarch.rpm \
181 && sudo rpm
-ivh epel-release-7-5.noarch.rpm
&& sudo yum
install -y epel-release
&& rm -f epel-release-7-5.noarch.rpm
182 [ "$_DISTRO" == "CentOS" -o "$_DISTRO" == "Red" ] && sudo yum repolist
186 if [[ -z "$NO_PACKAGES" ]]
189 #################################################################
190 ##### INSTALL REQUIRED PACKAGES #####
191 #################################################################'
192 [ "$_DISTRO" == "Ubuntu" ] && install_packages
"git screen wget mysql-server"
193 [ "$_DISTRO" == "CentOS" -o "$_DISTRO" == "Red" ] && install_packages
"git screen wget mariadb mariadb-server"
195 if [[ "$_DISTRO" == "Ubuntu" ]]
197 #start services. By default CentOS does not start services
198 service mysql start
>> /dev
/null
199 # try to set admin password, ignore if fails
200 [[ -n $DBPASSWD ]] && mysqladmin
-u $DBUSER -s password
$DBPASSWD
203 if [ "$_DISTRO" == "CentOS" -o "$_DISTRO" == "Red" ]
205 #start services. By default CentOS does not start services
206 service mariadb start
208 systemctl
enable mariadb
209 systemctl
enable httpd
210 read -e -p "Do you want to configure mariadb (recommended if not done before) (Y/n)" KK
211 [ "$KK" != "n" -a "$KK" != "no" ] && mysql_secure_installation
213 read -e -p "Do you want to set firewall to grant web access port 80,443 (Y/n)" KK
214 [ "$KK" != "n" -a "$KK" != "no" ] &&
215 firewall-cmd
--permanent --zone=public
--add-service=http
&&
216 firewall-cmd
--permanent --zone=public
--add-service=https
&&
217 firewall-cmd
--reload
219 fi #[[ -z "$NO_PACKAGES" ]]
221 #check and ask for database user password. Must be done after database installation
222 if [[ -n $QUIET_MODE ]]
224 echo -e "\nCheking database connection and ask for credentials"
225 while ! mysqladmin
-s -u$DBUSER $DBPASSWD_PARAM status
>/dev
/null
227 [ -n "$logintry" ] && echo -e "\nInvalid database credentials!!!. Try again (Ctrl+c to abort)"
228 [ -z "$logintry" ] && echo -e "\nProvide database credentials"
229 read -e -p "database user? ($DBUSER) " DBUSER_
230 [ -n "$DBUSER_" ] && DBUSER
=$DBUSER_
231 read -e -s -p "database password? (Enter for not using password) " DBPASSWD_
232 [ -n "$DBPASSWD_" ] && DBPASSWD
="$DBPASSWD_" && DBPASSWD_PARAM
="-p$DBPASSWD_"
233 [ -z "$DBPASSWD_" ] && DBPASSWD
="" && DBPASSWD_PARAM
=""
238 if [[ -z "$NO_PACKAGES" ]]
241 #################################################################
242 ##### INSTALL PYTHON PACKAGES #####
243 #################################################################'
244 [ "$_DISTRO" == "Ubuntu" ] && install_packages
"python-yaml python-bottle python-mysqldb python-jsonschema python-paramiko python-argcomplete python-requests python-logutils"
245 [ "$_DISTRO" == "CentOS" -o "$_DISTRO" == "Red" ] && install_packages
"PyYAML MySQL-python python-jsonschema python-paramiko python-argcomplete python-requests python-logutils"
247 #The only way to install python-bottle on Centos7 is with easy_install or pip
248 [ "$_DISTRO" == "CentOS" -o "$_DISTRO" == "Red" ] && easy_install
-U bottle
250 #install openstack client needed for using openstack as a VIM
251 [ "$_DISTRO" == "Ubuntu" ] && install_packages
"python-novaclient python-keystoneclient python-glanceclient python-neutronclient"
252 [ "$_DISTRO" == "CentOS" -o "$_DISTRO" == "Red" ] && install_packages
"python-devel" && easy_install python-novaclient python-keystoneclient python-glanceclient python-neutronclient
#TODO revise if gcc python-pip is needed
253 fi #[[ -z "$NO_PACKAGES" ]]
255 if [[ -z $NOCLONE ]]; then
257 #################################################################
258 ##### DOWNLOAD SOURCE #####
259 #################################################################'
260 su
$SUDO_USER -c 'git clone '"${GIT_URL}"' openmano'
261 #[[ -z $DEVELOP ]] && su $SUDO_USER -c 'git checkout <tag version>'
265 #################################################################
266 ##### CREATE DATABASE #####
267 #################################################################'
268 echo -e "\nCreating temporary file form MYSQL installation and initialization"
269 TEMPFILE
="$(mktemp -q --tmpdir "installopenmano.XXXXXX
")"
270 trap 'rm -f "$TEMPFILE"' EXIT SIGINT SIGTERM
271 chmod 0600 "$TEMPFILE"
272 cat >"$TEMPFILE" <<EOF
278 if db_exists
"mano_db" $TEMPFILE ; then
279 if [[ -n $FORCEDB ]]; then
280 echo " Deleting previous database mano_db"
282 [[ -n $QUIET_MODE ]] && DBDELETEPARAM
="-f"
283 mysqladmin
--defaults-extra-file=$TEMPFILE -s drop mano_db
$DBDELETEPARAM ||
! echo "Could not delete mano_db database" ||
exit 1
284 #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
285 #echo "DELETE USER 'mano'@'localhost';" | mysql --defaults-extra-file=$TEMPFILE -s || ! echo "Failed while creating user mano at database" || exit 1
286 mysqladmin
--defaults-extra-file=$TEMPFILE -s create mano_db ||
! echo "Error creating mano_db database" ||
exit 1
287 echo "DROP USER 'mano'@'localhost';" | mysql
--defaults-extra-file=$TEMPFILE -s ||
! echo "Failed while creating user mano at database" ||
exit 1
288 echo "CREATE USER 'mano'@'localhost' identified by 'manopw';" | mysql
--defaults-extra-file=$TEMPFILE -s ||
! echo "Failed while creating user mano at database" ||
exit 1
289 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
290 echo " Database 'mano_db' created, user 'mano' password 'manopw'"
292 echo "Database exists. Use option '--forcedb' to force the deletion of the existing one" && exit 1
295 mysqladmin
-u$DBUSER $DBPASSWD_PARAM -s create mano_db ||
! echo "Error creating mano_db database" ||
exit 1
296 echo "CREATE USER 'mano'@'localhost' identified by 'manopw';" | mysql
--defaults-extra-file=$TEMPFILE -s ||
! echo "Failed while creating user mano at database" ||
exit 1
297 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
298 echo " Database 'mano_db' created, user 'mano' password 'manopw'"
302 #Next operations require knowing OPENMANO_BASEFOLDER
303 HERE
=$
(realpath $
(dirname $0))
304 if [[ -z $NOCLONE ]]; then
305 OPENMANO_BASEFOLDER
="${HERE}/openmano"
307 OPENMANO_BASEFOLDER
=$
(dirname $HERE)
312 #################################################################
313 ##### INIT DATABASE #####
314 #################################################################'
315 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
318 if [ "$_DISTRO" == "CentOS" -o "$_DISTRO" == "Red" ]
321 #################################################################
322 ##### CONFIGURE firewalld #####
323 #################################################################'
325 [[ -z $QUIET_MODE ]] && read -e -p "Configure firewalld for openmanod port 9090? (Y/n)" KK
326 if [ "$KK" != "n" -a "$KK" != "no" ]
328 #Creates a service file for openmano
329 echo '<?xml version="1.0" encoding="utf-8"?>
331 <short>openmanod</short>
332 <description>openmanod service</description>
333 <port protocol="tcp" port="9090"/>
334 </service>' > /etc
/firewalld
/services
/openmanod.xml
335 #put proper permissions
336 pushd /etc
/firewalld
/services
> /dev
/null
337 restorecon openmanod.xml
338 chmod 640 openmanod.xml
340 #Add the openmanod service to the default zone permanently and reload the firewall configuration
341 firewall-cmd
--permanent --add-service=openmanod
> /dev
/null
342 firewall-cmd
--reload > /dev
/null
350 #################################################################
351 ##### CONFIGURE OPENMANO CLIENT #####
352 #################################################################'
353 #creates a link at ~/bin
354 su
$SUDO_USER -c 'mkdir -p ${HOME}/bin'
355 su
$SUDO_USER -c 'rm -f ${HOME}/bin/openmano'
356 su
$SUDO_USER -c 'rm -f ${HOME}/bin/openmano-report'
357 su
$SUDO_USER -c 'rm -f ${HOME}/bin/service-openmano'
358 su
$SUDO_USER -c 'ln -s '${OPENMANO_BASEFOLDER}'/openmano ${HOME}/bin/openmano'
359 su
$SUDO_USER -c 'ln -s '${OPENMANO_BASEFOLDER}'/scripts/openmano-report.sh ${HOME}/bin/openmano-report'
360 su
$SUDO_USER -c 'ln -s '${OPENMANO_BASEFOLDER}'/scripts/service-openmano.sh ${HOME}/bin/service-openmano'
362 #insert /home/<user>/bin in the PATH
363 #skiped because normally this is done authomatically when ~/bin exist
364 #if ! su $SUDO_USER -c 'echo $PATH' | grep -q "${HOME}/bin"
366 # echo " inserting /home/$SUDO_USER/bin in the PATH at .bashrc"
367 # su $SUDO_USER -c 'echo "PATH=\$PATH:\${HOME}/bin" >> ~/.bashrc'
369 if [[ $SUDO_USER == root
]]
371 if ! echo $PATH |
grep -q "${HOME}/bin"
373 echo "PATH=\$PATH:\${HOME}/bin" >> ${HOME}/.bashrc
377 #configure arg-autocomplete for this user
378 #in case of minimal instalation this package is not installed by default
379 [[ "$_DISTRO" == "CentOS" ||
"$_DISTRO" == "Red" ]] && yum
install -y bash-completion
380 #su $SUDO_USER -c 'mkdir -p ~/.bash_completion.d'
381 su
$SUDO_USER -c 'activate-global-python-argcomplete --user'
382 if ! su
$SUDO_USER -c 'grep -q bash_completion.d/python-argcomplete.sh ${HOME}/.bashrc'
384 echo " inserting .bash_completion.d/python-argcomplete.sh execution at .bashrc"
385 su
$SUDO_USER -c 'echo ". ${HOME}/.bash_completion.d/python-argcomplete.sh" >> ~/.bashrc'
391 if [[ "$_DISTRO" == "Ubuntu" ]] && [[ ${_RELEASE%%.*} == 16 ]] && [[ -z $DEVELOP ]]
394 #################################################################
395 ##### CONFIGURE OPENMANO SERVICE #####
396 #################################################################'
398 ${OPENMANO_BASEFOLDER}/scripts
/install-openmano-service.sh
-f ${OPENMANO_BASEFOLDER} #-u $SUDO_USER
399 # alias service-openmano="service openmano"
400 # echo 'alias service-openmano="service openmano"' >> ${HOME}/.bashrc
403 echo "Done! you may need to logout and login again for loading client configuration"
404 echo " Manage server with 'service openmano start|stop|status|...' "
410 echo "Done! you may need to logout and login again for loading client configuration"
411 echo " Run './openmano/scripts/service-openmano.sh start' for starting openmano in a screen"