3 # ============LICENSE_START=======================================================
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
14 # http://www.apache.org/licenses/LICENSE-2.0
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=========================================================
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
28 # Test if repository exists, like this mvn:org.onap.ccsdk.features.sdnr.wt/sdnr-wt-devicemanager-oran-feature/0.7.2/xml/features
31 REPO=$(echo "$1" | sed -E "s#mvn:(.*)/xml/features\$#\1#")
36 path="$ODL_HOME/system/$(echo "$2" | tr '.' '/')/$3/$4"
40 # Add features repository to karaf featuresRepositories configuration
41 # $1 repositories to be added
43 CFG=$ODL_FEATURES_BOOT_FILE
45 if isRepoExisting "$1" ; then
46 printf "%s\n" "Add repository: $1"
47 sed -i "\|featuresRepositories|s|$|, $1|" "$CFG"
49 printf "%s\n" "Repo does not exist: $1"
53 # Append features to karaf boot feature configuration
54 # $1 additional feature to be added
55 # $2 repositories to be added (optional)
57 CFG=$ODL_FEATURES_BOOT_FILE
60 printf "%s\n" "Add repository: $2"
62 sed -e "\|featuresRepositories|s|$|,$2|" "$ORIG" > "$CFG"
64 printf "%s\n" "Add boot feature: $1"
66 sed -e "\|featuresBoot *=|s|$|,$1|" "$ORIG" > "$CFG"
69 # Append features to karaf boot feature configuration
72 replaceFeatureBoot() {
73 CFG="$ODL_HOME"/etc/org.apache.karaf.features.cfg
75 printf "%s %s\n" "Replace boot feature $1 with: $2"
76 sed -i "/featuresBoot/ s/$1/$2/g" "$CFG"
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"
86 printf "SDN-R Database Initialization"
87 INITCMD="$JAVA_HOME/bin/java -jar "
88 FN=$(find "$ODL_HOME/system" -name "sdnr-wt-data-provider-setup-*.jar")
89 INITCMD="${INITCMD} ${FN} $SDNRDBCOMMAND"
90 printf "%s\n" "Execute: $INITCMD"
92 until [ $n -ge 5 ] ; do
100 install_sdnrwt_features() {
101 # Repository setup provided via sdnc dockerfile
106 addToFeatureBoot "$SDNRDM_BOOTFEATURES"
107 if $SDNR_NETCONF_CALLHOME_ENABLED; then
108 addToFeatureBoot "$SDNR_NETCONF_CALLHOME_FEATURE"
112 install_sdnr_oauth_features() {
113 addToFeatureBoot "$SDNROAUTH_BOOTFEATURES"
115 install_sdnr_northbound_features() {
116 addToFeatureBoot "$SDNR_NORTHBOUND_BOOTFEATURES"
118 install_a1_northbound_features() {
119 addToFeatureBoot "$A1_ADAPTER_NORTHBOUND_BOOTFEATURES"
121 # Reconfigure ODL from default single node configuration to cluster
123 enable_odl_cluster() {
124 if [ -z "$SDNC_REPLICAS" ]; then
125 printf "SDNC_REPLICAS is not configured in Env field"
130 printf "Installing Opendaylight cluster features for mdsal and netconf\n"
132 #Be sure to remove feature odl-netconf-connector-all from list
133 replaceFeatureBoot "odl-netconf-connector-all,"
135 printf "Installing Opendaylight cluster features\n"
136 replaceFeatureBoot odl-netconf-topology odl-netconf-clustered-topology
137 replaceFeatureBoot odl-mdsal-all odl-mdsal-all,odl-mdsal-clustering
138 addToFeatureBoot odl-jolokia
139 #${ODL_HOME}/bin/client feature:install odl-mdsal-clustering
140 #${ODL_HOME}/bin/client feature:install odl-jolokia
142 # ODL Cluster or Geo cluster configuration
144 printf "Update cluster information statically\n"
146 printf "%s\n" "Get current fqdn ${fqdn}"
148 # Extract node index using first digit after "-"
149 # Example 2 from "sdnr-2.logo.ost.das.r32.com"
150 node_index=$(echo "${fqdn}" | sed -r 's/.*-([0-9]).*/\1/g')
153 if $GEO_ENABLED; then
154 printf "This is a Geo cluster\n"
156 if [ -z "$IS_PRIMARY_CLUSTER" ] || [ -z "$MY_ODL_CLUSTER" ] || [ -z "$PEER_ODL_CLUSTER" ]; then
157 printf "IS_PRIMARY_CLUSTER, MY_ODL_CLUSTER and PEER_ODL_CLUSTER must all be configured in Env field\n"
161 if $IS_PRIMARY_CLUSTER; then
162 PRIMARY_NODE=${MY_ODL_CLUSTER}
163 SECONDARY_NODE=${PEER_ODL_CLUSTER}
165 PRIMARY_NODE=${PEER_ODL_CLUSTER}
166 SECONDARY_NODE=${MY_ODL_CLUSTER}
170 node_list="${PRIMARY_NODE} ${SECONDARY_NODE}"
172 "${SDNC_BIN}"/configure_geo_cluster.sh $((node_index+member_offset)) "${node_list}"
174 printf "This is a local cluster\n"
177 # SERVICE_NAME and NAMESPACE are used to create cluster node names and are provided via Helm charts in OOM environment
178 if [ ! -z "$SERVICE_NAME" ] && [ ! -z "$NAMESPACE" ]; then
179 # Extract node name minus the index
180 # Example sdnr from "sdnr-2.logo.ost.das.r32.com"
181 node_name=$(echo "${fqdn}" | sed 's/-[0-9].*$//g')
182 while [ $i -lt "$SDNC_REPLICAS" ]; do
183 node_list="${node_list} ${node_name}-$i.${SERVICE_NAME}-cluster.${NAMESPACE}"
186 "${ODL_HOME}"/bin/configure_cluster.sh $((node_index+1)) "${node_list}"
187 elif [ -z "$SERVICE_NAME" ] && [ -z "$NAMESPACE" ]; then
188 # Hostname is used in Standalone environment to create cluster node names
189 while [ $i -lt "$SDNC_REPLICAS" ]; do
190 #assemble node list by replacing node-index in hostname with "i"
191 node_name=$(echo "${fqdn}" | sed -r "s/-[0-9]/-$i/g")
192 node_list="${node_list} ${node_name}"
195 "${ODL_HOME}"/bin/configure_cluster.sh $((node_index+1)) "${node_list}"
197 printf "Unhandled cluster scenario. Terminating the container\n"
198 printf "Any one of the below 2 conditions should be satisfied for successfully enabling cluster mode : \n"
199 printf "1. OOM Environment - Both SERVICE_NAME and NAMESPACE environment variables have to be set.\n"
200 printf "2. Docker (standalone) Environment - Neither of SERVICE_NAME and NAMESPACE have to be set.\n"
201 printf "Current configuration - SERVICE_NAME = $SERVICE_NAME NAMESPACE = $NAMESPACE\n"
208 # Install SDN-C platform components if not already installed and start container
210 # -----------------------
211 # Main script starts here
212 printf "Installing SDNC/R from startODL.sh script\n"
213 ODL_HOME=${ODL_HOME:-/opt/opendaylight/current}
214 ODL_FEATURES_BOOT_FILE=$ODL_HOME/etc/org.apache.karaf.features.cfg
215 FEATURESBOOTMARKER="featuresBoot *="
216 REPOSITORIESBOOTMARKER="featuresRepositories *="
218 ODL_ADMIN_USERNAME=${ODL_ADMIN_USERNAME:-admin}
219 ODL_REMOVEIDMDB=${ODL_REMOVEIDMDB:-true}
221 if $ODL_REMOVEIDMDB ; then
222 if [ -f $ODL_HOME/data/idmlight.db.mv.db ]; then
223 rm $ODL_HOME/data/idmlight.db.mv.db
227 CCSDK_HOME=${CCSDK_HOME:-/opt/onap/ccsdk}
228 SDNC_HOME=${SDNC_HOME:-/opt/onap/sdnc}
229 SDNC_BIN=${SDNC_BIN:-/opt/onap/sdnc/bin}
230 JDEBUG=${JDEBUG:-false}
231 SDNC_AAF_ENABLED=${SDNC_AAF_ENABLED:-false}
232 INSTALLED_DIR=${INSTALLED_FILE:-/opt/opendaylight/current/daexim}
234 # Whether to intialize MYSql DB or not. Default is to initialize
235 SDNC_DB_INIT=${SDNC_DB_INIT:-false}
236 MYSQL_ROOT_PASSWORD=${MYSQL_ROOT_PASSWORD:-openECOMP1.0}
238 IS_PRIMARY_CLUSTER=${IS_PRIMARY_CLUSTER:-false}
239 MY_ODL_CLUSTER=${MY_ODL_CLUSTER:-127.0.0.1}
240 ENABLE_ODL_CLUSTER=${ENABLE_ODL_CLUSTER:-false}
241 ENABLE_OAUTH=${ENABLE_OAUTH:-false}
242 ENABLE_ODLUX_RBAC=${ENABLE_ODLUX_RBAC:-false}
243 GEO_ENABLED=${GEO_ENABLED:-false}
245 SDNRWT=${SDNRWT:-false}
246 SDNRDM=${SDNRDM:-false}
247 SDNROAUTH_BOOTFEATURES=${SDNROAUTH_BOOTFEATURES:-sdnr-wt-feature-aggregator-oauth}
248 SDNR_NETCONF_CALLHOME_ENABLED=${SDNR_NETCONF_CALLHOME_ENABLED:-false}
250 # Add devicemanager features
251 SDNRDM_SDM_LIST=${SDNRDM_SDM_LIST:-sdnr-wt-feature-aggregator-devicemanager}
252 SDNRDM_BOOTFEATURES=${SDNRDM_BOOTFEATURES:-sdnr-wt-feature-aggregator-devicemanager-base,${SDNRDM_SDM_LIST}}
254 # Whether to Initialize the ElasticSearch DB.
255 SDNRINIT=${SDNRINIT:-false}
256 SDNRONLY=${SDNRONLY:-false}
257 SDNRDBTYPE=${SDNRDBTYPE:-ELASTICSEARCH}
258 SDNRDBURL=${SDNRDBURL:-http://sdnrdb:9200}
259 SDNRDBCOMMAND=${SDNRDBCOMMAND:--c init -db $SDNRDBURL -dbt $SDNRDBTYPE -dbu $SDNRDBUSERNAME -dbp $SDNRDBPASSWORD $SDNRDBPARAMETER}
260 SDNR_WEBSOCKET_PORT=${SDNR_WEBSOCKET_PORT:-8182}
262 SDNR_NORTHBOUND=${SDNR_NORTHBOUND:-false}
263 SDNR_NORTHBOUND_BOOTFEATURES=${SDNR_NORTHBOUND_BOOTFEATURES:-sdnr-northbound-all}
264 SDNR_NETCONF_CALLHOME_FEATURE=${SDNR_NETCONF_CALLHOME_FEATURE:-odl-netconf-callhome-ssh}
266 # if only SDNR features then do not start A1 adapter
268 A1_ADAPTER_NORTHBOUND=false
270 A1_ADAPTER_NORTHBOUND=${A1_ADAPTER_NORTHBOUND:-true}
272 A1_ADAPTER_NORTHBOUND_BOOTFEATURES=${A1_ADAPTER_NORTHBOUND_BOOTFEATURES:-a1-adapter-northbound}
275 #export for installCerts.py
276 export ODL_ADMIN_PASSWORD ODL_ADMIN_USERNAME
279 printf "Activate remote debugging\n"
280 #JSTADTPOLICYFILE="$ODL_HOME/etc/tools.policy"
281 #echo -e "grant codebase \"file:${JAVA_HOME}/lib/tools.jar\" {\n permission java.security.AllPermission;\n };" > $JSTADTPOLICYFILE
283 #$JAVA_HOME/bin/jstatd -p 1089 -J-Djava.security.policy=$JSTADTPOLICYFILE &
284 EXTRA_JAVA_OPTS="${EXTRA_JAVA_OPTS} -Dcom.sun.management.jmxremote.port=1090"
285 EXTRA_JAVA_OPTS="${EXTRA_JAVA_OPTS} -Dcom.sun.management.jmxremote.rmi.port=1090"
286 EXTRA_JAVA_OPTS="${EXTRA_JAVA_OPTS} -Djava.rmi.server.hostname=$(hostname) "
287 EXTRA_JAVA_OPTS="${EXTRA_JAVA_OPTS} -Dcom.sun.management.jmxremote.local.only=false"
288 EXTRA_JAVA_OPTS="${EXTRA_JAVA_OPTS} -Dcom.sun.management.jmxremote.ssl=false"
289 EXTRA_JAVA_OPTS="${EXTRA_JAVA_OPTS} -Dcom.sun.management.jmxremote.authenticate=false"
290 export EXTRA_JAVA_OPTS
295 printf "%s\n" " SDNC_BIN=$SDNC_BIN"
296 printf "%s\n" " SDNC_HOME=$SDNC_HOME"
297 printf "%s\n" " SDNC_DB_INIT=$SDNC_DB_INIT"
298 printf "%s\n" " ODL_CERT_DIR=$ODL_CERT_DIR"
299 printf "%s\n" " ENABLE_ODL_CLUSTER=$ENABLE_ODL_CLUSTER"
300 printf "%s\n" " ODL_REMOVEIDMDB=$ODL_REMOVEIDMDB"
301 printf "%s\n" " SDNC_REPLICAS=$SDNC_REPLICAS"
302 printf "%s\n" " ENABLE_OAUTH=$ENABLE_OAUTH"
303 printf "%s\n" " ENABLE_ODLUX_RBAC=$ENABLE_ODLUX_RBAC"
304 printf "%s\n" " SDNRWT=$SDNRWT"
305 printf "%s\n" " SDNRDM=$SDNRDM"
306 printf "%s\n" " SDNRONLY=$SDNRONLY"
307 printf "%s\n" " SDNRINIT=$SDNRINIT"
308 printf "%s\n" " SDNRDBURL=$SDNRDBURL"
309 printf "%s\n" " SDNRDBTYPE=$SDNRDBTYPE"
310 printf "%s\n" " SDNRDBUSERNAME=$SDNRDBUSERNAME"
311 printf "%s\n" " GEO_ENABLED=$GEO_ENABLED"
312 printf "%s\n" " IS_PRIMARY_CLUSTER=$IS_PRIMARY_CLUSTER"
313 printf "%s\n" " MY_ODL_CLUSTER=$MY_ODL_CLUSTER"
314 printf "%s\n" " PEER_ODL_CLUSTER=$PEER_ODL_CLUSTER"
315 printf "%s\n" " SDNR_NORTHBOUND=$SDNR_NORTHBOUND"
316 printf "%s\n" " AAF_ENABLED=$SDNC_AAF_ENABLED"
317 printf "%s\n" " SERVICE_NAME=$SERVICE_NAME"
318 printf "%s\n" " NAMESPACE=$NAMESPACE"
319 printf "%s\n" " SDNR_NETCONF_CALLHOME_ENABLED=$SDNR_NETCONF_CALLHOME_ENABLED"
321 if "$SDNC_AAF_ENABLED"; then
322 export SDNC_AAF_STORE_DIR=/opt/app/osaaf/local
323 export SDNC_AAF_CONFIG_DIR=/opt/app/osaaf/local
324 export SDNC_KEYPASS=$(cat /opt/app/osaaf/local/.pass)
325 export SDNC_KEYSTORE=org.onap.sdnc.p12
326 sed -i '/cadi_prop_files/d' "$ODL_HOME"/etc/system.properties
327 echo "cadi_prop_files=$SDNC_AAF_CONFIG_DIR/org.onap.sdnc.props" >> "$ODL_HOME"/etc/system.properties
329 sed -i '/org.ops4j.pax.web.ssl.keystore/d' "$ODL_HOME"/etc/custom.properties
330 sed -i '/org.ops4j.pax.web.ssl.password/d' "$ODL_HOME"/etc/custom.properties
331 sed -i '/org.ops4j.pax.web.ssl.keypassword/d' "$ODL_HOME"/etc/custom.properties
332 echo "org.ops4j.pax.web.ssl.keystore=$SDNC_AAF_STORE_DIR/$SDNC_KEYSTORE" >> "$ODL_HOME"/etc/custom.properties
333 echo "org.ops4j.pax.web.ssl.password=\"$SDNC_KEYPASS\"" >> "$ODL_HOME"/etc/custom.properties
334 echo "org.ops4j.pax.web.ssl.keypassword=\"$SDNC_KEYPASS\"" >> "$ODL_HOME"/etc/custom.properties
338 #One time intialization action
341 printf "%s\n" "Result of init script: $init_result"
343 printf "Proceed to initialize sdnr\n"
349 # do not start container if ADMIN_PASSWORD is not set
350 if [ -z "$ODL_ADMIN_PASSWORD" ]; then
351 echo "ODL_ADMIN_PASSWORD is not set"
355 # Check for MySQL DB connectivity only if SDNC_DB_INIT is set to "true"
356 if $SDNC_DB_INIT; then
360 printf "Waiting for mysql"
361 until mysql -h dbhost -u root -p"${MYSQL_ROOT_PASSWORD}" -e "select 1" > /dev/null 2>&1
366 printf "\nmysql ready"
370 if [ ! -d "${INSTALLED_DIR}" ]
372 mkdir -p "${INSTALLED_DIR}"
375 if [ ! -f "${SDNC_HOME}"/.installed ]
377 # for integration testing. In OOM, a separate job takes care of installing it.
378 if $SDNC_DB_INIT; then
379 printf "Installing SDN-C database\n"
380 "${SDNC_HOME}"/bin/installSdncDb.sh
382 printf "Installing SDN-C keyStore\n"
383 "${SDNC_HOME}"/bin/addSdncKeyStore.sh
384 printf "Installing A1-adapter trustStore\n"
385 "${SDNC_HOME}"/bin/addA1TrustStore.sh
387 if [ -x "${SDNC_HOME}"/svclogic/bin/install.sh ]
389 printf "Installing directed graphs\n"
390 "${SDNC_HOME}"/svclogic/bin/install.sh
393 if $SDNRWT ; then install_sdnrwt_features ; fi
394 if $ENABLE_OAUTH ; then
395 cp $SDNC_HOME/data/oauth-aaa-app-config.xml $(find $ODL_HOME/system/org/opendaylight/aaa/ -name *aaa-app-config.xml)
396 echo -e "\norg.ops4j.pax.web.session.cookie = none" >> $ODL_HOME/etc/org.ops4j.pax.web.cfg
397 install_sdnr_oauth_features
400 # The enable_odl_cluster call should not be moved above this line as the cleanFeatureBoot will overwrite entries. Ex: odl-jolokia
401 if $ENABLE_ODL_CLUSTER ; then enable_odl_cluster ; fi
403 if $SDNR_NORTHBOUND ; then install_sdnr_northbound_features ; fi
404 if $A1_ADAPTER_NORTHBOUND ; then install_a1_northbound_features ; fi
406 printf "%s" "Installed at $(date)" > "${SDNC_HOME}"/.installed
409 #cp /opt/opendaylight/current/certs/* /tmp
410 #cp /var/custom-certs/* /tmp
412 if [ -n "$OVERRIDE_FEATURES_BOOT" ] ; then
413 printf "%s\n" "Override features boot: $OVERRIDE_FEATURES_BOOT"
414 sed -i "/$FEATURESBOOTMARKER/c\featuresBoot = $OVERRIDE_FEATURES_BOOT" "$ODL_FEATURES_BOOT_FILE"
417 # Odl configuration done
418 ODL_REPOSITORIES_BOOT=$(sed -n "/$REPOSITORIESBOOTMARKER/p" "$ODL_FEATURES_BOOT_FILE")
419 ODL_FEATURES_BOOT=$(sed -n "/$FEATURESBOOTMARKER/p" "$ODL_FEATURES_BOOT_FILE")
420 export ODL_FEATURES_BOOT
422 # Create ODL data log directory (it nornally is created after karaf
423 # is started, but needs to exist before installCerts.py runs)
424 if [ -z "$ODL_CERT_DIR" ] ; then
425 printf "No certs provided. Skip installation.\n"
427 printf "Start background cert installer\n"
428 mkdir -p /opt/opendaylight/data/log
429 nohup python3 "${SDNC_BIN}"/installCerts.py &
430 printf "Start monitoring certificate installation. \n"
431 nohup sh "${SDNC_BIN}"/monitorCertsInstall.sh &
434 printf "Startup opendaylight\n"
435 printf "%s\n" "$ODL_REPOSITORIES_BOOT"
436 printf "%s\n" "$ODL_FEATURES_BOOT"
438 exec "${ODL_HOME}"/bin/karaf server