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 from binaries or source code (by default, from binaries)"
  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" == "13" ] && 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 function install_osm_ngsa_service() {
 348     [ -z "${DEBUG_INSTALL}" ] || DEBUG beginning of function
 349     NGSA_OPTS="-d ${OSM_HELM_WORK_DIR} -D ${OSM_DEVOPS} -t ${OSM_DOCKER_TAG} -U ${DOCKER_USER} ${DEBUG_INSTALL}"
 350     [ -n "${DOCKER_REGISTRY_URL}" ] && NGSA_OPTS="${NGSA_OPTS} -r ${DOCKER_REGISTRY_URL}"
 351     $OSM_DEVOPS/installers/install_ngsa.sh ${NGSA_OPTS} || \
 352     FATAL_TRACK install_osm_ngsa_service "install_ngsa.sh failed"
 353     [ -z "${DEBUG_INSTALL}" ] || DEBUG end of function
 354 }
 355
 356 function add_local_k8scluster() {
 357     [ -z "${DEBUG_INSTALL}" ] || DEBUG beginning of function
 358     /usr/bin/osm --all-projects vim-create \
 359       --name _system-osm-vim \
 360       --account_type dummy \
 361       --auth_url http://dummy \
 362       --user osm --password osm --tenant osm \
 363       --description "dummy" \
 364       --config '{management_network_name: mgmt}'
 365     /usr/bin/osm --all-projects k8scluster-add \
 366       --creds ${HOME}/.kube/config \
 367       --vim _system-osm-vim \
 368       --k8s-nets '{"net1": null}' \
 369       --version '1.15' \
 370       --description "OSM Internal Cluster" \
 371       _system-osm-k8s
 372     [ -z "${DEBUG_INSTALL}" ] || DEBUG end of function
 373 }
 374
 375 function configure_apt_proxy() {
 376     [ -z "${DEBUG_INSTALL}" ] || DEBUG beginning of function
 377     OSM_APT_PROXY=$1
 378     OSM_APT_PROXY_FILE="/etc/apt/apt.conf.d/osm-apt"
 379     echo "Configuring apt proxy in file ${OSM_APT_PROXY_FILE}"
 380     if [ ! -f ${OSM_APT_PROXY_FILE} ]; then
 381         sudo bash -c "cat <<EOF > ${OSM_APT_PROXY}
 382 Acquire::http { Proxy \"${OSM_APT_PROXY}\"; }
 383 EOF"
 384     else
 385         sudo sed -i "s|Proxy.*|Proxy \"${OSM_APT_PROXY}\"; }|" ${OSM_APT_PROXY_FILE}
 386     fi
 387     sudo apt-get update || FATAL "Configured apt proxy, but couldn't run 'apt-get update'. Check ${OSM_APT_PROXY_FILE}"
 388     track prereq apt_proxy_configured_ok
 389     [ -z "${DEBUG_INSTALL}" ] || DEBUG end of function
 390 }
 391
 392 function ask_proceed() {
 393     [ -z "${DEBUG_INSTALL}" ] || DEBUG beginning of function
 394
 395     [ -z "$ASSUME_YES" ] && ! ask_user "The installation will do the following
 396     1. Install and configure LXD
 397     2. Install juju
 398     3. Install docker CE
 399     4. Disable swap space
 400     5. Install and initialize Kubernetes
 401     as pre-requirements.
 402     Do you want to proceed (Y/n)? " y && echo "Cancelled!" && exit 1
 403
 404     [ -z "${DEBUG_INSTALL}" ] || DEBUG end of function
 405 }
 406
 407 function check_osm_behind_proxy() {
 408     [ -z "${DEBUG_INSTALL}" ] || DEBUG beginning of function
 409
 410     export OSM_BEHIND_PROXY=""
 411     export OSM_PROXY_ENV_VARIABLES=""
 412     [ -n "${http_proxy}" ] && OSM_BEHIND_PROXY="y" && echo "http_proxy=${http_proxy}" && OSM_PROXY_ENV_VARIABLES="${OSM_PROXY_ENV_VARIABLES} http_proxy"
 413     [ -n "${https_proxy}" ] && OSM_BEHIND_PROXY="y" && echo "https_proxy=${https_proxy}" && OSM_PROXY_ENV_VARIABLES="${OSM_PROXY_ENV_VARIABLES} https_proxy"
 414     [ -n "${HTTP_PROXY}" ] && OSM_BEHIND_PROXY="y" && echo "HTTP_PROXY=${HTTP_PROXY}" && OSM_PROXY_ENV_VARIABLES="${OSM_PROXY_ENV_VARIABLES} HTTP_PROXY"
 415     [ -n "${HTTPS_PROXY}" ] && OSM_BEHIND_PROXY="y" && echo "https_proxy=${HTTPS_PROXY}" && OSM_PROXY_ENV_VARIABLES="${OSM_PROXY_ENV_VARIABLES} HTTPS_PROXY"
 416     [ -n "${no_proxy}" ] && echo "no_proxy=${no_proxy}" && OSM_PROXY_ENV_VARIABLES="${OSM_PROXY_ENV_VARIABLES} no_proxy"
 417     [ -n "${NO_PROXY}" ] && echo "NO_PROXY=${NO_PROXY}" && OSM_PROXY_ENV_VARIABLES="${OSM_PROXY_ENV_VARIABLES} NO_PROXY"
 418
 419     echo "OSM_BEHIND_PROXY=${OSM_BEHIND_PROXY}"
 420     echo "OSM_PROXY_ENV_VARIABLES=${OSM_PROXY_ENV_VARIABLES}"
 421
 422     if [ -n "${OSM_BEHIND_PROXY}" ]; then
 423         [ -z "$ASSUME_YES" ] && ! ask_user "
 424 The following env variables have been found for the current user:
 425 ${OSM_PROXY_ENV_VARIABLES}.
 426
 427 This suggests that this machine is behind a proxy and a special configuration is required.
 428 The installer will install Docker CE, LXD and Juju to work behind a proxy using those
 429 env variables.
 430
 431 Take into account that the installer uses apt, curl, wget, docker, lxd, juju and snap.
 432 Depending on the program, the env variables to work behind a proxy might be different
 433 (e.g. http_proxy vs HTTP_PROXY).
 434
 435 For that reason, it is strongly recommended that at least http_proxy, https_proxy, HTTP_PROXY
 436 and HTTPS_PROXY are defined.
 437
 438 Finally, some of the programs (apt, snap) those programs are run as sudoer, requiring that
 439 those env variables are also set for root user. If you are not sure whether those variables
 440 are configured for the root user, you can stop the installation now.
 441
 442 Do you want to proceed with the installation (Y/n)? " y && echo "Cancelled!" && exit 1
 443     else
 444         echo "This machine is not behind a proxy"
 445     fi
 446
 447     [ -z "${DEBUG_INSTALL}" ] || DEBUG end of function
 448 }
 449
 450 function find_devops_folder() {
 451     if [ -z "$OSM_DEVOPS" ]; then
 452         if [ -n "$TEST_INSTALLER" ]; then
 453             echo -e "\nUsing local devops repo for OSM installation"
 454             OSM_DEVOPS="$(dirname $(realpath $(dirname $0)))"
 455         else
 456             echo -e "\nCreating temporary dir for OSM installation"
 457             OSM_DEVOPS="$(mktemp -d -q --tmpdir "installosm.XXXXXX")"
 458             trap 'rm -rf "$OSM_DEVOPS"' EXIT
 459             git clone https://osm.etsi.org/gerrit/osm/devops.git $OSM_DEVOPS
 460         fi
 461     fi
 462 }
 463
 464 function install_osm() {
 465     [ -z "${DEBUG_INSTALL}" ] || DEBUG beginning of function
 466
 467     trap ctrl_c INT
 468
 469
 470     check_osm_behind_proxy
 471     check_packages "git wget curl tar snapd"
 472     sudo snap install jq || FATAL "Could not install jq (snap package). Make sure that snap works"
 473     find_devops_folder
 474
 475     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
 476
 477     track checks checkingroot_ok
 478     [ "$USER" == "root" ] && FATAL "You are running the installer as root. The installer is prepared to be executed as a normal user with sudo privileges."
 479     track checks noroot_ok
 480     ask_proceed
 481     track checks proceed_ok
 482
 483     echo "Installing OSM"
 484
 485     [ -n "$DOCKER_REGISTRY_URL" ] && parse_docker_registry_url
 486
 487     echo "Determining IP address of the interface with the default route"
 488     [ -z "$OSM_DEFAULT_IF" ] && OSM_DEFAULT_IF=$(ip route list|awk '$1=="default" {print $5; exit}')
 489     [ -z "$OSM_DEFAULT_IF" ] && OSM_DEFAULT_IF=$(route -n |awk '$1~/^0.0.0.0/ {print $8; exit}')
 490     [ -z "$OSM_DEFAULT_IF" ] && FATAL "Not possible to determine the interface with the default route 0.0.0.0"
 491     OSM_DEFAULT_IP=`ip -o -4 a s ${OSM_DEFAULT_IF} |awk '{split($4,a,"/"); print a[1]; exit}'`
 492     [ -z "$OSM_DEFAULT_IP" ] && FATAL "Not possible to determine the IP address of the interface with the default route"
 493
 494     # configure apt proxy
 495     [ -n "$APT_PROXY_URL" ] && configure_apt_proxy $APT_PROXY_URL
 496
 497     # if no host is passed in, we need to install lxd, unless explicilty asked not to
 498     if [ -z "$OSM_VCA_HOST" ] && [ -z "$INSTALL_NOLXD" ] && [ -z "$LXD_CLOUD_FILE" ]; then
 499         LXD_INSTALL_OPTS="-D ${OSM_DEVOPS} -i ${OSM_DEFAULT_IF} ${DEBUG_INSTALL}"
 500         [ -n "${OSM_BEHIND_PROXY}" ] && LXD_INSTALL_OPTS="${LXD_INSTALL_OPTS} -P"
 501         $OSM_DEVOPS/installers/install_lxd.sh ${LXD_INSTALL_OPTS} || FATAL_TRACK lxd "install_lxd.sh failed"
 502     fi
 503
 504     track prereq prereqok_ok
 505
 506     if [ ! -n "$INSTALL_NODOCKER" ]; then
 507         DOCKER_CE_OPTS="-D ${OSM_DEVOPS} ${DEBUG_INSTALL}"
 508         [ -n "${DOCKER_PROXY_URL}" ] && DOCKER_CE_OPTS="${DOCKER_CE_OPTS} -p ${DOCKER_PROXY_URL}"
 509         [ -n "${OSM_BEHIND_PROXY}" ] && DOCKER_CE_OPTS="${DOCKER_CE_OPTS} -P"
 510         $OSM_DEVOPS/installers/install_docker_ce.sh ${DOCKER_CE_OPTS} || FATAL_TRACK docker_ce "install_docker_ce.sh failed"
 511     fi
 512
 513     track docker_ce docker_ce_ok
 514
 515     echo "Creating folders for installation"
 516     [ ! -d "$OSM_WORK_DIR" ] && sudo mkdir -p $OSM_WORK_DIR
 517     sudo cp -b $OSM_DEVOPS/installers/kubeadm-config.yaml $OSM_WORK_DIR/kubeadm-config.yaml
 518
 519     $OSM_DEVOPS/installers/install_kubeadm_cluster.sh -i ${OSM_DEFAULT_IP} -d ${OSM_WORK_DIR} -D ${OSM_DEVOPS} ${DEBUG_INSTALL} || \
 520     FATAL_TRACK k8scluster "install_kubeadm_cluster.sh failed"
 521     track k8scluster k8scluster_ok
 522
 523     JUJU_OPTS="-D ${OSM_DEVOPS} -s ${OSM_NAMESPACE} -i ${OSM_DEFAULT_IP} ${DEBUG_INSTALL} ${INSTALL_NOJUJU} ${INSTALL_CACHELXDIMAGES}"
 524     [ -n "${OSM_VCA_HOST}" ] && JUJU_OPTS="$JUJU_OPTS -H ${OSM_VCA_HOST}"
 525     [ -n "${LXD_CLOUD_FILE}" ] && JUJU_OPTS="$JUJU_OPTS -l ${LXD_CLOUD_FILE}"
 526     [ -n "${LXD_CRED_FILE}" ] && JUJU_OPTS="$JUJU_OPTS -L ${LXD_CRED_FILE}"
 527     [ -n "${CONTROLLER_NAME}" ] && JUJU_OPTS="$JUJU_OPTS -K ${CONTROLLER_NAME}"
 528     [ -n "${OSM_BEHIND_PROXY}" ] && JUJU_OPTS="${JUJU_OPTS} -P"
 529     $OSM_DEVOPS/installers/install_juju.sh ${JUJU_OPTS} || FATAL_TRACK juju "install_juju.sh failed"
 530     set_vca_variables
 531     track juju juju_ok
 532
 533     # Deploy OSM services
 534     [ -z "$DOCKER_NOBUILD" ] && pull_docker_images
 535     [ -z "$DOCKER_NOBUILD" ] && [ -z "$PULL_IMAGES" ] && generate_docker_images
 536     track docker_images docker_images_ok
 537
 538     deploy_charmed_services
 539     track deploy_osm deploy_mongodb_ok
 540     deploy_osm_services
 541     track deploy_osm deploy_osm_services_k8s_ok
 542     if [ -n "$INSTALL_K8S_MONITOR" ]; then
 543         # install OSM MONITORING
 544         install_k8s_monitoring
 545         track deploy_osm install_k8s_monitoring_ok
 546     fi
 547     if [ -n "$INSTALL_NGSA" ]; then
 548         # optional NGSA install
 549         install_osm_ngsa_service
 550         track deploy_osm install_osm_ngsa_ok
 551     fi
 552
 553     [ -z "$INSTALL_NOHOSTCLIENT" ] && install_osmclient
 554     track osmclient osmclient_ok
 555
 556     echo -e "Checking OSM health state..."
 557     $OSM_DEVOPS/installers/osm_health.sh -s ${OSM_NAMESPACE} -k || \
 558     (echo -e "OSM is not healthy, but will probably converge to a healthy state soon." && \
 559     echo -e "Check OSM status with: kubectl -n ${OSM_NAMESPACE} get all" && \
 560     track healthchecks osm_unhealthy didnotconverge)
 561     track healthchecks after_healthcheck_ok
 562
 563     add_local_k8scluster
 564     track final_ops add_local_k8scluster_ok
 565
 566     arrange_docker_default_network_policy
 567
 568     wget -q -O- https://osm-download.etsi.org/ftp/osm-13.0-thirteen/README2.txt &> /dev/null
 569     track end
 570     sudo find /etc/osm
 571     [ -z "${DEBUG_INSTALL}" ] || DEBUG end of function
 572     return 0
 573 }
 574
 575 function install_to_openstack() {
 576     [ -z "${DEBUG_INSTALL}" ] || DEBUG beginning of function
 577
 578     if [ -z "$2" ]; then
 579         FATAL "OpenStack installer requires a valid external network name"
 580     fi
 581
 582     # Install Pip for Python3
 583     sudo apt install -y python3-pip python3-venv
 584     sudo -H LC_ALL=C python3 -m pip install -U pip
 585
 586     # Create a venv to avoid conflicts with the host installation
 587     python3 -m venv $OPENSTACK_PYTHON_VENV
 588
 589     source $OPENSTACK_PYTHON_VENV/bin/activate
 590
 591     # Install Ansible, OpenStack client and SDK, latest openstack version supported is Train
 592     python -m pip install -U wheel
 593     python -m pip install -U "python-openstackclient<=4.0.2" "openstacksdk>=0.12.0,<=0.36.2" "ansible>=2.10,<2.11"
 594
 595     # Install the Openstack cloud module (ansible>=2.10)
 596     ansible-galaxy collection install openstack.cloud
 597
 598     export ANSIBLE_CONFIG="$OSM_DEVOPS/installers/openstack/ansible.cfg"
 599
 600     OSM_INSTALLER_ARGS="${REPO_ARGS[@]}"
 601
 602     ANSIBLE_VARS="external_network_name=$2 setup_volume=$3 server_name=$OPENSTACK_VM_NAME"
 603
 604     if [ -n "$OPENSTACK_SSH_KEY_FILE" ]; then
 605         ANSIBLE_VARS+=" key_file=$OPENSTACK_SSH_KEY_FILE"
 606     fi
 607
 608     if [ -n "$OPENSTACK_USERDATA_FILE" ]; then
 609         ANSIBLE_VARS+=" userdata_file=$OPENSTACK_USERDATA_FILE"
 610     fi
 611
 612     # Execute the Ansible playbook based on openrc or clouds.yaml
 613     if [ -e "$1" ]; then
 614         . $1
 615         ansible-playbook -e installer_args="\"$OSM_INSTALLER_ARGS\"" -e "$ANSIBLE_VARS" \
 616         $OSM_DEVOPS/installers/openstack/site.yml
 617     else
 618         ansible-playbook -e installer_args="\"$OSM_INSTALLER_ARGS\"" -e "$ANSIBLE_VARS" \
 619         -e cloud_name=$1 $OSM_DEVOPS/installers/openstack/site.yml
 620     fi
 621
 622     # Exit from venv
 623     deactivate
 624
 625     [ -z "${DEBUG_INSTALL}" ] || DEBUG end of function
 626     return 0
 627 }
 628
 629 function arrange_docker_default_network_policy() {
 630     echo -e "Fixing firewall so docker and LXD can share the same host without affecting each other."
 631     sudo iptables -I DOCKER-USER -j ACCEPT
 632     sudo iptables-save | sudo tee /etc/iptables/rules.v4
 633     sudo ip6tables-save | sudo tee /etc/iptables/rules.v6
 634 }
 635
 636 function install_k8s_monitoring() {
 637     [ -z "${DEBUG_INSTALL}" ] || DEBUG beginning of function
 638     # install OSM monitoring
 639     sudo chmod +x $OSM_DEVOPS/installers/k8s/*.sh
 640     sudo $OSM_DEVOPS/installers/k8s/install_osm_k8s_monitoring.sh || FATAL_TRACK install_k8s_monitoring "k8s/install_osm_k8s_monitoring.sh failed"
 641     [ -z "${DEBUG_INSTALL}" ] || DEBUG end of function
 642 }
 643
 644 function dump_vars(){
 645     [ -z "${DEBUG_INSTALL}" ] || DEBUG beginning of function
 646     echo "APT_PROXY_URL=$APT_PROXY_URL"
 647     echo "DEVELOP=$DEVELOP"
 648     echo "DEBUG_INSTALL=$DEBUG_INSTALL"
 649     echo "DOCKER_NOBUILD=$DOCKER_NOBUILD"
 650     echo "DOCKER_PROXY_URL=$DOCKER_PROXY_URL"
 651     echo "DOCKER_REGISTRY_URL=$DOCKER_REGISTRY_URL"
 652     echo "DOCKER_USER=$DOCKER_USER"
 653     echo "INSTALL_CACHELXDIMAGES=$INSTALL_CACHELXDIMAGES"
 654     echo "INSTALL_FROM_SOURCE=$INSTALL_FROM_SOURCE"
 655     echo "INSTALL_K8S_MONITOR=$INSTALL_K8S_MONITOR"
 656     echo "INSTALL_LIGHTWEIGHT=$INSTALL_LIGHTWEIGHT"
 657     echo "INSTALL_LXD=$INSTALL_LXD"
 658     echo "INSTALL_NGSA=$INSTALL_NGSA"
 659     echo "INSTALL_NODOCKER=$INSTALL_NODOCKER"
 660     echo "INSTALL_NOJUJU=$INSTALL_NOJUJU"
 661     echo "INSTALL_NOLXD=$INSTALL_NOLXD"
 662     echo "INSTALL_ONLY=$INSTALL_ONLY"
 663     echo "INSTALL_PLA=$INSTALL_PLA"
 664     echo "INSTALL_TO_OPENSTACK=$INSTALL_TO_OPENSTACK"
 665     echo "INSTALL_VIMEMU=$INSTALL_VIMEMU"
 666     echo "NO_HOST_PORTS=$NO_HOST_PORTS"
 667     echo "OPENSTACK_PUBLIC_NET_NAME=$OPENSTACK_PUBLIC_NET_NAME"
 668     echo "OPENSTACK_OPENRC_FILE_OR_CLOUD=$OPENSTACK_OPENRC_FILE_OR_CLOUD"
 669     echo "OPENSTACK_ATTACH_VOLUME=$OPENSTACK_ATTACH_VOLUME"
 670     echo "OPENSTACK_SSH_KEY_FILE"="$OPENSTACK_SSH_KEY_FILE"
 671     echo "OPENSTACK_USERDATA_FILE"="$OPENSTACK_USERDATA_FILE"
 672     echo "OPENSTACK_VM_NAME"="$OPENSTACK_VM_NAME"
 673     echo "OSM_DEVOPS=$OSM_DEVOPS"
 674     echo "OSM_DOCKER_TAG=$OSM_DOCKER_TAG"
 675     echo "OSM_HELM_WORK_DIR=$OSM_HELM_WORK_DIR"
 676     echo "OSM_NAMESPACE=$OSM_NAMESPACE"
 677     echo "OSM_VCA_HOST=$OSM_VCA_HOST"
 678     echo "OSM_VCA_PUBKEY=$OSM_VCA_PUBKEY"
 679     echo "OSM_VCA_SECRET=$OSM_VCA_SECRET"
 680     echo "OSM_WORK_DIR=$OSM_WORK_DIR"
 681     echo "PULL_IMAGES=$PULL_IMAGES"
 682     echo "RECONFIGURE=$RECONFIGURE"
 683     echo "RELEASE=$RELEASE"
 684     echo "REPOSITORY=$REPOSITORY"
 685     echo "REPOSITORY_BASE=$REPOSITORY_BASE"
 686     echo "REPOSITORY_KEY=$REPOSITORY_KEY"
 687     echo "SHOWOPTS=$SHOWOPTS"
 688     echo "TEST_INSTALLER=$TEST_INSTALLER"
 689     echo "TO_REBUILD=$TO_REBUILD"
 690     echo "UNINSTALL=$UNINSTALL"
 691     echo "UPDATE=$UPDATE"
 692     echo "Install from specific refspec (-b): $COMMIT_ID"
 693     [ -z "${DEBUG_INSTALL}" ] || DEBUG end of function
 694 }
 695
 696 function parse_docker_registry_url() {
 697     [ -z "${DEBUG_INSTALL}" ] || DEBUG beginning of function
 698     DOCKER_REGISTRY_USER=$(echo "$DOCKER_REGISTRY_URL" | awk '{split($1,a,"@"); split(a[1],b,":"); print b[1]}')
 699     DOCKER_REGISTRY_PASSWORD=$(echo "$DOCKER_REGISTRY_URL" | awk '{split($1,a,"@"); split(a[1],b,":"); print b[2]}')
 700     DOCKER_REGISTRY_URL=$(echo "$DOCKER_REGISTRY_URL" | awk '{split($1,a,"@"); print a[2]}')
 701     [ -z "${DEBUG_INSTALL}" ] || DEBUG end of function
 702 }
 703
 704 function ctrl_c() {
 705     [ -z "${DEBUG_INSTALL}" ] || DEBUG beginning of function
 706     echo "** Trapped CTRL-C"
 707     FATAL "User stopped the installation"
 708     [ -z "${DEBUG_INSTALL}" ] || DEBUG end of function
 709 }
 710
 711 UNINSTALL=""
 712 DEVELOP=""
 713 UPDATE=""
 714 RECONFIGURE=""
 715 TEST_INSTALLER=""
 716 INSTALL_LXD=""
 717 SHOWOPTS=""
 718 COMMIT_ID=""
 719 ASSUME_YES=""
 720 APT_PROXY_URL=""
 721 INSTALL_FROM_SOURCE=""
 722 DEBUG_INSTALL=""
 723 RELEASE="ReleaseTEN"
 724 REPOSITORY="stable"
 725 INSTALL_K8S_MONITOR=""
 726 INSTALL_NGSA="y"
 727 INSTALL_PLA=""
 728 INSTALL_VIMEMU=""
 729 LXD_REPOSITORY_BASE="https://osm-download.etsi.org/repository/osm/lxd"
 730 LXD_REPOSITORY_PATH=""
 731 INSTALL_LIGHTWEIGHT="y"
 732 INSTALL_TO_OPENSTACK=""
 733 OPENSTACK_OPENRC_FILE_OR_CLOUD=""
 734 OPENSTACK_PUBLIC_NET_NAME=""
 735 OPENSTACK_ATTACH_VOLUME="false"
 736 OPENSTACK_SSH_KEY_FILE=""
 737 OPENSTACK_USERDATA_FILE=""
 738 OPENSTACK_VM_NAME="server-osm"
 739 OPENSTACK_PYTHON_VENV="$HOME/.virtual-envs/osm"
 740 INSTALL_ONLY=""
 741 TO_REBUILD=""
 742 INSTALL_NOLXD=""
 743 INSTALL_NODOCKER=""
 744 INSTALL_NOJUJU=""
 745 INSTALL_NOHOSTCLIENT=""
 746 INSTALL_CACHELXDIMAGES=""
 747 OSM_DEVOPS=
 748 OSM_VCA_HOST=
 749 OSM_VCA_SECRET=
 750 OSM_VCA_PUBKEY=
 751 OSM_VCA_CLOUDNAME="localhost"
 752 OSM_VCA_K8S_CLOUDNAME="k8scloud"
 753 OSM_NAMESPACE=osm
 754 NO_HOST_PORTS=""
 755 DOCKER_NOBUILD=""
 756 REPOSITORY_KEY="OSM%20ETSI%20Release%20Key.gpg"
 757 REPOSITORY_BASE="https://osm-download.etsi.org/repository/osm/debian"
 758 OSM_WORK_DIR="/etc/osm"
 759 OSM_HELM_WORK_DIR="${OSM_WORK_DIR}/helm"
 760 OSM_HOST_VOL="/var/lib/osm"
 761 OSM_NAMESPACE_VOL="${OSM_HOST_VOL}/${OSM_NAMESPACE}"
 762 OSM_DOCKER_TAG=latest
 763 DOCKER_USER=opensourcemano
 764 PULL_IMAGES="y"
 765 KAFKA_TAG=2.11-1.0.2
 766 KIWIGRID_K8S_SIDECAR_TAG="1.15.6"
 767 PROMETHEUS_TAG=v2.28.1
 768 GRAFANA_TAG=8.1.1
 769 PROMETHEUS_NODE_EXPORTER_TAG=0.18.1
 770 PROMETHEUS_CADVISOR_TAG=latest
 771 KEYSTONEDB_TAG=10
 772 OSM_DATABASE_COMMONKEY=
 773 ELASTIC_VERSION=6.4.2
 774 ELASTIC_CURATOR_VERSION=5.5.4
 775 POD_NETWORK_CIDR=10.244.0.0/16
 776 K8S_MANIFEST_DIR="/etc/kubernetes/manifests"
 777 RE_CHECK='^[a-z0-9]([-a-z0-9]*[a-z0-9])?$'
 778 DOCKER_REGISTRY_URL=
 779 DOCKER_PROXY_URL=
 780 MODULE_DOCKER_TAG=
 781 OSM_INSTALLATION_TYPE="Default"
 782
 783 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
 784     case "${o}" in
 785         a)
 786             APT_PROXY_URL=${OPTARG}
 787             ;;
 788         b)
 789             COMMIT_ID=${OPTARG}
 790             PULL_IMAGES=""
 791             ;;
 792         r)
 793             REPOSITORY="${OPTARG}"
 794             REPO_ARGS+=(-r "$REPOSITORY")
 795             ;;
 796         k)
 797             REPOSITORY_KEY="${OPTARG}"
 798             REPO_ARGS+=(-k "$REPOSITORY_KEY")
 799             ;;
 800         u)
 801             REPOSITORY_BASE="${OPTARG}"
 802             REPO_ARGS+=(-u "$REPOSITORY_BASE")
 803             ;;
 804         R)
 805             RELEASE="${OPTARG}"
 806             REPO_ARGS+=(-R "$RELEASE")
 807             ;;
 808         D)
 809             OSM_DEVOPS="${OPTARG}"
 810             ;;
 811         o)
 812             INSTALL_ONLY="y"
 813             [ "${OPTARG}" == "k8s_monitor" ] && INSTALL_K8S_MONITOR="y" && continue
 814             [ "${OPTARG}" == "ng-sa" ] && INSTALL_NGSA="y" && continue
 815             ;;
 816         O)
 817             INSTALL_TO_OPENSTACK="y"
 818             if [ -n "${OPTARG}" ]; then
 819                 OPENSTACK_OPENRC_FILE_OR_CLOUD="${OPTARG}"
 820             else
 821                 echo -e "Invalid argument for -O : ' $OPTARG'\n" >&2
 822                 usage && exit 1
 823             fi
 824             ;;
 825         f)
 826             OPENSTACK_SSH_KEY_FILE="${OPTARG}"
 827             ;;
 828         F)
 829             OPENSTACK_USERDATA_FILE="${OPTARG}"
 830             ;;
 831         N)
 832             OPENSTACK_PUBLIC_NET_NAME="${OPTARG}"
 833             ;;
 834         m)
 835             [ "${OPTARG}" == "NG-UI" ] && TO_REBUILD="$TO_REBUILD NG-UI" && continue
 836             [ "${OPTARG}" == "NBI" ] && TO_REBUILD="$TO_REBUILD NBI" && continue
 837             [ "${OPTARG}" == "LCM" ] && TO_REBUILD="$TO_REBUILD LCM" && continue
 838             [ "${OPTARG}" == "RO" ] && TO_REBUILD="$TO_REBUILD RO" && continue
 839             [ "${OPTARG}" == "MON" ] && TO_REBUILD="$TO_REBUILD MON" && continue
 840             [ "${OPTARG}" == "POL" ] && TO_REBUILD="$TO_REBUILD POL" && continue
 841             [ "${OPTARG}" == "PLA" ] && TO_REBUILD="$TO_REBUILD PLA" && continue
 842             [ "${OPTARG}" == "osmclient" ] && TO_REBUILD="$TO_REBUILD osmclient" && continue
 843             [ "${OPTARG}" == "KAFKA" ] && TO_REBUILD="$TO_REBUILD KAFKA" && continue
 844             [ "${OPTARG}" == "MONGO" ] && TO_REBUILD="$TO_REBUILD MONGO" && continue
 845             [ "${OPTARG}" == "PROMETHEUS" ] && TO_REBUILD="$TO_REBUILD PROMETHEUS" && continue
 846             [ "${OPTARG}" == "PROMETHEUS-CADVISOR" ] && TO_REBUILD="$TO_REBUILD PROMETHEUS-CADVISOR" && continue
 847             [ "${OPTARG}" == "KEYSTONE-DB" ] && TO_REBUILD="$TO_REBUILD KEYSTONE-DB" && continue
 848             [ "${OPTARG}" == "GRAFANA" ] && TO_REBUILD="$TO_REBUILD GRAFANA" && continue
 849             [ "${OPTARG}" == "NONE" ] && TO_REBUILD="$TO_REBUILD NONE" && continue
 850             ;;
 851         H)
 852             OSM_VCA_HOST="${OPTARG}"
 853             ;;
 854         S)
 855             OSM_VCA_SECRET="${OPTARG}"
 856             ;;
 857         s)
 858             OSM_NAMESPACE="${OPTARG}" && [[ ! "${OPTARG}" =~ $RE_CHECK ]] && echo "Namespace $OPTARG is invalid. Regex used for validation is $RE_CHECK" && exit 0
 859             ;;
 860         t)
 861             OSM_DOCKER_TAG="${OPTARG}"
 862             REPO_ARGS+=(-t "$OSM_DOCKER_TAG")
 863             ;;
 864         U)
 865             DOCKER_USER="${OPTARG}"
 866             ;;
 867         P)
 868             OSM_VCA_PUBKEY=$(cat ${OPTARG})
 869             ;;
 870         A)
 871             OSM_VCA_APIPROXY="${OPTARG}"
 872             ;;
 873         l)
 874             LXD_CLOUD_FILE="${OPTARG}"
 875             ;;
 876         L)
 877             LXD_CRED_FILE="${OPTARG}"
 878             ;;
 879         K)
 880             CONTROLLER_NAME="${OPTARG}"
 881             ;;
 882         d)
 883             DOCKER_REGISTRY_URL="${OPTARG}"
 884             ;;
 885         p)
 886             DOCKER_PROXY_URL="${OPTARG}"
 887             ;;
 888         T)
 889             MODULE_DOCKER_TAG="${OPTARG}"
 890             ;;
 891         -)
 892             [ "${OPTARG}" == "help" ] && usage && exit 0
 893             [ "${OPTARG}" == "source" ] && INSTALL_FROM_SOURCE="y" && PULL_IMAGES="" && continue
 894             [ "${OPTARG}" == "debug" ] && DEBUG_INSTALL="--debug" && continue
 895             [ "${OPTARG}" == "develop" ] && DEVELOP="y" && continue
 896             [ "${OPTARG}" == "uninstall" ] && UNINSTALL="y" && continue
 897             [ "${OPTARG}" == "update" ] && UPDATE="y" && continue
 898             [ "${OPTARG}" == "reconfigure" ] && RECONFIGURE="y" && continue
 899             [ "${OPTARG}" == "test" ] && TEST_INSTALLER="y" && continue
 900             [ "${OPTARG}" == "lxdinstall" ] && INSTALL_LXD="y" && continue
 901             [ "${OPTARG}" == "nolxd" ] && INSTALL_NOLXD="y" && continue
 902             [ "${OPTARG}" == "nodocker" ] && INSTALL_NODOCKER="y" && continue
 903             [ "${OPTARG}" == "showopts" ] && SHOWOPTS="y" && continue
 904             [ "${OPTARG}" == "nohostports" ] && NO_HOST_PORTS="y" && continue
 905             [ "${OPTARG}" == "nojuju" ] && INSTALL_NOJUJU="--nojuju" && continue
 906             [ "${OPTARG}" == "nodockerbuild" ] && DOCKER_NOBUILD="y" && continue
 907             [ "${OPTARG}" == "nohostclient" ] && INSTALL_NOHOSTCLIENT="y" && continue
 908             [ "${OPTARG}" == "pullimages" ] && continue
 909             [ "${OPTARG}" == "k8s_monitor" ] && INSTALL_K8S_MONITOR="y" && continue
 910             [ "${OPTARG}" == "charmed" ] && CHARMED="y" && OSM_INSTALLATION_TYPE="Charmed" && continue
 911             [ "${OPTARG}" == "bundle" ] && continue
 912             [ "${OPTARG}" == "k8s" ] && continue
 913             [ "${OPTARG}" == "lxd" ] && continue
 914             [ "${OPTARG}" == "lxd-cred" ] && continue
 915             [ "${OPTARG}" == "microstack" ] && continue
 916             [ "${OPTARG}" == "overlay" ] && continue
 917             [ "${OPTARG}" == "only-vca" ] && continue
 918             [ "${OPTARG}" == "small-profile" ] && continue
 919             [ "${OPTARG}" == "vca" ] && continue
 920             [ "${OPTARG}" == "ha" ] && continue
 921             [ "${OPTARG}" == "tag" ] && continue
 922             [ "${OPTARG}" == "registry" ] && continue
 923             [ "${OPTARG}" == "pla" ] && INSTALL_PLA="y" && continue
 924             [ "${OPTARG}" == "old-sa" ] && INSTALL_NGSA="" && continue
 925             [ "${OPTARG}" == "ng-sa" ] && INSTALL_NGSA="y" && continue
 926             [ "${OPTARG}" == "volume" ] && OPENSTACK_ATTACH_VOLUME="true" && continue
 927             [ "${OPTARG}" == "nocachelxdimages" ] && continue
 928             [ "${OPTARG}" == "cachelxdimages" ] && INSTALL_CACHELXDIMAGES="--cachelxdimages" && continue
 929             echo -e "Invalid option: '--$OPTARG'\n" >&2
 930             usage && exit 1
 931             ;;
 932         :)
 933             echo "Option -$OPTARG requires an argument" >&2
 934             usage && exit 1
 935             ;;
 936         \?)
 937             echo -e "Invalid option: '-$OPTARG'\n" >&2
 938             usage && exit 1
 939             ;;
 940         h)
 941             usage && exit 0
 942             ;;
 943         y)
 944             ASSUME_YES="y"
 945             ;;
 946         *)
 947             usage && exit 1
 948             ;;
 949     esac
 950 done
 951
 952 source $OSM_DEVOPS/common/all_funcs
 953
 954 [ -z "${DEBUG_INSTALL}" ] || DEBUG Debug is on
 955 [ -n "$SHOWOPTS" ] && dump_vars && exit 0
 956
 957 # Uninstall if "--uninstall"
 958 if [ -n "$UNINSTALL" ]; then
 959     if [ -n "$CHARMED" ]; then
 960         ${OSM_DEVOPS}/installers/charmed_uninstall.sh -R $RELEASE -r $REPOSITORY -u $REPOSITORY_BASE -D $OSM_DEVOPS -t $DOCKER_TAG "$@" || \
 961         FATAL_TRACK charmed_uninstall "charmed_uninstall.sh failed"
 962     else
 963         ${OSM_DEVOPS}/installers/uninstall_osm.sh "$@" || \
 964         FATAL_TRACK community_uninstall "uninstall_osm.sh failed"
 965     fi
 966     echo -e "\nDONE"
 967     exit 0
 968 fi
 969
 970 # Installation starts here
 971
 972 # Get README and create OSM_TRACK_INSTALLATION_ID
 973 wget -q -O- https://osm-download.etsi.org/ftp/osm-13.0-thirteen/README.txt &> /dev/null
 974 export OSM_TRACK_INSTALLATION_ID="$(date +%s)-$(head /dev/urandom | tr -dc A-Za-z0-9 | head -c 16)"
 975
 976 # Get OS info to be tracked
 977 os_distro=$(lsb_release -i 2>/dev/null | awk '{print $3}')
 978 echo $os_distro
 979 os_release=$(lsb_release -r 2>/dev/null | awk '{print $2}')
 980 echo $os_release
 981 os_info="${os_distro}_${os_release}"
 982 os_info="${os_info// /_}"
 983
 984 # Charmed installation
 985 if [ -n "$CHARMED" ]; then
 986     sudo snap install jq || FATAL "Could not install jq (snap package). Make sure that snap works"
 987     ${OSM_DEVOPS}/installers/charmed_install.sh --tag $OSM_DOCKER_TAG "$@" || \
 988     FATAL_TRACK charmed_install "charmed_install.sh failed"
 989     wget -q -O- https://osm-download.etsi.org/ftp/osm-13.0-thirteen/README2.txt &> /dev/null
 990     echo -e "\nDONE"
 991     exit 0
 992 fi
 993
 994 # Installation to Openstack
 995 if [ -n "$INSTALL_TO_OPENSTACK" ]; then
 996     install_to_openstack $OPENSTACK_OPENRC_FILE_OR_CLOUD $OPENSTACK_PUBLIC_NET_NAME $OPENSTACK_ATTACH_VOLUME
 997     echo -e "\nDONE"
 998     exit 0
 999 fi
1000
1001 # Community_installer
1002 # Check incompatible options
1003 [ -n "$TO_REBUILD" ] && [ "$TO_REBUILD" != " NONE" ] && echo $TO_REBUILD | grep -q NONE && FATAL "Incompatible option: -m NONE cannot be used with other -m options"
1004 [ -n "$TO_REBUILD" ] && [ "$TO_REBUILD" == " PLA" ] && [ -z "$INSTALL_PLA" ] && FATAL "Incompatible option: -m PLA cannot be used without --pla option"
1005 # Special cases go first
1006 # if develop, we force master
1007 [ -z "$COMMIT_ID" ] && [ -n "$DEVELOP" ] && COMMIT_ID="master"
1008 [ -n "$INSTALL_ONLY" ] && [ -n "$INSTALL_K8S_MONITOR" ] && install_k8s_monitoring
1009 [ -n "$INSTALL_ONLY" ] && [ -n "$INSTALL_NGSA" ] && install_osm_ngsa_service
1010 [ -n "$INSTALL_ONLY" ] && echo -e "\nDONE" && exit 0
1011 # This is where installation starts
1012 install_osm
1013 echo -e "\nDONE"
1014 exit 0