blob: 8863297b32af3843c23f709de370cf603f49fa6a [file] [log] [blame]
garciadeblas93c61312016-09-28 15:12:48 +02001#!/bin/bash
garciadeblas38d91ee2019-11-07 16:31:23 +01002#
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#
garciadeblasd8bc5c32018-05-09 17:37:56 +020015REPOSITORY_BASE=https://osm-download.etsi.org/repository/osm/debian
garciadeblasa14e6282021-11-08 12:40:18 +010016RELEASE=ReleaseELEVEN
garciadeblas7bcadc52020-02-02 22:40:15 +010017REPOSITORY=stable
garciadeblasa14e6282021-11-08 12:40:18 +010018DOCKER_TAG=11
garciadeblas2bf767a2021-05-19 10:54:46 +020019DEVOPS_PATH=/usr/share/osm-devops
garciadeblas93c61312016-09-28 15:12:48 +020020
garciadeblas38d91ee2019-11-07 16:31:23 +010021function usage(){
22 echo -e "usage: $0 [OPTIONS]"
23 echo -e "Install OSM from binaries or source code (by default, from binaries)"
24 echo -e " OPTIONS"
garciadeblas7f1e1042020-11-30 14:07:03 +000025 echo -e " -h / --help: print this help"
26 echo -e " -y: do not prompt for confirmation, assumes yes"
garciadeblas38d91ee2019-11-07 16:31:23 +010027 echo -e " -r <repo>: use specified repository name for osm packages"
28 echo -e " -R <release>: use specified release for osm binaries (deb packages, lxd images, ...)"
29 echo -e " -u <repo base>: use specified repository url for osm packages"
30 echo -e " -k <repo key>: use specified repository public key url"
31 echo -e " -b <refspec>: install OSM from source code using a specific branch (master, v2.0, ...) or tag"
32 echo -e " -b master (main dev branch)"
33 echo -e " -b v2.0 (v2.0 branch)"
34 echo -e " -b tags/v1.1.0 (a specific tag)"
35 echo -e " ..."
garciadeblascb129372020-11-14 23:06:42 +000036 echo -e " -c <orchestrator> deploy osm services using container <orchestrator>. Valid values are <k8s> or <swarm>. If -c is not used then osm will be deployed using default orchestrator. When used with --uninstall, osm services deployed by the orchestrator will be uninstalled"
garciadeblascb129372020-11-14 23:06:42 +000037 echo -e " -s <stack name> or <namespace> user defined stack name when installed using swarm or namespace when installed using k8s, default is osm"
garciadeblas38d91ee2019-11-07 16:31:23 +010038 echo -e " -H <VCA host> use specific juju host controller IP"
39 echo -e " -S <VCA secret> use VCA/juju secret key"
40 echo -e " -P <VCA pubkey> use VCA/juju public key file"
41 echo -e " -C <VCA cacert> use VCA/juju CA certificate file"
42 echo -e " -A <VCA apiproxy> use VCA/juju API proxy"
43 echo -e " --vimemu: additionally deploy the VIM emulator as a docker container"
44 echo -e " --elk_stack: additionally deploy an ELK docker stack for event logging"
magnussonl1bbe9452020-02-25 13:43:17 +010045 echo -e " --pla: install the PLA module for placement support"
garciadeblascb129372020-11-14 23:06:42 +000046 echo -e " -m <MODULE>: install OSM but only rebuild the specified docker images (LW-UI, NBI, LCM, RO, MON, POL, KAFKA, MONGO, PROMETHEUS, PROMETHEUS-CADVISOR, KEYSTONE-DB, PLA, NONE)"
47 echo -e " -o <ADDON>: ONLY (un)installs one of the addons (vimemu, elk_stack, k8s_monitor)"
48 echo -e " -O <openrc file/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/"
49 echo -e " -N <openstack public network name/ID>: Public network name required to setup OSM to OpenStack"
garciadeblas38d91ee2019-11-07 16:31:23 +010050 echo -e " -D <devops path> use local devops installation path"
51 echo -e " -w <work dir> Location to store runtime installation"
52 echo -e " -t <docker tag> specify osm docker tag (default is latest)"
David Garcia79f4f532020-04-07 12:59:34 +020053 echo -e " -l: LXD cloud yaml file"
54 echo -e " -L: LXD credentials yaml file"
David Garcia404ae122020-04-28 11:47:55 +020055 echo -e " -K: Specifies the name of the controller to use - The controller must be already bootstrapped"
garciadeblas7f1e1042020-11-30 14:07:03 +000056 echo -e " -d <docker registry URL> use docker registry URL instead of dockerhub"
57 echo -e " -p <docker proxy URL> set docker proxy URL as part of docker CE configuration"
garciadeblas9a510862021-04-21 14:15:56 +020058 echo -e " -T <docker tag> specify docker tag for the modules specified with option -m"
59 echo -e " --nocachelxdimages: do not cache local lxd images, do not create cronjob for that cache (will save installation time, might affect instantiation time)"
David Garcia79f4f532020-04-07 12:59:34 +020060 echo -e " --nolxd: do not install and configure LXD, allowing unattended installations (assumes LXD is already installed and confifured)"
garciadeblas38d91ee2019-11-07 16:31:23 +010061 echo -e " --nodocker: do not install docker, do not initialize a swarm (assumes docker is already installed and a swarm has been initialized)"
62 echo -e " --nojuju: do not juju, assumes already installed"
63 echo -e " --nodockerbuild:do not build docker images (use existing locally cached images)"
64 echo -e " --nohostports: do not expose docker ports to host (useful for creating multiple instances of osm on the same host)"
65 echo -e " --nohostclient: do not install the osmclient"
66 echo -e " --uninstall: uninstall OSM: remove the containers and delete NAT rules"
67 echo -e " --source: install OSM from source code using the latest stable tag"
68 echo -e " --develop: (deprecated, use '-b master') install OSM from source code using the master branch"
garciadeblas38d91ee2019-11-07 16:31:23 +010069 echo -e " --pullimages: pull/run osm images from docker.io/opensourcemano"
garciadeblascb129372020-11-14 23:06:42 +000070 echo -e " --k8s_monitor: install the OSM kubernetes monitoring with prometheus and grafana"
71 echo -e " --volume: create a VM volume when installing to OpenStack"
garciadeblas38d91ee2019-11-07 16:31:23 +010072 echo -e " --showopts: print chosen options and exit (only for debugging)"
Dominik Fleischmann7a97a4c2020-06-04 10:52:05 +020073 echo -e " --charmed: Deploy and operate OSM with Charms on k8s"
74 echo -e " [--bundle <bundle path>]: Specify with which bundle to deploy OSM with charms (--charmed option)"
75 echo -e " [--k8s <kubeconfig path>]: Specify with which kubernetes to deploy OSM with charms (--charmed option)"
garciadeblascb129372020-11-14 23:06:42 +000076 echo -e " [--vca <name>]: Specifies the name of the controller to use - The controller must be already bootstrapped (--charmed option)"
77 echo -e " [--lxd <yaml path>]: Takes a YAML file as a parameter with the LXD Cloud information (--charmed option)"
Dominik Fleischmann7a97a4c2020-06-04 10:52:05 +020078 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)"
David Garcia4bd2bf02021-05-05 19:01:43 +020080 echo -e " [--overlay]: Add an overlay to override some defaults of the default bundle (--charmed option)"
Dominik Fleischmannc57296f2020-06-09 11:45:08 +020081 echo -e " [--ha]: Installs High Availability bundle. (--charmed option)"
garciadeblascb129372020-11-14 23:06:42 +000082 echo -e " [--tag]: Docker image tag. (--charmed option)"
83 echo -e " [--registry]: Docker registry with optional credentials as user:pass@hostname:port (--charmed option)"
Dominik Fleischmann7a97a4c2020-06-04 10:52:05 +020084
garciadeblas38d91ee2019-11-07 16:31:23 +010085}
86
garciadeblasd8bc5c32018-05-09 17:37:56 +020087add_repo() {
88 REPO_CHECK="^$1"
89 grep "${REPO_CHECK/\[arch=amd64\]/\\[arch=amd64\\]}" /etc/apt/sources.list > /dev/null 2>&1
90 if [ $? -ne 0 ]
91 then
garciadeblasbd925e42018-06-14 14:32:12 +020092 need_packages_lw="software-properties-common apt-transport-https"
garciadeblas0bc87522021-10-20 22:16:17 +020093 echo -e "Checking required packages to add ETSI OSM debian repo: $need_packages_lw"
garciadeblasbd925e42018-06-14 14:32:12 +020094 dpkg -l $need_packages_lw &>/dev/null \
95 || ! echo -e "One or several required packages are not installed. Updating apt cache requires root privileges." \
garciadeblasc93d2022022-02-10 01:43:59 +010096 || sudo apt-get -qy update \
Mike Marchetti34124182018-10-16 08:22:30 -040097 || ! echo "failed to run apt-get update" \
garciadeblasbd925e42018-06-14 14:32:12 +020098 || exit 1
99 dpkg -l $need_packages_lw &>/dev/null \
100 || ! echo -e "Installing $need_packages_lw requires root privileges." \
101 || sudo apt-get install -y $need_packages_lw \
Mike Marchetti34124182018-10-16 08:22:30 -0400102 || ! echo "failed to install $need_packages_lw" \
garciadeblasbd925e42018-06-14 14:32:12 +0200103 || exit 1
garciadeblas024b5ed2022-04-21 00:29:02 +0200104 wget -q -O OSM-ETSI-Release-key.gpg "$REPOSITORY_BASE/$RELEASE/OSM%20ETSI%20Release%20Key.gpg"
105 sudo APT_KEY_DONT_WARN_ON_DANGEROUS_USAGE=1 apt-key add OSM-ETSI-Release-key.gpg \
106 || ! echo -e "Could not add GPG key $REPOSITORY_BASE/$RELEASE/OSM%20ETSI%20Release%20Key.gpg" \
107 || exit 1
garciadeblasc93d2022022-02-10 01:43:59 +0100108 sudo DEBIAN_FRONTEND=noninteractive add-apt-repository -y "$1"
garciadeblas024b5ed2022-04-21 00:29:02 +0200109 sudo DEBIAN_FRONTEND=noninteractive apt-get -y update
garciadeblas429b9f82018-03-20 02:09:44 +0100110 return 0
garciadeblasd8bc5c32018-05-09 17:37:56 +0200111 fi
112
113 return 1
garciadeblas55490d42016-10-29 14:22:03 +0200114}
115
garciadeblas25e87d22020-01-31 14:27:29 +0100116clean_old_repo() {
madaviae0784f2020-01-22 16:29:19 +0530117dpkg -s 'osm-devops' &> /dev/null
madaviae0784f2020-01-22 16:29:19 +0530118if [ $? -eq 0 ]; then
madaviae0784f2020-01-22 16:29:19 +0530119 # Clean the previous repos that might exist
120 sudo sed -i "/osm-download.etsi.org/d" /etc/apt/sources.list
121fi
122}
123
garciadeblas0bc87522021-10-20 22:16:17 +0200124function configure_apt_proxy() {
125 [ -z "${DEBUG_INSTALL}" ] || DEBUG beginning of function
126 OSM_APT_PROXY=$1
127 OSM_APT_PROXY_FILE="/etc/apt/apt.conf.d/osm-apt"
128 echo "Configuring apt proxy in file ${OSM_APT_PROXY_FILE}"
129 if [ ! -f ${OSM_APT_PROXY_FILE} ]; then
130 sudo bash -c "cat <<EOF > ${OSM_APT_PROXY}
131Acquire::http { Proxy \"${OSM_APT_PROXY}\"; }
132EOF"
133 else
134 sudo sed -i "s|Proxy.*|Proxy \"${OSM_APT_PROXY}\"; }|" ${OSM_APT_PROXY_FILE}
135 fi
garciadeblasc93d2022022-02-10 01:43:59 +0100136 sudo apt-get -y update || FATAL "Configured apt proxy, but couldn't run 'apt-get update'. Check ${OSM_APT_PROXY_FILE}"
garciadeblas0bc87522021-10-20 22:16:17 +0200137 [ -z "${DEBUG_INSTALL}" ] || DEBUG end of function
138}
139
140while 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
garciadeblas38d91ee2019-11-07 16:31:23 +0100141 case "${o}" in
Antonio Marsico75a38c72020-12-21 17:29:42 +0100142 D)
143 DEVOPS_PATH="${OPTARG}"
144 ;;
garciadeblas38d91ee2019-11-07 16:31:23 +0100145 r)
146 REPOSITORY="${OPTARG}"
147 ;;
148 R)
149 RELEASE="${OPTARG}"
150 ;;
151 u)
152 REPOSITORY_BASE="${OPTARG}"
153 ;;
154 t)
garciadeblas25e87d22020-01-31 14:27:29 +0100155 DOCKER_TAG="${OPTARG}"
garciadeblas38d91ee2019-11-07 16:31:23 +0100156 ;;
garciadeblas72399e32019-11-22 10:09:40 +0100157 -)
158 [ "${OPTARG}" == "help" ] && usage && exit 0
Dominik Fleischmann5e4a7512020-03-06 14:05:06 +0100159 ;;
garciadeblas25e87d22020-01-31 14:27:29 +0100160 :)
161 echo "Option -$OPTARG requires an argument" >&2
162 usage && exit 1
163 ;;
164 \?)
165 echo -e "Invalid option: '-$OPTARG'\n" >&2
166 usage && exit 1
167 ;;
168 h)
169 usage && exit 0
170 ;;
garciadeblas38d91ee2019-11-07 16:31:23 +0100171 *)
172 ;;
173 esac
174done
175
garciadeblas25e87d22020-01-31 14:27:29 +0100176clean_old_repo
garciadeblasd8bc5c32018-05-09 17:37:56 +0200177add_repo "deb [arch=amd64] $REPOSITORY_BASE/$RELEASE $REPOSITORY devops"
garciadeblasc93d2022022-02-10 01:43:59 +0100178sudo DEBIAN_FRONTEND=noninteractive apt-get -qy update
179sudo DEBIAN_FRONTEND=noninteractive apt-get -y install osm-devops
Antonio Marsico75a38c72020-12-21 17:29:42 +0100180$DEVOPS_PATH/installers/full_install_osm.sh -R $RELEASE -r $REPOSITORY -u $REPOSITORY_BASE -D $DEVOPS_PATH -t $DOCKER_TAG "$@"