installers/full_install_osm.sh

   1 #!/bin/bash
   2 #
   3 #   Licensed under the Apache License, Version 2.0 (the "License");
   4 #   you may not use this file except in compliance with the License.
   5 #   You may obtain a copy of the License at
   6 #
   7 #       http://www.apache.org/licenses/LICENSE-2.0
   8 #
   9 #   Unless required by applicable law or agreed to in writing, software
  10 #   distributed under the License is distributed on an "AS IS" BASIS,
  11 #   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12 #   See the License for the specific language governing permissions and
  13 #   limitations under the License.
  14 #
  15
  16 function usage(){
  17     [ -z "${DEBUG_INSTALL}" ] || DEBUG beginning of function
  18     echo -e "usage: $0 [OPTIONS]"
  19     echo -e "Install OSM"
  20     echo -e "  OPTIONS"
  21     echo -e "     -h / --help:    print this help"
  22     echo -e "     -y:             do not prompt for confirmation, assumes yes"
  23     echo -e "     -r <repo>:      use specified repository name for osm packages"
  24     echo -e "     -R <release>:   use specified release for osm binaries (deb packages, lxd images, ...)"
  25     echo -e "     -u <repo base>: use specified repository url for osm packages"
  26     echo -e "     -k <repo key>:  use specified repository public key url"
  27     echo -e "     -b <refspec>:   install OSM from source code using a specific branch (master, v2.0, ...) or tag"
  28     echo -e "                     -b master          (main dev branch)"
  29     echo -e "                     -b v2.0            (v2.0 branch)"
  30     echo -e "                     -b tags/v1.1.0     (a specific tag)"
  31     echo -e "                     ..."
  32     echo -e "     -a <apt proxy url>: use this apt proxy url when downloading apt packages (air-gapped installation)"
  33     echo -e "     -s <namespace>  namespace when installed using k8s, default is osm"
  34     echo -e "     -H <VCA host>   use specific juju host controller IP"
  35     echo -e "     -S <VCA secret> use VCA/juju secret key"
  36     echo -e "     -P <VCA pubkey> use VCA/juju public key file"
  37     echo -e "     -A <VCA apiproxy> use VCA/juju API proxy"
  38     echo -e "     --pla:          install the PLA module for placement support"
  39     echo -e "     --old-sa:       install old Service Assurance framework (MON, POL); do not install Airflow and Pushgateway"
  40     echo -e "     --ng-sa:        install new Service Assurance framework (Airflow, AlertManager and Pushgateway)  (enabled by default)"
  41     echo -e "     -m <MODULE>:    install OSM but only rebuild or pull the specified docker images (NG-UI, NBI, LCM, RO, MON, POL, PLA, KAFKA, MONGO, PROMETHEUS, PROMETHEUS-CADVISOR, KEYSTONE-DB, NONE)"
  42     echo -e "     -o <ADDON>:     ONLY (un)installs one of the addons (k8s_monitor, ng-sa)"
  43     echo -e "     -O <openrc file path/cloud name>: Install OSM to an OpenStack infrastructure. <openrc file/cloud name> is required. If a <cloud name> is used, the clouds.yaml file should be under ~/.config/openstack/ or /etc/openstack/"
  44     echo -e "     -N <openstack public network name/ID>: Public network name required to setup OSM to OpenStack"
  45     echo -e "     -f <path to SSH public key>: Public SSH key to use to deploy OSM to OpenStack"
  46     echo -e "     -F <path to cloud-init file>: Cloud-Init userdata file to deploy OSM to OpenStack"
  47     echo -e "     -D <devops path> use local devops installation path"
  48     echo -e "     -w <work dir>   Location to store runtime installation"
  49     echo -e "     -t <docker tag> specify osm docker tag (default is latest)"
  50     echo -e "     -l:             LXD cloud yaml file"
  51     echo -e "     -L:             LXD credentials yaml file"
  52     echo -e "     -K:             Specifies the name of the controller to use - The controller must be already bootstrapped"
  53     echo -e "     -d <docker registry URL> use docker registry URL instead of dockerhub"
  54     echo -e "     -p <docker proxy URL> set docker proxy URL as part of docker CE configuration"
  55     echo -e "     -T <docker tag> specify docker tag for the modules specified with option -m"
  56     echo -e "     --debug:        debug mode"
  57     echo -e "     --nocachelxdimages:  do not cache local lxd images, do not create cronjob for that cache (will save installation time, might affect instantiation time)"
  58     echo -e "     --cachelxdimages:  cache local lxd images, create cronjob for that cache (will make installation longer)"
  59     echo -e "     --nolxd:        do not install and configure LXD, allowing unattended installations (assumes LXD is already installed and confifured)"
  60     echo -e "     --nodocker:     do not install docker, do not initialize a swarm (assumes docker is already installed and a swarm has been initialized)"
  61     echo -e "     --nojuju:       do not juju, assumes already installed"
  62     echo -e "     --nodockerbuild:do not build docker images (use existing locally cached images)"
  63     echo -e "     --nohostports:  do not expose docker ports to host (useful for creating multiple instances of osm on the same host)"
  64     echo -e "     --nohostclient: do not install the osmclient"
  65     echo -e "     --uninstall:    uninstall OSM: remove the containers and delete NAT rules"
  66     echo -e "     --source:       install OSM from source code using the latest stable tag"
  67     echo -e "     --develop:      (deprecated, use '-b master') install OSM from source code using the master branch"
  68     echo -e "     --pullimages:   pull/run osm images from docker.io/opensourcemano"
  69     echo -e "     --k8s_monitor:  install the OSM kubernetes monitoring with prometheus and grafana"
  70     echo -e "     --volume:       create a VM volume when installing to OpenStack"
  71     echo -e "     --showopts:     print chosen options and exit (only for debugging)"
  72     echo -e "     --charmed:                   Deploy and operate OSM with Charms on k8s"
  73     echo -e "     [--bundle <bundle path>]:    Specify with which bundle to deploy OSM with charms (--charmed option)"
  74     echo -e "     [--k8s <kubeconfig path>]:   Specify with which kubernetes to deploy OSM with charms (--charmed option)"
  75     echo -e "     [--vca <name>]:              Specifies the name of the controller to use - The controller must be already bootstrapped (--charmed option)"
  76     echo -e "     [--small-profile]:           Do not install and configure LXD which aims to use only K8s Clouds (--charmed option)"
  77     echo -e "     [--lxd <yaml path>]:         Takes a YAML file as a parameter with the LXD Cloud information (--charmed option)"
  78     echo -e "     [--lxd-cred <yaml path>]:    Takes a YAML file as a parameter with the LXD Credentials information (--charmed option)"
  79     echo -e "     [--microstack]:              Installs microstack as a vim. (--charmed option)"
  80     echo -e "     [--overlay]:                 Add an overlay to override some defaults of the default bundle (--charmed option)"
  81     echo -e "     [--ha]:                      Installs High Availability bundle. (--charmed option)"
  82     echo -e "     [--tag]:                     Docker image tag. (--charmed option)"
  83     echo -e "     [--registry]:                Docker registry with optional credentials as user:pass@hostname:port (--charmed option)"
  84     [ -z "${DEBUG_INSTALL}" ] || DEBUG end of function
  85 }
  86
  87 # takes a juju/accounts.yaml file and returns the password specific
  88 # for a controller. I wrote this using only bash tools to minimize
  89 # additions of other packages
  90 function parse_juju_password {
  91     [ -z "${DEBUG_INSTALL}" ] || DEBUG beginning of function
  92     password_file="${HOME}/.local/share/juju/accounts.yaml"
  93     local controller_name=$1
  94     local s='[[:space:]]*' w='[a-zA-Z0-9_-]*' fs=$(echo @|tr @ '\034')
  95     sed -ne "s|^\($s\):|\1|" \
  96          -e "s|^\($s\)\($w\)$s:$s[\"']\(.*\)[\"']$s\$|\1$fs\2$fs\3|p" \
  97          -e "s|^\($s\)\($w\)$s:$s\(.*\)$s\$|\1$fs\2$fs\3|p" $password_file |
  98     awk -F$fs -v controller=$controller_name '{
  99         indent = length($1)/2;
 100         vname[indent] = $2;
 101         for (i in vname) {if (i > indent) {delete vname[i]}}
 102         if (length($3) > 0) {
 103             vn=""; for (i=0; i<indent; i++) {vn=(vn)(vname[i])("_")}
 104             if (match(vn,controller) && match($2,"password")) {
 105                 printf("%s",$3);
 106             }
 107         }
 108     }'
 109     [ -z "${DEBUG_INSTALL}" ] || DEBUG end of function
 110 }
 111
 112 function set_vca_variables() {
 113     OSM_VCA_CLOUDNAME="lxd-cloud"
 114     [ -n "$OSM_VCA_HOST" ] && OSM_VCA_CLOUDNAME="localhost"
 115     if [ -z "$OSM_VCA_HOST" ]; then
 116         [ -z "$CONTROLLER_NAME" ] && OSM_VCA_HOST=`sg lxd -c "juju show-controller $OSM_NAMESPACE"|grep api-endpoints|awk -F\' '{print $2}'|awk -F\: '{print $1}'`
 117         [ -n "$CONTROLLER_NAME" ] && OSM_VCA_HOST=`juju show-controller $CONTROLLER_NAME |grep api-endpoints|awk -F\' '{print $2}'|awk -F\: '{print $1}'`
 118         [ -z "$OSM_VCA_HOST" ] && FATAL "Cannot obtain juju controller IP address"
 119     fi
 120     if [ -z "$OSM_VCA_SECRET" ]; then
 121         [ -z "$CONTROLLER_NAME" ] && OSM_VCA_SECRET=$(parse_juju_password $OSM_NAMESPACE)
 122         [ -n "$CONTROLLER_NAME" ] && OSM_VCA_SECRET=$(parse_juju_password $CONTROLLER_NAME)
 123         [ -z "$OSM_VCA_SECRET" ] && FATAL "Cannot obtain juju secret"
 124     fi
 125     if [ -z "$OSM_VCA_PUBKEY" ]; then
 126         OSM_VCA_PUBKEY=$(cat $HOME/.local/share/juju/ssh/juju_id_rsa.pub)
 127         [ -z "$OSM_VCA_PUBKEY" ] && FATAL "Cannot obtain juju public key"
 128     fi
 129     if [ -z "$OSM_VCA_CACERT" ]; then
 130         [ -z "$CONTROLLER_NAME" ] && OSM_VCA_CACERT=$(juju controllers --format json | jq -r --arg controller $OSM_NAMESPACE '.controllers[$controller]["ca-cert"]' | base64 | tr -d \\n)
 131         [ -n "$CONTROLLER_NAME" ] && OSM_VCA_CACERT=$(juju controllers --format json | jq -r --arg controller $CONTROLLER_NAME '.controllers[$controller]["ca-cert"]' | base64 | tr -d \\n)
 132         [ -z "$OSM_VCA_CACERT" ] && FATAL "Cannot obtain juju CA certificate"
 133     fi
 134 }
 135
 136 function generate_secret() {
 137     [ -z "${DEBUG_INSTALL}" ] || DEBUG beginning of function
 138     head /dev/urandom | tr -dc A-Za-z0-9 | head -c 32
 139     [ -z "${DEBUG_INSTALL}" ] || DEBUG end of function
 140 }
 141
 142 function check_packages() {
 143     NEEDED_PACKAGES="$1"
 144     echo -e "Checking required packages: ${NEEDED_PACKAGES}"
 145     for PACKAGE in ${NEEDED_PACKAGES} ; do
 146         dpkg -L ${PACKAGE}
 147         if [ $? -ne 0 ]; then
 148             echo -e "Package ${PACKAGE} is not installed."
 149             echo -e "Updating apt-cache ..."
 150             sudo apt-get update
 151             echo -e "Installing ${PACKAGE} ..."
 152             sudo apt-get install -y ${PACKAGE} || FATAL "failed to install ${PACKAGE}"
 153         fi
 154     done
 155     echo -e "Required packages are present: ${NEEDED_PACKAGES}"
 156 }
 157
 158 function ask_user(){
 159     # ask to the user and parse a response among 'y', 'yes', 'n' or 'no'. Case insensitive
 160     # Params: $1 text to ask;   $2 Action by default, can be 'y' for yes, 'n' for no, other or empty for not allowed
 161     # Return: true(0) if user type 'yes'; false (1) if user type 'no'
 162     [ -z "${DEBUG_INSTALL}" ] || DEBUG beginning of function
 163     read -e -p "$1" USER_CONFIRMATION
 164     while true ; do
 165         [ -z "$USER_CONFIRMATION" ] && [ "$2" == 'y' ] && return 0
 166         [ -z "$USER_CONFIRMATION" ] && [ "$2" == 'n' ] && return 1
 167         [ "${USER_CONFIRMATION,,}" == "yes" ] || [ "${USER_CONFIRMATION,,}" == "y" ] && return 0
 168         [ "${USER_CONFIRMATION,,}" == "no" ]  || [ "${USER_CONFIRMATION,,}" == "n" ] && return 1
 169         read -e -p "Please type 'yes' or 'no': " USER_CONFIRMATION
 170     done
 171     [ -z "${DEBUG_INSTALL}" ] || DEBUG end of function
 172 }
 173
 174 function install_osmclient(){
 175     [ -z "${DEBUG_INSTALL}" ] || DEBUG beginning of function
 176     CLIENT_RELEASE=${RELEASE#"-R "}
 177     CLIENT_REPOSITORY_KEY="OSM%20ETSI%20Release%20Key.gpg"
 178     CLIENT_REPOSITORY=${REPOSITORY#"-r "}
 179     CLIENT_REPOSITORY_BASE=${REPOSITORY_BASE#"-u "}
 180     key_location=$CLIENT_REPOSITORY_BASE/$CLIENT_RELEASE/$CLIENT_REPOSITORY_KEY
 181     curl $key_location | sudo APT_KEY_DONT_WARN_ON_DANGEROUS_USAGE=1 apt-key add -
 182     sudo add-apt-repository -y "deb [arch=amd64] $CLIENT_REPOSITORY_BASE/$CLIENT_RELEASE $CLIENT_REPOSITORY osmclient IM"
 183     sudo apt-get -y update
 184     sudo DEBIAN_FRONTEND=noninteractive apt-get install -y python3-pip
 185     sudo -H LC_ALL=C python3 -m pip install -U pip
 186     sudo DEBIAN_FRONTEND=noninteractive apt-get install -y python3-osm-im python3-osmclient
 187     if [ -f /usr/lib/python3/dist-packages/osm_im/requirements.txt ]; then
 188         python3 -m pip install -r /usr/lib/python3/dist-packages/osm_im/requirements.txt
 189     fi
 190     if [ -f /usr/lib/python3/dist-packages/osmclient/requirements.txt ]; then
 191         sudo DEBIAN_FRONTEND=noninteractive apt-get install -y libmagic1
 192         python3 -m pip install -r /usr/lib/python3/dist-packages/osmclient/requirements.txt
 193     fi
 194     [ -z "$INSTALL_LIGHTWEIGHT" ] && export OSM_HOSTNAME=`lxc list | awk '($2=="SO-ub"){print $6}'`
 195     [ -z "$INSTALL_LIGHTWEIGHT" ] && export OSM_RO_HOSTNAME=`lxc list | awk '($2=="RO"){print $6}'`
 196     echo -e "\nOSM client installed"
 197     if [ -z "$INSTALL_LIGHTWEIGHT" ]; then
 198         echo -e "You might be interested in adding the following OSM client env variables to your .bashrc file:"
 199         echo "     export OSM_HOSTNAME=${OSM_HOSTNAME}"
 200         echo "     export OSM_RO_HOSTNAME=${OSM_RO_HOSTNAME}"
 201     else
 202         echo -e "OSM client assumes that OSM host is running in localhost (127.0.0.1)."
 203         echo -e "In case you want to interact with a different OSM host, you will have to configure this env variable in your .bashrc file:"
 204         echo "     export OSM_HOSTNAME=<OSM_host>"
 205     fi
 206     [ -z "${DEBUG_INSTALL}" ] || DEBUG end of function
 207     return 0
 208 }
 209
 210 function docker_login() {
 211     [ -z "${DEBUG_INSTALL}" ] || DEBUG beginning of function
 212     echo "Docker login"
 213     [ -z "${DEBUG_INSTALL}" ] || DEBUG "Docker registry user: ${DOCKER_REGISTRY_USER}"
 214     sg docker -c "docker login -u ${DOCKER_REGISTRY_USER} -p ${DOCKER_REGISTRY_PASSWORD} --password-stdin"
 215     [ -z "${DEBUG_INSTALL}" ] || DEBUG end of function
 216 }
 217
 218 function pull_docker_images() {
 219     [ -z "${DEBUG_INSTALL}" ] || DEBUG beginning of function
 220     echo "Pulling docker images"
 221     [ -n "${DOCKER_REGISTRY_URL}" ] && docker_login
 222
 223     echo "Pulling non-OSM docker images"
 224     sg docker -c "docker pull wurstmeister/zookeeper" || FATAL "cannot get zookeeper docker image"
 225     sg docker -c "docker pull wurstmeister/kafka:${KAFKA_TAG}" || FATAL "cannot get kafka docker image"
 226     sg docker -c "docker pull prom/prometheus:${PROMETHEUS_TAG}" || FATAL "cannot get prometheus docker image"
 227     sg docker -c "docker pull google/cadvisor:${PROMETHEUS_CADVISOR_TAG}" || FATAL "cannot get prometheus cadvisor docker image"
 228     sg docker -c "docker pull grafana/grafana:${GRAFANA_TAG}" || FATAL "cannot get grafana docker image"
 229     sg docker -c "docker pull kiwigrid/k8s-sidecar:${KIWIGRID_K8S_SIDECAR_TAG}" || FATAL "cannot get kiwigrid k8s-sidecar docker image"
 230     sg docker -c "docker pull mariadb:${KEYSTONEDB_TAG}" || FATAL "cannot get keystone-db docker image"
 231     sg docker -c "docker pull mysql:5" || FATAL "cannot get mysql docker image"
 232
 233     list_of_modules="MON NBI KEYSTONE RO LCM NG-UI osmclient prometheus"
 234     if [ -n "$INSTALL_NGSA" ]; then
 235         list_of_modules="${list_of_modules} Airflow Webhook"
 236     else
 237         list_of_modules="${list_of_modules} POL"
 238     fi
 239     if [ -n "$INSTALL_PLA" ]; then
 240         list_of_modules="${list_of_modules} PLA"
 241     fi
 242     echo "Pulling OSM docker images for the following modules: ${list_of_modules}"
 243     for module in ${list_of_modules}; do
 244         module_lower=${module,,}
 245         module_tag="${OSM_DOCKER_TAG}"
 246         if [ -n "${MODULE_DOCKER_TAG}" ] && echo $TO_REBUILD | grep -q $module ; then
 247             module_tag="${MODULE_DOCKER_TAG}"
 248         fi
 249         echo "Pulling ${DOCKER_REGISTRY_URL}${DOCKER_USER}/${module_lower}:${module_tag} docker image"
 250         sg docker -c "docker pull ${DOCKER_REGISTRY_URL}${DOCKER_USER}/${module_lower}:${module_tag}" || FATAL "cannot pull $module docker image"
 251     done
 252
 253     echo "Finished pulling docker images"
 254     [ -z "${DEBUG_INSTALL}" ] || DEBUG end of function
 255 }
 256
 257 function generate_docker_images() {
 258     [ -z "${DEBUG_INSTALL}" ] || DEBUG beginning of function
 259     echo "Generating docker images"
 260     _build_from=$COMMIT_ID
 261     [ -z "$_build_from" ] && _build_from="latest"
 262     echo "OSM Docker images generated from $_build_from"
 263     LWTEMPDIR="$(mktemp -d -q --tmpdir "installosmlight.XXXXXX")"
 264     trap 'rm -rf "${LWTEMPDIR}"' EXIT
 265     for module in MON POL NBI KEYSTONE RO LCM NG-UI PLA; do
 266         if [ -z "$TO_REBUILD" ] || echo $TO_REBUILD | grep -q ${module} ; then
 267             module_lower=${module,,}
 268             if [ $module == "PLA" -a ! -n "$INSTALL_PLA" ]; then
 269                 continue
 270             fi
 271             git -C ${LWTEMPDIR} clone https://osm.etsi.org/gerrit/osm/$module
 272             git -C ${LWTEMPDIR}/${module} checkout ${COMMIT_ID}
 273             sg docker -c "docker build ${LWTEMPDIR}/${module} -f ${LWTEMPDIR}/${module}/docker/Dockerfile -t ${DOCKER_USER}/${module_lower} --no-cache" || FATAL "cannot build ${module} docker image"
 274         fi
 275     done
 276     if [ -z "$TO_REBUILD" ] || echo $TO_REBUILD | grep -q osmclient; then
 277         BUILD_ARGS+=(--build-arg REPOSITORY="$REPOSITORY")
 278         BUILD_ARGS+=(--build-arg RELEASE="$RELEASE")
 279         BUILD_ARGS+=(--build-arg REPOSITORY_KEY="$REPOSITORY_KEY")
 280         BUILD_ARGS+=(--build-arg REPOSITORY_BASE="$REPOSITORY_BASE")
 281         sg docker -c "docker build -t ${DOCKER_USER}/osmclient ${BUILD_ARGS[@]} -f $OSM_DEVOPS/docker/osmclient ."
 282     fi
 283     echo "Finished generation of docker images"
 284     [ -z "${DEBUG_INSTALL}" ] || DEBUG end of function
 285 }
 286
 287 function cmp_overwrite() {
 288     [ -z "${DEBUG_INSTALL}" ] || DEBUG beginning of function
 289     file1="$1"
 290     file2="$2"
 291     if ! $(cmp "${file1}" "${file2}" >/dev/null 2>&1); then
 292         if [ -f "${file2}" ]; then
 293             ask_user "The file ${file2} already exists. Overwrite (y/N)? " n && cp -b ${file1} ${file2}
 294         else
 295             cp -b ${file1} ${file2}
 296         fi
 297     fi
 298     [ -z "${DEBUG_INSTALL}" ] || DEBUG end of function
 299 }
 300
 301 #deploys osm pods and services
 302 function deploy_osm_services() {
 303     [ -z "${DEBUG_INSTALL}" ] || DEBUG beginning of function
 304     # helm is already installed as part of install_kubeadm_cluster.sh
 305
 306     # Generate helm values to be passed with -f osm-values.yaml
 307     sudo mkdir -p ${OSM_HELM_WORK_DIR}
 308     sudo bash -c "cat << EOF > ${OSM_HELM_WORK_DIR}/osm-values.yaml
 309 vca:
 310   pubkey: \"${OSM_VCA_PUBKEY}\"
 311 EOF"
 312
 313     # Generate helm values to be passed with --set
 314     OSM_HELM_OPTS=""
 315     # OSM_HELM_OPTS="${OSM_HELM_OPTS} --set nbi.useOsmSecret=false"
 316     OSM_HELM_OPTS="${OSM_HELM_OPTS} --set global.image.repositoryBase=${DOCKER_REGISTRY_URL}${DOCKER_USER}"
 317     OSM_HELM_OPTS="${OSM_HELM_OPTS} --set mysql.dbHostPath=${OSM_NAMESPACE_VOL}"
 318     OSM_HELM_OPTS="${OSM_HELM_OPTS} --set vca.host=${OSM_VCA_HOST}"
 319     OSM_HELM_OPTS="${OSM_HELM_OPTS} --set vca.secret=${OSM_VCA_SECRET}"
 320     OSM_HELM_OPTS="${OSM_HELM_OPTS} --set vca.cacert=${OSM_VCA_CACERT}"
 321     [ -n "$OSM_VCA_APIPROXY" ] && OSM_HELM_OPTS="${OSM_HELM_OPTS} --set lcm.config.OSMLCM_VCA_APIPROXY=${OSM_VCA_APIPROXY}"
 322     [ ! "$OSM_DOCKER_TAG" == "testing-daily" ] && OSM_HELM_OPTS="${OSM_HELM_OPTS} --set global.image.tag=${OSM_DOCKER_TAG}"
 323     [ -n "${INSTALL_NGSA}" ] || OSM_HELM_OPTS="${OSM_HELM_OPTS} --set global.oldServiceAssurance=true"
 324     if [ -n "${OSM_BEHIND_PROXY}" ]; then
 325         OSM_HELM_OPTS="${OSM_HELM_OPTS} --set global.behindHttpProxy=true"
 326         [ -n "${HTTP_PROXY}" ] && OSM_HELM_OPTS="${OSM_HELM_OPTS} --set global.httpProxy.HTTP_PROXY=${HTTP_PROXY}"
 327         [ -n "${HTTPS_PROXY}" ] && OSM_HELM_OPTS="${OSM_HELM_OPTS} --set global.httpProxy.HTTPS_PROXY=${HTTPS_PROXY}"
 328         [ -n "${NO_PROXY}" ] && OSM_HELM_OPTS="${OSM_HELM_OPTS} --set global.httpProxy.NO_PROXY=${NO_PROXY}"
 329     fi
 330
 331     echo "helm -n $OSM_NAMESPACE install $OSM_NAMESPACE $OSM_DEVOPS/installers/helm/osm -f ${OSM_HELM_WORK_DIR}/osm-values.yaml ${OSM_HELM_OPTS}"
 332     helm -n $OSM_NAMESPACE install $OSM_NAMESPACE $OSM_DEVOPS/installers/helm/osm -f ${OSM_HELM_WORK_DIR}/osm-values.yaml ${OSM_HELM_OPTS}
 333
 334     # Override existing values.yaml with the final values.yaml used to install OSM
 335     helm -n $OSM_NAMESPACE get values $OSM_NAMESPACE | sudo tee -a ${OSM_HELM_WORK_DIR}/osm-values.yaml
 336     [ -z "${DEBUG_INSTALL}" ] || DEBUG end of function
 337 }
 338
 339 #deploy charmed services
 340 function deploy_charmed_services() {
 341     [ -z "${DEBUG_INSTALL}" ] || DEBUG beginning of function
 342     juju add-model $OSM_NAMESPACE $OSM_VCA_K8S_CLOUDNAME
 343     juju deploy ch:mongodb-k8s -m $OSM_NAMESPACE
 344     [ -z "${DEBUG_INSTALL}" ] || DEBUG end of function
 345 }
 346
 347 #deploy mongodb
 348 function deploy_mongodb() {
 349     [ -z "${DEBUG_INSTALL}" ] || DEBUG beginning of function
 350     deploy_charmed_services
 351     [ -z "${DEBUG_INSTALL}" ] || DEBUG end of function
 352 }
 353
 354 function install_osm_ngsa_service() {
 355     [ -z "${DEBUG_INSTALL}" ] || DEBUG beginning of function
 356     NGSA_OPTS="-d ${OSM_HELM_WORK_DIR} -D ${OSM_DEVOPS} -t ${OSM_DOCKER_TAG} -U ${DOCKER_USER} ${DEBUG_INSTALL}"
 357     [ -n "${DOCKER_REGISTRY_URL}" ] && NGSA_OPTS="${NGSA_OPTS} -r ${DOCKER_REGISTRY_URL}"
 358     $OSM_DEVOPS/installers/install_ngsa.sh ${NGSA_OPTS} || \
 359     FATAL_TRACK install_osm_ngsa_service "install_ngsa.sh failed"
 360     [ -z "${DEBUG_INSTALL}" ] || DEBUG end of function
 361 }
 362
 363 function add_local_k8scluster() {
 364     [ -z "${DEBUG_INSTALL}" ] || DEBUG beginning of function
 365     /usr/bin/osm --all-projects vim-create \
 366       --name _system-osm-vim \
 367       --account_type dummy \
 368       --auth_url http://dummy \
 369       --user osm --password osm --tenant osm \
 370       --description "dummy" \
 371       --config '{management_network_name: mgmt}'
 372     /usr/bin/osm --all-projects k8scluster-add \
 373       --creds ${HOME}/.kube/config \
 374       --vim _system-osm-vim \
 375       --k8s-nets '{"net1": null}' \
 376       --version '1.15' \
 377       --description "OSM Internal Cluster" \
 378       _system-osm-k8s
 379     [ -z "${DEBUG_INSTALL}" ] || DEBUG end of function
 380 }
 381
 382 function configure_apt_proxy() {
 383     [ -z "${DEBUG_INSTALL}" ] || DEBUG beginning of function
 384     OSM_APT_PROXY=$1
 385     OSM_APT_PROXY_FILE="/etc/apt/apt.conf.d/osm-apt"
 386     echo "Configuring apt proxy in file ${OSM_APT_PROXY_FILE}"
 387     if [ ! -f ${OSM_APT_PROXY_FILE} ]; then
 388         sudo bash -c "cat <<EOF > ${OSM_APT_PROXY}
 389 Acquire::http { Proxy \"${OSM_APT_PROXY}\"; }
 390 EOF"
 391     else
 392         sudo sed -i "s|Proxy.*|Proxy \"${OSM_APT_PROXY}\"; }|" ${OSM_APT_PROXY_FILE}
 393     fi
 394     sudo apt-get update || FATAL "Configured apt proxy, but couldn't run 'apt-get update'. Check ${OSM_APT_PROXY_FILE}"
 395     track prereq apt_proxy_configured_ok
 396     [ -z "${DEBUG_INSTALL}" ] || DEBUG end of function
 397 }
 398
 399 function ask_proceed() {
 400     [ -z "${DEBUG_INSTALL}" ] || DEBUG beginning of function
 401
 402     [ -z "$ASSUME_YES" ] && ! ask_user "The installation will do the following
 403     1. Install and configure LXD
 404     2. Install juju
 405     3. Install docker CE
 406     4. Disable swap space
 407     5. Install and initialize Kubernetes
 408     as pre-requirements.
 409     Do you want to proceed (Y/n)? " y && echo "Cancelled!" && exit 1
 410
 411     [ -z "${DEBUG_INSTALL}" ] || DEBUG end of function
 412 }
 413
 414 function check_osm_behind_proxy() {
 415     [ -z "${DEBUG_INSTALL}" ] || DEBUG beginning of function
 416
 417     export OSM_BEHIND_PROXY=""
 418     export OSM_PROXY_ENV_VARIABLES=""
 419     [ -n "${http_proxy}" ] && OSM_BEHIND_PROXY="y" && echo "http_proxy=${http_proxy}" && OSM_PROXY_ENV_VARIABLES="${OSM_PROXY_ENV_VARIABLES} http_proxy"
 420     [ -n "${https_proxy}" ] && OSM_BEHIND_PROXY="y" && echo "https_proxy=${https_proxy}" && OSM_PROXY_ENV_VARIABLES="${OSM_PROXY_ENV_VARIABLES} https_proxy"
 421     [ -n "${HTTP_PROXY}" ] && OSM_BEHIND_PROXY="y" && echo "HTTP_PROXY=${HTTP_PROXY}" && OSM_PROXY_ENV_VARIABLES="${OSM_PROXY_ENV_VARIABLES} HTTP_PROXY"
 422     [ -n "${HTTPS_PROXY}" ] && OSM_BEHIND_PROXY="y" && echo "https_proxy=${HTTPS_PROXY}" && OSM_PROXY_ENV_VARIABLES="${OSM_PROXY_ENV_VARIABLES} HTTPS_PROXY"
 423     [ -n "${no_proxy}" ] && echo "no_proxy=${no_proxy}" && OSM_PROXY_ENV_VARIABLES="${OSM_PROXY_ENV_VARIABLES} no_proxy"
 424     [ -n "${NO_PROXY}" ] && echo "NO_PROXY=${NO_PROXY}" && OSM_PROXY_ENV_VARIABLES="${OSM_PROXY_ENV_VARIABLES} NO_PROXY"
 425
 426     echo "OSM_BEHIND_PROXY=${OSM_BEHIND_PROXY}"
 427     echo "OSM_PROXY_ENV_VARIABLES=${OSM_PROXY_ENV_VARIABLES}"
 428
 429     if [ -n "${OSM_BEHIND_PROXY}" ]; then
 430         [ -z "$ASSUME_YES" ] && ! ask_user "
 431 The following env variables have been found for the current user:
 432 ${OSM_PROXY_ENV_VARIABLES}.
 433
 434 This suggests that this machine is behind a proxy and a special configuration is required.
 435 The installer will install Docker CE, LXD and Juju to work behind a proxy using those
 436 env variables.
 437
 438 Take into account that the installer uses apt, curl, wget, docker, lxd, juju and snap.
 439 Depending on the program, the env variables to work behind a proxy might be different
 440 (e.g. http_proxy vs HTTP_PROXY).
 441
 442 For that reason, it is strongly recommended that at least http_proxy, https_proxy, HTTP_PROXY
 443 and HTTPS_PROXY are defined.
 444
 445 Finally, some of the programs (apt, snap) those programs are run as sudoer, requiring that
 446 those env variables are also set for root user. If you are not sure whether those variables
 447 are configured for the root user, you can stop the installation now.
 448
 449 Do you want to proceed with the installation (Y/n)? " y && echo "Cancelled!" && exit 1
 450     else
 451         echo "This machine is not behind a proxy"
 452     fi
 453
 454     [ -z "${DEBUG_INSTALL}" ] || DEBUG end of function
 455 }
 456
 457 function find_devops_folder() {
 458     if [ -z "$OSM_DEVOPS" ]; then
 459         if [ -n "$TEST_INSTALLER" ]; then
 460             echo -e "\nUsing local devops repo for OSM installation"
 461             OSM_DEVOPS="$(dirname $(realpath $(dirname $0)))"
 462         else
 463             echo -e "\nCreating temporary dir for OSM installation"
 464             OSM_DEVOPS="$(mktemp -d -q --tmpdir "installosm.XXXXXX")"
 465             trap 'rm -rf "$OSM_DEVOPS"' EXIT
 466             git clone https://osm.etsi.org/gerrit/osm/devops.git $OSM_DEVOPS
 467         fi
 468     fi
 469 }
 470
 471 function install_osm() {
 472     [ -z "${DEBUG_INSTALL}" ] || DEBUG beginning of function
 473
 474     trap ctrl_c INT
 475
 476
 477     check_osm_behind_proxy
 478     check_packages "git wget curl tar snapd"
 479     sudo snap install jq || FATAL "Could not install jq (snap package). Make sure that snap works"
 480     find_devops_folder
 481
 482     track start release $RELEASE none none docker_tag $OSM_DOCKER_TAG none none installation_type $OSM_INSTALLATION_TYPE none none os_info $os_info none none
 483
 484     track checks checkingroot_ok
 485     [ "$USER" == "root" ] && FATAL "You are running the installer as root. The installer is prepared to be executed as a normal user with sudo privileges."
 486     track checks noroot_ok
 487     ask_proceed
 488     track checks proceed_ok
 489
 490     echo "Installing OSM"
 491
 492     [ -n "$DOCKER_REGISTRY_URL" ] && parse_docker_registry_url
 493
 494     echo "Determining IP address of the interface with the default route"
 495     [ -z "$OSM_DEFAULT_IF" ] && OSM_DEFAULT_IF=$(ip route list|awk '$1=="default" {print $5; exit}')
 496     [ -z "$OSM_DEFAULT_IF" ] && OSM_DEFAULT_IF=$(route -n |awk '$1~/^0.0.0.0/ {print $8; exit}')
 497     [ -z "$OSM_DEFAULT_IF" ] && FATAL "Not possible to determine the interface with the default route 0.0.0.0"
 498     OSM_DEFAULT_IP=`ip -o -4 a s ${OSM_DEFAULT_IF} |awk '{split($4,a,"/"); print a[1]; exit}'`
 499     [ -z "$OSM_DEFAULT_IP" ] && FATAL "Not possible to determine the IP address of the interface with the default route"
 500
 501     # configure apt proxy
 502     [ -n "$APT_PROXY_URL" ] && configure_apt_proxy $APT_PROXY_URL
 503
 504     # if no host is passed in, we need to install lxd, unless explicilty asked not to
 505     if [ -z "$OSM_VCA_HOST" ] && [ -z "$INSTALL_NOLXD" ] && [ -z "$LXD_CLOUD_FILE" ]; then
 506         LXD_INSTALL_OPTS="-D ${OSM_DEVOPS} -i ${OSM_DEFAULT_IF} ${DEBUG_INSTALL}"
 507         [ -n "${OSM_BEHIND_PROXY}" ] && LXD_INSTALL_OPTS="${LXD_INSTALL_OPTS} -P"
 508         $OSM_DEVOPS/installers/install_lxd.sh ${LXD_INSTALL_OPTS} || FATAL_TRACK lxd "install_lxd.sh failed"
 509     fi
 510
 511     track prereq prereqok_ok
 512
 513     if [ ! -n "$INSTALL_NODOCKER" ]; then
 514         DOCKER_CE_OPTS="-D ${OSM_DEVOPS} ${DEBUG_INSTALL}"
 515         [ -n "${DOCKER_PROXY_URL}" ] && DOCKER_CE_OPTS="${DOCKER_CE_OPTS} -p ${DOCKER_PROXY_URL}"
 516         [ -n "${OSM_BEHIND_PROXY}" ] && DOCKER_CE_OPTS="${DOCKER_CE_OPTS} -P"
 517         $OSM_DEVOPS/installers/install_docker_ce.sh ${DOCKER_CE_OPTS} || FATAL_TRACK docker_ce "install_docker_ce.sh failed"
 518     fi
 519
 520     track docker_ce docker_ce_ok
 521
 522     echo "Creating folders for installation"
 523     [ ! -d "$OSM_WORK_DIR" ] && sudo mkdir -p $OSM_WORK_DIR
 524     sudo cp -b $OSM_DEVOPS/installers/kubeadm-config.yaml $OSM_WORK_DIR/kubeadm-config.yaml
 525
 526     $OSM_DEVOPS/installers/install_kubeadm_cluster.sh -i ${OSM_DEFAULT_IP} -d ${OSM_WORK_DIR} -D ${OSM_DEVOPS} ${DEBUG_INSTALL} || \
 527     FATAL_TRACK k8scluster "install_kubeadm_cluster.sh failed"
 528     track k8scluster k8scluster_ok
 529
 530     JUJU_OPTS="-D ${OSM_DEVOPS} -s ${OSM_NAMESPACE} -i ${OSM_DEFAULT_IP} ${DEBUG_INSTALL} ${INSTALL_NOJUJU} ${INSTALL_CACHELXDIMAGES}"
 531     [ -n "${OSM_VCA_HOST}" ] && JUJU_OPTS="$JUJU_OPTS -H ${OSM_VCA_HOST}"
 532     [ -n "${LXD_CLOUD_FILE}" ] && JUJU_OPTS="$JUJU_OPTS -l ${LXD_CLOUD_FILE}"
 533     [ -n "${LXD_CRED_FILE}" ] && JUJU_OPTS="$JUJU_OPTS -L ${LXD_CRED_FILE}"
 534     [ -n "${CONTROLLER_NAME}" ] && JUJU_OPTS="$JUJU_OPTS -K ${CONTROLLER_NAME}"
 535     [ -n "${OSM_BEHIND_PROXY}" ] && JUJU_OPTS="${JUJU_OPTS} -P"
 536     $OSM_DEVOPS/installers/install_juju.sh ${JUJU_OPTS} || FATAL_TRACK juju "install_juju.sh failed"
 537     set_vca_variables
 538     track juju juju_ok
 539
 540     # Deploy OSM services
 541     [ -z "$DOCKER_NOBUILD" ] && pull_docker_images
 542     [ -z "$DOCKER_NOBUILD" ] && [ -z "$PULL_IMAGES" ] && generate_docker_images
 543     track docker_images docker_images_ok
 544
 545     deploy_mongodb
 546     track deploy_osm deploy_mongodb_ok
 547     deploy_osm_services
 548     track deploy_osm deploy_osm_services_k8s_ok
 549     if [ -n "$INSTALL_K8S_MONITOR" ]; then
 550         # install OSM MONITORING
 551         install_k8s_monitoring
 552         track deploy_osm install_k8s_monitoring_ok
 553     fi
 554     if [ -n "$INSTALL_NGSA" ]; then
 555         # optional NGSA install
 556         install_osm_ngsa_service
 557         track deploy_osm install_osm_ngsa_ok
 558     fi
 559
 560     [ -z "$INSTALL_NOHOSTCLIENT" ] && install_osmclient
 561     track osmclient osmclient_ok
 562
 563     echo -e "Checking OSM health state..."
 564     $OSM_DEVOPS/installers/osm_health.sh -s ${OSM_NAMESPACE} -k || \
 565     (echo -e "OSM is not healthy, but will probably converge to a healthy state soon." && \
 566     echo -e "Check OSM status with: kubectl -n ${OSM_NAMESPACE} get all" && \
 567     track healthchecks osm_unhealthy didnotconverge)
 568     track healthchecks after_healthcheck_ok
 569
 570     add_local_k8scluster
 571     track final_ops add_local_k8scluster_ok
 572
 573     arrange_docker_default_network_policy
 574
 575     wget -q -O- https://osm-download.etsi.org/ftp/osm-13.0-thirteen/README2.txt &> /dev/null
 576     track end
 577     sudo find /etc/osm
 578     [ -z "${DEBUG_INSTALL}" ] || DEBUG end of function
 579     return 0
 580 }
 581
 582 function install_to_openstack() {
 583     [ -z "${DEBUG_INSTALL}" ] || DEBUG beginning of function
 584
 585     if [ -z "$2" ]; then
 586         FATAL "OpenStack installer requires a valid external network name"
 587     fi
 588
 589     # Install Pip for Python3
 590     sudo apt install -y python3-pip python3-venv
 591     sudo -H LC_ALL=C python3 -m pip install -U pip
 592
 593     # Create a venv to avoid conflicts with the host installation
 594     python3 -m venv $OPENSTACK_PYTHON_VENV
 595
 596     source $OPENSTACK_PYTHON_VENV/bin/activate
 597
 598     # Install Ansible, OpenStack client and SDK, latest openstack version supported is Train
 599     python -m pip install -U wheel
 600     python -m pip install -U "python-openstackclient<=4.0.2" "openstacksdk>=0.12.0,<=0.36.2" "ansible>=2.10,<2.11"
 601
 602     # Install the Openstack cloud module (ansible>=2.10)
 603     ansible-galaxy collection install openstack.cloud
 604
 605     export ANSIBLE_CONFIG="$OSM_DEVOPS/installers/openstack/ansible.cfg"
 606
 607     OSM_INSTALLER_ARGS="${REPO_ARGS[@]}"
 608
 609     ANSIBLE_VARS="external_network_name=$2 setup_volume=$3 server_name=$OPENSTACK_VM_NAME"
 610
 611     if [ -n "$OPENSTACK_SSH_KEY_FILE" ]; then
 612         ANSIBLE_VARS+=" key_file=$OPENSTACK_SSH_KEY_FILE"
 613     fi
 614
 615     if [ -n "$OPENSTACK_USERDATA_FILE" ]; then
 616         ANSIBLE_VARS+=" userdata_file=$OPENSTACK_USERDATA_FILE"
 617     fi
 618
 619     # Execute the Ansible playbook based on openrc or clouds.yaml
 620     if [ -e "$1" ]; then
 621         . $1
 622         ansible-playbook -e installer_args="\"$OSM_INSTALLER_ARGS\"" -e "$ANSIBLE_VARS" \
 623         $OSM_DEVOPS/installers/openstack/site.yml
 624     else
 625         ansible-playbook -e installer_args="\"$OSM_INSTALLER_ARGS\"" -e "$ANSIBLE_VARS" \
 626         -e cloud_name=$1 $OSM_DEVOPS/installers/openstack/site.yml
 627     fi
 628
 629     # Exit from venv
 630     deactivate
 631
 632     [ -z "${DEBUG_INSTALL}" ] || DEBUG end of function
 633     return 0
 634 }
 635
 636 function arrange_docker_default_network_policy() {
 637     echo -e "Fixing firewall so docker and LXD can share the same host without affecting each other."
 638     sudo iptables -I DOCKER-USER -j ACCEPT
 639     sudo iptables-save | sudo tee /etc/iptables/rules.v4
 640     sudo ip6tables-save | sudo tee /etc/iptables/rules.v6
 641 }
 642
 643 function install_k8s_monitoring() {
 644     [ -z "${DEBUG_INSTALL}" ] || DEBUG beginning of function
 645     # install OSM monitoring
 646     sudo chmod +x $OSM_DEVOPS/installers/k8s/*.sh
 647     sudo $OSM_DEVOPS/installers/k8s/install_osm_k8s_monitoring.sh || FATAL_TRACK install_k8s_monitoring "k8s/install_osm_k8s_monitoring.sh failed"
 648     [ -z "${DEBUG_INSTALL}" ] || DEBUG end of function
 649 }
 650
 651 function dump_vars(){
 652     [ -z "${DEBUG_INSTALL}" ] || DEBUG beginning of function
 653     echo "APT_PROXY_URL=$APT_PROXY_URL"
 654     echo "DEVELOP=$DEVELOP"
 655     echo "DEBUG_INSTALL=$DEBUG_INSTALL"
 656     echo "DOCKER_NOBUILD=$DOCKER_NOBUILD"
 657     echo "DOCKER_PROXY_URL=$DOCKER_PROXY_URL"
 658     echo "DOCKER_REGISTRY_URL=$DOCKER_REGISTRY_URL"
 659     echo "DOCKER_USER=$DOCKER_USER"
 660     echo "INSTALL_CACHELXDIMAGES=$INSTALL_CACHELXDIMAGES"
 661     echo "INSTALL_FROM_SOURCE=$INSTALL_FROM_SOURCE"
 662     echo "INSTALL_K8S_MONITOR=$INSTALL_K8S_MONITOR"
 663     echo "INSTALL_LIGHTWEIGHT=$INSTALL_LIGHTWEIGHT"
 664     echo "INSTALL_LXD=$INSTALL_LXD"
 665     echo "INSTALL_NGSA=$INSTALL_NGSA"
 666     echo "INSTALL_NODOCKER=$INSTALL_NODOCKER"
 667     echo "INSTALL_NOJUJU=$INSTALL_NOJUJU"
 668     echo "INSTALL_NOLXD=$INSTALL_NOLXD"
 669     echo "INSTALL_ONLY=$INSTALL_ONLY"
 670     echo "INSTALL_PLA=$INSTALL_PLA"
 671     echo "INSTALL_TO_OPENSTACK=$INSTALL_TO_OPENSTACK"
 672     echo "INSTALL_VIMEMU=$INSTALL_VIMEMU"
 673     echo "NO_HOST_PORTS=$NO_HOST_PORTS"
 674     echo "OPENSTACK_PUBLIC_NET_NAME=$OPENSTACK_PUBLIC_NET_NAME"
 675     echo "OPENSTACK_OPENRC_FILE_OR_CLOUD=$OPENSTACK_OPENRC_FILE_OR_CLOUD"
 676     echo "OPENSTACK_ATTACH_VOLUME=$OPENSTACK_ATTACH_VOLUME"
 677     echo "OPENSTACK_SSH_KEY_FILE"="$OPENSTACK_SSH_KEY_FILE"
 678     echo "OPENSTACK_USERDATA_FILE"="$OPENSTACK_USERDATA_FILE"
 679     echo "OPENSTACK_VM_NAME"="$OPENSTACK_VM_NAME"
 680     echo "OSM_DEVOPS=$OSM_DEVOPS"
 681     echo "OSM_DOCKER_TAG=$OSM_DOCKER_TAG"
 682     echo "OSM_HELM_WORK_DIR=$OSM_HELM_WORK_DIR"
 683     echo "OSM_NAMESPACE=$OSM_NAMESPACE"
 684     echo "OSM_VCA_HOST=$OSM_VCA_HOST"
 685     echo "OSM_VCA_PUBKEY=$OSM_VCA_PUBKEY"
 686     echo "OSM_VCA_SECRET=$OSM_VCA_SECRET"
 687     echo "OSM_WORK_DIR=$OSM_WORK_DIR"
 688     echo "PULL_IMAGES=$PULL_IMAGES"
 689     echo "RECONFIGURE=$RECONFIGURE"
 690     echo "RELEASE=$RELEASE"
 691     echo "REPOSITORY=$REPOSITORY"
 692     echo "REPOSITORY_BASE=$REPOSITORY_BASE"
 693     echo "REPOSITORY_KEY=$REPOSITORY_KEY"
 694     echo "SHOWOPTS=$SHOWOPTS"
 695     echo "TEST_INSTALLER=$TEST_INSTALLER"
 696     echo "TO_REBUILD=$TO_REBUILD"
 697     echo "UNINSTALL=$UNINSTALL"
 698     echo "UPDATE=$UPDATE"
 699     echo "Install from specific refspec (-b): $COMMIT_ID"
 700     [ -z "${DEBUG_INSTALL}" ] || DEBUG end of function
 701 }
 702
 703 function parse_docker_registry_url() {
 704     [ -z "${DEBUG_INSTALL}" ] || DEBUG beginning of function
 705     DOCKER_REGISTRY_USER=$(echo "$DOCKER_REGISTRY_URL" | awk '{split($1,a,"@"); split(a[1],b,":"); print b[1]}')
 706     DOCKER_REGISTRY_PASSWORD=$(echo "$DOCKER_REGISTRY_URL" | awk '{split($1,a,"@"); split(a[1],b,":"); print b[2]}')
 707     DOCKER_REGISTRY_URL=$(echo "$DOCKER_REGISTRY_URL" | awk '{split($1,a,"@"); print a[2]}')
 708     [ -z "${DEBUG_INSTALL}" ] || DEBUG end of function
 709 }
 710
 711 function ctrl_c() {
 712     [ -z "${DEBUG_INSTALL}" ] || DEBUG beginning of function
 713     echo "** Trapped CTRL-C"
 714     FATAL "User stopped the installation"
 715     [ -z "${DEBUG_INSTALL}" ] || DEBUG end of function
 716 }
 717
 718 UNINSTALL=""
 719 DEVELOP=""
 720 UPDATE=""
 721 RECONFIGURE=""
 722 TEST_INSTALLER=""
 723 INSTALL_LXD=""
 724 SHOWOPTS=""
 725 COMMIT_ID=""
 726 ASSUME_YES=""
 727 APT_PROXY_URL=""
 728 INSTALL_FROM_SOURCE=""
 729 DEBUG_INSTALL=""
 730 RELEASE="ReleaseTEN"
 731 REPOSITORY="stable"
 732 INSTALL_K8S_MONITOR=""
 733 INSTALL_NGSA="y"
 734 INSTALL_PLA=""
 735 INSTALL_VIMEMU=""
 736 LXD_REPOSITORY_BASE="https://osm-download.etsi.org/repository/osm/lxd"
 737 LXD_REPOSITORY_PATH=""
 738 INSTALL_LIGHTWEIGHT="y"
 739 INSTALL_TO_OPENSTACK=""
 740 OPENSTACK_OPENRC_FILE_OR_CLOUD=""
 741 OPENSTACK_PUBLIC_NET_NAME=""
 742 OPENSTACK_ATTACH_VOLUME="false"
 743 OPENSTACK_SSH_KEY_FILE=""
 744 OPENSTACK_USERDATA_FILE=""
 745 OPENSTACK_VM_NAME="server-osm"
 746 OPENSTACK_PYTHON_VENV="$HOME/.virtual-envs/osm"
 747 INSTALL_ONLY=""
 748 TO_REBUILD=""
 749 INSTALL_NOLXD=""
 750 INSTALL_NODOCKER=""
 751 INSTALL_NOJUJU=""
 752 INSTALL_NOHOSTCLIENT=""
 753 INSTALL_CACHELXDIMAGES=""
 754 OSM_DEVOPS=
 755 OSM_VCA_HOST=
 756 OSM_VCA_SECRET=
 757 OSM_VCA_PUBKEY=
 758 OSM_VCA_CLOUDNAME="localhost"
 759 OSM_VCA_K8S_CLOUDNAME="k8scloud"
 760 OSM_NAMESPACE=osm
 761 NO_HOST_PORTS=""
 762 DOCKER_NOBUILD=""
 763 REPOSITORY_KEY="OSM%20ETSI%20Release%20Key.gpg"
 764 REPOSITORY_BASE="https://osm-download.etsi.org/repository/osm/debian"
 765 OSM_WORK_DIR="/etc/osm"
 766 OSM_HELM_WORK_DIR="${OSM_WORK_DIR}/helm"
 767 OSM_HOST_VOL="/var/lib/osm"
 768 OSM_NAMESPACE_VOL="${OSM_HOST_VOL}/${OSM_NAMESPACE}"
 769 OSM_DOCKER_TAG=latest
 770 DOCKER_USER=opensourcemano
 771 PULL_IMAGES="y"
 772 KAFKA_TAG=2.11-1.0.2
 773 KIWIGRID_K8S_SIDECAR_TAG="1.15.6"
 774 PROMETHEUS_TAG=v2.28.1
 775 GRAFANA_TAG=8.1.1
 776 PROMETHEUS_NODE_EXPORTER_TAG=0.18.1
 777 PROMETHEUS_CADVISOR_TAG=latest
 778 KEYSTONEDB_TAG=10
 779 OSM_DATABASE_COMMONKEY=
 780 ELASTIC_VERSION=6.4.2
 781 ELASTIC_CURATOR_VERSION=5.5.4
 782 POD_NETWORK_CIDR=10.244.0.0/16
 783 K8S_MANIFEST_DIR="/etc/kubernetes/manifests"
 784 RE_CHECK='^[a-z0-9]([-a-z0-9]*[a-z0-9])?$'
 785 DOCKER_REGISTRY_URL=
 786 DOCKER_PROXY_URL=
 787 MODULE_DOCKER_TAG=
 788 OSM_INSTALLATION_TYPE="Default"
 789
 790 while getopts ":a:b:r:n:k:u:R:D:o:O:m:N:H:S:s:t:U:P:A:l:L:K:d:p:T:f:F:-: hy" o; do
 791     case "${o}" in
 792         a)
 793             APT_PROXY_URL=${OPTARG}
 794             ;;
 795         b)
 796             COMMIT_ID=${OPTARG}
 797             PULL_IMAGES=""
 798             ;;
 799         r)
 800             REPOSITORY="${OPTARG}"
 801             REPO_ARGS+=(-r "$REPOSITORY")
 802             ;;
 803         k)
 804             REPOSITORY_KEY="${OPTARG}"
 805             REPO_ARGS+=(-k "$REPOSITORY_KEY")
 806             ;;
 807         u)
 808             REPOSITORY_BASE="${OPTARG}"
 809             REPO_ARGS+=(-u "$REPOSITORY_BASE")
 810             ;;
 811         R)
 812             RELEASE="${OPTARG}"
 813             REPO_ARGS+=(-R "$RELEASE")
 814             ;;
 815         D)
 816             OSM_DEVOPS="${OPTARG}"
 817             ;;
 818         o)
 819             INSTALL_ONLY="y"
 820             [ "${OPTARG}" == "k8s_monitor" ] && INSTALL_K8S_MONITOR="y" && continue
 821             [ "${OPTARG}" == "ng-sa" ] && INSTALL_NGSA="y" && continue
 822             ;;
 823         O)
 824             INSTALL_TO_OPENSTACK="y"
 825             if [ -n "${OPTARG}" ]; then
 826                 OPENSTACK_OPENRC_FILE_OR_CLOUD="${OPTARG}"
 827             else
 828                 echo -e "Invalid argument for -O : ' $OPTARG'\n" >&2
 829                 usage && exit 1
 830             fi
 831             ;;
 832         f)
 833             OPENSTACK_SSH_KEY_FILE="${OPTARG}"
 834             ;;
 835         F)
 836             OPENSTACK_USERDATA_FILE="${OPTARG}"
 837             ;;
 838         N)
 839             OPENSTACK_PUBLIC_NET_NAME="${OPTARG}"
 840             ;;
 841         m)
 842             [ "${OPTARG}" == "NG-UI" ] && TO_REBUILD="$TO_REBUILD NG-UI" && continue
 843             [ "${OPTARG}" == "NBI" ] && TO_REBUILD="$TO_REBUILD NBI" && continue
 844             [ "${OPTARG}" == "LCM" ] && TO_REBUILD="$TO_REBUILD LCM" && continue
 845             [ "${OPTARG}" == "RO" ] && TO_REBUILD="$TO_REBUILD RO" && continue
 846             [ "${OPTARG}" == "MON" ] && TO_REBUILD="$TO_REBUILD MON" && continue
 847             [ "${OPTARG}" == "POL" ] && TO_REBUILD="$TO_REBUILD POL" && continue
 848             [ "${OPTARG}" == "PLA" ] && TO_REBUILD="$TO_REBUILD PLA" && continue
 849             [ "${OPTARG}" == "osmclient" ] && TO_REBUILD="$TO_REBUILD osmclient" && continue
 850             [ "${OPTARG}" == "KAFKA" ] && TO_REBUILD="$TO_REBUILD KAFKA" && continue
 851             [ "${OPTARG}" == "MONGO" ] && TO_REBUILD="$TO_REBUILD MONGO" && continue
 852             [ "${OPTARG}" == "PROMETHEUS" ] && TO_REBUILD="$TO_REBUILD PROMETHEUS" && continue
 853             [ "${OPTARG}" == "PROMETHEUS-CADVISOR" ] && TO_REBUILD="$TO_REBUILD PROMETHEUS-CADVISOR" && continue
 854             [ "${OPTARG}" == "KEYSTONE-DB" ] && TO_REBUILD="$TO_REBUILD KEYSTONE-DB" && continue
 855             [ "${OPTARG}" == "GRAFANA" ] && TO_REBUILD="$TO_REBUILD GRAFANA" && continue
 856             [ "${OPTARG}" == "NONE" ] && TO_REBUILD="$TO_REBUILD NONE" && continue
 857             ;;
 858         H)
 859             OSM_VCA_HOST="${OPTARG}"
 860             ;;
 861         S)
 862             OSM_VCA_SECRET="${OPTARG}"
 863             ;;
 864         s)
 865             OSM_NAMESPACE="${OPTARG}" && [[ ! "${OPTARG}" =~ $RE_CHECK ]] && echo "Namespace $OPTARG is invalid. Regex used for validation is $RE_CHECK" && exit 0
 866             ;;
 867         t)
 868             OSM_DOCKER_TAG="${OPTARG}"
 869             REPO_ARGS+=(-t "$OSM_DOCKER_TAG")
 870             ;;
 871         U)
 872             DOCKER_USER="${OPTARG}"
 873             ;;
 874         P)
 875             OSM_VCA_PUBKEY=$(cat ${OPTARG})
 876             ;;
 877         A)
 878             OSM_VCA_APIPROXY="${OPTARG}"
 879             ;;
 880         l)
 881             LXD_CLOUD_FILE="${OPTARG}"
 882             ;;
 883         L)
 884             LXD_CRED_FILE="${OPTARG}"
 885             ;;
 886         K)
 887             CONTROLLER_NAME="${OPTARG}"
 888             ;;
 889         d)
 890             DOCKER_REGISTRY_URL="${OPTARG}"
 891             ;;
 892         p)
 893             DOCKER_PROXY_URL="${OPTARG}"
 894             ;;
 895         T)
 896             MODULE_DOCKER_TAG="${OPTARG}"
 897             ;;
 898         -)
 899             [ "${OPTARG}" == "help" ] && usage && exit 0
 900             [ "${OPTARG}" == "source" ] && INSTALL_FROM_SOURCE="y" && PULL_IMAGES="" && continue
 901             [ "${OPTARG}" == "debug" ] && DEBUG_INSTALL="--debug" && continue
 902             [ "${OPTARG}" == "develop" ] && DEVELOP="y" && continue
 903             [ "${OPTARG}" == "uninstall" ] && UNINSTALL="y" && continue
 904             [ "${OPTARG}" == "update" ] && UPDATE="y" && continue
 905             [ "${OPTARG}" == "reconfigure" ] && RECONFIGURE="y" && continue
 906             [ "${OPTARG}" == "test" ] && TEST_INSTALLER="y" && continue
 907             [ "${OPTARG}" == "lxdinstall" ] && INSTALL_LXD="y" && continue
 908             [ "${OPTARG}" == "nolxd" ] && INSTALL_NOLXD="y" && continue
 909             [ "${OPTARG}" == "nodocker" ] && INSTALL_NODOCKER="y" && continue
 910             [ "${OPTARG}" == "showopts" ] && SHOWOPTS="y" && continue
 911             [ "${OPTARG}" == "nohostports" ] && NO_HOST_PORTS="y" && continue
 912             [ "${OPTARG}" == "nojuju" ] && INSTALL_NOJUJU="--nojuju" && continue
 913             [ "${OPTARG}" == "nodockerbuild" ] && DOCKER_NOBUILD="y" && continue
 914             [ "${OPTARG}" == "nohostclient" ] && INSTALL_NOHOSTCLIENT="y" && continue
 915             [ "${OPTARG}" == "pullimages" ] && continue
 916             [ "${OPTARG}" == "k8s_monitor" ] && INSTALL_K8S_MONITOR="y" && continue
 917             [ "${OPTARG}" == "charmed" ] && CHARMED="y" && OSM_INSTALLATION_TYPE="Charmed" && continue
 918             [ "${OPTARG}" == "bundle" ] && continue
 919             [ "${OPTARG}" == "k8s" ] && continue
 920             [ "${OPTARG}" == "lxd" ] && continue
 921             [ "${OPTARG}" == "lxd-cred" ] && continue
 922             [ "${OPTARG}" == "microstack" ] && continue
 923             [ "${OPTARG}" == "overlay" ] && continue
 924             [ "${OPTARG}" == "only-vca" ] && continue
 925             [ "${OPTARG}" == "small-profile" ] && continue
 926             [ "${OPTARG}" == "vca" ] && continue
 927             [ "${OPTARG}" == "ha" ] && continue
 928             [ "${OPTARG}" == "tag" ] && continue
 929             [ "${OPTARG}" == "registry" ] && continue
 930             [ "${OPTARG}" == "pla" ] && INSTALL_PLA="y" && continue
 931             [ "${OPTARG}" == "old-sa" ] && INSTALL_NGSA="" && continue
 932             [ "${OPTARG}" == "ng-sa" ] && INSTALL_NGSA="y" && continue
 933             [ "${OPTARG}" == "volume" ] && OPENSTACK_ATTACH_VOLUME="true" && continue
 934             [ "${OPTARG}" == "nocachelxdimages" ] && continue
 935             [ "${OPTARG}" == "cachelxdimages" ] && INSTALL_CACHELXDIMAGES="--cachelxdimages" && continue
 936             echo -e "Invalid option: '--$OPTARG'\n" >&2
 937             usage && exit 1
 938             ;;
 939         :)
 940             echo "Option -$OPTARG requires an argument" >&2
 941             usage && exit 1
 942             ;;
 943         \?)
 944             echo -e "Invalid option: '-$OPTARG'\n" >&2
 945             usage && exit 1
 946             ;;
 947         h)
 948             usage && exit 0
 949             ;;
 950         y)
 951             ASSUME_YES="y"
 952             ;;
 953         *)
 954             usage && exit 1
 955             ;;
 956     esac
 957 done
 958
 959 source $OSM_DEVOPS/common/all_funcs
 960
 961 [ -z "${DEBUG_INSTALL}" ] || DEBUG Debug is on
 962 [ -n "$SHOWOPTS" ] && dump_vars && exit 0
 963
 964 # Uninstall if "--uninstall"
 965 if [ -n "$UNINSTALL" ]; then
 966     if [ -n "$CHARMED" ]; then
 967         ${OSM_DEVOPS}/installers/charmed_uninstall.sh -R $RELEASE -r $REPOSITORY -u $REPOSITORY_BASE -D $OSM_DEVOPS -t $DOCKER_TAG "$@" || \
 968         FATAL_TRACK charmed_uninstall "charmed_uninstall.sh failed"
 969     else
 970         ${OSM_DEVOPS}/installers/uninstall_osm.sh "$@" || \
 971         FATAL_TRACK community_uninstall "uninstall_osm.sh failed"
 972     fi
 973     echo -e "\nDONE"
 974     exit 0
 975 fi
 976
 977 # Installation starts here
 978
 979 # Get README and create OSM_TRACK_INSTALLATION_ID
 980 wget -q -O- https://osm-download.etsi.org/ftp/osm-13.0-thirteen/README.txt &> /dev/null
 981 export OSM_TRACK_INSTALLATION_ID="$(date +%s)-$(head /dev/urandom | tr -dc A-Za-z0-9 | head -c 16)"
 982
 983 # Get OS info to be tracked
 984 os_distro=$(lsb_release -i 2>/dev/null | awk '{print $3}')
 985 echo $os_distro
 986 os_release=$(lsb_release -r 2>/dev/null | awk '{print $2}')
 987 echo $os_release
 988 os_info="${os_distro}_${os_release}"
 989 os_info="${os_info// /_}"
 990
 991 # Charmed installation
 992 if [ -n "$CHARMED" ]; then
 993     sudo snap install jq || FATAL "Could not install jq (snap package). Make sure that snap works"
 994     ${OSM_DEVOPS}/installers/charmed_install.sh --tag $OSM_DOCKER_TAG "$@" || \
 995     FATAL_TRACK charmed_install "charmed_install.sh failed"
 996     wget -q -O- https://osm-download.etsi.org/ftp/osm-13.0-thirteen/README2.txt &> /dev/null
 997     echo -e "\nDONE"
 998     exit 0
 999 fi
1000
1001 # Installation to Openstack
1002 if [ -n "$INSTALL_TO_OPENSTACK" ]; then
1003     install_to_openstack $OPENSTACK_OPENRC_FILE_OR_CLOUD $OPENSTACK_PUBLIC_NET_NAME $OPENSTACK_ATTACH_VOLUME
1004     echo -e "\nDONE"
1005     exit 0
1006 fi
1007
1008 # Community_installer
1009 # Check incompatible options
1010 [ -n "$TO_REBUILD" ] && [ "$TO_REBUILD" != " NONE" ] && echo $TO_REBUILD | grep -q NONE && FATAL "Incompatible option: -m NONE cannot be used with other -m options"
1011 [ -n "$TO_REBUILD" ] && [ "$TO_REBUILD" == " PLA" ] && [ -z "$INSTALL_PLA" ] && FATAL "Incompatible option: -m PLA cannot be used without --pla option"
1012 # Special cases go first
1013 # if develop, we force master
1014 [ -z "$COMMIT_ID" ] && [ -n "$DEVELOP" ] && COMMIT_ID="master"
1015 [ -n "$INSTALL_ONLY" ] && [ -n "$INSTALL_K8S_MONITOR" ] && install_k8s_monitoring
1016 [ -n "$INSTALL_ONLY" ] && [ -n "$INSTALL_NGSA" ] && install_osm_ngsa_service
1017 [ -n "$INSTALL_ONLY" ] && echo -e "\nDONE" && exit 0
1018 # This is where installation starts
1019 install_osm
1020 echo -e "\nDONE"
1021 exit 0