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