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