Merge "Update release notes for Honolulu"
[sdnc/oam.git] / installation / sdnc / src / main / scripts / startODL.sh
1 #!/bin/sh
2 ###
3 # ============LICENSE_START=======================================================
4 # SDN-C
5 # ================================================================================
6 # Copyright (C) 2020 Samsung Electronics
7 # Copyright (C) 2017 AT&T Intellectual Property. All rights reserved.
8 # Copyright (C) 2020 Highstreet Technologies
9 # ================================================================================
10 # Licensed under the Apache License, Version 2.0 (the "License");
11 # you may not use this file except in compliance with the License.
12 # You may obtain a copy of the License at
13 #
14 #      http://www.apache.org/licenses/LICENSE-2.0
15 #
16 # Unless required by applicable law or agreed to in writing, software
17 # distributed under the License is distributed on an "AS IS" BASIS,
18 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
19 # See the License for the specific language governing permissions and
20 # limitations under the License.
21 # ============LICENSE_END=========================================================
22 ###
23 # A single entry point script that can be used in Kubernetes based deployments (via OOM) and standalone docker deployments.
24 # Please see https://wiki.onap.org/display/DW/startODL.sh+-+Important+Environment+variables+and+their+description for more details
25
26 # Functions
27
28 # Test if repository exists, like this mvn:org.onap.ccsdk.features.sdnr.wt/sdnr-wt-devicemanager-oran-feature/0.7.2/xml/features
29 # $1 repository
30 isRepoExisting() {
31   REPO=$(echo "$1" | sed -E "s#mvn:(.*)/xml/features\$#\1#")
32   OIFS="$IFS"
33   IFS='/' 
34   set parts $REPO
35   IFS="$OIFS"
36   path="$ODL_HOME/system/$(echo "$2" | tr '.' '/')/$3/$4"
37   [ -d "$path" ]
38 }
39
40 # Add features repository to karaf featuresRepositories configuration
41 # $1 repositories to be added
42 addRepository() {
43   CFG=$ODL_FEATURES_BOOT_FILE
44   ORIG=$CFG.orig
45   if isRepoExisting "$1" ; then
46     printf "%s\n" "Add repository: $1"
47     sed -i "\|featuresRepositories|s|$|, $1|" "$CFG"
48   else
49     printf "%s\n" "Repo does not exist: $1"
50   fi
51 }
52
53 # Append features to karaf boot feature configuration
54 # $1 additional feature to be added
55 # $2 repositories to be added (optional)
56 addToFeatureBoot() {
57   CFG=$ODL_FEATURES_BOOT_FILE
58   ORIG=$CFG.orig
59   if [ -n "$2" ] ; then
60     printf "%s\n" "Add repository: $2"
61     mv "$CFG" "$ORIG"
62     sed -e "\|featuresRepositories|s|$|,$2|" "$ORIG" > "$CFG"
63   fi
64   printf "%s\n" "Add boot feature: $1"
65   mv "$CFG" "$ORIG"
66   sed -e "\|featuresBoot *=|s|$|,$1|" "$ORIG" > "$CFG"
67 }
68
69 # Append features to karaf boot feature configuration
70 # $1 search pattern
71 # $2 replacement
72 replaceFeatureBoot() {
73   CFG="$ODL_HOME"/etc/org.apache.karaf.features.cfg
74   ORIG=$CFG.orig
75   printf "%s %s\n" "Replace boot feature $1 with: $2"
76   sed -i "/featuresBoot/ s/$1/$2/g" "$CFG"
77 }
78
79 # Remove all sdnc specific features
80 cleanupFeatureBoot() {
81   printf "Remove northbound bootfeatures \n"
82   sed -i "/featuresBoot/ s/,ccsdk-sli-core-all.*$//g" "$ODL_FEATURES_BOOT_FILE"
83 }
84
85 initialize_sdnrdb() {
86   printf "SDN-R Database Initialization"
87   INITCMD="$JAVA_HOME/bin/java -jar "
88   FN="$ODL_HOME/${FEATURES_SDNR}/sdnr-wt-data-provider-setup/$CCSDKFEATUREVERSION/sdnr-dmt.jar"
89   if [ ! -f "$FN" ];then
90     FN="$ODL_HOME/${FEATURES_SDNR}/sdnr-wt-data-provider-setup/$CCSDKFEATUREVERSION/sdnr-wt-data-provider-setup-$CCSDKFEATUREVERSION.jar"
91   fi
92   INITCMD="${INITCMD} ${FN} $SDNRDBCOMMAND"
93   printf "%s\n" "Execute: $INITCMD"
94   n=0
95   until [ $n -ge 5 ] ; do
96     $INITCMD && break
97     n=$((n+1))
98     sleep 15
99   done
100   return $?
101 }
102
103 install_sdnrwt_features() {
104   # Repository setup provided via sdnc dockerfile
105   if $SDNRWT; then
106
107     if $SDNRONLY; then
108       cleanupFeatureBoot
109     fi
110     addToFeatureBoot "$SDNRDM_BOOTFEATURES"
111     if ! $SDNRDM; then
112       addToFeatureBoot "$SDNRODLUX_BOOTFEATURES"
113     fi
114     if $SDNR_NETCONF_CALLHOME_ENABLED; then
115       addToFeatureBoot "$SDNR_NETCONF_CALLHOME_FEATURE"
116     fi
117   fi
118 }
119 install_sdnr_oauth_features() {
120   addToFeatureBoot "$SDNROAUTH_BOOTFEATURES"
121 }
122 install_sdnr_northbound_features() {
123   addToFeatureBoot "$SDNR_NORTHBOUND_BOOTFEATURES" 
124 }
125 install_a1_northbound_features() {
126   addToFeatureBoot "$A1_ADAPTER_NORTHBOUND_BOOTFEATURES"
127 }
128 # Reconfigure ODL from default single node configuration to cluster
129
130 enable_odl_cluster() {
131   if [ -z "$SDNC_REPLICAS" ]; then
132      printf "SDNC_REPLICAS is not configured in Env field"
133      exit
134   fi
135
136   # ODL NETCONF setup
137   printf "Installing Opendaylight cluster features for mdsal and netconf\n"
138   
139   #Be sure to remove feature odl-netconf-connector-all from list
140   replaceFeatureBoot "odl-netconf-connector-all,"
141
142   printf "Installing Opendaylight cluster features\n"
143   replaceFeatureBoot odl-netconf-topology odl-netconf-clustered-topology
144   replaceFeatureBoot odl-mdsal-all odl-mdsal-all,odl-mdsal-clustering
145   addToFeatureBoot odl-jolokia
146   #${ODL_HOME}/bin/client feature:install odl-mdsal-clustering
147   #${ODL_HOME}/bin/client feature:install odl-jolokia
148
149   # ODL Cluster or Geo cluster configuration
150   
151   printf "Update cluster information statically\n"
152   fqdn=$(hostname -f)
153   printf "%s\n" "Get current fqdn ${fqdn}"
154
155   # Extract node index using first digit after "-"
156   # Example 2 from "sdnr-2.logo.ost.das.r32.com"
157   node_index=$(echo "${fqdn}" | sed -r 's/.*-([0-9]).*/\1/g')
158   member_offset=1
159
160   if $GEO_ENABLED; then
161     printf "This is a Geo cluster\n"
162
163     if [ -z "$IS_PRIMARY_CLUSTER" ] || [ -z "$MY_ODL_CLUSTER" ] || [ -z "$PEER_ODL_CLUSTER" ]; then
164      printf "IS_PRIMARY_CLUSTER, MY_ODL_CLUSTER and PEER_ODL_CLUSTER must all be configured in Env field\n"
165      return
166     fi
167
168     if $IS_PRIMARY_CLUSTER; then
169        PRIMARY_NODE=${MY_ODL_CLUSTER}
170        SECONDARY_NODE=${PEER_ODL_CLUSTER}
171     else
172        PRIMARY_NODE=${PEER_ODL_CLUSTER}
173        SECONDARY_NODE=${MY_ODL_CLUSTER}
174        member_offset=4
175     fi
176
177     node_list="${PRIMARY_NODE} ${SECONDARY_NODE}"
178
179     "${SDNC_BIN}"/configure_geo_cluster.sh $((node_index+member_offset)) "${node_list}"
180   else
181     printf "This is a local cluster\n"
182     i=0
183     node_list=""
184     # SERVICE_NAME and NAMESPACE are used to create cluster node names and are provided via Helm charts in OOM environment
185     if [ ! -z "$SERVICE_NAME" ] && [ ! -z "$NAMESPACE" ]; then
186        # Extract node name minus the index
187        # Example sdnr from "sdnr-2.logo.ost.das.r32.com"
188        node_name=$(echo "${fqdn}" | sed 's/-[0-9].*$//g')
189        while [ $i -lt "$SDNC_REPLICAS" ]; do
190          node_list="${node_list} ${node_name}-$i.${SERVICE_NAME}-cluster.${NAMESPACE}"
191          i=$(($i + 1))
192        done
193        "${ODL_HOME}"/bin/configure_cluster.sh $((node_index+1)) "${node_list}"
194     elif [ -z "$SERVICE_NAME" ] && [ -z "$NAMESPACE" ]; then
195       # Hostname is used in Standalone environment to create cluster node names
196        while [ $i -lt "$SDNC_REPLICAS" ]; do
197          #assemble node list by replacing node-index in hostname with "i"
198          node_name=$(echo "${fqdn}" | sed -r "s/-[0-9]/-$i/g")
199          node_list="${node_list} ${node_name}"
200          i=$(($i + 1))
201        done
202        "${ODL_HOME}"/bin/configure_cluster.sh $((node_index+1)) "${node_list}"
203     else
204        printf "Unhandled cluster scenario. Terminating the container\n" 
205        printf "Any one of the below 2 conditions should be satisfied for successfully enabling cluster mode : \n"
206        printf "1. OOM Environment - Both SERVICE_NAME and NAMESPACE environment variables have to be set.\n"
207        printf "2. Docker (standalone) Environment - Neither of SERVICE_NAME and NAMESPACE have to be set.\n"
208        printf "Current configuration - SERVICE_NAME = $SERVICE_NAME  NAMESPACE = $NAMESPACE\n"
209        exit $NOTOK
210     fi
211   fi
212 }
213
214
215 # Install SDN-C platform components if not already installed and start container
216
217 # -----------------------
218 # Main script starts here
219 printf "Installing SDNC/R from startODL.sh script\n"
220 ODL_HOME=${ODL_HOME:-/opt/opendaylight/current}
221 ODL_FEATURES_BOOT_FILE=$ODL_HOME/etc/org.apache.karaf.features.cfg
222
223 ODL_ADMIN_USERNAME=${ODL_ADMIN_USERNAME:-admin}
224 ODL_REMOVEIDMDB=${ODL_REMOVEIDMDB:-true}
225
226 if $ODL_REMOVEIDMDB ; then
227   if [ -f $ODL_HOME/data/idmlight.db.mv.db ]; then 
228     rm $ODL_HOME/data/idmlight.db.mv.db
229   fi
230 fi
231
232 SDNC_HOME=${SDNC_HOME:-/opt/onap/sdnc}
233 SDNC_BIN=${SDNC_BIN:-/opt/onap/sdnc/bin}
234 # Whether to intialize MYSql DB or not. Default is to initialize
235 SDNC_DB_INIT=${SDNC_DB_INIT:-false}
236 CCSDK_HOME=${CCSDK_HOME:-/opt/onap/ccsdk}
237 JDEBUG=${JDEBUG:-false}
238 MYSQL_ROOT_PASSWORD=${MYSQL_ROOT_PASSWORD:-openECOMP1.0}
239 ENABLE_ODL_CLUSTER=${ENABLE_ODL_CLUSTER:-false}
240 ENABLE_OAUTH=${ENABLE_OAUTH:-false}
241 ENABLE_ODLUX_RBAC=${ENABLE_ODLUX_RBAC:-false}
242 GEO_ENABLED=${GEO_ENABLED:-false}
243 SDNC_AAF_ENABLED=${SDNC_AAF_ENABLED:-false}
244 IS_PRIMARY_CLUSTER=${IS_PRIMARY_CLUSTER:-false}
245 MY_ODL_CLUSTER=${MY_ODL_CLUSTER:-127.0.0.1}
246 INSTALLED_DIR=${INSTALLED_FILE:-/opt/opendaylight/current/daexim}
247 SDNRWT=${SDNRWT:-false}
248 SDNRODLUX_BOOTFEATURES=${SDNRODLUX_BOOTFEATURES:-sdnr-wt-helpserver-feature,sdnr-wt-odlux-core-feature,sdnr-wt-odlux-apps-feature}
249 SDNROAUTH_BOOTFEATURES=${SDNROAUTH_BOOTFEATURES:-sdnr-wt-feature-aggregator-oauth}
250 SDNRDM=${SDNRDM:-false}
251 SDNR_NETCONF_CALLHOME_ENABLED=${SDNR_NETCONF_CALLHOME_ENABLED:-false}
252 # Add devicemanager features
253 SDNRDM_SDM_LIST=${SDNRDM_SDM_LIST:-sdnr-wt-feature-aggregator-devicemanager}
254 SDNRDM_BOOTFEATURES=${SDNRDM_BOOTFEATURES:-sdnr-wt-feature-aggregator-devicemanager-base,${SDNRDM_SDM_LIST}}
255 # Whether to Initialize the ElasticSearch DB.
256 SDNRINIT=${SDNRINIT:-false}
257 SDNRONLY=${SDNRONLY:-false}
258 SDNRDBURL=${SDNRDBURL:-http://sdnrdb:9200}
259 SDNRDBCOMMAND=${SDNRDBCOMMAND:--c init -db $SDNRDBURL -dbu $SDNRDBUSERNAME -dbp $SDNRDBPASSWORD $SDNRDBPARAMETER}
260
261 SDNR_NORTHBOUND=${SDNR_NORTHBOUND:-false}
262 SDNR_NORTHBOUND_BOOTFEATURES=${SDNR_NORTHBOUND_BOOTFEATURES:-sdnr-northbound-all}
263 SDNR_NETCONF_CALLHOME_FEATURE=${SDNR_NETCONF_CALLHOME_FEATURE:-odl-netconf-callhome-ssh}
264 # if only SDNR features then do not start A1 adapter
265 if $SDNRONLY ; then
266   A1_ADAPTER_NORTHBOUND=false
267 else
268   A1_ADAPTER_NORTHBOUND=${A1_ADAPTER_NORTHBOUND:-true}
269 fi
270 A1_ADAPTER_NORTHBOUND_BOOTFEATURES=${A1_ADAPTER_NORTHBOUND_BOOTFEATURES:-a1-adapter-northbound}
271
272 NOTOK=1
273 #export for installCerts.py
274 export ODL_ADMIN_PASSWORD ODL_ADMIN_USERNAME
275
276 if $JDEBUG ; then
277     printf "Activate remote debugging\n"
278     #JSTADTPOLICYFILE="$ODL_HOME/etc/tools.policy"
279     #echo -e "grant codebase \"file:${JAVA_HOME}/lib/tools.jar\" {\n  permission java.security.AllPermission;\n };" > $JSTADTPOLICYFILE
280     #sleep 1
281     #$JAVA_HOME/bin/jstatd -p 1089 -J-Djava.security.policy=$JSTADTPOLICYFILE &
282     EXTRA_JAVA_OPTS="${EXTRA_JAVA_OPTS} -Dcom.sun.management.jmxremote.port=1090"
283     EXTRA_JAVA_OPTS="${EXTRA_JAVA_OPTS} -Dcom.sun.management.jmxremote.rmi.port=1090"
284     EXTRA_JAVA_OPTS="${EXTRA_JAVA_OPTS} -Djava.rmi.server.hostname=$(hostname)  "
285     EXTRA_JAVA_OPTS="${EXTRA_JAVA_OPTS} -Dcom.sun.management.jmxremote.local.only=false"
286     EXTRA_JAVA_OPTS="${EXTRA_JAVA_OPTS} -Dcom.sun.management.jmxremote.ssl=false"
287     EXTRA_JAVA_OPTS="${EXTRA_JAVA_OPTS} -Dcom.sun.management.jmxremote.authenticate=false"
288     export EXTRA_JAVA_OPTS
289 fi
290
291
292 printf "Settings:\n"
293 printf "%s\n" "  SDNC_BIN=$SDNC_BIN"
294 printf "%s\n" "  SDNC_HOME=$SDNC_HOME"
295 printf "%s\n" "  SDNC_DB_INIT=$SDNC_DB_INIT"
296 printf "%s\n" "  ODL_CERT_DIR=$ODL_CERT_DIR"
297 printf "%s\n" "  CCSDKFEATUREVERSION=$CCSDKFEATUREVERSION"
298 printf "%s\n" "  ENABLE_ODL_CLUSTER=$ENABLE_ODL_CLUSTER"
299 printf "%s\n" "  ODL_REMOVEIDMDB=$ODL_REMOVEIDMDB"
300 printf "%s\n" "  SDNC_REPLICAS=$SDNC_REPLICAS"
301 printf "%s\n" "  ENABLE_OAUTH=$ENABLE_OAUTH"
302 printf "%s\n" "  ENABLE_ODLUX_RBAC=$ENABLE_ODLUX_RBAC"
303 printf "%s\n" "  SDNRWT=$SDNRWT"
304 printf "%s\n" "  SDNRDM=$SDNRDM"
305 printf "%s\n" "  SDNRONLY=$SDNRONLY"
306 printf "%s\n" "  SDNRINIT=$SDNRINIT"
307 printf "%s\n" "  SDNRDBURL=$SDNRDBURL"
308 printf "%s\n" "  SDNRDBUSERNAME=$SDNRDBUSERNAME"
309 printf "%s\n" "  GEO_ENABLED=$GEO_ENABLED"
310 printf "%s\n" "  IS_PRIMARY_CLUSTER=$IS_PRIMARY_CLUSTER"
311 printf "%s\n" "  MY_ODL_CLUSTER=$MY_ODL_CLUSTER"
312 printf "%s\n" "  PEER_ODL_CLUSTER=$PEER_ODL_CLUSTER"
313 printf "%s\n" "  SDNR_NORTHBOUND=$SDNR_NORTHBOUND"
314 printf "%s\n" "  AAF_ENABLED=$SDNC_AAF_ENABLED"
315 printf "%s\n" "  SERVICE_NAME=$SERVICE_NAME"
316 printf "%s\n" "  NAMESPACE=$NAMESPACE"
317 printf "%s\n" "  SDNR_NETCONF_CALLHOME_ENABLED=$SDNR_NETCONF_CALLHOME_ENABLED"
318
319 if "$SDNC_AAF_ENABLED"; then
320         export SDNC_AAF_STORE_DIR=/opt/app/osaaf/local
321         export SDNC_AAF_CONFIG_DIR=/opt/app/osaaf/local
322         export SDNC_KEYPASS=$(cat /opt/app/osaaf/local/.pass)
323         export SDNC_KEYSTORE=org.onap.sdnc.p12
324         sed -i '/cadi_prop_files/d' "$ODL_HOME"/etc/system.properties
325         echo "cadi_prop_files=$SDNC_AAF_CONFIG_DIR/org.onap.sdnc.props" >> "$ODL_HOME"/etc/system.properties
326
327         sed -i '/org.ops4j.pax.web.ssl.keystore/d' "$ODL_HOME"/etc/custom.properties
328         sed -i '/org.ops4j.pax.web.ssl.password/d' "$ODL_HOME"/etc/custom.properties
329         sed -i '/org.ops4j.pax.web.ssl.keypassword/d' "$ODL_HOME"/etc/custom.properties
330         echo "org.ops4j.pax.web.ssl.keystore=$SDNC_AAF_STORE_DIR/$SDNC_KEYSTORE" >> "$ODL_HOME"/etc/custom.properties
331         echo "org.ops4j.pax.web.ssl.password=$SDNC_KEYPASS" >> "$ODL_HOME"/etc/custom.properties
332         echo "org.ops4j.pax.web.ssl.keypassword=$SDNC_KEYPASS" >> "$ODL_HOME"/etc/custom.properties
333 fi
334
335 if $SDNRINIT ; then
336   #One time intialization action
337   initialize_sdnrdb
338   init_result=$?
339   printf "%s\n" "Result of init script: $init_result"
340   if $SDNRWT ; then
341     printf "Proceed to initialize sdnr\n"
342   else
343     exit $init_result
344   fi
345 fi
346
347 # do not start container if ADMIN_PASSWORD is not set
348 if [ -z "$ODL_ADMIN_PASSWORD" ]; then
349   echo "ODL_ADMIN_PASSWORD is not set"
350   exit 1
351 fi
352
353 # Check for MySQL DB connectivity only if SDNC_DB_INIT is set to "true" 
354 if $SDNC_DB_INIT; then
355 #
356 # Wait for database
357 #
358   printf "Waiting for mysql"
359   until mysql -h dbhost -u root -p"${MYSQL_ROOT_PASSWORD}" -e "select 1" > /dev/null 2>&1 
360   do
361     printf "."
362     sleep 1
363   done
364   printf "\nmysql ready"
365 fi
366
367
368 if [ ! -d "${INSTALLED_DIR}" ]
369 then
370     mkdir -p "${INSTALLED_DIR}"
371 fi
372
373 if [ ! -f "${SDNC_HOME}"/.installed ]
374 then
375     # for integration testing. In OOM, a separate job takes care of installing it.
376     if $SDNC_DB_INIT; then
377       printf "Installing SDN-C database\n"
378       "${SDNC_HOME}"/bin/installSdncDb.sh
379     fi
380     printf "Installing SDN-C keyStore\n"
381     "${SDNC_HOME}"/bin/addSdncKeyStore.sh
382     printf "Installing A1-adapter trustStore\n"
383     "${SDNC_HOME}"/bin/addA1TrustStore.sh
384
385     if [ -x "${SDNC_HOME}"/svclogic/bin/install.sh ]
386     then
387       printf "Installing directed graphs\n"
388       "${SDNC_HOME}"/svclogic/bin/install.sh
389     fi
390
391   if $SDNRWT ; then install_sdnrwt_features ; fi
392   if $ENABLE_OAUTH ; then
393     cp $SDNC_HOME/data/oauth-aaa-app-config.xml $ODL_HOME/system/org/opendaylight/aaa/aaa-shiro/0.12.1/aaa-shiro-0.12.1-aaa-app-config.xml
394     install_sdnr_oauth_features 
395   fi
396   
397   # The enable_odl_cluster call should not be moved above this line as the cleanFeatureBoot will overwrite entries. Ex: odl-jolokia
398   if $ENABLE_ODL_CLUSTER ; then enable_odl_cluster ; fi
399
400   if $SDNR_NORTHBOUND ; then install_sdnr_northbound_features ; fi
401   if $A1_ADAPTER_NORTHBOUND ; then install_a1_northbound_features ; fi
402   
403   printf "%s" "Installed at $(date)" > "${SDNC_HOME}"/.installed
404 fi
405
406 #cp /opt/opendaylight/current/certs/* /tmp
407 #cp /var/custom-certs/* /tmp
408
409 if [ -n "$OVERRIDE_FEATURES_BOOT" ] ; then
410   printf "%s\n" "Override features boot: $OVERRIDE_FEATURES_BOOT"
411   sed -i "/$FEATURESBOOTMARKER/c\featuresBoot = $OVERRIDE_FEATURES_BOOT" "$ODL_FEATURES_BOOT_FILE"
412 fi
413
414 # Odl configuration done
415 ODL_REPOSITORIES_BOOT=$(sed -n "/$REPOSITORIESBOOTMARKER/p" "$ODL_FEATURES_BOOT_FILE")
416 ODL_FEATURES_BOOT=$(sed -n "/$FEATURESBOOTMARKER/p" "$ODL_FEATURES_BOOT_FILE")
417 export ODL_FEATURES_BOOT
418
419 # Create ODL data log directory (it nornally is created after karaf
420 # is started, but needs to exist before installCerts.py runs)
421 if [ -z "$ODL_CERT_DIR" ] ; then
422   printf "No certs provided. Skip installation.\n"
423 else
424   printf "Start background cert installer\n"
425   mkdir -p /opt/opendaylight/data/log
426   nohup python3 "${SDNC_BIN}"/installCerts.py &
427   printf "Start monitoring certificate installation. \n"
428   nohup sh "${SDNC_BIN}"/monitorCertsInstall.sh &
429 fi
430
431 printf "Startup opendaylight\n"
432 printf "%s\n" "$ODL_REPOSITORIES_BOOT"
433 printf "%s\n" "$ODL_FEATURES_BOOT"
434 exec "${ODL_HOME}"/bin/karaf server