installers/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 REPOSITORY_BASE=https://osm-download.etsi.org/repository/osm/debian
  16 RELEASE=ReleaseSEVEN
  17 REPOSITORY=stable
  18 DOCKER_TAG=7
  19
  20 function usage(){
  21     echo -e "usage: $0 [OPTIONS]"
  22     echo -e "Install OSM from binaries or source code (by default, from binaries)"
  23     echo -e "  OPTIONS"
  24     echo -e "     -r <repo>:      use specified repository name for osm packages"
  25     echo -e "     -R <release>:   use specified release for osm binaries (deb packages, lxd images, ...)"
  26     echo -e "     -u <repo base>: use specified repository url for osm packages"
  27     echo -e "     -k <repo key>:  use specified repository public key url"
  28     echo -e "     -b <refspec>:   install OSM from source code using a specific branch (master, v2.0, ...) or tag"
  29     echo -e "                     -b master          (main dev branch)"
  30     echo -e "                     -b v2.0            (v2.0 branch)"
  31     echo -e "                     -b tags/v1.1.0     (a specific tag)"
  32     echo -e "                     ..."
  33     echo -e "     -n <ui> install OSM with Next Gen UI. Valid values are <lwui> or <ngui>. If -n is not specified osm will be installed with light-ui. When used with uninstall, osm along with the UI specified will be uninstalled"
  34     echo -e "     -s <stack name> user defined stack name, default is osm"
  35     echo -e "     -H <VCA host>   use specific juju host controller IP"
  36     echo -e "     -S <VCA secret> use VCA/juju secret key"
  37     echo -e "     -P <VCA pubkey> use VCA/juju public key file"
  38     echo -e "     -C <VCA cacert> use VCA/juju CA certificate file"
  39     echo -e "     -A <VCA apiproxy> use VCA/juju API proxy"
  40     echo -e "     --vimemu:       additionally deploy the VIM emulator as a docker container"
  41     echo -e "     --elk_stack:    additionally deploy an ELK docker stack for event logging"
  42     echo -e "     --pla:          install the PLA module for placement support"
  43     echo -e "     --pm_stack:     additionally deploy a Prometheus+Grafana stack for performance monitoring (PM)"
  44     echo -e "     -m <MODULE>:    install OSM but only rebuild the specified docker images (LW-UI, NBI, LCM, RO, MON, POL, KAFKA, MONGO, PROMETHEUS, KEYSTONE-DB, PLA, NONE)"
  45     echo -e "     -o <ADDON>:     ONLY (un)installs one of the addons (vimemu, elk_stack, pm_stack)"
  46     echo -e "     -D <devops path> use local devops installation path"
  47     echo -e "     -w <work dir>   Location to store runtime installation"
  48     echo -e "     -t <docker tag> specify osm docker tag (default is latest)"
  49     echo -e "     -l:             LXD cloud yaml file"
  50     echo -e "     -L:             LXD credentials yaml file"
  51     echo -e "     -K:             Specifies the name of the controller to use - The controller must be already bootstrapped"
  52     echo -e "     --nolxd:        do not install and configure LXD, allowing unattended installations (assumes LXD is already installed and confifured)"
  53     echo -e "     --nodocker:     do not install docker, do not initialize a swarm (assumes docker is already installed and a swarm has been initialized)"
  54     echo -e "     --nojuju:       do not juju, assumes already installed"
  55     echo -e "     --nodockerbuild:do not build docker images (use existing locally cached images)"
  56     echo -e "     --nohostports:  do not expose docker ports to host (useful for creating multiple instances of osm on the same host)"
  57     echo -e "     --nohostclient: do not install the osmclient"
  58     echo -e "     --uninstall:    uninstall OSM: remove the containers and delete NAT rules"
  59     echo -e "     --source:       install OSM from source code using the latest stable tag"
  60     echo -e "     --develop:      (deprecated, use '-b master') install OSM from source code using the master branch"
  61     echo -e "     --soui:         install classic build of OSM (Rel THREE v3.1, based on LXD containers, with SO and UI)"
  62     echo -e "     --lxdimages:    (only for Rel THREE with --soui) download lxd images from OSM repository instead of creating them from scratch"
  63     echo -e "     --pullimages:   pull/run osm images from docker.io/opensourcemano"
  64     echo -e "     -l <lxd_repo>:  (only for Rel THREE with --soui) use specified repository url for lxd images"
  65     echo -e "     -p <path>:      (only for Rel THREE with --soui) use specified repository path for lxd images"
  66     echo -e "     --nat:          (only for Rel THREE with --soui) install only NAT rules"
  67     echo -e "     --noconfigure:  (only for Rel THREE with --soui) DO NOT install osmclient, DO NOT install NAT rules, DO NOT configure modules"
  68     echo -e "     --showopts:     print chosen options and exit (only for debugging)"
  69     #echo -e "     --clean_volumes To clear all the mounted volumes from docker swarm"
  70     echo -e "     -y:             do not prompt for confirmation, assumes yes"
  71     echo -e "     -h / --help:    print this help"
  72     echo -e "     --charmed:                       install OSM with charms"
  73     echo -e "     --bundle <bundle path>:          Specify with which bundle to deploy OSM with charms (--charmed option)"
  74     echo -e "     --kubeconfig <kubeconfig path>:  Specify with which kubernetes to deploy OSM with charms (--charmed option)"
  75     echo -e "     --controller <name>:             Specifies the name of the controller to use - The controller must be already bootstrapped (--charmed option)"
  76     echo -e "     --lxd-cloud <yaml path>:         Takes a YAML file as a parameter with the LXD Cloud information (--charmed option)"
  77     echo -e "     --lxd-credentials <yaml path>:   Takes a YAML file as a parameter with the LXD Credentials information (--charmed option)"
  78 }
  79
  80 add_repo() {
  81   REPO_CHECK="^$1"
  82   grep "${REPO_CHECK/\[arch=amd64\]/\\[arch=amd64\\]}" /etc/apt/sources.list > /dev/null 2>&1
  83   if [ $? -ne 0 ]
  84   then
  85     need_packages_lw="software-properties-common apt-transport-https"
  86     echo -e "Checking required packages: $need_packages_lw"
  87     dpkg -l $need_packages_lw &>/dev/null \
  88       || ! echo -e "One or several required packages are not installed. Updating apt cache requires root privileges." \
  89       || sudo apt-get -q update \
  90       || ! echo "failed to run apt-get update" \
  91       || exit 1
  92     dpkg -l $need_packages_lw &>/dev/null \
  93       || ! echo -e "Installing $need_packages_lw requires root privileges." \
  94       || sudo apt-get install -y $need_packages_lw \
  95       || ! echo "failed to install $need_packages_lw" \
  96       || exit 1
  97     wget -qO - $REPOSITORY_BASE/$RELEASE/OSM%20ETSI%20Release%20Key.gpg | sudo apt-key add -
  98     sudo DEBIAN_FRONTEND=noninteractive add-apt-repository -y "$1" && sudo DEBIAN_FRONTEND=noninteractive apt-get update
  99     return 0
 100   fi
 101
 102   return 1
 103 }
 104
 105 clean_old_repo() {
 106 dpkg -s 'osm-devops' &> /dev/null
 107 if [ $? -eq 0 ]; then
 108   # Clean the previous repos that might exist
 109   sudo sed -i "/osm-download.etsi.org/d" /etc/apt/sources.list
 110 fi
 111 }
 112
 113 while getopts ":b:r:c:n:k:u:R:l:L:K:p:D:o:m:H:S:s:w:t:U:P:A:-: hy" o; do
 114     case "${o}" in
 115         r)
 116             REPOSITORY="${OPTARG}"
 117             ;;
 118         R)
 119             RELEASE="${OPTARG}"
 120             ;;
 121         u)
 122             REPOSITORY_BASE="${OPTARG}"
 123             ;;
 124         t)
 125             DOCKER_TAG="${OPTARG}"
 126             ;;
 127         -)
 128             [ "${OPTARG}" == "help" ] && usage && exit 0
 129             ;;
 130         :)
 131             echo "Option -$OPTARG requires an argument" >&2
 132             usage && exit 1
 133             ;;
 134         \?)
 135             echo -e "Invalid option: '-$OPTARG'\n" >&2
 136             usage && exit 1
 137             ;;
 138         h)
 139             usage && exit 0
 140             ;;
 141         *)
 142             ;;
 143     esac
 144 done
 145
 146 clean_old_repo
 147 add_repo "deb [arch=amd64] $REPOSITORY_BASE/$RELEASE $REPOSITORY devops"
 148 sudo DEBIAN_FRONTEND=noninteractive apt-get -q update
 149 sudo DEBIAN_FRONTEND=noninteractive apt-get install osm-devops
 150 /usr/share/osm-devops/installers/full_install_osm.sh -R $RELEASE -r $REPOSITORY -u $REPOSITORY_BASE -D /usr/share/osm-devops -t $DOCKER_TAG "$@"