blob: 18619da857674be214e80fe2d1c3fc909354b777 [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
Thomas Vachuska6066dff2016-10-26 13:57:36 -07006[ ! -d "$ONOS_ROOT" ] && echo "ONOS_ROOT is not defined" >&2 && exit 1
7cd $ONOS_ROOT && onos-buck build onos --show-output && onos-check-bits
8exit $?
9
10#=============================================================================
11
12# FIXME: This needs to be refactored using Buck; for now it is disabled
13# FIXME: .deb, .rpm, .zip need to be re-implemented
14# FIXME: SM-ONOS packaging flavour needs to be re-implemented
15
Brian O'Connorf5d93632015-09-04 20:18:31 -070016set -e
17
Luca Pretee6183752015-07-29 01:55:50 -070018# Build the staging directory used to produce the packages
19function build_stage_dir() {
20 # Make sure we have the original apache karaf bits first
21 [ ! -d $M2_REPO ] && echo "M2 repository $M2_REPO not found" && exit 1
22 [ -d $ONOS_STAGE ] && echo "ONOS stage $ONOS_STAGE already exists" && exit 1
23
24 # Create the stage directory and warp into it
25 mkdir -p $ONOS_STAGE
26 cd $ONOS_STAGE
27
28 # Check if Apache Karaf bits are available and if not, fetch them.
29 if [ ! -f $KARAF_ZIP -a ! -f $KARAF_TAR ]; then
30 echo "Downloading $KARAF_TAR..."
31 curl -sL http://downloads.onosproject.org/third-party/apache-karaf-$KARAF_VERSION.tar.gz > $KARAF_TAR
32 fi
33 [ ! -f $KARAF_ZIP -a ! -f $KARAF_TAR ] && \
34 echo "Apache Karaf bits $KARAF_ZIP or $KARAF_TAR not found" && exit 1
35
36 # Unroll the Apache Karaf bits, prune them and make ONOS top-level directories.
37 [ -f $KARAF_ZIP ] && unzip -q $KARAF_ZIP && rm -rf $ONOS_STAGE/$KARAF_DIST/demos
38 [ -f $KARAF_TAR ] && tar zxf $KARAF_TAR && rm -rf $ONOS_STAGE/$KARAF_DIST/demos
39 mkdir bin
40
Thomas Vachuska08ab6a62015-09-23 16:55:45 -070041 # Patch the log-file size in place to increase it to 10 MB
42 perl -pi.old -e "s/maxFileSize=1MB/maxFileSize=10MB/g" \
43 $ONOS_STAGE/$KARAF_DIST/etc/org.ops4j.pax.logging.cfg
44
Luca Pretee6183752015-07-29 01:55:50 -070045 # Stage the ONOS admin scripts and patch in Karaf service wrapper extras
46 cp -r $ONOS_ROOT/tools/package/bin .
Brian O'Connor0eed29e2015-09-16 11:38:33 -070047 cp -r $ONOS_ROOT/tools/package/init $ONOS_STAGE/init
Luca Pretee6183752015-07-29 01:55:50 -070048 cp -r $ONOS_ROOT/tools/package/etc/* $ONOS_STAGE/$KARAF_DIST/etc
49
50 # Stage all builtin ONOS apps for factory install
51 onos-stage-apps $ONOS_STAGE/apps $ONOS_STAGE/$KARAF_DIST/system
52
53 # Mark the org.onosproject.drivers app active by default
54 touch $ONOS_STAGE/apps/org.onosproject.drivers/active
55
56 # Patch-in proper Karaf version into the startup script
57 sed "s/\$KARAF_VERSION/$KARAF_VERSION/g" \
58 $ONOS_ROOT/tools/package/bin/onos-service > bin/onos-service
Luca Pretee6183752015-07-29 01:55:50 -070059 chmod a+x bin/onos-service bin/onos
60
Thomas Vachuska8c9ee812015-11-24 17:29:37 -080061 if [ -d $ONOS_ROOT/tools/package/karaf-assembly/target/repo ]; then
62 cp -r $ONOS_ROOT/tools/package/karaf-assembly/target/repo/* $ONOS_STAGE/$KARAF_DIST/system
Brian O'Connoreca5bbc2015-12-05 00:55:58 -080063 #FIXME we need to add onos-features manually
64 mkdir -p $ONOS_STAGE/$KARAF_DIST/system/org/onosproject/onos-features/$ONOS_POM_VERSION
65 cp $M2_REPO/org/onosproject/onos-features/$ONOS_POM_VERSION/onos-features* \
66 $ONOS_STAGE/$KARAF_DIST/system/org/onosproject/onos-features/$ONOS_POM_VERSION
Thomas Vachuska8c9ee812015-11-24 17:29:37 -080067 else
68 # TODO: Deprecated so remove when confident staging works.
69 # Stage the ONOS bundles, but only those that match the version
70 mkdir -p $ONOS_STAGE/$KARAF_DIST/system/org/onosproject
71 find $M2_REPO/org/onosproject -type f -path "*/$ONOS_POM_VERSION/*" \
72 \( -name '*.jar' -o -name '*.pom' -o -name '*-features.xml' \) \
73 | grep -v -Ee '-tests.jar|-[0-9]{8}.[0-9]{6}-' \
74 | while read src; do
75 dst=$ONOS_STAGE/$KARAF_DIST/system/${src#$M2_REPO/*}
76 mkdir -p $(dirname $dst)
77 cp $src $dst
78 done
79 fi
Luca Pretee6183752015-07-29 01:55:50 -070080
81 # ONOS Patching ----------------------------------------------------------------
82
Brian O'Connordfe13c82015-09-01 22:02:52 -070083 export BOOT_FEATURES="webconsole,onos-api,onos-core,onos-incubator,onos-cli,onos-rest,onos-gui"
84
85 [ "$ONOS_SECURITY_MODE" = true ] && enable_security_mode
86
Luca Pretee6183752015-07-29 01:55:50 -070087 # Patch the Apache Karaf distribution file to add ONOS features repository
88 perl -pi.old -e "s|^(featuresRepositories=.*)|\1,mvn:org.onosproject/onos-features/$ONOS_POM_VERSION/xml/features|" \
89 $ONOS_STAGE/$KARAF_DIST/etc/org.apache.karaf.features.cfg
90
91 # Patch the Apache Karaf distribution file to load default ONOS boot features
Luca Pretee6183752015-07-29 01:55:50 -070092 perl -pi.old -e "s|^(featuresBoot=.*)|\1,$BOOT_FEATURES|" \
93 $ONOS_STAGE/$KARAF_DIST/etc/org.apache.karaf.features.cfg
94
95 # Patch the Apache Karaf distribution with ONOS branding bundle
96 cp $M2_REPO/org/onosproject/onos-branding/$ONOS_POM_VERSION/onos-branding-*.jar \
97 $ONOS_STAGE/$KARAF_DIST/lib
98
99 # Patch in the ONOS version file
100 echo $ONOS_VERSION > $ONOS_STAGE/VERSION
101}
102
Brian O'Connordfe13c82015-09-01 22:02:52 -0700103function clean_stage_dir() {
104 [ -d "$ONOS_STAGE" ] && rm -r $ONOS_STAGE || :
105}
106
107function enable_security_mode() {
108 echo "Enabling security mode ONOS..."
109
110 # SM-ONOS step 1: downgrade felix config admin
111 FELIX_CFG_ADMIN=${FELIX_CFG_ADMIN:-~/Downloads/org.apache.felix.configadmin-1.6.0.jar}
112 if [ ! -f $FELIX_CFG_ADMIN ]; then
113 echo "Downloading $FELIX_CFG_ADMIN..."
114 curl -sL http://archive.apache.org/dist/felix/org.apache.felix.configadmin-1.6.0.jar > $FELIX_CFG_ADMIN
115 fi
116 [ ! -f $FELIX_CFG_ADMIN ] && \
117 echo "Felix config admin not found: $FELIX_CFG_ADMIN" && exit 1
118
119 mkdir -p $ONOS_STAGE/$KARAF_DIST/system/org/apache/felix/org.apache.felix.configadmin/1.6.0
120 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 +0900121 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 -0700122 $ONOS_STAGE/$KARAF_DIST/etc/startup.properties
123
124 # SM-ONOS step 2: stage ONOS Felix framework security (this is already done by karaf assembly); end
125
126 # SM-ONOS step 3.1: configure karaf
127 perl -pi.old -e "s|#java.security.policy|java.security.policy|" \
128 $ONOS_STAGE/$KARAF_DIST/etc/system.properties
129 perl -pi.old -e "s|#org.osgi.framework.security|org.osgi.framework.security|" \
130 $ONOS_STAGE/$KARAF_DIST/etc/system.properties
131
132 # SM-ONOS step 3.2: update featuresBoot
133 export BOOT_FEATURES="onos-security,$BOOT_FEATURES"
134}
135
136function build_compressed_zip() {
Luca Pretee6183752015-07-29 01:55:50 -0700137 cd $ONOS_STAGE_ROOT
Brian O'Connordfe13c82015-09-01 22:02:52 -0700138 rm -f $ONOS_ZIP
139 which zip >/dev/null && zip -rq $ONOS_ZIP $ONOS_BITS && ls -lh $ONOS_ZIP
140}
Luca Pretee6183752015-07-29 01:55:50 -0700141
Brian O'Connordfe13c82015-09-01 22:02:52 -0700142function build_compressed_tar() {
143 cd $ONOS_STAGE_ROOT
144 rm -f $ONOS_TAR
145 COPYFILE_DISABLE=1 tar zcf $ONOS_TAR $ONOS_BITS && ls -lh $ONOS_TAR
Luca Pretee6183752015-07-29 01:55:50 -0700146}
147
148# Build a DEB package
Luca Pretef2049d12015-08-01 14:48:01 -0700149function build_deb() {
Brian O'Connor8a0c20e2015-09-16 22:54:24 -0700150 echo "This command may ask for your password to run commands as sudo,"
151 echo " because you need to be root in order to generate a proper DEB package."
Luca Pretee6183752015-07-29 01:55:50 -0700152
153 sudo rm -fr $ONOS_DEB_ROOT
154
Luca Pretef2049d12015-08-01 14:48:01 -0700155 mkdir -p $ONOS_DEB_ROOT/{DEBIAN,opt,etc/init}
Luca Pretee6183752015-07-29 01:55:50 -0700156
Brian O'Connor8a0c20e2015-09-16 22:54:24 -0700157 # Copy the debian directory and fill in version
158 cp -r $ONOS_ROOT/tools/package/deb/* $ONOS_DEB_ROOT/DEBIAN/
159 sed -i'' -E "s/@ONOS_POM_VERSION/$ONOS_POM_VERSION/" $ONOS_DEB_ROOT/DEBIAN/control
Luca Pretee6183752015-07-29 01:55:50 -0700160
161 cp -r $ONOS_STAGE $ONOS_DEB_ROOT/opt/onos
Brian O'Connor0eed29e2015-09-16 11:38:33 -0700162 cp $ONOS_ROOT/tools/package/init/onos.conf $ONOS_DEB_ROOT/etc/init/
Luca Pretee6183752015-07-29 01:55:50 -0700163
164 mkdir -p $ONOS_DEB_ROOT/opt/onos/var/
165
166 sudo chown -R root:root $ONOS_DEB_ROOT
Luca Pretef2049d12015-08-01 14:48:01 -0700167
Luca Pretee6183752015-07-29 01:55:50 -0700168 sudo dpkg-deb --build $ONOS_DEB_ROOT > /dev/null &&
169 sudo mv $ONOS_STAGE_ROOT/deb.deb $ONOS_DEB && ls -l $ONOS_DEB
Brian O'Connor8a0c20e2015-09-16 22:54:24 -0700170
171 #TODO run lintian on .deb
Luca Pretee6183752015-07-29 01:55:50 -0700172}
173
Luca Pretef2049d12015-08-01 14:48:01 -0700174# Build an RPM package
175function build_rpm() {
176 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 -0700177 [[ "$response" =~ ^[Nn] ]] && exit 0
Luca Pretef2049d12015-08-01 14:48:01 -0700178
Brian O'Connorac322442015-09-17 23:49:17 -0700179 sudo rm -fr $ONOS_RPM_ROOT
Luca Pretef2049d12015-08-01 14:48:01 -0700180
Brian O'Connorac322442015-09-17 23:49:17 -0700181 sudo yum -y install rpm-build
Luca Pretef2049d12015-08-01 14:48:01 -0700182
Brian O'Connorac322442015-09-17 23:49:17 -0700183 mkdir -p $ONOS_RPM_ROOT/{BUILD,RPMS,SOURCES/onos-$ONOS_RPM_VERSION/{etc/init,opt},SPECS,SRPMS}
Luca Pretef2049d12015-08-01 14:48:01 -0700184
Brian O'Connorac322442015-09-17 23:49:17 -0700185 cp -r $ONOS_STAGE $ONOS_RPM_ROOT/SOURCES/onos-$ONOS_RPM_VERSION/opt/onos
186 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 -0700187
Brian O'Connorac322442015-09-17 23:49:17 -0700188 cd $ONOS_RPM_ROOT/SOURCES
189 COPYFILE_DISABLE=1 tar zcf onos-$ONOS_RPM_VERSION.tar.gz onos-$ONOS_RPM_VERSION
Luca Pretef2049d12015-08-01 14:48:01 -0700190
Brian O'Connorac322442015-09-17 23:49:17 -0700191 cp $ONOS_ROOT/tools/package/rpm/onos.spec $ONOS_RPM_ROOT/SPECS/
192 sed -i'' -E "s/@ONOS_RPM_VERSION/$ONOS_RPM_VERSION/g" $ONOS_RPM_ROOT/SPECS/onos.spec
Luca Pretef2049d12015-08-01 14:48:01 -0700193
Brian O'Connorac322442015-09-17 23:49:17 -0700194 rpmbuild --define "_topdir $ONOS_RPM_ROOT" -bb $ONOS_RPM_ROOT/SPECS/onos.spec
195
196 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 -0700197}
198
Luca Pretee6183752015-07-29 01:55:50 -0700199# Script entry point
tom5c255702014-09-18 06:57:39 -0700200[ ! -d "$ONOS_ROOT" ] && echo "ONOS_ROOT is not defined" >&2 && exit 1
201. $ONOS_ROOT/tools/build/envDefaults
tom4d0c6632014-09-15 23:27:01 -0700202
203# Bail on any errors
204set -e
205
Brian O'Connordfe13c82015-09-01 22:02:52 -0700206[[ $# == 0 ]] && ONOS_PACKAGE_TAR_arg=true
Yuta HIGUCHI2f39b542017-01-18 20:09:17 -0800207while [[ $# -gt 0 ]]; do
Brian O'Connordfe13c82015-09-01 22:02:52 -0700208case $1 in
209 -t|--tar)
210 ONOS_PACKAGE_TAR_arg=true
211 ;;
212 -z|--zip)
213 ONOS_PACKAGE_ZIP_arg=true
214 ;;
215 -d|--deb)
216 ONOS_PACKAGE_DEB_arg=true
217 ;;
218 -r|--rpm)
219 ONOS_PACKAGE_RPM_arg=true
220 ;;
221 -s|--secure)
222 ONOS_SECURITY_MODE=true
223 ;;
224 *)
225 # unknown option
226 echo "Unknown options: $1"
227 echo "usage: $(basename $0) [--tar] [--zip] [--deb] [--rpm] [--secure]" >&2 && exit 1
228 ;;
229esac
230shift
231done
232
Brian O'Connor37c486f2015-12-14 20:28:48 -0800233#TODO consider moving this block to build_stage_dir
Thomas Vachuska82082052015-12-04 16:12:45 -0800234# Run karaf assembly to collect artifacts for off-line installations.
235aux=/tmp/assembly-$$.log
236trap "rm -f $aux 2>/dev/null" EXIT
Brian O'Connor37c486f2015-12-14 20:28:48 -0800237#TODO possibly merge with MAVEN_OPTS, also M2_REPO must be set for the reasons
238[ -n "$M2_REPO" ] && args="-Dmaven.repo.local=$M2_REPO" || args=""
239cd $ONOS_ROOT/tools/package/karaf-assembly &&
240 mvn $args clean install > $aux 2>&1 ||
Brian O'Connor68498e22016-01-04 14:02:03 -0800241 ( cat $aux &&
242 printf "\nFailed to run karaf-assembly, which stages artifacts for offline deployments.\n" &&
243 exit 1 )
Thomas Vachuska82082052015-12-04 16:12:45 -0800244
Luca Pretee6183752015-07-29 01:55:50 -0700245# Before starting make sure the environment is clan - delete onos staging folder
Brian O'Connordfe13c82015-09-01 22:02:52 -0700246clean_stage_dir
tom4d0c6632014-09-15 23:27:01 -0700247
Brian O'Connordfe13c82015-09-01 22:02:52 -0700248build_stage_dir
249[ "$ONOS_PACKAGE_TAR_arg" = true ] && build_compressed_tar
250[ "$ONOS_PACKAGE_ZIP_arg" = true ] && build_compressed_zip
251[ "$ONOS_PACKAGE_DEB_arg" = true ] && build_deb
252[ "$ONOS_PACKAGE_RPM_arg" = true ] && build_rpm
253clean_stage_dir