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 " --updatedb: do not reinstall mano_db DB if exist, just update database"
40 echo -e " --force: makes idenpotent, delete previous installations folders if needed. It assumes --updatedb if --forcedb option is not provided"
41 echo -e " --noclone: assumes that openmano was cloned previously and that this script is run from the local repo"
42 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 echo -e " --no-db: do not install mysql server"
46 function install_packages
(){
47 [ -x /usr
/bin
/apt-get
] && apt-get
install -y $
*
48 [ -x /usr
/bin
/yum
] && yum
install -y $
*
50 #check properly installed
53 PACKAGE_INSTALLED
="no"
54 [ -x /usr
/bin
/apt-get
] && dpkg
-l $PACKAGE &>> /dev
/null
&& PACKAGE_INSTALLED
="yes"
55 [ -x /usr
/bin
/yum
] && yum list installed
$PACKAGE &>> /dev
/null
&& PACKAGE_INSTALLED
="yes"
56 if [ "$PACKAGE_INSTALLED" = "no" ]
58 echo "failed to install package '$PACKAGE'. Revise network connectivity and try again" >&2
64 GIT_URL
=https
://osm.etsi.org
/gerrit
/osm
/RO.git
65 GIT_OVIM_URL
=https
://osm.etsi.org
/gerrit
/osm
/openvim.git
77 while getopts ":u:p:hiq-:" o
; do
80 export DBUSER
="$OPTARG"
83 export DBPASSWD
="$OPTARG"
84 export DBPASSWD_PARAM
="-p$OPTARG"
88 export DEBIAN_FRONTEND
=noninteractive
94 [ "${OPTARG}" == "help" ] && usage
&& exit 0
95 [ "${OPTARG}" == "develop" ] && DEVELOP
="y" && continue
96 [ "${OPTARG}" == "forcedb" ] && DB_FORCE_UPDATE
="${DB_FORCE_UPDATE}--forcedb" && continue
97 [ "${OPTARG}" == "updatedb" ] && DB_FORCE_UPDATE
="${DB_FORCE_UPDATE}--updatedb" && continue
98 [ "${OPTARG}" == "force" ] && FORCE
="y" && continue
99 [ "${OPTARG}" == "noclone" ] && NOCLONE
="y" && continue
100 [ "${OPTARG}" == "quiet" ] && export QUIET_MODE
=yes && export DEBIAN_FRONTEND
=noninteractive
&& continue
101 [ "${OPTARG}" == "no-install-packages" ] && export NO_PACKAGES
=yes && continue
102 [ "${OPTARG}" == "no-db" ] && NO_DB
="y" && 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 if [ "$DB_FORCE_UPDATE" == "--forcedb--updatedb" ] ||
[ "$DB_FORCE_UPDATE" == "--updatedb--forcedb" ] ; then
122 echo "Error: options --forcedb and --updatedb are mutually exclusive" >&2
124 elif [ -n "$FORCE" ] && [ -z "$DB_FORCE_UPDATE" ] ; then
125 DB_FORCE_UPDATE
="--updatedb"
128 #check root privileges and non a root user behind
129 [ "$USER" != "root" ] && echo "Needed root privileges" >&2 && exit 1
130 if [[ -z "$SUDO_USER" ]] ||
[[ "$SUDO_USER" = "root" ]]
132 [[ -z $QUIET_MODE ]] && read -e -p "Install in the root user (y/N)?" KK
133 [[ -z $QUIET_MODE ]] && [[ "$KK" != "y" ]] && [[ "$KK" != "yes" ]] && echo "Cancelled" && exit 1
134 export SUDO_USER
=root
137 #Discover Linux distribution
139 [ -f /etc
/redhat-release
] && _DISTRO
=$
(cat /etc
/redhat-release
2>/dev
/null | cut
-d" " -f1)
140 #else assuming ubuntu type
141 [ -f /etc
/redhat-release
] || _DISTRO
=$
(lsb_release
-is 2>/dev
/null
)
142 if [ "$_DISTRO" == "Ubuntu" ]
144 _RELEASE
=$
(lsb_release
-rs)
145 if [[ ${_RELEASE%%.*} != 14 ]] && [[ ${_RELEASE%%.*} != 16 ]]
147 [[ -z $QUIET_MODE ]] && read -e -p "WARNING! Not tested Ubuntu version. Continue assuming a trusty (14.XX)'? (y/N)" KK
148 [[ -z $QUIET_MODE ]] && [[ "$KK" != "y" ]] && [[ "$KK" != "yes" ]] && echo "Cancelled" && exit 1
151 elif [ "$_DISTRO" == "CentOS" ]
154 if ! cat /etc
/redhat-release |
grep -q "7."
156 [[ -z $QUIET_MODE ]] && read -e -p "WARNING! Not tested CentOS version. Continue assuming a '_RELEASE' type? (y/N)" KK
157 [[ -z $QUIET_MODE ]] && [[ "$KK" != "y" ]] && [[ "$KK" != "yes" ]] && echo "Cancelled" && exit 1
159 elif [ "$_DISTRO" == "Red" ]
162 if ! cat /etc
/redhat-release |
grep -q "7."
164 [[ -z $QUIET_MODE ]] && read -e -p "WARNING! Not tested Red Hat OS version. Continue assuming a '_RELEASE' type? (y/N)" KK
165 [[ -z $QUIET_MODE ]] && [[ "$KK" != "y" ]] && [[ "$KK" != "yes" ]] && echo "Cancelled" && exit 1
167 else #[ "$_DISTRO" != "Ubuntu" -a "$_DISTRO" != "CentOS" -a "$_DISTRO" != "Red" ]
168 _DISTRO_DISCOVER
=$_DISTRO
169 [ -x /usr
/bin
/apt-get
] && _DISTRO
="Ubuntu" && _RELEASE
="14"
170 [ -x /usr
/bin
/yum
] && _DISTRO
="CentOS" && _RELEASE
="7"
171 [[ -z $QUIET_MODE ]] && read -e -p "WARNING! Not tested Linux distribution '$_DISTRO_DISCOVER '. Continue assuming a '$_DISTRO $_RELEASE' type? (y/N)" KK
172 [[ -z $QUIET_MODE ]] && [[ "$KK" != "y" ]] && [[ "$KK" != "yes" ]] && echo "Cancelled" && exit 1
175 #check if installed as a service
176 INSTALL_AS_A_SERVICE
=""
177 [[ "$_DISTRO" == "Ubuntu" ]] && [[ ${_RELEASE%%.*} == 16 ]] && [[ -z $DEVELOP ]] && INSTALL_AS_A_SERVICE
="y"
178 #Next operations require knowing OPENMANO_BASEFOLDER
179 if [[ -z "$NOCLONE" ]]; then
180 if [[ -n "$INSTALL_AS_A_SERVICE" ]] ; then
181 OPENMANO_BASEFOLDER
=__openmano__
${RANDOM}
183 OPENMANO_BASEFOLDER
="${PWD}/openmano"
185 [[ -n "$FORCE" ]] && rm -rf $OPENMANO_BASEFOLDER #make idempotent
187 HERE
=$
(realpath $
(dirname $0))
188 OPENMANO_BASEFOLDER
=$
(dirname $HERE)
191 if [[ -z "$NO_PACKAGES" ]] #if (UPDATE REPOS)
194 #################################################################
195 ##### UPDATE REPOSITORIES #####
196 #################################################################'
197 [ "$_DISTRO" == "Ubuntu" ] && apt-get update
-y
199 [ "$_DISTRO" == "CentOS" -o "$_DISTRO" == "Red" ] && yum check-update
-y
200 [ "$_DISTRO" == "CentOS" ] && sudo yum
install -y epel-release
201 [ "$_DISTRO" == "Red" ] && wget http
://dl.fedoraproject.org
/pub
/epel
/7/x86_64
/e
/epel-release-7-5.noarch.rpm \
202 && sudo rpm
-ivh epel-release-7-5.noarch.rpm
&& sudo yum
install -y epel-release
&& rm -f epel-release-7-5.noarch.rpm
203 [ "$_DISTRO" == "CentOS" -o "$_DISTRO" == "Red" ] && sudo yum repolist
205 fi #if (UPDATE REPOS)
207 if [[ -z "$NO_PACKAGES" ]] #if (INSTALL DEPENDENCIES)
210 #################################################################
211 ##### INSTALL REQUIRED PACKAGES #####
212 #################################################################'
213 [ "$_DISTRO" == "Ubuntu" ] && install_packages
"git make screen wget mysql-client"
214 [ "$_DISTRO" == "CentOS" -o "$_DISTRO" == "Red" ] && install_packages
"git make screen wget mariadb-client"
215 fi #if (INSTALL DEPENDENCIES)
217 if [[ -z "$NO_PACKAGES" ]] #if (PYTHON PACKAGES AND PIP PACKAGES)
220 #################################################################
221 ##### INSTALL PYTHON PACKAGES #####
222 #################################################################'
223 [ "$_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"
224 [ "$_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"
225 #The only way to install python-bottle on Centos7 is with easy_install or pip
226 [ "$_DISTRO" == "CentOS" -o "$_DISTRO" == "Red" ] && easy_install
-U bottle
228 #required for vmware connector TODO move that to separete opt in install script
229 sudo pip
install --upgrade pip
230 sudo pip
install pyvcloud
231 sudo pip
install progressbar
232 sudo pip
install prettytable
233 sudo pip
install pyvmomi
235 #required for AWS connector
236 [ "$_DISTRO" == "Ubuntu" ] && install_packages
"python-boto"
237 [ "$_DISTRO" == "CentOS" -o "$_DISTRO" == "Red" ] && install_packages
"python-boto" #TODO check if at Centos it exist with this name, or PIP should be used
239 #install openstack client needed for using openstack as a VIM
240 [ "$_DISTRO" == "Ubuntu" ] && install_packages
"python-novaclient python-keystoneclient python-glanceclient python-neutronclient python-cinderclient"
241 [ "$_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
242 fi #if (PYTHON PACKAGES AND PIP PACKAGES)
244 if [[ -z $NOCLONE ]]; then
246 #################################################################
247 ##### DOWNLOAD SOURCE #####
248 #################################################################'
249 su
$SUDO_USER -c "git clone ${GIT_URL} ${OPENMANO_BASEFOLDER}"
250 su
$SUDO_USER -c "cp ${OPENMANO_BASEFOLDER}/.gitignore-common ${OPENMANO_BASEFOLDER}/.gitignore"
251 [[ -z $DEVELOP ]] && su
$SUDO_USER -c "git -C ${OPENMANO_BASEFOLDER} checkout v2.0"
255 #################################################################
256 ##### INSTALLING OVIM LIBRARY #####
257 #################################################################'
258 su
$SUDO_USER -c "git -C ${OPENMANO_BASEFOLDER} clone ${GIT_OVIM_URL} openvim"
259 [[ -z $DEVELOP ]] && su
$SUDO_USER -c "git -C ${OPENMANO_BASEFOLDER}/openvim checkout v2.0"
261 # Install debian dependencies before setup.py
262 [ "$_DISTRO" == "Ubuntu" ] && install_packages
"libmysqlclient-dev"
263 [ "$_DISTRO" == "CentOS" -o "$_DISTRO" == "Red" ] && install_packages
"libmysqlclient-dev" #TODO check if that's the name in CentOS and RedHat
264 make -C ${OPENMANO_BASEFOLDER}/openvim lite
265 rm -rf "${OPENMANO_BASEFOLDER}/openvim"
266 OSMLIBOVIM_PATH
=`python -c 'import lib_osm_openvim; print lib_osm_openvim.__path__[0]'`
268 if [ "$_DISTRO" == "CentOS" -o "$_DISTRO" == "Red" ]
271 #################################################################
272 ##### CONFIGURE firewalld #####
273 #################################################################'
275 [[ -z $QUIET_MODE ]] && read -e -p "Configure firewalld for openmanod port 9090? (Y/n)" KK
276 if [ "$KK" != "n" -a "$KK" != "no" ]
278 #Creates a service file for openmano
279 echo '<?xml version="1.0" encoding="utf-8"?>
281 <short>openmanod</short>
282 <description>openmanod service</description>
283 <port protocol="tcp" port="9090"/>
284 </service>' > /etc
/firewalld
/services
/openmanod.xml
285 #put proper permissions
286 pushd /etc
/firewalld
/services
> /dev
/null
287 restorecon openmanod.xml
288 chmod 640 openmanod.xml
290 #Add the openmanod service to the default zone permanently and reload the firewall configuration
291 firewall-cmd
--permanent --add-service=openmanod
> /dev
/null
292 firewall-cmd
--reload > /dev
/null
300 #################################################################
301 ##### CONFIGURE OPENMANO CLIENT #####
302 #################################################################'
303 #creates a link at ~/bin if not configured as a service
304 if [[ -z "$INSTALL_AS_A_SERVICE" ]]
306 su
$SUDO_USER -c 'mkdir -p ${HOME}/bin'
307 su
$SUDO_USER -c 'rm -f ${HOME}/bin/openmano'
308 su
$SUDO_USER -c 'rm -f ${HOME}/bin/openmano-report'
309 su
$SUDO_USER -c 'rm -f ${HOME}/bin/service-openmano'
310 su
$SUDO_USER -c "ln -s '${OPENMANO_BASEFOLDER}/openmano' "'${HOME}/bin/openmano'
311 su
$SUDO_USER -c "ln -s '${OPENMANO_BASEFOLDER}/scripts/openmano-report.sh' "'${HOME}/bin/openmano-report'
312 su
$SUDO_USER -c "ln -s '${OPENMANO_BASEFOLDER}/scripts/service-openmano' "'${HOME}/bin/service-openmano'
314 #insert /home/<user>/bin in the PATH
315 #skiped because normally this is done authomatically when ~/bin exist
316 #if ! su $SUDO_USER -c 'echo $PATH' | grep -q "${HOME}/bin"
318 # echo " inserting /home/$SUDO_USER/bin in the PATH at .bashrc"
319 # su $SUDO_USER -c 'echo "PATH=\$PATH:\${HOME}/bin" >> ~/.bashrc'
321 if [[ $SUDO_USER == root
]]
323 if ! echo $PATH |
grep -q "${HOME}/bin"
325 echo "PATH=\$PATH:\${HOME}/bin" >> ${HOME}/.bashrc
330 #configure arg-autocomplete for this user
331 #in case of minimal instalation this package is not installed by default
332 [[ "$_DISTRO" == "CentOS" ||
"$_DISTRO" == "Red" ]] && yum
install -y bash-completion
333 #su $SUDO_USER -c 'mkdir -p ~/.bash_completion.d'
334 su
$SUDO_USER -c 'activate-global-python-argcomplete --user'
335 if ! su
$SUDO_USER -c 'grep -q bash_completion.d/python-argcomplete.sh ${HOME}/.bashrc'
337 echo " inserting .bash_completion.d/python-argcomplete.sh execution at .bashrc"
338 su
$SUDO_USER -c 'echo ". ${HOME}/.bash_completion.d/python-argcomplete.sh" >> ~/.bashrc'
341 if [ -z "$NO_DB" ]; then
343 #################################################################
344 ##### INSTALL DATABASE SERVER #####
345 #################################################################'
347 if [ -n "$QUIET_MODE" ]; then
350 ${OPENMANO_BASEFOLDER}/database_utils
/install-db-server.sh
-U $DBUSER ${DBPASSWD_PARAM/p/P} $DB_QUIET $DB_FORCE_UPDATE ||
exit 1
352 #################################################################
353 ##### CREATE AND INIT MANO_VIM DATABASE #####
354 #################################################################'
355 # Install mano_vim_db after setup
356 ${OSMLIBOVIM_PATH}/database_utils
/install-db-server.sh
-U $DBUSER ${DBPASSWD_PARAM/p/P} -u mano
-p manopw
-d mano_vim_db
$DB_QUIET $DB_FORCE_UPDATE ||
exit 1
360 if [[ -n "$INSTALL_AS_A_SERVICE" ]]
363 #################################################################
364 ##### CONFIGURE OPENMANO SERVICE #####
365 #################################################################'
367 ${OPENMANO_BASEFOLDER}/scripts
/install-openmano-service.sh
-f ${OPENMANO_BASEFOLDER} `[[ -z "$NOCLONE" ]] && echo "-d"`
368 # rm -rf ${OPENMANO_BASEFOLDER}
369 # alias service-openmano="service openmano"
370 # echo 'alias service-openmano="service openmano"' >> ${HOME}/.bashrc
373 echo "Done! installed at /opt/openmano"
374 echo " Manage server with 'sudo service osm-ro start|stop|status|...' "
380 echo "Done! you may need to logout and login again for loading client configuration"
381 echo " Run './${OPENMANO_BASEFOLDER}/scripts/service-openmano start' for starting openmano in a screen"