blob: 5feef002b42adf83e5a38acd0628750b55acafa8 [file] [log] [blame]
tom4d0c6632014-09-15 23:27:01 -07001#!/bin/bash
Pavlin Radoslavov91413792014-10-15 11:00:32 -07002# -----------------------------------------------------------------------------
Luca Pretee6183752015-07-29 01:55:50 -07003# Packages ONOS distributable into onos.tar.gz, onos.zip or a deb file
Pavlin Radoslavov91413792014-10-15 11:00:32 -07004# -----------------------------------------------------------------------------
tom4d0c6632014-09-15 23:27:01 -07005
Brian O'Connorf5d93632015-09-04 20:18:31 -07006set -e
7
Luca Pretee6183752015-07-29 01:55:50 -07008# Build the staging directory used to produce the packages
9function build_stage_dir() {
10 # Make sure we have the original apache karaf bits first
11 [ ! -d $M2_REPO ] && echo "M2 repository $M2_REPO not found" && exit 1
12 [ -d $ONOS_STAGE ] && echo "ONOS stage $ONOS_STAGE already exists" && exit 1
13
14 # Create the stage directory and warp into it
15 mkdir -p $ONOS_STAGE
16 cd $ONOS_STAGE
17
18 # Check if Apache Karaf bits are available and if not, fetch them.
19 if [ ! -f $KARAF_ZIP -a ! -f $KARAF_TAR ]; then
20 echo "Downloading $KARAF_TAR..."
21 curl -sL http://downloads.onosproject.org/third-party/apache-karaf-$KARAF_VERSION.tar.gz > $KARAF_TAR
22 fi
23 [ ! -f $KARAF_ZIP -a ! -f $KARAF_TAR ] && \
24 echo "Apache Karaf bits $KARAF_ZIP or $KARAF_TAR not found" && exit 1
25
26 # Unroll the Apache Karaf bits, prune them and make ONOS top-level directories.
27 [ -f $KARAF_ZIP ] && unzip -q $KARAF_ZIP && rm -rf $ONOS_STAGE/$KARAF_DIST/demos
28 [ -f $KARAF_TAR ] && tar zxf $KARAF_TAR && rm -rf $ONOS_STAGE/$KARAF_DIST/demos
29 mkdir bin
30
Thomas Vachuska08ab6a62015-09-23 16:55:45 -070031 # Patch the log-file size in place to increase it to 10 MB
32 perl -pi.old -e "s/maxFileSize=1MB/maxFileSize=10MB/g" \
33 $ONOS_STAGE/$KARAF_DIST/etc/org.ops4j.pax.logging.cfg
34
Luca Pretee6183752015-07-29 01:55:50 -070035 # Stage the ONOS admin scripts and patch in Karaf service wrapper extras
36 cp -r $ONOS_ROOT/tools/package/bin .
Brian O'Connor0eed29e2015-09-16 11:38:33 -070037 cp -r $ONOS_ROOT/tools/package/init $ONOS_STAGE/init
Luca Pretee6183752015-07-29 01:55:50 -070038 cp -r $ONOS_ROOT/tools/package/etc/* $ONOS_STAGE/$KARAF_DIST/etc
39
40 # Stage all builtin ONOS apps for factory install
41 onos-stage-apps $ONOS_STAGE/apps $ONOS_STAGE/$KARAF_DIST/system
42
43 # Mark the org.onosproject.drivers app active by default
44 touch $ONOS_STAGE/apps/org.onosproject.drivers/active
45
46 # Patch-in proper Karaf version into the startup script
47 sed "s/\$KARAF_VERSION/$KARAF_VERSION/g" \
48 $ONOS_ROOT/tools/package/bin/onos-service > bin/onos-service
49 sed "s/\$KARAF_VERSION/$KARAF_VERSION/g" \
50 $ONOS_ROOT/tools/package/bin/onos-client > bin/onos
51 chmod a+x bin/onos-service bin/onos
52
Thomas Vachuska8c9ee812015-11-24 17:29:37 -080053 if [ -d $ONOS_ROOT/tools/package/karaf-assembly/target/repo ]; then
54 cp -r $ONOS_ROOT/tools/package/karaf-assembly/target/repo/* $ONOS_STAGE/$KARAF_DIST/system
Brian O'Connoreca5bbc2015-12-05 00:55:58 -080055 #FIXME we need to add onos-features manually
56 mkdir -p $ONOS_STAGE/$KARAF_DIST/system/org/onosproject/onos-features/$ONOS_POM_VERSION
57 cp $M2_REPO/org/onosproject/onos-features/$ONOS_POM_VERSION/onos-features* \
58 $ONOS_STAGE/$KARAF_DIST/system/org/onosproject/onos-features/$ONOS_POM_VERSION
Thomas Vachuska8c9ee812015-11-24 17:29:37 -080059 else
60 # TODO: Deprecated so remove when confident staging works.
61 # Stage the ONOS bundles, but only those that match the version
62 mkdir -p $ONOS_STAGE/$KARAF_DIST/system/org/onosproject
63 find $M2_REPO/org/onosproject -type f -path "*/$ONOS_POM_VERSION/*" \
64 \( -name '*.jar' -o -name '*.pom' -o -name '*-features.xml' \) \
65 | grep -v -Ee '-tests.jar|-[0-9]{8}.[0-9]{6}-' \
66 | while read src; do
67 dst=$ONOS_STAGE/$KARAF_DIST/system/${src#$M2_REPO/*}
68 mkdir -p $(dirname $dst)
69 cp $src $dst
70 done
71 fi
Luca Pretee6183752015-07-29 01:55:50 -070072
73 # ONOS Patching ----------------------------------------------------------------
74
Brian O'Connordfe13c82015-09-01 22:02:52 -070075 export BOOT_FEATURES="webconsole,onos-api,onos-core,onos-incubator,onos-cli,onos-rest,onos-gui"
76
77 [ "$ONOS_SECURITY_MODE" = true ] && enable_security_mode
78
Luca Pretee6183752015-07-29 01:55:50 -070079 # Patch the Apache Karaf distribution file to add ONOS features repository
80 perl -pi.old -e "s|^(featuresRepositories=.*)|\1,mvn:org.onosproject/onos-features/$ONOS_POM_VERSION/xml/features|" \
81 $ONOS_STAGE/$KARAF_DIST/etc/org.apache.karaf.features.cfg
82
83 # Patch the Apache Karaf distribution file to load default ONOS boot features
Luca Pretee6183752015-07-29 01:55:50 -070084 perl -pi.old -e "s|^(featuresBoot=.*)|\1,$BOOT_FEATURES|" \
85 $ONOS_STAGE/$KARAF_DIST/etc/org.apache.karaf.features.cfg
86
Brian O'Connora84637c2016-05-10 19:16:18 -070087 # Patch the karaf start script to disable user interrupts
88 perl -pi.old -e "s|(-Dkaraf.startLocalConsole=true -Dkaraf.startRemoteShell=true)|\1 -Dkaraf.ignoreInterrupts=true|" \
89 $ONOS_STAGE/$KARAF_DIST/bin/karaf
90
Luca Pretee6183752015-07-29 01:55:50 -070091 # Patch the Apache Karaf distribution with ONOS branding bundle
92 cp $M2_REPO/org/onosproject/onos-branding/$ONOS_POM_VERSION/onos-branding-*.jar \
93 $ONOS_STAGE/$KARAF_DIST/lib
94
95 # Patch in the ONOS version file
96 echo $ONOS_VERSION > $ONOS_STAGE/VERSION
97}
98
Brian O'Connordfe13c82015-09-01 22:02:52 -070099function clean_stage_dir() {
100 [ -d "$ONOS_STAGE" ] && rm -r $ONOS_STAGE || :
101}
102
103function enable_security_mode() {
104 echo "Enabling security mode ONOS..."
105
106 # SM-ONOS step 1: downgrade felix config admin
107 FELIX_CFG_ADMIN=${FELIX_CFG_ADMIN:-~/Downloads/org.apache.felix.configadmin-1.6.0.jar}
108 if [ ! -f $FELIX_CFG_ADMIN ]; then
109 echo "Downloading $FELIX_CFG_ADMIN..."
110 curl -sL http://archive.apache.org/dist/felix/org.apache.felix.configadmin-1.6.0.jar > $FELIX_CFG_ADMIN
111 fi
112 [ ! -f $FELIX_CFG_ADMIN ] && \
113 echo "Felix config admin not found: $FELIX_CFG_ADMIN" && exit 1
114
115 mkdir -p $ONOS_STAGE/$KARAF_DIST/system/org/apache/felix/org.apache.felix.configadmin/1.6.0
116 cp $FELIX_CFG_ADMIN $ONOS_STAGE/$KARAF_DIST/system/org/apache/felix/org.apache.felix.configadmin/1.6.0
Changhoon Yoona68e6f92016-05-02 15:36:43 +0900117 perl -pi.old -e "s|^(.*org.apache.felix.configadmin.*)|mvn\\\\:org.apache.felix/org.apache.felix.configadmin/1.6.0 = 10|" \
Brian O'Connordfe13c82015-09-01 22:02:52 -0700118 $ONOS_STAGE/$KARAF_DIST/etc/startup.properties
119
120 # SM-ONOS step 2: stage ONOS Felix framework security (this is already done by karaf assembly); end
121
122 # SM-ONOS step 3.1: configure karaf
123 perl -pi.old -e "s|#java.security.policy|java.security.policy|" \
124 $ONOS_STAGE/$KARAF_DIST/etc/system.properties
125 perl -pi.old -e "s|#org.osgi.framework.security|org.osgi.framework.security|" \
126 $ONOS_STAGE/$KARAF_DIST/etc/system.properties
127
128 # SM-ONOS step 3.2: update featuresBoot
129 export BOOT_FEATURES="onos-security,$BOOT_FEATURES"
130}
131
132function build_compressed_zip() {
Luca Pretee6183752015-07-29 01:55:50 -0700133 cd $ONOS_STAGE_ROOT
Brian O'Connordfe13c82015-09-01 22:02:52 -0700134 rm -f $ONOS_ZIP
135 which zip >/dev/null && zip -rq $ONOS_ZIP $ONOS_BITS && ls -lh $ONOS_ZIP
136}
Luca Pretee6183752015-07-29 01:55:50 -0700137
Brian O'Connordfe13c82015-09-01 22:02:52 -0700138function build_compressed_tar() {
139 cd $ONOS_STAGE_ROOT
140 rm -f $ONOS_TAR
141 COPYFILE_DISABLE=1 tar zcf $ONOS_TAR $ONOS_BITS && ls -lh $ONOS_TAR
Luca Pretee6183752015-07-29 01:55:50 -0700142}
143
144# Build a DEB package
Luca Pretef2049d12015-08-01 14:48:01 -0700145function build_deb() {
Brian O'Connor8a0c20e2015-09-16 22:54:24 -0700146 echo "This command may ask for your password to run commands as sudo,"
147 echo " because you need to be root in order to generate a proper DEB package."
Luca Pretee6183752015-07-29 01:55:50 -0700148
149 sudo rm -fr $ONOS_DEB_ROOT
150
Luca Pretef2049d12015-08-01 14:48:01 -0700151 mkdir -p $ONOS_DEB_ROOT/{DEBIAN,opt,etc/init}
Luca Pretee6183752015-07-29 01:55:50 -0700152
Brian O'Connor8a0c20e2015-09-16 22:54:24 -0700153 # Copy the debian directory and fill in version
154 cp -r $ONOS_ROOT/tools/package/deb/* $ONOS_DEB_ROOT/DEBIAN/
155 sed -i'' -E "s/@ONOS_POM_VERSION/$ONOS_POM_VERSION/" $ONOS_DEB_ROOT/DEBIAN/control
Luca Pretee6183752015-07-29 01:55:50 -0700156
157 cp -r $ONOS_STAGE $ONOS_DEB_ROOT/opt/onos
Brian O'Connor0eed29e2015-09-16 11:38:33 -0700158 cp $ONOS_ROOT/tools/package/init/onos.conf $ONOS_DEB_ROOT/etc/init/
Luca Pretee6183752015-07-29 01:55:50 -0700159
160 mkdir -p $ONOS_DEB_ROOT/opt/onos/var/
161
162 sudo chown -R root:root $ONOS_DEB_ROOT
Luca Pretef2049d12015-08-01 14:48:01 -0700163
Luca Pretee6183752015-07-29 01:55:50 -0700164 sudo dpkg-deb --build $ONOS_DEB_ROOT > /dev/null &&
165 sudo mv $ONOS_STAGE_ROOT/deb.deb $ONOS_DEB && ls -l $ONOS_DEB
Brian O'Connor8a0c20e2015-09-16 22:54:24 -0700166
167 #TODO run lintian on .deb
Luca Pretee6183752015-07-29 01:55:50 -0700168}
169
Luca Pretef2049d12015-08-01 14:48:01 -0700170# Build an RPM package
171function build_rpm() {
172 read -r -p "WARN: rpm-build utility and root priviledges are need to build the package. Do you want to continue? [Y/n] " response
Brian O'Connorac322442015-09-17 23:49:17 -0700173 [[ "$response" =~ ^[Nn] ]] && exit 0
Luca Pretef2049d12015-08-01 14:48:01 -0700174
Brian O'Connorac322442015-09-17 23:49:17 -0700175 sudo rm -fr $ONOS_RPM_ROOT
Luca Pretef2049d12015-08-01 14:48:01 -0700176
Brian O'Connorac322442015-09-17 23:49:17 -0700177 sudo yum -y install rpm-build
Luca Pretef2049d12015-08-01 14:48:01 -0700178
Brian O'Connorac322442015-09-17 23:49:17 -0700179 mkdir -p $ONOS_RPM_ROOT/{BUILD,RPMS,SOURCES/onos-$ONOS_RPM_VERSION/{etc/init,opt},SPECS,SRPMS}
Luca Pretef2049d12015-08-01 14:48:01 -0700180
Brian O'Connorac322442015-09-17 23:49:17 -0700181 cp -r $ONOS_STAGE $ONOS_RPM_ROOT/SOURCES/onos-$ONOS_RPM_VERSION/opt/onos
182 cp $ONOS_ROOT/tools/package/init/onos.conf $ONOS_RPM_ROOT/SOURCES/onos-$ONOS_RPM_VERSION/etc/init/
Luca Pretef2049d12015-08-01 14:48:01 -0700183
Brian O'Connorac322442015-09-17 23:49:17 -0700184 cd $ONOS_RPM_ROOT/SOURCES
185 COPYFILE_DISABLE=1 tar zcf onos-$ONOS_RPM_VERSION.tar.gz onos-$ONOS_RPM_VERSION
Luca Pretef2049d12015-08-01 14:48:01 -0700186
Brian O'Connorac322442015-09-17 23:49:17 -0700187 cp $ONOS_ROOT/tools/package/rpm/onos.spec $ONOS_RPM_ROOT/SPECS/
188 sed -i'' -E "s/@ONOS_RPM_VERSION/$ONOS_RPM_VERSION/g" $ONOS_RPM_ROOT/SPECS/onos.spec
Luca Pretef2049d12015-08-01 14:48:01 -0700189
Brian O'Connorac322442015-09-17 23:49:17 -0700190 rpmbuild --define "_topdir $ONOS_RPM_ROOT" -bb $ONOS_RPM_ROOT/SPECS/onos.spec
191
192 cp $ONOS_RPM_ROOT/RPMS/noarch/onos-$ONOS_RPM_VERSION-1.noarch.rpm $ONOS_STAGE_ROOT && ls -l $ONOS_STAGE_ROOT/onos-$ONOS_RPM_VERSION-1.noarch.rpm
Luca Pretef2049d12015-08-01 14:48:01 -0700193}
194
Luca Pretee6183752015-07-29 01:55:50 -0700195# Script entry point
tom5c255702014-09-18 06:57:39 -0700196[ ! -d "$ONOS_ROOT" ] && echo "ONOS_ROOT is not defined" >&2 && exit 1
197. $ONOS_ROOT/tools/build/envDefaults
tom4d0c6632014-09-15 23:27:01 -0700198
199# Bail on any errors
200set -e
201
Brian O'Connordfe13c82015-09-01 22:02:52 -0700202[[ $# == 0 ]] && ONOS_PACKAGE_TAR_arg=true
203while [[ $# > 0 ]]; do
204case $1 in
205 -t|--tar)
206 ONOS_PACKAGE_TAR_arg=true
207 ;;
208 -z|--zip)
209 ONOS_PACKAGE_ZIP_arg=true
210 ;;
211 -d|--deb)
212 ONOS_PACKAGE_DEB_arg=true
213 ;;
214 -r|--rpm)
215 ONOS_PACKAGE_RPM_arg=true
216 ;;
217 -s|--secure)
218 ONOS_SECURITY_MODE=true
219 ;;
220 *)
221 # unknown option
222 echo "Unknown options: $1"
223 echo "usage: $(basename $0) [--tar] [--zip] [--deb] [--rpm] [--secure]" >&2 && exit 1
224 ;;
225esac
226shift
227done
228
Brian O'Connor37c486f2015-12-14 20:28:48 -0800229#TODO consider moving this block to build_stage_dir
Thomas Vachuska82082052015-12-04 16:12:45 -0800230# Run karaf assembly to collect artifacts for off-line installations.
231aux=/tmp/assembly-$$.log
232trap "rm -f $aux 2>/dev/null" EXIT
Brian O'Connor37c486f2015-12-14 20:28:48 -0800233#TODO possibly merge with MAVEN_OPTS, also M2_REPO must be set for the reasons
234[ -n "$M2_REPO" ] && args="-Dmaven.repo.local=$M2_REPO" || args=""
235cd $ONOS_ROOT/tools/package/karaf-assembly &&
236 mvn $args clean install > $aux 2>&1 ||
Brian O'Connor68498e22016-01-04 14:02:03 -0800237 ( cat $aux &&
238 printf "\nFailed to run karaf-assembly, which stages artifacts for offline deployments.\n" &&
239 exit 1 )
Thomas Vachuska82082052015-12-04 16:12:45 -0800240
Luca Pretee6183752015-07-29 01:55:50 -0700241# Before starting make sure the environment is clan - delete onos staging folder
Brian O'Connordfe13c82015-09-01 22:02:52 -0700242clean_stage_dir
tom4d0c6632014-09-15 23:27:01 -0700243
Brian O'Connordfe13c82015-09-01 22:02:52 -0700244build_stage_dir
245[ "$ONOS_PACKAGE_TAR_arg" = true ] && build_compressed_tar
246[ "$ONOS_PACKAGE_ZIP_arg" = true ] && build_compressed_zip
247[ "$ONOS_PACKAGE_DEB_arg" = true ] && build_deb
248[ "$ONOS_PACKAGE_RPM_arg" = true ] && build_rpm
249clean_stage_dir