4 # Copyright 2015 Telefónica Investigación y Desarrollo, S.A.U.
5 # This file is part of openvim
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 openvim
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 ./openvim and the needed packages"
31 echo -e "On a Ubuntu 16.04 it configures openvim 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 vim_db DB, deleting previous database if exists and creating a new one"
39 echo -e " --updatedb: do not reinstall vim_db DB if it exists, 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 openvim 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
65 # ask to the user and parse a response among 'y', 'yes', 'n' or 'no'. Case insensitive
66 # Params: $1 text to ask; $2 Action by default, can be 'y' for yes, 'n' for no, other or empty for not allowed
67 # Return: true(0) if user type 'yes'; false (1) if user type 'no'
68 read -e -p "$1" USER_CONFIRMATION
70 [ -z "$USER_CONFIRMATION" ] && [ "$2" == 'y' ] && return 0
71 [ -z "$USER_CONFIRMATION" ] && [ "$2" == 'n' ] && return 1
72 [ "${USER_CONFIRMATION,,}" == "yes" ] ||
[ "${USER_CONFIRMATION,,}" == "y" ] && return 0
73 [ "${USER_CONFIRMATION,,}" == "no" ] ||
[ "${USER_CONFIRMATION,,}" == "n" ] && return 1
74 read -e -p "Please type 'yes' or 'no': " USER_CONFIRMATION
79 GIT_URL
=https
://osm.etsi.org
/gerrit
/osm
/openvim.git
92 while getopts ":u:p:hiq-:" o
; do
95 export DBUSER
="$OPTARG"
98 export DBPASSWD
="$OPTARG"
99 export DBPASSWD_PARAM
="-p$OPTARG"
102 export QUIET_MODE
=yes
103 export DEBIAN_FRONTEND
=noninteractive
109 [ "${OPTARG}" == "help" ] && usage
&& exit 0
110 [ "${OPTARG}" == "develop" ] && DEVELOP
="y" && continue
111 [ "${OPTARG}" == "forcedb" ] && DB_FORCE_UPDATE
="${DB_FORCE_UPDATE}--forcedb" && continue
112 [ "${OPTARG}" == "updatedb" ] && DB_FORCE_UPDATE
="${DB_FORCE_UPDATE}--updatedb" && continue
113 [ "${OPTARG}" == "force" ] && FORCE
="y" && continue
114 [ "${OPTARG}" == "noclone" ] && NOCLONE
="y" && continue
115 [ "${OPTARG}" == "quiet" ] && export QUIET_MODE
=yes && export DEBIAN_FRONTEND
=noninteractive
&& continue
116 [ "${OPTARG}" == "no-install-packages" ] && export NO_PACKAGES
=yes && continue
117 [ "${OPTARG}" == "no-db" ] && NO_DB
="y" && continue
118 echo -e "Invalid option: '--$OPTARG'\nTry $0 --help for more information" >&2
122 echo -e "Invalid option: '-$OPTARG'\nTry $0 --help for more information" >&2
126 echo -e "Option '-$OPTARG' requires an argument\nTry $0 --help for more information" >&2
136 if [ "$DB_FORCE_UPDATE" == "--forcedb--updatedb" ] ||
[ "$DB_FORCE_UPDATE" == "--updatedb--forcedb" ] ; then
137 echo "Error: options --forcedb and --updatedb are mutually exclusive" >&2
139 elif [ -n "$FORCE" ] && [ -z "$DB_FORCE_UPDATE" ] ; then
140 DB_FORCE_UPDATE
="--updatedb"
143 #check root privileges and non a root user behind
144 [ "$USER" != "root" ] && echo "Needed root privileges" >&2 && exit 1
145 if [[ -z "$SUDO_USER" ]] ||
[[ "$SUDO_USER" = "root" ]]
147 [[ -z $QUIET_MODE ]] && ! ask_user
"Install in the root user (y/N)? " n
&& echo "Cancelled" && exit 1
148 export SUDO_USER
=root
151 # Discover Linux distribution
153 [ -f /etc
/redhat-release
] && _DISTRO
=$
(cat /etc
/redhat-release
2>/dev
/null | cut
-d" " -f1)
154 # if not assuming ubuntu type
155 [ -f /etc
/redhat-release
] || _DISTRO
=$
(lsb_release
-is 2>/dev
/null
)
156 if [ "$_DISTRO" == "Ubuntu" ]
158 _RELEASE
=$
(lsb_release
-rs)
159 if [[ ${_RELEASE%%.*} != 14 ]] && [[ ${_RELEASE%%.*} != 16 ]]
161 [[ -z $QUIET_MODE ]] &&
162 ! ask_user
"WARNING! Not tested Ubuntu version. Continue assuming a trusty (14.XX)' (y/N)? " n
&&
163 echo "Cancelled" && exit 1
166 elif [ "$_DISTRO" == "CentOS" ]
169 if ! cat /etc
/redhat-release |
grep -q "7."
171 [[ -z $QUIET_MODE ]] &&
172 ! ask_user
"WARNING! Not tested CentOS version. Continue assuming a '$_RELEASE' type (y/N)? " n
&&
173 echo "Cancelled" && exit 1
175 elif [ "$_DISTRO" == "Red" ]
178 if ! cat /etc
/redhat-release |
grep -q "7."
180 [[ -z $QUIET_MODE ]] &&
181 ! ask_user
"WARNING! Not tested Red Hat OS version. Continue assuming a '$_RELEASE' type (y/N)? " n
&&
182 echo "Cancelled" && exit 1
184 else #[ "$_DISTRO" != "Ubuntu" -a "$_DISTRO" != "CentOS" -a "$_DISTRO" != "Red" ]
185 _DISTRO_DISCOVER
=$_DISTRO
186 [ -x /usr
/bin
/apt-get
] && _DISTRO
="Ubuntu" && _RELEASE
="14"
187 [ -x /usr
/bin
/yum
] && _DISTRO
="CentOS" && _RELEASE
="7"
188 [[ -z $QUIET_MODE ]] &&
189 ! ask_user
"WARNING! Not tested Linux distribution '$_DISTRO_DISCOVER '. Continue assuming a '$_DISTRO $_RELEASE' type (y/N)? " n
&&
190 echo "Cancelled" && exit 1
193 #check if installed as a service
194 INSTALL_AS_A_SERVICE
=""
195 [[ "$_DISTRO" == "Ubuntu" ]] && [[ ${_RELEASE%%.*} == 16 ]] && [[ -z $DEVELOP ]] && INSTALL_AS_A_SERVICE
="y"
197 # Next operations require knowing BASEFOLDER
198 if [[ -z "$NOCLONE" ]]; then
199 if [[ -n "$INSTALL_AS_A_SERVICE" ]] ; then
200 BASEFOLDER
=__openvim__
${RANDOM}
202 BASEFOLDER
="${PWD}/openvim"
204 [[ -n "$FORCE" ]] && rm -rf $BASEFOLDER #make idempotent
206 HERE
=$
(dirname $
(readlink
-f ${BASH_SOURCE[0]}))
207 BASEFOLDER
=$
(dirname $HERE)
210 if [[ -z "$NO_PACKAGES" ]]
213 "#################################################################\n"\
214 "##### UPDATE REPOSITORIES #####\n"\
215 "#################################################################"
216 [ "$_DISTRO" == "Ubuntu" ] && apt-get update
-y
218 [ "$_DISTRO" == "CentOS" -o "$_DISTRO" == "Red" ] && yum check-update
-y
219 [ "$_DISTRO" == "CentOS" ] && sudo yum
install -y epel-release
220 [ "$_DISTRO" == "Red" ] && wget http
://dl.fedoraproject.org
/pub
/epel
/7/x86_64
/e
/epel-release-7-5.noarch.rpm \
221 && sudo rpm
-ivh epel-release-7-5.noarch.rpm
&& sudo yum
install -y epel-release
&& rm -f epel-release-7-5.noarch.rpm
222 [ "$_DISTRO" == "CentOS" -o "$_DISTRO" == "Red" ] && sudo yum repolist
225 "#################################################################\n"\
226 "##### INSTALL REQUIRED PACKAGES #####\n"\
227 "#################################################################"
228 [ "$_DISTRO" == "Ubuntu" ] && install_packages
"git make screen wget mysql-client"
229 [ "$_DISTRO" == "CentOS" -o "$_DISTRO" == "Red" ] && install_packages
"git make screen wget mariadb-client"
232 "#################################################################\n"\
233 "##### INSTALL PYTHON PACKAGES #####\n"\
234 "#################################################################"
235 [ "$_DISTRO" == "Ubuntu" ] && install_packages
"python-yaml python-libvirt python-bottle python-mysqldb python-jsonschema python-paramiko python-argcomplete python-requests python-netaddr python-pexpect"
236 [ "$_DISTRO" == "CentOS" -o "$_DISTRO" == "Red" ] && install_packages
"PyYAML libvirt-python MySQL-python python-jsonschema python-paramiko python-argcomplete python-requests python-netaddr python-pexpect"
237 # The only way to install python-bottle on Centos7 is with easy_install or pip
238 [ "$_DISTRO" == "CentOS" -o "$_DISTRO" == "Red" ] && easy_install
-U bottle
240 fi # [[ -z "$NO_PACKAGES" ]]
242 if [[ -z $NOCLONE ]]; then
244 "#################################################################\n"\
245 "##### DOWNLOAD SOURCE #####\n"\
246 "#################################################################"
247 if [[ -d "${BASEFOLDER}" ]] ; then
248 if [[ -n "$FORCE" ]] ; then
249 echo "deleting '${BASEFOLDER}' folder"
250 rm -rf "$BASEFOLDER" #make idempotent
251 elif [[ -z "$QUIET_MODE" ]] ; then
252 ! ask_user
"folder '${BASEFOLDER}' exists, overwrite (y/N)? " n
&& echo "Cancelled!" && exit 1
255 echo "'${BASEFOLDER}' folder exists. Use "--force" to overwrite" >&2 && exit 1
258 su
$SUDO_USER -c "git clone ${GIT_URL} ${BASEFOLDER}"
259 LATEST_STABLE_TAG
=`git -C "${BASEFOLDER}" tag -l v[0-9].* | tail -n1`
260 [[ -z $DEVELOP ]] && su
$SUDO_USER -c "git -C ${BASEFOLDER} checkout tags/${LATEST_STABLE_TAG}"
261 su
$SUDO_USER -c "cp ${BASEFOLDER}/.gitignore-common ${BASEFOLDER}/.gitignore"
266 if [ "$_DISTRO" == "CentOS" -o "$_DISTRO" == "Red" ]
269 "#################################################################\n"\
270 "##### CONFIGURE firewalld #####\n"\
271 "#################################################################"
272 if [[ -z $QUIET_MODE ]] || ask_user
"Configure firewalld for openvimd port 9080 (Y/n)? " y
274 #Creates a service file for openvim
275 echo '<?xml version="1.0" encoding="utf-8"?>
277 <short>openvimd</short>
278 <description>openvimd service</description>
279 <port protocol="tcp" port="9080"/>
280 </service>' > /etc
/firewalld
/services
/openvimd.xml
281 #put proper permissions
282 pushd /etc
/firewalld
/services
> /dev
/null
286 #Add the openvim service to the default zone permanently and reload the firewall configuration
287 firewall-cmd
--permanent --add-service=openvim
> /dev
/null
288 firewall-cmd
--reload > /dev
/null
296 "#################################################################\n"\
297 "##### CONFIGURE OPENVIM CLIENT #####\n"\
298 "#################################################################"
299 #creates a link at ~/bin if not configured as a service
300 if [[ -z "$INSTALL_AS_A_SERVICE" ]]
302 su
$SUDO_USER -c 'mkdir -p ${HOME}/bin'
303 su
$SUDO_USER -c 'rm -f ${HOME}/bin/openvim'
304 su
$SUDO_USER -c 'rm -f ${HOME}/bin/openflow'
305 su
$SUDO_USER -c 'rm -f ${HOME}/bin/service-openvim'
306 su
$SUDO_USER -c 'rm -f ${HOME}/bin/initopenvim'
307 su
$SUDO_USER -c 'rm -f ${HOME}/bin/service-floodlight'
308 su
$SUDO_USER -c 'rm -f ${HOME}/bin/service-opendaylight'
309 su
$SUDO_USER -c 'rm -f ${HOME}/bin/get_dhcp_lease.sh'
310 su
$SUDO_USER -c "ln -s '${BASEFOLDER}/openvim' "'${HOME}/bin/openvim'
311 su
$SUDO_USER -c "ln -s '${BASEFOLDER}/openflow' "'${HOME}/bin/openflow'
312 su
$SUDO_USER -c "ln -s '${BASEFOLDER}/scripts/service-openvim' "'${HOME}/bin/service-openvim'
313 su
$SUDO_USER -c "ln -s '${BASEFOLDER}/scripts/initopenvim' "'${HOME}/bin/initopenvim'
314 su
$SUDO_USER -c "ln -s '${BASEFOLDER}/scripts/service-floodlight' "'${HOME}/bin/service-floodlight'
315 su
$SUDO_USER -c "ln -s '${BASEFOLDER}/scripts/service-opendaylight' "'${HOME}/bin/service-opendaylight'
316 su
$SUDO_USER -c "ln -s '${BASEFOLDER}/scripts/get_dhcp_lease.sh' "'${HOME}/bin/get_dhcp_lease.sh'
318 #insert /home/<user>/bin in the PATH
319 #skiped because normally this is done authomatically when ~/bin exists
320 #if ! su $SUDO_USER -c 'echo $PATH' | grep -q "${HOME}/bin"
322 # echo " inserting /home/$SUDO_USER/bin in the PATH at .bashrc"
323 # su $SUDO_USER -c 'echo "PATH=\$PATH:\${HOME}/bin" >> ~/.bashrc'
326 if [[ $SUDO_USER == root
]]
328 if ! echo $PATH |
grep -q "${HOME}/bin"
330 echo "PATH=\$PATH:\${HOME}/bin" >> ${HOME}/.bashrc
335 #configure arg-autocomplete for this user
336 #in case of minimal instalation this package is not installed by default
337 [[ "$_DISTRO" == "CentOS" ||
"$_DISTRO" == "Red" ]] && yum
install -y bash-completion
338 #su $SUDO_USER -c 'mkdir -p ~/.bash_completion.d'
339 su
$SUDO_USER -c 'activate-global-python-argcomplete --user'
340 if ! su
$SUDO_USER -c 'grep -q bash_completion.d/python-argcomplete.sh ${HOME}/.bashrc'
342 echo " inserting .bash_completion.d/python-argcomplete.sh execution at .bashrc"
343 su
$SUDO_USER -c 'echo ". ${HOME}/.bash_completion.d/python-argcomplete.sh" >> ~/.bashrc'
346 if [ -z "$NO_DB" ]; then
348 "#################################################################\n"\
349 "##### INSTALL DATABASE SERVER #####\n"\
350 "#################################################################"
352 if [ -n "$QUIET_MODE" ]; then
355 ${BASEFOLDER}/database_utils
/install-db-server.sh
-U $DBUSER ${DBPASSWD_PARAM/p/P} $DB_QUIET $DB_FORCE_UPDATE ||
exit 1
358 if [[ -n "$INSTALL_AS_A_SERVICE" ]]
361 "#################################################################\n"\
362 "##### CONFIGURE OPENVIM SERVICE #####\n"\
363 "#################################################################"
365 ${BASEFOLDER}/scripts
/install-openvim-service.sh
-f ${BASEFOLDER} `[[ -z "$NOCLONE" ]] && echo "-d"`
366 # rm -rf ${BASEFOLDER}
367 # alias service-openvim="service openvim"
368 # echo 'alias service-openvim="service openvim"' >> ${HOME}/.bashrc
370 echo "Done! installed at /opt/openvim"
371 echo " Manage server with 'sudo service osm-openvim start|stop|status|...' "
374 echo "Done! you may need to logout and login again for loading client configuration"
375 echo " Run './${BASEFOLDER}/scripts/service-openvim start' for starting openvim in a screen"