blob: a35396f4afa1d22d3eb1d69820238d5a87b160a3 [file] [log] [blame]
garciadeblasd8bc5c32018-05-09 17:37:56 +02001#!/bin/bash
garciadeblasd8bc5c32018-05-09 17:37:56 +02002#
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.
garciadeblas0bc87522021-10-20 22:16:17 +020014#
garciadeblasd8bc5c32018-05-09 17:37:56 +020015
16function usage(){
garciadeblas0bc87522021-10-20 22:16:17 +020017 [ -z "${DEBUG_INSTALL}" ] || DEBUG beginning of function
garciadeblasd8bc5c32018-05-09 17:37:56 +020018 echo -e "usage: $0 [OPTIONS]"
garciadeblas81077ae2023-07-03 19:31:15 +020019 echo -e "Install OSM"
garciadeblasd8bc5c32018-05-09 17:37:56 +020020 echo -e " OPTIONS"
garciadeblas7f1e1042020-11-30 14:07:03 +000021 echo -e " -h / --help: print this help"
22 echo -e " -y: do not prompt for confirmation, assumes yes"
garciadeblasd8bc5c32018-05-09 17:37:56 +020023 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"
garciadeblas0bc87522021-10-20 22:16:17 +020027 echo -e " -a <apt proxy url>: use this apt proxy url when downloading apt packages (air-gapped installation)"
garciadeblasb3797412024-06-06 14:26:24 +020028 echo -e " -c <kubernetes engine>: use a specific kubernetes engine (options: kubeadm, k3s), default is kubeadm"
garciadeblas8d8cd992024-05-21 16:04:14 +020029 echo -e " -t <docker tag> specify osm docker tag (default is latest)"
30 echo -e " -M <KUBECONFIG_FILE>: Kubeconfig of an existing cluster to be used as mgmt cluster instead of OSM cluster"
31 echo -e " -G <KUBECONFIG_FILE>: Kubeconfig of an existing cluster to be used as auxiliary cluster instead of OSM cluster"
32 echo -e " --no-mgmt-cluster: Do not provision a mgmt cluster for cloud-native gitops operations in OSM (NEW in Release SIXTEEN) (by default, it is installed)"
33 echo -e " --no-aux-cluster: Do not provision an auxiliary cluster for cloud-native gitops operations in OSM (NEW in Release SIXTEEN) (by default, it is installed)"
34 echo -e " -D <devops path>: use local devops installation path"
garciadeblas325032a2023-04-13 18:07:44 +020035 echo -e " -s <namespace> namespace when installed using k8s, default is osm"
Mike Marchettib8420852018-09-13 13:45:06 -040036 echo -e " -H <VCA host> use specific juju host controller IP"
37 echo -e " -S <VCA secret> use VCA/juju secret key"
garciadeblasaa3ddf42019-04-04 19:04:32 +020038 echo -e " -P <VCA pubkey> use VCA/juju public key file"
Adam Israel5ddc97f2019-09-03 18:11:12 -040039 echo -e " -A <VCA apiproxy> use VCA/juju API proxy"
garciadeblasef3f37c2024-05-31 17:30:48 +020040 echo -e " -o <COMPONENT>: ONLY installs the specified component (k8s_monitor, ng-sa, k8scluster, docker, deploy-osm)"
garciadeblas8d8cd992024-05-21 16:04:14 +020041 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/"
42 echo -e " -N <openstack public network name/ID>: public network name required to setup OSM to OpenStack"
43 echo -e " -f <path to SSH public key>: public SSH key to use to deploy OSM to OpenStack"
44 echo -e " -F <path to cloud-init file>: cloud-init userdata file to deploy OSM to OpenStack"
45 echo -e " -w <work dir>: Location to store runtime installation"
David Garcia79f4f532020-04-07 12:59:34 +020046 echo -e " -l: LXD cloud yaml file"
47 echo -e " -L: LXD credentials yaml file"
David Garcia404ae122020-04-28 11:47:55 +020048 echo -e " -K: Specifies the name of the controller to use - The controller must be already bootstrapped"
garciadeblas7f1e1042020-11-30 14:07:03 +000049 echo -e " -d <docker registry URL> use docker registry URL instead of dockerhub"
50 echo -e " -p <docker proxy URL> set docker proxy URL as part of docker CE configuration"
51 echo -e " -T <docker tag> specify docker tag for the modules specified with option -m"
garciadeblas0bc87522021-10-20 22:16:17 +020052 echo -e " --debug: debug mode"
garciadeblas9a510862021-04-21 14:15:56 +020053 echo -e " --nocachelxdimages: do not cache local lxd images, do not create cronjob for that cache (will save installation time, might affect instantiation time)"
garciadeblas0bc87522021-10-20 22:16:17 +020054 echo -e " --cachelxdimages: cache local lxd images, create cronjob for that cache (will make installation longer)"
David Garcia79f4f532020-04-07 12:59:34 +020055 echo -e " --nolxd: do not install and configure LXD, allowing unattended installations (assumes LXD is already installed and confifured)"
garciadeblasa3e26612018-05-30 17:58:55 +020056 echo -e " --nodocker: do not install docker, do not initialize a swarm (assumes docker is already installed and a swarm has been initialized)"
Mike Marchettib8420852018-09-13 13:45:06 -040057 echo -e " --nojuju: do not juju, assumes already installed"
Mike Marchettib8420852018-09-13 13:45:06 -040058 echo -e " --nohostports: do not expose docker ports to host (useful for creating multiple instances of osm on the same host)"
59 echo -e " --nohostclient: do not install the osmclient"
garciadeblase990f662018-05-18 11:43:39 +020060 echo -e " --uninstall: uninstall OSM: remove the containers and delete NAT rules"
romeromonser599d5e22020-03-06 10:23:29 +010061 echo -e " --k8s_monitor: install the OSM kubernetes monitoring with prometheus and grafana"
Antonio Marsicof4ce57c2020-04-23 12:06:19 +020062 echo -e " --volume: create a VM volume when installing to OpenStack"
garciadeblasd8bc5c32018-05-09 17:37:56 +020063 echo -e " --showopts: print chosen options and exit (only for debugging)"
Dominik Fleischmann7a97a4c2020-06-04 10:52:05 +020064 echo -e " --charmed: Deploy and operate OSM with Charms on k8s"
65 echo -e " [--bundle <bundle path>]: Specify with which bundle to deploy OSM with charms (--charmed option)"
66 echo -e " [--k8s <kubeconfig path>]: Specify with which kubernetes to deploy OSM with charms (--charmed option)"
Dominik Fleischmannc57296f2020-06-09 11:45:08 +020067 echo -e " [--vca <name>]: Specifies the name of the controller to use - The controller must be already bootstrapped (--charmed option)"
aticig5d19ac22022-05-06 13:46:22 +030068 echo -e " [--small-profile]: Do not install and configure LXD which aims to use only K8s Clouds (--charmed option)"
Dominik Fleischmannc57296f2020-06-09 11:45:08 +020069 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 +020070 echo -e " [--lxd-cred <yaml path>]: Takes a YAML file as a parameter with the LXD Credentials information (--charmed option)"
71 echo -e " [--microstack]: Installs microstack as a vim. (--charmed option)"
David Garcia4bd2bf02021-05-05 19:01:43 +020072 echo -e " [--overlay]: Add an overlay to override some defaults of the default bundle (--charmed option)"
Dominik Fleischmannc57296f2020-06-09 11:45:08 +020073 echo -e " [--ha]: Installs High Availability bundle. (--charmed option)"
beierlmf2782c52020-11-05 17:04:05 -050074 echo -e " [--tag]: Docker image tag. (--charmed option)"
75 echo -e " [--registry]: Docker registry with optional credentials as user:pass@hostname:port (--charmed option)"
garciadeblas0bc87522021-10-20 22:16:17 +020076 [ -z "${DEBUG_INSTALL}" ] || DEBUG end of function
garciadeblasd8bc5c32018-05-09 17:37:56 +020077}
78
Mike Marchettib8420852018-09-13 13:45:06 -040079# takes a juju/accounts.yaml file and returns the password specific
Adam Israel8232e562018-11-21 16:47:45 -050080# for a controller. I wrote this using only bash tools to minimize
Mike Marchettib8420852018-09-13 13:45:06 -040081# additions of other packages
82function parse_juju_password {
garciadeblas0bc87522021-10-20 22:16:17 +020083 [ -z "${DEBUG_INSTALL}" ] || DEBUG beginning of function
84 password_file="${HOME}/.local/share/juju/accounts.yaml"
85 local controller_name=$1
86 local s='[[:space:]]*' w='[a-zA-Z0-9_-]*' fs=$(echo @|tr @ '\034')
87 sed -ne "s|^\($s\):|\1|" \
88 -e "s|^\($s\)\($w\)$s:$s[\"']\(.*\)[\"']$s\$|\1$fs\2$fs\3|p" \
89 -e "s|^\($s\)\($w\)$s:$s\(.*\)$s\$|\1$fs\2$fs\3|p" $password_file |
90 awk -F$fs -v controller=$controller_name '{
91 indent = length($1)/2;
92 vname[indent] = $2;
93 for (i in vname) {if (i > indent) {delete vname[i]}}
94 if (length($3) > 0) {
95 vn=""; for (i=0; i<indent; i++) {vn=(vn)(vname[i])("_")}
96 if (match(vn,controller) && match($2,"password")) {
97 printf("%s",$3);
98 }
99 }
100 }'
101 [ -z "${DEBUG_INSTALL}" ] || DEBUG end of function
102}
103
104function set_vca_variables() {
105 OSM_VCA_CLOUDNAME="lxd-cloud"
106 [ -n "$OSM_VCA_HOST" ] && OSM_VCA_CLOUDNAME="localhost"
107 if [ -z "$OSM_VCA_HOST" ]; then
garciadeblas325032a2023-04-13 18:07:44 +0200108 [ -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}'`
garciadeblas0bc87522021-10-20 22:16:17 +0200109 [ -n "$CONTROLLER_NAME" ] && OSM_VCA_HOST=`juju show-controller $CONTROLLER_NAME |grep api-endpoints|awk -F\' '{print $2}'|awk -F\: '{print $1}'`
110 [ -z "$OSM_VCA_HOST" ] && FATAL "Cannot obtain juju controller IP address"
111 fi
112 if [ -z "$OSM_VCA_SECRET" ]; then
garciadeblas325032a2023-04-13 18:07:44 +0200113 [ -z "$CONTROLLER_NAME" ] && OSM_VCA_SECRET=$(parse_juju_password $OSM_NAMESPACE)
garciadeblas0bc87522021-10-20 22:16:17 +0200114 [ -n "$CONTROLLER_NAME" ] && OSM_VCA_SECRET=$(parse_juju_password $CONTROLLER_NAME)
115 [ -z "$OSM_VCA_SECRET" ] && FATAL "Cannot obtain juju secret"
116 fi
117 if [ -z "$OSM_VCA_PUBKEY" ]; then
118 OSM_VCA_PUBKEY=$(cat $HOME/.local/share/juju/ssh/juju_id_rsa.pub)
119 [ -z "$OSM_VCA_PUBKEY" ] && FATAL "Cannot obtain juju public key"
120 fi
121 if [ -z "$OSM_VCA_CACERT" ]; then
garciadeblas325032a2023-04-13 18:07:44 +0200122 [ -z "$CONTROLLER_NAME" ] && OSM_VCA_CACERT=$(juju controllers --format json | jq -r --arg controller $OSM_NAMESPACE '.controllers[$controller]["ca-cert"]' | base64 | tr -d \\n)
garciadeblas0bc87522021-10-20 22:16:17 +0200123 [ -n "$CONTROLLER_NAME" ] && OSM_VCA_CACERT=$(juju controllers --format json | jq -r --arg controller $CONTROLLER_NAME '.controllers[$controller]["ca-cert"]' | base64 | tr -d \\n)
124 [ -z "$OSM_VCA_CACERT" ] && FATAL "Cannot obtain juju CA certificate"
125 fi
Mike Marchettib8420852018-09-13 13:45:06 -0400126}
127
Benjamin Diazba2cca92018-11-08 21:07:15 -0300128function generate_secret() {
garciadeblas0bc87522021-10-20 22:16:17 +0200129 [ -z "${DEBUG_INSTALL}" ] || DEBUG beginning of function
Benjamin Diazba2cca92018-11-08 21:07:15 -0300130 head /dev/urandom | tr -dc A-Za-z0-9 | head -c 32
garciadeblas0bc87522021-10-20 22:16:17 +0200131 [ -z "${DEBUG_INSTALL}" ] || DEBUG end of function
calvinosanc10c82da02020-08-17 11:45:15 +0200132}
133
beierlm2ce2b002021-12-07 16:02:22 -0500134function check_packages() {
135 NEEDED_PACKAGES="$1"
136 echo -e "Checking required packages: ${NEEDED_PACKAGES}"
137 for PACKAGE in ${NEEDED_PACKAGES} ; do
garciadeblas835088e2022-01-28 11:25:18 +0100138 dpkg -L ${PACKAGE}
beierlm2ce2b002021-12-07 16:02:22 -0500139 if [ $? -ne 0 ]; then
garciadeblas835088e2022-01-28 11:25:18 +0100140 echo -e "Package ${PACKAGE} is not installed."
141 echo -e "Updating apt-cache ..."
beierlm2ce2b002021-12-07 16:02:22 -0500142 sudo apt-get update
garciadeblas835088e2022-01-28 11:25:18 +0100143 echo -e "Installing ${PACKAGE} ..."
beierlm2ce2b002021-12-07 16:02:22 -0500144 sudo apt-get install -y ${PACKAGE} || FATAL "failed to install ${PACKAGE}"
145 fi
146 done
147 echo -e "Required packages are present: ${NEEDED_PACKAGES}"
148}
149
garciadeblasd8bc5c32018-05-09 17:37:56 +0200150function ask_user(){
151 # ask to the user and parse a response among 'y', 'yes', 'n' or 'no'. Case insensitive
152 # Params: $1 text to ask; $2 Action by default, can be 'y' for yes, 'n' for no, other or empty for not allowed
153 # Return: true(0) if user type 'yes'; false (1) if user type 'no'
garciadeblas0bc87522021-10-20 22:16:17 +0200154 [ -z "${DEBUG_INSTALL}" ] || DEBUG beginning of function
garciadeblasd8bc5c32018-05-09 17:37:56 +0200155 read -e -p "$1" USER_CONFIRMATION
156 while true ; do
157 [ -z "$USER_CONFIRMATION" ] && [ "$2" == 'y' ] && return 0
158 [ -z "$USER_CONFIRMATION" ] && [ "$2" == 'n' ] && return 1
159 [ "${USER_CONFIRMATION,,}" == "yes" ] || [ "${USER_CONFIRMATION,,}" == "y" ] && return 0
160 [ "${USER_CONFIRMATION,,}" == "no" ] || [ "${USER_CONFIRMATION,,}" == "n" ] && return 1
161 read -e -p "Please type 'yes' or 'no': " USER_CONFIRMATION
162 done
garciadeblas0bc87522021-10-20 22:16:17 +0200163 [ -z "${DEBUG_INSTALL}" ] || DEBUG end of function
garciadeblasd8bc5c32018-05-09 17:37:56 +0200164}
165
garciadeblasd8bc5c32018-05-09 17:37:56 +0200166function install_osmclient(){
garciadeblas0bc87522021-10-20 22:16:17 +0200167 [ -z "${DEBUG_INSTALL}" ] || DEBUG beginning of function
garciadeblasd8bc5c32018-05-09 17:37:56 +0200168 CLIENT_RELEASE=${RELEASE#"-R "}
169 CLIENT_REPOSITORY_KEY="OSM%20ETSI%20Release%20Key.gpg"
170 CLIENT_REPOSITORY=${REPOSITORY#"-r "}
garciadeblasd8bc5c32018-05-09 17:37:56 +0200171 CLIENT_REPOSITORY_BASE=${REPOSITORY_BASE#"-u "}
172 key_location=$CLIENT_REPOSITORY_BASE/$CLIENT_RELEASE/$CLIENT_REPOSITORY_KEY
garciadeblas0bc87522021-10-20 22:16:17 +0200173 curl $key_location | sudo APT_KEY_DONT_WARN_ON_DANGEROUS_USAGE=1 apt-key add -
garciadeblas078f5982019-11-27 15:06:06 +0100174 sudo add-apt-repository -y "deb [arch=amd64] $CLIENT_REPOSITORY_BASE/$CLIENT_RELEASE $CLIENT_REPOSITORY osmclient IM"
garciadeblas80b2e172023-06-01 18:38:13 +0200175 sudo apt-get -y update
176 sudo DEBIAN_FRONTEND=noninteractive apt-get install -y python3-pip
garciadeblas078f5982019-11-27 15:06:06 +0100177 sudo -H LC_ALL=C python3 -m pip install -U pip
garciadeblas80b2e172023-06-01 18:38:13 +0200178 sudo DEBIAN_FRONTEND=noninteractive apt-get install -y python3-osm-im python3-osmclient
beierlm920d7562021-04-21 05:13:53 -0400179 if [ -f /usr/lib/python3/dist-packages/osm_im/requirements.txt ]; then
beierlm021b3072021-04-27 14:33:24 -0400180 python3 -m pip install -r /usr/lib/python3/dist-packages/osm_im/requirements.txt
beierlm920d7562021-04-21 05:13:53 -0400181 fi
182 if [ -f /usr/lib/python3/dist-packages/osmclient/requirements.txt ]; then
garciadeblas357a3c22023-06-26 09:10:11 +0200183 sudo DEBIAN_FRONTEND=noninteractive apt-get install -y libmagic1
beierlm021b3072021-04-27 14:33:24 -0400184 python3 -m pip install -r /usr/lib/python3/dist-packages/osmclient/requirements.txt
beierlm920d7562021-04-21 05:13:53 -0400185 fi
garciadeblasd8bc5c32018-05-09 17:37:56 +0200186 echo -e "\nOSM client installed"
garciadeblase3a84a52024-09-27 11:34:55 +0200187 echo "You can get the OSM NBI endpoint using the following command"
188 echo ' kubectl -n osm get ingress nbi-ingress -o jsonpath="{.spec.rules[0].host}"'
189 echo "You will have to configure this env variable in your .bashrc file:"
190 echo " export OSM_HOSTNAME=nbi.${OSM_K8S_EXTERNAL_IP}.nip.io"
garciadeblas0bc87522021-10-20 22:16:17 +0200191 [ -z "${DEBUG_INSTALL}" ] || DEBUG end of function
garciadeblasd8bc5c32018-05-09 17:37:56 +0200192 return 0
193}
194
garciadeblas453d4582020-12-16 19:03:10 +0100195function docker_login() {
garciadeblas0bc87522021-10-20 22:16:17 +0200196 [ -z "${DEBUG_INSTALL}" ] || DEBUG beginning of function
garciadeblas453d4582020-12-16 19:03:10 +0100197 echo "Docker login"
garciadeblas0bc87522021-10-20 22:16:17 +0200198 [ -z "${DEBUG_INSTALL}" ] || DEBUG "Docker registry user: ${DOCKER_REGISTRY_USER}"
199 sg docker -c "docker login -u ${DOCKER_REGISTRY_USER} -p ${DOCKER_REGISTRY_PASSWORD} --password-stdin"
200 [ -z "${DEBUG_INSTALL}" ] || DEBUG end of function
garciadeblas453d4582020-12-16 19:03:10 +0100201}
202
garciadeblasf6ed60c2020-07-08 14:30:29 +0000203#deploys osm pods and services
garciadeblas9bae86f2024-05-31 17:15:18 +0200204function deploy_osm_helm_chart() {
garciadeblas0bc87522021-10-20 22:16:17 +0200205 [ -z "${DEBUG_INSTALL}" ] || DEBUG beginning of function
garciadeblas8080e4b2023-04-14 09:57:17 +0200206 # Generate helm values to be passed with -f osm-values.yaml
207 sudo mkdir -p ${OSM_HELM_WORK_DIR}
garciadeblas8375da12023-10-10 10:52:29 +0200208 if [ -n "${INSTALL_JUJU}" ]; then
209 sudo bash -c "cat << EOF > ${OSM_HELM_WORK_DIR}/osm-values.yaml
garciadeblas8080e4b2023-04-14 09:57:17 +0200210vca:
211 pubkey: \"${OSM_VCA_PUBKEY}\"
212EOF"
garciadeblas8375da12023-10-10 10:52:29 +0200213 fi
garciadeblas8080e4b2023-04-14 09:57:17 +0200214
215 # Generate helm values to be passed with --set
216 OSM_HELM_OPTS=""
217 # OSM_HELM_OPTS="${OSM_HELM_OPTS} --set nbi.useOsmSecret=false"
garciadeblase6d45882024-05-22 15:03:00 +0200218
219 OSM_HELM_OPTS="${OSM_HELM_OPTS} --set global.image.repositoryBase=${DOCKER_REGISTRY_URL}${DOCKER_USER}"
220 [ ! "$OSM_DOCKER_TAG" == "testing-daily" ] && OSM_HELM_OPTS="${OSM_HELM_OPTS} --set-string global.image.tag=${OSM_DOCKER_TAG}"
221 [ ! "$OSM_DOCKER_TAG" == "testing-daily" ] && OSM_HELM_OPTS="${OSM_HELM_OPTS} --set prometheus.server.sidecarContainers.prometheus-config-sidecar.image=${DOCKER_REGISTRY_URL}${DOCKER_USER}/prometheus:${OSM_DOCKER_TAG}"
222
garciadeblase3a84a52024-09-27 11:34:55 +0200223 OSM_HELM_OPTS="${OSM_HELM_OPTS} --set global.hostname=${OSM_K8S_EXTERNAL_IP}.nip.io"
224 OSM_HELM_OPTS="${OSM_HELM_OPTS} --set grafana.ingress.hosts={grafana.${OSM_K8S_EXTERNAL_IP}.nip.io}"
225 OSM_HELM_OPTS="${OSM_HELM_OPTS} --set prometheus.server.ingress.hosts={prometheus.${OSM_K8S_EXTERNAL_IP}.nip.io}"
226 # OSM_HELM_OPTS="${OSM_HELM_OPTS} --set prometheus.alertmanager.ingress.hosts={alertmanager.${OSM_K8S_EXTERNAL_IP}.nip.io}"
garciadeblas1f6e09a2024-09-10 18:50:29 +0200227 if [ -z "${INSTALL_MGMT_CLUSTER}" ]; then
228 OSM_HELM_OPTS="${OSM_HELM_OPTS} --set global.gitops.enabled=false"
229 else
230 source "${HOME}/.osm/.credentials/gitea_environment.rc"
231 OSM_HELM_OPTS="${OSM_HELM_OPTS} --set global.gitops.gitBaseUrl=${GITEA_HTTP_URL}"
232 OSM_HELM_OPTS="${OSM_HELM_OPTS} --set global.gitops.gitUser=${GITEA_STD_USERNAME}"
233 AGE_MGMT_PUBKEY=$(tr -d '\n' < ${HOME}/.osm/.credentials/age.mgmt.pub)
234 OSM_HELM_OPTS="${OSM_HELM_OPTS} --set global.gitops.pubkey=${AGE_MGMT_PUBKEY}"
235 fi
garciadeblas18582e92024-05-21 12:13:50 +0200236
garciadeblas8375da12023-10-10 10:52:29 +0200237 if [ -n "${INSTALL_JUJU}" ]; then
238 OSM_HELM_OPTS="${OSM_HELM_OPTS} --set vca.enabled=true"
239 OSM_HELM_OPTS="${OSM_HELM_OPTS} --set vca.host=${OSM_VCA_HOST}"
240 OSM_HELM_OPTS="${OSM_HELM_OPTS} --set vca.secret=${OSM_VCA_SECRET}"
241 OSM_HELM_OPTS="${OSM_HELM_OPTS} --set vca.cacert=${OSM_VCA_CACERT}"
242 fi
garciadeblas8080e4b2023-04-14 09:57:17 +0200243 [ -n "$OSM_VCA_APIPROXY" ] && OSM_HELM_OPTS="${OSM_HELM_OPTS} --set lcm.config.OSMLCM_VCA_APIPROXY=${OSM_VCA_APIPROXY}"
garciadeblas18582e92024-05-21 12:13:50 +0200244
khelifi81a1a222025-04-28 09:35:51 +0100245 OSM_HELM_OPTS="${OSM_HELM_OPTS} --set airflow.defaultAirflowRepository=${DOCKER_REGISTRY_URL}${DOCKER_USER}/airflow"
246 [ ! "$OSM_DOCKER_TAG" == "testing-daily" ] && OSM_HELM_OPTS="${OSM_HELM_OPTS} --set-string airflow.defaultAirflowTag=${OSM_DOCKER_TAG}"
247 OSM_HELM_OPTS="${OSM_HELM_OPTS} --set airflow.ingress.web.hosts[0].name=airflow.${OSM_K8S_EXTERNAL_IP}.nip.io"
248
garciadeblas555702a2023-05-31 23:47:01 +0200249 if [ -n "${OSM_BEHIND_PROXY}" ]; then
250 OSM_HELM_OPTS="${OSM_HELM_OPTS} --set global.behindHttpProxy=true"
garciadeblas8c2b2642023-11-02 07:56:50 +0100251 [ -n "${HTTP_PROXY}" ] && OSM_HELM_OPTS="${OSM_HELM_OPTS} --set global.httpProxy.HTTP_PROXY=\"${HTTP_PROXY}\""
252 [ -n "${HTTPS_PROXY}" ] && OSM_HELM_OPTS="${OSM_HELM_OPTS} --set global.httpProxy.HTTPS_PROXY=\"${HTTPS_PROXY}\""
253 if [ -n "${NO_PROXY}" ]; then
254 if [[ ! "${NO_PROXY}" =~ .*".svc".* ]]; then
255 NO_PROXY="${NO_PROXY},.svc"
256 fi
257 if [[ ! "${NO_PROXY}" =~ .*".cluster.local".* ]]; then
258 NO_PROXY="${NO_PROXY},.cluster.local"
259 fi
260 OSM_HELM_OPTS="${OSM_HELM_OPTS} --set global.httpProxy.NO_PROXY=\"${NO_PROXY//,/\,}\""
261 fi
garciadeblas555702a2023-05-31 23:47:01 +0200262 fi
garciadeblas8080e4b2023-04-14 09:57:17 +0200263
garciadeblas8375da12023-10-10 10:52:29 +0200264 if [ -n "${INSTALL_JUJU}" ]; then
265 OSM_HELM_OPTS="-f ${OSM_HELM_WORK_DIR}/osm-values.yaml ${OSM_HELM_OPTS}"
266 fi
garciadeblase6d45882024-05-22 15:03:00 +0200267 echo "helm upgrade --install -n $OSM_NAMESPACE --create-namespace $OSM_NAMESPACE $OSM_DEVOPS/installers/helm/osm ${OSM_HELM_OPTS}"
268 helm upgrade --install -n $OSM_NAMESPACE --create-namespace $OSM_NAMESPACE $OSM_DEVOPS/installers/helm/osm ${OSM_HELM_OPTS}
garciadeblas8080e4b2023-04-14 09:57:17 +0200269 # Override existing values.yaml with the final values.yaml used to install OSM
270 helm -n $OSM_NAMESPACE get values $OSM_NAMESPACE | sudo tee -a ${OSM_HELM_WORK_DIR}/osm-values.yaml
garciadeblas0bc87522021-10-20 22:16:17 +0200271 [ -z "${DEBUG_INSTALL}" ] || DEBUG end of function
vijaynag8339ed22019-07-25 17:10:58 +0530272}
273
garciadeblase92a18d2020-07-03 16:24:23 +0000274function add_local_k8scluster() {
garciadeblas0bc87522021-10-20 22:16:17 +0200275 [ -z "${DEBUG_INSTALL}" ] || DEBUG beginning of function
garciadeblas18582e92024-05-21 12:13:50 +0200276 # OSM_HOSTNAME=$(kubectl get --namespace osm -o jsonpath="{.spec.rules[0].host}" ingress nbi-ingress)
garciadeblase3a84a52024-09-27 11:34:55 +0200277 OSM_HOSTNAME="nbi.${OSM_K8S_EXTERNAL_IP}.nip.io:443"
garciadeblas18582e92024-05-21 12:13:50 +0200278 /usr/bin/osm --hostname ${OSM_HOSTNAME} --all-projects vim-create \
garciadeblase92a18d2020-07-03 16:24:23 +0000279 --name _system-osm-vim \
280 --account_type dummy \
281 --auth_url http://dummy \
282 --user osm --password osm --tenant osm \
283 --description "dummy" \
284 --config '{management_network_name: mgmt}'
garciadeblas18582e92024-05-21 12:13:50 +0200285 /usr/bin/osm --hostname ${OSM_HOSTNAME} --all-projects k8scluster-add \
garciadeblase92a18d2020-07-03 16:24:23 +0000286 --creds ${HOME}/.kube/config \
287 --vim _system-osm-vim \
288 --k8s-nets '{"net1": null}' \
garciadeblas18582e92024-05-21 12:13:50 +0200289 --version '1.29' \
garciadeblase92a18d2020-07-03 16:24:23 +0000290 --description "OSM Internal Cluster" \
291 _system-osm-k8s
garciadeblas0bc87522021-10-20 22:16:17 +0200292 [ -z "${DEBUG_INSTALL}" ] || DEBUG end of function
garciadeblase92a18d2020-07-03 16:24:23 +0000293}
294
garciadeblas0bc87522021-10-20 22:16:17 +0200295function configure_apt_proxy() {
296 [ -z "${DEBUG_INSTALL}" ] || DEBUG beginning of function
297 OSM_APT_PROXY=$1
298 OSM_APT_PROXY_FILE="/etc/apt/apt.conf.d/osm-apt"
299 echo "Configuring apt proxy in file ${OSM_APT_PROXY_FILE}"
300 if [ ! -f ${OSM_APT_PROXY_FILE} ]; then
301 sudo bash -c "cat <<EOF > ${OSM_APT_PROXY}
302Acquire::http { Proxy \"${OSM_APT_PROXY}\"; }
303EOF"
304 else
305 sudo sed -i "s|Proxy.*|Proxy \"${OSM_APT_PROXY}\"; }|" ${OSM_APT_PROXY_FILE}
306 fi
307 sudo apt-get update || FATAL "Configured apt proxy, but couldn't run 'apt-get update'. Check ${OSM_APT_PROXY_FILE}"
garciadeblas4d89c372021-11-25 11:57:18 +0100308 track prereq apt_proxy_configured_ok
garciadeblas0bc87522021-10-20 22:16:17 +0200309 [ -z "${DEBUG_INSTALL}" ] || DEBUG end of function
310}
311
garciadeblasfa3eb332022-11-15 14:11:56 +0100312function ask_proceed() {
garciadeblas0bc87522021-10-20 22:16:17 +0200313 [ -z "${DEBUG_INSTALL}" ] || DEBUG beginning of function
garciadeblasadcf95e2022-01-28 17:15:39 +0100314
garciadeblas0bc87522021-10-20 22:16:17 +0200315 [ -z "$ASSUME_YES" ] && ! ask_user "The installation will do the following
316 1. Install and configure LXD
317 2. Install juju
318 3. Install docker CE
319 4. Disable swap space
320 5. Install and initialize Kubernetes
321 as pre-requirements.
322 Do you want to proceed (Y/n)? " y && echo "Cancelled!" && exit 1
garciadeblasfa3eb332022-11-15 14:11:56 +0100323
324 [ -z "${DEBUG_INSTALL}" ] || DEBUG end of function
325}
326
327function check_osm_behind_proxy() {
328 [ -z "${DEBUG_INSTALL}" ] || DEBUG beginning of function
329
330 export OSM_BEHIND_PROXY=""
331 export OSM_PROXY_ENV_VARIABLES=""
332 [ -n "${http_proxy}" ] && OSM_BEHIND_PROXY="y" && echo "http_proxy=${http_proxy}" && OSM_PROXY_ENV_VARIABLES="${OSM_PROXY_ENV_VARIABLES} http_proxy"
333 [ -n "${https_proxy}" ] && OSM_BEHIND_PROXY="y" && echo "https_proxy=${https_proxy}" && OSM_PROXY_ENV_VARIABLES="${OSM_PROXY_ENV_VARIABLES} https_proxy"
334 [ -n "${HTTP_PROXY}" ] && OSM_BEHIND_PROXY="y" && echo "HTTP_PROXY=${HTTP_PROXY}" && OSM_PROXY_ENV_VARIABLES="${OSM_PROXY_ENV_VARIABLES} HTTP_PROXY"
335 [ -n "${HTTPS_PROXY}" ] && OSM_BEHIND_PROXY="y" && echo "https_proxy=${HTTPS_PROXY}" && OSM_PROXY_ENV_VARIABLES="${OSM_PROXY_ENV_VARIABLES} HTTPS_PROXY"
336 [ -n "${no_proxy}" ] && echo "no_proxy=${no_proxy}" && OSM_PROXY_ENV_VARIABLES="${OSM_PROXY_ENV_VARIABLES} no_proxy"
337 [ -n "${NO_PROXY}" ] && echo "NO_PROXY=${NO_PROXY}" && OSM_PROXY_ENV_VARIABLES="${OSM_PROXY_ENV_VARIABLES} NO_PROXY"
338
339 echo "OSM_BEHIND_PROXY=${OSM_BEHIND_PROXY}"
340 echo "OSM_PROXY_ENV_VARIABLES=${OSM_PROXY_ENV_VARIABLES}"
341
342 if [ -n "${OSM_BEHIND_PROXY}" ]; then
343 [ -z "$ASSUME_YES" ] && ! ask_user "
344The following env variables have been found for the current user:
345${OSM_PROXY_ENV_VARIABLES}.
346
347This suggests that this machine is behind a proxy and a special configuration is required.
348The installer will install Docker CE, LXD and Juju to work behind a proxy using those
349env variables.
350
351Take into account that the installer uses apt, curl, wget, docker, lxd, juju and snap.
352Depending on the program, the env variables to work behind a proxy might be different
353(e.g. http_proxy vs HTTP_PROXY).
354
355For that reason, it is strongly recommended that at least http_proxy, https_proxy, HTTP_PROXY
356and HTTPS_PROXY are defined.
357
358Finally, some of the programs (apt, snap) those programs are run as sudoer, requiring that
359those env variables are also set for root user. If you are not sure whether those variables
360are configured for the root user, you can stop the installation now.
361
362Do you want to proceed with the installation (Y/n)? " y && echo "Cancelled!" && exit 1
363 else
364 echo "This machine is not behind a proxy"
365 fi
366
367 [ -z "${DEBUG_INSTALL}" ] || DEBUG end of function
368}
369
370function find_devops_folder() {
garciadeblas9bae86f2024-05-31 17:15:18 +0200371 [ -z "${DEBUG_INSTALL}" ] || DEBUG beginning of function
garciadeblasfa3eb332022-11-15 14:11:56 +0100372 if [ -z "$OSM_DEVOPS" ]; then
373 if [ -n "$TEST_INSTALLER" ]; then
374 echo -e "\nUsing local devops repo for OSM installation"
375 OSM_DEVOPS="$(dirname $(realpath $(dirname $0)))"
376 else
377 echo -e "\nCreating temporary dir for OSM installation"
378 OSM_DEVOPS="$(mktemp -d -q --tmpdir "installosm.XXXXXX")"
379 trap 'rm -rf "$OSM_DEVOPS"' EXIT
380 git clone https://osm.etsi.org/gerrit/osm/devops.git $OSM_DEVOPS
381 fi
382 fi
garciadeblas9bae86f2024-05-31 17:15:18 +0200383 [ -z "${DEBUG_INSTALL}" ] || DEBUG end of function
384}
385
386function install_lxd() {
387 [ -z "${DEBUG_INSTALL}" ] || DEBUG beginning of function
388 LXD_INSTALL_OPTS="-D ${OSM_DEVOPS} -i ${OSM_DEFAULT_IF} ${DEBUG_INSTALL}"
389 [ -n "${OSM_BEHIND_PROXY}" ] && LXD_INSTALL_OPTS="${LXD_INSTALL_OPTS} -P"
390 $OSM_DEVOPS/installers/install_lxd.sh ${LXD_INSTALL_OPTS} || FATAL_TRACK lxd "install_lxd.sh failed"
391 [ -z "${DEBUG_INSTALL}" ] || DEBUG end of function
392}
393
394function install_docker_ce() {
395 [ -z "${DEBUG_INSTALL}" ] || DEBUG beginning of function
396 DOCKER_CE_OPTS="-D ${OSM_DEVOPS} ${DEBUG_INSTALL}"
397 [ -n "${DOCKER_PROXY_URL}" ] && DOCKER_CE_OPTS="${DOCKER_CE_OPTS} -p ${DOCKER_PROXY_URL}"
398 [ -n "${OSM_BEHIND_PROXY}" ] && DOCKER_CE_OPTS="${DOCKER_CE_OPTS} -P"
399 $OSM_DEVOPS/installers/install_docker_ce.sh ${DOCKER_CE_OPTS} || FATAL_TRACK docker_ce "install_docker_ce.sh failed"
400 [ -z "${DEBUG_INSTALL}" ] || DEBUG end of function
401}
402
403function install_k8s_cluster() {
404 [ -z "${DEBUG_INSTALL}" ] || DEBUG beginning of function
405 if [ "${K8S_CLUSTER_ENGINE}" == "kubeadm" ]; then
406 KUBEADM_INSTALL_OPTS="-d ${OSM_WORK_DIR} -D ${OSM_DEVOPS} ${DEBUG_INSTALL}"
407 $OSM_DEVOPS/installers/install_kubeadm_cluster.sh ${KUBEADM_INSTALL_OPTS} || \
408 FATAL_TRACK k8scluster "install_kubeadm_cluster.sh failed"
garciadeblasb3797412024-06-06 14:26:24 +0200409 K8SCLUSTER_ADDONS_INSTALL_OPTS="-i ${OSM_DEFAULT_IP} -d ${OSM_WORK_DIR} -D ${OSM_DEVOPS} ${DEBUG_INSTALL} --all"
garciadeblas9bae86f2024-05-31 17:15:18 +0200410 $OSM_DEVOPS/installers/install_cluster_addons.sh ${K8SCLUSTER_ADDONS_INSTALL_OPTS} || \
garciadeblasb3797412024-06-06 14:26:24 +0200411 FATAL_TRACK k8scluster "install_cluster_addons.sh failed for kubeadm cluster"
412 elif [ "${K8S_CLUSTER_ENGINE}" == "k3s" ]; then
garciadeblas1f338482024-07-04 19:26:54 +0200413 K3S_INSTALL_OPTS="-i ${OSM_DEFAULT_IP} -D ${OSM_DEVOPS} ${DEBUG_INSTALL}"
garciadeblase3a84a52024-09-27 11:34:55 +0200414 [ "${OSM_K8S_EXTERNAL_IP}" != "${OSM_DEFAULT_IP}" ] && K3S_INSTALL_OPTS="${K3S_INSTALL_OPTS} -e ${OSM_K8S_EXTERNAL_IP}"
garciadeblas117fd4a2024-08-21 18:18:14 +0200415 [ -n "${DOCKER_PROXY_URL}" ] && K3S_INSTALL_OPTS="${K3S_INSTALL_OPTS} -p ${DOCKER_PROXY_URL}"
garciadeblas2efb98b2024-08-21 21:19:36 +0200416 [ -n "${DOCKER_REGISTRY_URL}" ] && K3S_INSTALL_OPTS="${K3S_INSTALL_OPTS} -d ${DOCKER_REGISTRY_URL}"
417 [ -n "${DOCKER_REGISTRY_USER}" ] && K3S_INSTALL_OPTS="${K3S_INSTALL_OPTS} -u ${DOCKER_REGISTRY_USER}"
418 [ -n "${DOCKER_REGISTRY_PASSWORD}" ] && K3S_INSTALL_OPTS="${K3S_INSTALL_OPTS} -P ${DOCKER_REGISTRY_PASSWORD}"
garciadeblasb3797412024-06-06 14:26:24 +0200419 # The K3s installation script will automatically take the HTTP_PROXY, HTTPS_PROXY and NO_PROXY,
420 # as well as the CONTAINERD_HTTP_PROXY, CONTAINERD_HTTPS_PROXY and CONTAINERD_NO_PROXY variables
421 # from the shell, if they are present, and write them to the environment file of k3s systemd service,
422 $OSM_DEVOPS/installers/install_k3s_cluster.sh ${K3S_INSTALL_OPTS} || \
423 FATAL_TRACK k8scluster "install_k3s_cluster.sh failed"
424 K8SCLUSTER_ADDONS_INSTALL_OPTS="-i ${OSM_DEFAULT_IP} -d ${OSM_WORK_DIR} -D ${OSM_DEVOPS} ${DEBUG_INSTALL} --certmgr --nginx"
425 $OSM_DEVOPS/installers/install_cluster_addons.sh ${K8SCLUSTER_ADDONS_INSTALL_OPTS} || \
426 FATAL_TRACK k8scluster "install_cluster_addons.sh failed for k3s cluster"
garciadeblas9bae86f2024-05-31 17:15:18 +0200427 fi
garciadeblas58b5ba62024-09-11 14:58:05 +0200428 echo "Updating fsnotify settings of the system kernel"
429 sudo bash -c "sysctl -w fs.inotify.max_user_watches=699050 > /etc/sysctl.d/99-custom-osm-sysctl.conf"
430 sudo bash -c "sysctl -w fs.inotify.max_user_instances=10922 >> /etc/sysctl.d/99-custom-osm-sysctl.conf"
431 sudo bash -c "sysctl -w fs.inotify.max_queued_events=1398101 >> /etc/sysctl.d/99-custom-osm-sysctl.conf"
garciadeblas9bae86f2024-05-31 17:15:18 +0200432 [ -z "${DEBUG_INSTALL}" ] || DEBUG end of function
433}
434
435function deploy_osm() {
garciadeblasb3797412024-06-06 14:26:24 +0200436 [ -z "${DEBUG_INSTALL}" ] || DEBUG beginning of function
garciadeblas9bae86f2024-05-31 17:15:18 +0200437 deploy_osm_helm_chart
garciadeblasc3aa9392025-04-22 14:13:23 +0200438 track deploy_osm deploy_mongodb_ok
garciadeblas9bae86f2024-05-31 17:15:18 +0200439 track deploy_osm deploy_osm_services_k8s_ok
garciadeblascfb60b12025-04-23 17:55:02 +0200440 track deploy_osm install_osm_ngsa_ok
garciadeblasb3797412024-06-06 14:26:24 +0200441 [ -z "${DEBUG_INSTALL}" ] || DEBUG end of function
garciadeblasfa3eb332022-11-15 14:11:56 +0100442}
443
garciadeblasf7a207d2025-01-30 15:54:08 +0100444function setup_external_ip() {
445 echo "Determining IP address of the interface with the default route"
446 [ -z "$OSM_DEFAULT_IF" ] && OSM_DEFAULT_IF=$(ip route list|awk '$1=="default" {print $5; exit}')
447 [ -z "$OSM_DEFAULT_IF" ] && OSM_DEFAULT_IF=$(route -n |awk '$1~/^0.0.0.0/ {print $8; exit}')
448 [ -z "$OSM_DEFAULT_IF" ] && FATAL "Not possible to determine the interface with the default route 0.0.0.0"
449 OSM_DEFAULT_IP=`ip -o -4 a s ${OSM_DEFAULT_IF} |awk '{split($4,a,"/"); print a[1]; exit}'`
450 [ -z "$OSM_DEFAULT_IP" ] && FATAL "Not possible to determine the IP address of the interface with the default route"
451 OSM_K8S_EXTERNAL_IP=${OSM_K8S_EXTERNAL_IP:-${OSM_DEFAULT_IP}}
452}
453
garciadeblasfa3eb332022-11-15 14:11:56 +0100454function install_osm() {
455 [ -z "${DEBUG_INSTALL}" ] || DEBUG beginning of function
456
457 trap ctrl_c INT
458
garciadeblasfa3eb332022-11-15 14:11:56 +0100459 check_osm_behind_proxy
garciadeblasfa3eb332022-11-15 14:11:56 +0100460 check_packages "git wget curl tar snapd"
garciadeblas8375da12023-10-10 10:52:29 +0200461 if [ -n "${INSTALL_JUJU}" ]; then
462 sudo snap install jq || FATAL "Could not install jq (snap package). Make sure that snap works"
463 fi
garciadeblasfa3eb332022-11-15 14:11:56 +0100464 find_devops_folder
465
garciadeblas28d71bd2023-06-07 23:06:50 +0200466 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
garciadeblasfa3eb332022-11-15 14:11:56 +0100467
468 track checks checkingroot_ok
469 [ "$USER" == "root" ] && FATAL "You are running the installer as root. The installer is prepared to be executed as a normal user with sudo privileges."
470 track checks noroot_ok
garciadeblasfa3eb332022-11-15 14:11:56 +0100471 ask_proceed
garciadeblas4d89c372021-11-25 11:57:18 +0100472 track checks proceed_ok
vijaynag8339ed22019-07-25 17:10:58 +0530473
garciadeblas0bc87522021-10-20 22:16:17 +0200474 echo "Installing OSM"
475
garciadeblas28d71bd2023-06-07 23:06:50 +0200476 [ -n "$DOCKER_REGISTRY_URL" ] && parse_docker_registry_url
477
garciadeblasf7a207d2025-01-30 15:54:08 +0100478 echo "Setting up external IP address"
479 setup_external_ip
garciadeblas0bc87522021-10-20 22:16:17 +0200480
481 # configure apt proxy
482 [ -n "$APT_PROXY_URL" ] && configure_apt_proxy $APT_PROXY_URL
Mike Marchettib8420852018-09-13 13:45:06 -0400483
garciadeblas8375da12023-10-10 10:52:29 +0200484 # if lxd is requested, we will install it
garciadeblas9bae86f2024-05-31 17:15:18 +0200485 [ -n "$INSTALL_LXD" ] && install_lxd
David Garcia79f4f532020-04-07 12:59:34 +0200486
garciadeblas4d89c372021-11-25 11:57:18 +0100487 track prereq prereqok_ok
Mike Marchettib8420852018-09-13 13:45:06 -0400488
garciadeblas250b0b62024-01-22 13:30:59 +0100489 if [ -n "$INSTALL_DOCKER" ] || [ "${K8S_CLUSTER_ENGINE}" == "kubeadm" ]; then
garciadeblas9c624882024-04-01 15:01:27 +0200490 if [ "${K8S_CLUSTER_ENGINE}" == "kubeadm" ]; then
491 echo "Kubeadm requires docker, so docker will be installed."
492 fi
garciadeblas9bae86f2024-05-31 17:15:18 +0200493 install_docker_ce
garciadeblas2efb98b2024-08-21 21:19:36 +0200494 [ -n "${DOCKER_REGISTRY_URL}" ] && docker_login
garciadeblas95804f82021-11-08 23:02:01 +0100495 fi
garciadeblas4d89c372021-11-25 11:57:18 +0100496 track docker_ce docker_ce_ok
David Garcia6cbfee12020-10-23 10:40:20 +0200497
garciadeblas8d8cd992024-05-21 16:04:14 +0200498 echo "Installing helm client ..."
garciadeblas9c624882024-04-01 15:01:27 +0200499 $OSM_DEVOPS/installers/install_helm_client.sh -D ${OSM_DEVOPS} ${DEBUG_INSTALL} || \
500 FATAL_TRACK k8scluster "install_helm_client.sh failed"
501 track helm_client install_helm_client_ok
502
garciadeblas8d8cd992024-05-21 16:04:14 +0200503 echo "Installing K8s cluster ..."
garciadeblas9bae86f2024-05-31 17:15:18 +0200504 install_k8s_cluster
garciadeblas8d8cd992024-05-21 16:04:14 +0200505 kubectl create namespace ${OSM_NAMESPACE}
garciadeblas9c624882024-04-01 15:01:27 +0200506 track k8scluster k8scluster_ok
David Garcia6cbfee12020-10-23 10:40:20 +0200507
garciadeblas8375da12023-10-10 10:52:29 +0200508 if [ -n "${INSTALL_JUJU}" ]; then
garciadeblas8d8cd992024-05-21 16:04:14 +0200509 echo "Installing Juju ..."
garciadeblas8375da12023-10-10 10:52:29 +0200510 JUJU_OPTS="-D ${OSM_DEVOPS} -s ${OSM_NAMESPACE} -i ${OSM_DEFAULT_IP} ${DEBUG_INSTALL} ${INSTALL_CACHELXDIMAGES}"
511 [ -n "${OSM_VCA_HOST}" ] && JUJU_OPTS="$JUJU_OPTS -H ${OSM_VCA_HOST}"
512 [ -n "${LXD_CLOUD_FILE}" ] && JUJU_OPTS="$JUJU_OPTS -l ${LXD_CLOUD_FILE}"
513 [ -n "${LXD_CRED_FILE}" ] && JUJU_OPTS="$JUJU_OPTS -L ${LXD_CRED_FILE}"
514 [ -n "${CONTROLLER_NAME}" ] && JUJU_OPTS="$JUJU_OPTS -K ${CONTROLLER_NAME}"
515 [ -n "${OSM_BEHIND_PROXY}" ] && JUJU_OPTS="${JUJU_OPTS} -P"
516 $OSM_DEVOPS/installers/install_juju.sh ${JUJU_OPTS} || FATAL_TRACK juju "install_juju.sh failed"
517 set_vca_variables
518 fi
garciadeblas4d89c372021-11-25 11:57:18 +0100519 track juju juju_ok
Adam Israel5ddc97f2019-09-03 18:11:12 -0400520
garciadeblas9bae86f2024-05-31 17:15:18 +0200521 # This track is maintained for backwards compatibility
garciadeblas4d89c372021-11-25 11:57:18 +0100522 track docker_images docker_images_ok
vijaynag8339ed22019-07-25 17:10:58 +0530523
garciadeblas8d8cd992024-05-21 16:04:14 +0200524 # Install mgmt cluster
525 echo "Installing mgmt cluster ..."
526 MGMTCLUSTER_INSTALL_OPTS="-D ${OSM_DEVOPS} ${DEBUG_INSTALL}"
527 [ -n "${INSTALL_MGMT_CLUSTER}" ] || MGMTCLUSTER_INSTALL_OPTS="${MGMTCLUSTER_INSTALL_OPTS} --no-mgmt-cluster"
528 [ -n "${INSTALL_AUX_CLUSTER}" ] || MGMTCLUSTER_INSTALL_OPTS="${MGMTCLUSTER_INSTALL_OPTS} --no-aux-cluster"
529 export KUBECONFIG_MGMT_CLUSTER=${KUBECONFIG_MGMT_CLUSTER:-"$HOME/.kube/config"}
530 export KUBECONFIG_AUX_CLUSTER=${KUBECONFIG_AUX_CLUSTER:-"$HOME/.kube/config"}
531 MGMTCLUSTER_INSTALL_OPTS="${MGMTCLUSTER_INSTALL_OPTS} -M ${KUBECONFIG_MGMT_CLUSTER}"
532 MGMTCLUSTER_INSTALL_OPTS="${MGMTCLUSTER_INSTALL_OPTS} -G ${KUBECONFIG_AUX_CLUSTER}"
533 echo "Options: ${MGMTCLUSTER_INSTALL_OPTS}"
534 $OSM_DEVOPS/installers/mgmt-cluster/install_mgmt_cluster.sh ${MGMTCLUSTER_INSTALL_OPTS} || \
535 FATAL_TRACK mgmtcluster "install_mgmt_cluster.sh failed"
garciadeblas1f6e09a2024-09-10 18:50:29 +0200536 if [ -n "${INSTALL_MGMT_CLUSTER}" ]; then
537 echo "Credentials stored under ${HOME}/.osm/.credentials"
538 echo "Repos stored under ${HOME}/.osm/repos"
539 fi
garciadeblas8d8cd992024-05-21 16:04:14 +0200540 track mgmtcluster mgmt_and_aux_cluster_ok
541
khelifi81a1a222025-04-28 09:35:51 +0100542 # Deploy OSM (OSM helm chart)
garciadeblas8d8cd992024-05-21 16:04:14 +0200543 echo "Deploying OSM in the K8s cluster ..."
garciadeblas9bae86f2024-05-31 17:15:18 +0200544 deploy_osm
545
garciadeblas0bc87522021-10-20 22:16:17 +0200546 if [ -n "$INSTALL_K8S_MONITOR" ]; then
547 # install OSM MONITORING
548 install_k8s_monitoring
garciadeblas4d89c372021-11-25 11:57:18 +0100549 track deploy_osm install_k8s_monitoring_ok
vijaynag8339ed22019-07-25 17:10:58 +0530550 fi
551
garciadeblas8d8cd992024-05-21 16:04:14 +0200552 [ -z "$INSTALL_NOHOSTCLIENT" ] && echo "Installing osmclient ..." && install_osmclient
garciadeblas4d89c372021-11-25 11:57:18 +0100553 track osmclient osmclient_ok
beierlma4a37f72020-06-26 12:55:01 -0400554
garciadeblas4a9adcd2020-07-03 15:32:05 +0000555 echo -e "Checking OSM health state..."
garciadeblas325032a2023-04-13 18:07:44 +0200556 $OSM_DEVOPS/installers/osm_health.sh -s ${OSM_NAMESPACE} -k || \
garciadeblasf4f0e0f2021-12-03 11:37:40 +0100557 (echo -e "OSM is not healthy, but will probably converge to a healthy state soon." && \
garciadeblas325032a2023-04-13 18:07:44 +0200558 echo -e "Check OSM status with: kubectl -n ${OSM_NAMESPACE} get all" && \
garciadeblasf4f0e0f2021-12-03 11:37:40 +0100559 track healthchecks osm_unhealthy didnotconverge)
garciadeblas4d89c372021-11-25 11:57:18 +0100560 track healthchecks after_healthcheck_ok
vijaynag8339ed22019-07-25 17:10:58 +0530561
garciadeblas8d8cd992024-05-21 16:04:14 +0200562 echo -e "Adding local K8s cluster _system-osm-k8s to OSM ..."
garciadeblas0bc87522021-10-20 22:16:17 +0200563 add_local_k8scluster
garciadeblas4d89c372021-11-25 11:57:18 +0100564 track final_ops add_local_k8scluster_ok
garciadeblase92a18d2020-07-03 16:24:23 +0000565
garciadeblasb4c35932024-01-22 12:56:21 +0100566 # if lxd is requested, iptables firewall is updated to work with both docker and LXD
567 if [ -n "$INSTALL_LXD" ]; then
568 arrange_docker_default_network_policy
569 fi
Gulsum Atici5e263302023-01-30 19:11:31 +0300570
garciadeblasf407c452024-08-22 14:23:40 +0200571 wget -q -O- https://osm-download.etsi.org/ftp/osm-16.0-sixteen/README2.txt &> /dev/null
garciadeblas6c66abf2018-05-16 14:46:19 +0200572 track end
garciadeblas0bc87522021-10-20 22:16:17 +0200573 sudo find /etc/osm
574 [ -z "${DEBUG_INSTALL}" ] || DEBUG end of function
garciadeblasd8bc5c32018-05-09 17:37:56 +0200575 return 0
576}
577
Antonio Marsicof4ce57c2020-04-23 12:06:19 +0200578function install_to_openstack() {
garciadeblas0bc87522021-10-20 22:16:17 +0200579 [ -z "${DEBUG_INSTALL}" ] || DEBUG beginning of function
Antonio Marsicof4ce57c2020-04-23 12:06:19 +0200580
581 if [ -z "$2" ]; then
582 FATAL "OpenStack installer requires a valid external network name"
583 fi
584
585 # Install Pip for Python3
garciadeblas0bc87522021-10-20 22:16:17 +0200586 sudo apt install -y python3-pip python3-venv
587 sudo -H LC_ALL=C python3 -m pip install -U pip
Antonio Marsicof4ce57c2020-04-23 12:06:19 +0200588
Antonio Marsico75a38c72020-12-21 17:29:42 +0100589 # Create a venv to avoid conflicts with the host installation
590 python3 -m venv $OPENSTACK_PYTHON_VENV
591
592 source $OPENSTACK_PYTHON_VENV/bin/activate
593
Antonio Marsicoef3b2362021-03-19 18:54:57 +0100594 # Install Ansible, OpenStack client and SDK, latest openstack version supported is Train
Antonio Marsico75a38c72020-12-21 17:29:42 +0100595 python -m pip install -U wheel
Antonio Marsicoef3b2362021-03-19 18:54:57 +0100596 python -m pip install -U "python-openstackclient<=4.0.2" "openstacksdk>=0.12.0,<=0.36.2" "ansible>=2.10,<2.11"
Antonio Marsico75a38c72020-12-21 17:29:42 +0100597
598 # Install the Openstack cloud module (ansible>=2.10)
599 ansible-galaxy collection install openstack.cloud
Antonio Marsicof4ce57c2020-04-23 12:06:19 +0200600
601 export ANSIBLE_CONFIG="$OSM_DEVOPS/installers/openstack/ansible.cfg"
602
603 OSM_INSTALLER_ARGS="${REPO_ARGS[@]}"
604
Antonio Marsico75a38c72020-12-21 17:29:42 +0100605 ANSIBLE_VARS="external_network_name=$2 setup_volume=$3 server_name=$OPENSTACK_VM_NAME"
606
607 if [ -n "$OPENSTACK_SSH_KEY_FILE" ]; then
608 ANSIBLE_VARS+=" key_file=$OPENSTACK_SSH_KEY_FILE"
609 fi
610
611 if [ -n "$OPENSTACK_USERDATA_FILE" ]; then
612 ANSIBLE_VARS+=" userdata_file=$OPENSTACK_USERDATA_FILE"
613 fi
614
Antonio Marsicof4ce57c2020-04-23 12:06:19 +0200615 # Execute the Ansible playbook based on openrc or clouds.yaml
616 if [ -e "$1" ]; then
617 . $1
Antonio Marsico75a38c72020-12-21 17:29:42 +0100618 ansible-playbook -e installer_args="\"$OSM_INSTALLER_ARGS\"" -e "$ANSIBLE_VARS" \
619 $OSM_DEVOPS/installers/openstack/site.yml
Antonio Marsicof4ce57c2020-04-23 12:06:19 +0200620 else
Antonio Marsico75a38c72020-12-21 17:29:42 +0100621 ansible-playbook -e installer_args="\"$OSM_INSTALLER_ARGS\"" -e "$ANSIBLE_VARS" \
622 -e cloud_name=$1 $OSM_DEVOPS/installers/openstack/site.yml
Antonio Marsicof4ce57c2020-04-23 12:06:19 +0200623 fi
624
Antonio Marsico75a38c72020-12-21 17:29:42 +0100625 # Exit from venv
626 deactivate
627
garciadeblas0bc87522021-10-20 22:16:17 +0200628 [ -z "${DEBUG_INSTALL}" ] || DEBUG end of function
Antonio Marsicof4ce57c2020-04-23 12:06:19 +0200629 return 0
630}
631
Gulsum Atici3d3a7672023-02-01 11:15:52 +0300632function arrange_docker_default_network_policy() {
633 echo -e "Fixing firewall so docker and LXD can share the same host without affecting each other."
634 sudo iptables -I DOCKER-USER -j ACCEPT
635 sudo iptables-save | sudo tee /etc/iptables/rules.v4
636 sudo ip6tables-save | sudo tee /etc/iptables/rules.v6
637}
638
romeromonsere366b1a2019-11-19 19:49:26 +0100639function install_k8s_monitoring() {
garciadeblas0bc87522021-10-20 22:16:17 +0200640 [ -z "${DEBUG_INSTALL}" ] || DEBUG beginning of function
romeromonsere366b1a2019-11-19 19:49:26 +0100641 # install OSM monitoring
garciadeblasb9a84e42024-05-31 15:06:40 +0200642 sudo $OSM_DEVOPS/installers/k8s/install_osm_k8s_monitoring.sh -o ${OSM_NAMESPACE} || FATAL_TRACK install_k8s_monitoring "k8s/install_osm_k8s_monitoring.sh failed"
garciadeblas0bc87522021-10-20 22:16:17 +0200643 [ -z "${DEBUG_INSTALL}" ] || DEBUG end of function
romeromonsere366b1a2019-11-19 19:49:26 +0100644}
645
garciadeblasd8bc5c32018-05-09 17:37:56 +0200646function dump_vars(){
garciadeblas0bc87522021-10-20 22:16:17 +0200647 [ -z "${DEBUG_INSTALL}" ] || DEBUG beginning of function
648 echo "APT_PROXY_URL=$APT_PROXY_URL"
garciadeblas250b0b62024-01-22 13:30:59 +0100649 echo "K8S_CLUSTER_ENGINE=$K8S_CLUSTER_ENGINE"
garciadeblas0bc87522021-10-20 22:16:17 +0200650 echo "DEBUG_INSTALL=$DEBUG_INSTALL"
garciadeblas0bc87522021-10-20 22:16:17 +0200651 echo "DOCKER_PROXY_URL=$DOCKER_PROXY_URL"
652 echo "DOCKER_REGISTRY_URL=$DOCKER_REGISTRY_URL"
653 echo "DOCKER_USER=$DOCKER_USER"
654 echo "INSTALL_CACHELXDIMAGES=$INSTALL_CACHELXDIMAGES"
garciadeblas8375da12023-10-10 10:52:29 +0200655 echo "INSTALL_JUJU=$INSTALL_JUJU"
garciadeblas0bc87522021-10-20 22:16:17 +0200656 echo "INSTALL_K8S_MONITOR=$INSTALL_K8S_MONITOR"
garciadeblas0bc87522021-10-20 22:16:17 +0200657 echo "INSTALL_LXD=$INSTALL_LXD"
garciadeblasf69804b2024-01-22 13:09:21 +0100658 echo "INSTALL_DOCKER=$INSTALL_DOCKER"
garciadeblas6c66abf2018-05-16 14:46:19 +0200659 echo "INSTALL_ONLY=$INSTALL_ONLY"
garciadeblasef3f37c2024-05-31 17:30:48 +0200660 echo "INSTALL_ONLY_DEPLOY_OSM=$INSTALL_ONLY_DEPLOY_OSM"
661 echo "INSTALL_ONLY_DOCKER_CE=$INSTALL_ONLY_DOCKER_CE"
662 echo "INSTALL_ONLY_K8S_CLUSTER=$INSTALL_ONLY_K8S_CLUSTER"
Antonio Marsicof4ce57c2020-04-23 12:06:19 +0200663 echo "INSTALL_TO_OPENSTACK=$INSTALL_TO_OPENSTACK"
garciadeblas0bc87522021-10-20 22:16:17 +0200664 echo "INSTALL_VIMEMU=$INSTALL_VIMEMU"
Antonio Marsicof4ce57c2020-04-23 12:06:19 +0200665 echo "OPENSTACK_PUBLIC_NET_NAME=$OPENSTACK_PUBLIC_NET_NAME"
666 echo "OPENSTACK_OPENRC_FILE_OR_CLOUD=$OPENSTACK_OPENRC_FILE_OR_CLOUD"
667 echo "OPENSTACK_ATTACH_VOLUME=$OPENSTACK_ATTACH_VOLUME"
Antonio Marsico75a38c72020-12-21 17:29:42 +0100668 echo "OPENSTACK_SSH_KEY_FILE"="$OPENSTACK_SSH_KEY_FILE"
669 echo "OPENSTACK_USERDATA_FILE"="$OPENSTACK_USERDATA_FILE"
670 echo "OPENSTACK_VM_NAME"="$OPENSTACK_VM_NAME"
garciadeblas0bc87522021-10-20 22:16:17 +0200671 echo "OSM_DEVOPS=$OSM_DEVOPS"
672 echo "OSM_DOCKER_TAG=$OSM_DOCKER_TAG"
garciadeblase3a84a52024-09-27 11:34:55 +0200673 echo "OSM_K8S_EXTERNAL_IP=$OSM_K8S_EXTERNAL_IP"
garciadeblas7b53d262022-11-04 23:18:48 +0100674 echo "OSM_HELM_WORK_DIR=$OSM_HELM_WORK_DIR"
garciadeblas325032a2023-04-13 18:07:44 +0200675 echo "OSM_NAMESPACE=$OSM_NAMESPACE"
garciadeblas0bc87522021-10-20 22:16:17 +0200676 echo "OSM_VCA_HOST=$OSM_VCA_HOST"
677 echo "OSM_VCA_PUBKEY=$OSM_VCA_PUBKEY"
678 echo "OSM_VCA_SECRET=$OSM_VCA_SECRET"
679 echo "OSM_WORK_DIR=$OSM_WORK_DIR"
680 echo "PULL_IMAGES=$PULL_IMAGES"
681 echo "RECONFIGURE=$RECONFIGURE"
garciadeblasd8bc5c32018-05-09 17:37:56 +0200682 echo "RELEASE=$RELEASE"
683 echo "REPOSITORY=$REPOSITORY"
684 echo "REPOSITORY_BASE=$REPOSITORY_BASE"
685 echo "REPOSITORY_KEY=$REPOSITORY_KEY"
garciadeblasd8bc5c32018-05-09 17:37:56 +0200686 echo "SHOWOPTS=$SHOWOPTS"
garciadeblas0bc87522021-10-20 22:16:17 +0200687 echo "TEST_INSTALLER=$TEST_INSTALLER"
garciadeblas0bc87522021-10-20 22:16:17 +0200688 echo "UNINSTALL=$UNINSTALL"
689 echo "UPDATE=$UPDATE"
garciadeblas0bc87522021-10-20 22:16:17 +0200690 [ -z "${DEBUG_INSTALL}" ] || DEBUG end of function
garciadeblasd8bc5c32018-05-09 17:37:56 +0200691}
692
garciadeblas453d4582020-12-16 19:03:10 +0100693function parse_docker_registry_url() {
garciadeblas0bc87522021-10-20 22:16:17 +0200694 [ -z "${DEBUG_INSTALL}" ] || DEBUG beginning of function
garciadeblas453d4582020-12-16 19:03:10 +0100695 DOCKER_REGISTRY_USER=$(echo "$DOCKER_REGISTRY_URL" | awk '{split($1,a,"@"); split(a[1],b,":"); print b[1]}')
696 DOCKER_REGISTRY_PASSWORD=$(echo "$DOCKER_REGISTRY_URL" | awk '{split($1,a,"@"); split(a[1],b,":"); print b[2]}')
697 DOCKER_REGISTRY_URL=$(echo "$DOCKER_REGISTRY_URL" | awk '{split($1,a,"@"); print a[2]}')
garciadeblas0bc87522021-10-20 22:16:17 +0200698 [ -z "${DEBUG_INSTALL}" ] || DEBUG end of function
garciadeblas453d4582020-12-16 19:03:10 +0100699}
700
garciadeblasadcf95e2022-01-28 17:15:39 +0100701function ctrl_c() {
702 [ -z "${DEBUG_INSTALL}" ] || DEBUG beginning of function
703 echo "** Trapped CTRL-C"
704 FATAL "User stopped the installation"
705 [ -z "${DEBUG_INSTALL}" ] || DEBUG end of function
706}
707
garciadeblasd8bc5c32018-05-09 17:37:56 +0200708UNINSTALL=""
garciadeblasd8bc5c32018-05-09 17:37:56 +0200709UPDATE=""
710RECONFIGURE=""
711TEST_INSTALLER=""
712INSTALL_LXD=""
713SHOWOPTS=""
garciadeblasd8bc5c32018-05-09 17:37:56 +0200714ASSUME_YES=""
garciadeblas0bc87522021-10-20 22:16:17 +0200715APT_PROXY_URL=""
garciadeblasb3797412024-06-06 14:26:24 +0200716K8S_CLUSTER_ENGINE="k3s"
garciadeblas0bc87522021-10-20 22:16:17 +0200717DEBUG_INSTALL=""
garciadeblas18582e92024-05-21 12:13:50 +0200718RELEASE="testing-daily"
719REPOSITORY="testing"
garciadeblasfa3eb332022-11-15 14:11:56 +0100720INSTALL_K8S_MONITOR=""
garciadeblasfa3eb332022-11-15 14:11:56 +0100721INSTALL_VIMEMU=""
garciadeblasd8bc5c32018-05-09 17:37:56 +0200722LXD_REPOSITORY_BASE="https://osm-download.etsi.org/repository/osm/lxd"
723LXD_REPOSITORY_PATH=""
Antonio Marsicof4ce57c2020-04-23 12:06:19 +0200724INSTALL_TO_OPENSTACK=""
725OPENSTACK_OPENRC_FILE_OR_CLOUD=""
726OPENSTACK_PUBLIC_NET_NAME=""
727OPENSTACK_ATTACH_VOLUME="false"
Antonio Marsico75a38c72020-12-21 17:29:42 +0100728OPENSTACK_SSH_KEY_FILE=""
729OPENSTACK_USERDATA_FILE=""
730OPENSTACK_VM_NAME="server-osm"
731OPENSTACK_PYTHON_VENV="$HOME/.virtual-envs/osm"
garciadeblas6c66abf2018-05-16 14:46:19 +0200732INSTALL_ONLY=""
garciadeblasef3f37c2024-05-31 17:30:48 +0200733INSTALL_ONLY_DEPLOY_OSM=""
734INSTALL_ONLY_DOCKER_CE=""
735INSTALL_ONLY_K8S_CLUSTER=""
garciadeblasb7166812024-01-22 13:16:26 +0100736INSTALL_DOCKER=""
garciadeblas8375da12023-10-10 10:52:29 +0200737INSTALL_JUJU=""
garciadeblas0d45bc82018-11-19 14:25:13 +0100738INSTALL_NOHOSTCLIENT=""
garciadeblas0bc87522021-10-20 22:16:17 +0200739INSTALL_CACHELXDIMAGES=""
garciadeblas8d8cd992024-05-21 16:04:14 +0200740INSTALL_AUX_CLUSTER="y"
741INSTALL_MGMT_CLUSTER="y"
garciadeblasd8bc5c32018-05-09 17:37:56 +0200742OSM_DEVOPS=
lavadoe07b1642018-10-25 10:58:34 -0500743OSM_VCA_HOST=
744OSM_VCA_SECRET=
garciadeblasaa3ddf42019-04-04 19:04:32 +0200745OSM_VCA_PUBKEY=
David Garcia79f4f532020-04-07 12:59:34 +0200746OSM_VCA_CLOUDNAME="localhost"
beierlma4a37f72020-06-26 12:55:01 -0400747OSM_VCA_K8S_CLOUDNAME="k8scloud"
garciadeblas325032a2023-04-13 18:07:44 +0200748OSM_NAMESPACE=osm
Mike Marchettib8420852018-09-13 13:45:06 -0400749REPOSITORY_KEY="OSM%20ETSI%20Release%20Key.gpg"
garciadeblas870e60a2018-11-21 16:44:21 +0100750REPOSITORY_BASE="https://osm-download.etsi.org/repository/osm/debian"
Mike Marchettib8420852018-09-13 13:45:06 -0400751OSM_WORK_DIR="/etc/osm"
garciadeblas7b53d262022-11-04 23:18:48 +0100752OSM_HELM_WORK_DIR="${OSM_WORK_DIR}/helm"
vijaynag8339ed22019-07-25 17:10:58 +0530753OSM_HOST_VOL="/var/lib/osm"
garciadeblas325032a2023-04-13 18:07:44 +0200754OSM_NAMESPACE_VOL="${OSM_HOST_VOL}/${OSM_NAMESPACE}"
garciadeblas931a5122023-10-03 17:52:02 +0200755OSM_DOCKER_TAG="testing-daily"
garciadeblas0d45bc82018-11-19 14:25:13 +0100756DOCKER_USER=opensourcemano
757PULL_IMAGES="y"
Benjamin Diazaa0af712018-10-04 14:02:34 -0300758KAFKA_TAG=2.11-1.0.2
garciadeblas0ab16612022-02-22 14:23:57 +0100759KIWIGRID_K8S_SIDECAR_TAG="1.15.6"
760PROMETHEUS_TAG=v2.28.1
761GRAFANA_TAG=8.1.1
lavado6ad812e2019-11-29 10:58:58 -0500762PROMETHEUS_NODE_EXPORTER_TAG=0.18.1
763PROMETHEUS_CADVISOR_TAG=latest
lavado9a8df7c2018-10-24 09:35:34 -0500764KEYSTONEDB_TAG=10
Benjamin Diazba2cca92018-11-08 21:07:15 -0300765OSM_DATABASE_COMMONKEY=
lavado53eb8f52018-11-16 12:58:23 -0500766ELASTIC_VERSION=6.4.2
lavado4e8662c2018-11-28 11:28:14 -0500767ELASTIC_CURATOR_VERSION=5.5.4
vijaynag8339ed22019-07-25 17:10:58 +0530768POD_NETWORK_CIDR=10.244.0.0/16
769K8S_MANIFEST_DIR="/etc/kubernetes/manifests"
770RE_CHECK='^[a-z0-9]([-a-z0-9]*[a-z0-9])?$'
garciadeblas7f1e1042020-11-30 14:07:03 +0000771DOCKER_REGISTRY_URL=
772DOCKER_PROXY_URL=
773MODULE_DOCKER_TAG=
garciadeblas4d89c372021-11-25 11:57:18 +0100774OSM_INSTALLATION_TYPE="Default"
garciadeblasd8bc5c32018-05-09 17:37:56 +0200775
garciadeblase3a84a52024-09-27 11:34:55 +0200776while getopts ":a:c:e:r:n:k:u:R:D:o:O:N:H:S:s:t:U:P:A:l:L:K:d:p:T:f:F:G:M:-: hy" o; do
garciadeblasd8bc5c32018-05-09 17:37:56 +0200777 case "${o}" in
garciadeblas0bc87522021-10-20 22:16:17 +0200778 a)
779 APT_PROXY_URL=${OPTARG}
780 ;;
garciadeblas250b0b62024-01-22 13:30:59 +0100781 c)
782 K8S_CLUSTER_ENGINE=${OPTARG}
783 [ "${K8S_CLUSTER_ENGINE}" == "kubeadm" ] && continue
784 [ "${K8S_CLUSTER_ENGINE}" == "k3s" ] && continue
garciadeblas250b0b62024-01-22 13:30:59 +0100785 echo -e "Invalid argument for -c : ' ${K8S_CLUSTER_ENGINE}'\n" >&2
786 usage && exit 1
787 ;;
garciadeblase3a84a52024-09-27 11:34:55 +0200788 e)
789 OSM_K8S_EXTERNAL_IP="${OPTARG}"
790 ;;
garciadeblasd8bc5c32018-05-09 17:37:56 +0200791 r)
Mike Marchettib8420852018-09-13 13:45:06 -0400792 REPOSITORY="${OPTARG}"
793 REPO_ARGS+=(-r "$REPOSITORY")
garciadeblasd8bc5c32018-05-09 17:37:56 +0200794 ;;
garciadeblasd8bc5c32018-05-09 17:37:56 +0200795 k)
Mike Marchettib8420852018-09-13 13:45:06 -0400796 REPOSITORY_KEY="${OPTARG}"
797 REPO_ARGS+=(-k "$REPOSITORY_KEY")
garciadeblasd8bc5c32018-05-09 17:37:56 +0200798 ;;
799 u)
Mike Marchettib8420852018-09-13 13:45:06 -0400800 REPOSITORY_BASE="${OPTARG}"
801 REPO_ARGS+=(-u "$REPOSITORY_BASE")
garciadeblasd8bc5c32018-05-09 17:37:56 +0200802 ;;
garciadeblas25e87d22020-01-31 14:27:29 +0100803 R)
804 RELEASE="${OPTARG}"
805 REPO_ARGS+=(-R "$RELEASE")
garciadeblas0d45bc82018-11-19 14:25:13 +0100806 ;;
garciadeblasd8bc5c32018-05-09 17:37:56 +0200807 D)
808 OSM_DEVOPS="${OPTARG}"
809 ;;
garciadeblas6c66abf2018-05-16 14:46:19 +0200810 o)
811 INSTALL_ONLY="y"
garciadeblasb5a630f2020-03-05 18:32:16 +0000812 [ "${OPTARG}" == "k8s_monitor" ] && INSTALL_K8S_MONITOR="y" && continue
garciadeblasef3f37c2024-05-31 17:30:48 +0200813 [ "${OPTARG}" == "docker" ] && INSTALL_ONLY_DOCKER_CE="y" && continue
814 [ "${OPTARG}" == "k8scluster" ] && INSTALL_ONLY_K8S_CLUSTER="y" && continue
815 [ "${OPTARG}" == "deploy-osm" ] && INSTALL_ONLY_DEPLOY_OSM="y" && continue
garciadeblas6c66abf2018-05-16 14:46:19 +0200816 ;;
Antonio Marsicof4ce57c2020-04-23 12:06:19 +0200817 O)
818 INSTALL_TO_OPENSTACK="y"
819 if [ -n "${OPTARG}" ]; then
820 OPENSTACK_OPENRC_FILE_OR_CLOUD="${OPTARG}"
821 else
822 echo -e "Invalid argument for -O : ' $OPTARG'\n" >&2
823 usage && exit 1
824 fi
825 ;;
Antonio Marsico75a38c72020-12-21 17:29:42 +0100826 f)
827 OPENSTACK_SSH_KEY_FILE="${OPTARG}"
828 ;;
829 F)
830 OPENSTACK_USERDATA_FILE="${OPTARG}"
831 ;;
Antonio Marsicof4ce57c2020-04-23 12:06:19 +0200832 N)
833 OPENSTACK_PUBLIC_NET_NAME="${OPTARG}"
834 ;;
garciadeblas25e87d22020-01-31 14:27:29 +0100835 H)
836 OSM_VCA_HOST="${OPTARG}"
837 ;;
838 S)
839 OSM_VCA_SECRET="${OPTARG}"
840 ;;
841 s)
garciadeblas325032a2023-04-13 18:07:44 +0200842 OSM_NAMESPACE="${OPTARG}" && [[ ! "${OPTARG}" =~ $RE_CHECK ]] && echo "Namespace $OPTARG is invalid. Regex used for validation is $RE_CHECK" && exit 0
garciadeblas25e87d22020-01-31 14:27:29 +0100843 ;;
844 t)
845 OSM_DOCKER_TAG="${OPTARG}"
Antonio Marsicof4ce57c2020-04-23 12:06:19 +0200846 REPO_ARGS+=(-t "$OSM_DOCKER_TAG")
garciadeblas25e87d22020-01-31 14:27:29 +0100847 ;;
848 U)
849 DOCKER_USER="${OPTARG}"
850 ;;
851 P)
852 OSM_VCA_PUBKEY=$(cat ${OPTARG})
853 ;;
854 A)
855 OSM_VCA_APIPROXY="${OPTARG}"
856 ;;
David Garcia79f4f532020-04-07 12:59:34 +0200857 l)
858 LXD_CLOUD_FILE="${OPTARG}"
859 ;;
860 L)
861 LXD_CRED_FILE="${OPTARG}"
862 ;;
David Garcia404ae122020-04-28 11:47:55 +0200863 K)
864 CONTROLLER_NAME="${OPTARG}"
865 ;;
garciadeblas7f1e1042020-11-30 14:07:03 +0000866 d)
867 DOCKER_REGISTRY_URL="${OPTARG}"
868 ;;
869 p)
870 DOCKER_PROXY_URL="${OPTARG}"
871 ;;
872 T)
873 MODULE_DOCKER_TAG="${OPTARG}"
874 ;;
garciadeblas8d8cd992024-05-21 16:04:14 +0200875 M)
876 KUBECONFIG_MGMT_CLUSTER="${OPTARG}"
877 ;;
878 G)
879 KUBECONFIG_AUX_CLUSTER="${OPTARG}"
880 ;;
garciadeblasd8bc5c32018-05-09 17:37:56 +0200881 -)
882 [ "${OPTARG}" == "help" ] && usage && exit 0
garciadeblas0bc87522021-10-20 22:16:17 +0200883 [ "${OPTARG}" == "debug" ] && DEBUG_INSTALL="--debug" && continue
garciadeblasd8bc5c32018-05-09 17:37:56 +0200884 [ "${OPTARG}" == "uninstall" ] && UNINSTALL="y" && continue
garciadeblas8d8cd992024-05-21 16:04:14 +0200885 [ "${OPTARG}" == "no-mgmt-cluster" ] && INSTALL_MGMT_CLUSTER="" && continue
886 [ "${OPTARG}" == "no-aux-cluster" ] && INSTALL_AUX_CLUSTER="" && continue
garciadeblasd8bc5c32018-05-09 17:37:56 +0200887 [ "${OPTARG}" == "update" ] && UPDATE="y" && continue
888 [ "${OPTARG}" == "reconfigure" ] && RECONFIGURE="y" && continue
889 [ "${OPTARG}" == "test" ] && TEST_INSTALLER="y" && continue
890 [ "${OPTARG}" == "lxdinstall" ] && INSTALL_LXD="y" && continue
garciadeblas8375da12023-10-10 10:52:29 +0200891 [ "${OPTARG}" == "lxd" ] && INSTALL_LXD="y" && continue
892 [ "${OPTARG}" == "nolxd" ] && INSTALL_LXD="" && continue
garciadeblasf69804b2024-01-22 13:09:21 +0100893 [ "${OPTARG}" == "docker" ] && INSTALL_DOCKER="y" && continue
894 [ "${OPTARG}" == "nodocker" ] && INSTALL_DOCKER="" && continue
garciadeblasd8bc5c32018-05-09 17:37:56 +0200895 [ "${OPTARG}" == "showopts" ] && SHOWOPTS="y" && continue
garciadeblas8375da12023-10-10 10:52:29 +0200896 [ "${OPTARG}" == "juju" ] && INSTALL_JUJU="y" && continue
897 [ "${OPTARG}" == "nojuju" ] && INSTALL_JUJU="" && continue
Mike Marchettib8420852018-09-13 13:45:06 -0400898 [ "${OPTARG}" == "nohostclient" ] && INSTALL_NOHOSTCLIENT="y" && continue
garciadeblasb5a630f2020-03-05 18:32:16 +0000899 [ "${OPTARG}" == "k8s_monitor" ] && INSTALL_K8S_MONITOR="y" && continue
garciadeblas4d89c372021-11-25 11:57:18 +0100900 [ "${OPTARG}" == "charmed" ] && CHARMED="y" && OSM_INSTALLATION_TYPE="Charmed" && continue
Dominik Fleischmann5e4a7512020-03-06 14:05:06 +0100901 [ "${OPTARG}" == "bundle" ] && continue
Dominik Fleischmann7a97a4c2020-06-04 10:52:05 +0200902 [ "${OPTARG}" == "k8s" ] && continue
Dominik Fleischmann7a97a4c2020-06-04 10:52:05 +0200903 [ "${OPTARG}" == "lxd-cred" ] && continue
Dominik Fleischmann5e4a7512020-03-06 14:05:06 +0100904 [ "${OPTARG}" == "microstack" ] && continue
David Garcia4bd2bf02021-05-05 19:01:43 +0200905 [ "${OPTARG}" == "overlay" ] && continue
David Garcia1bc71022021-05-03 18:27:18 +0200906 [ "${OPTARG}" == "only-vca" ] && continue
aticig5d19ac22022-05-06 13:46:22 +0300907 [ "${OPTARG}" == "small-profile" ] && continue
Dominik Fleischmannc63bed62020-09-25 12:17:54 +0200908 [ "${OPTARG}" == "vca" ] && continue
Dominik Fleischmannc57296f2020-06-09 11:45:08 +0200909 [ "${OPTARG}" == "ha" ] && continue
David Garcia69388c22020-05-07 12:14:19 +0200910 [ "${OPTARG}" == "tag" ] && continue
beierlmf2782c52020-11-05 17:04:05 -0500911 [ "${OPTARG}" == "registry" ] && continue
Antonio Marsicof4ce57c2020-04-23 12:06:19 +0200912 [ "${OPTARG}" == "volume" ] && OPENSTACK_ATTACH_VOLUME="true" && continue
garciadeblas0bc87522021-10-20 22:16:17 +0200913 [ "${OPTARG}" == "nocachelxdimages" ] && continue
914 [ "${OPTARG}" == "cachelxdimages" ] && INSTALL_CACHELXDIMAGES="--cachelxdimages" && continue
garciadeblasd8bc5c32018-05-09 17:37:56 +0200915 echo -e "Invalid option: '--$OPTARG'\n" >&2
916 usage && exit 1
917 ;;
garciadeblas25e87d22020-01-31 14:27:29 +0100918 :)
919 echo "Option -$OPTARG requires an argument" >&2
920 usage && exit 1
921 ;;
garciadeblasd8bc5c32018-05-09 17:37:56 +0200922 \?)
923 echo -e "Invalid option: '-$OPTARG'\n" >&2
924 usage && exit 1
925 ;;
garciadeblas25e87d22020-01-31 14:27:29 +0100926 h)
927 usage && exit 0
928 ;;
garciadeblasd8bc5c32018-05-09 17:37:56 +0200929 y)
930 ASSUME_YES="y"
931 ;;
932 *)
933 usage && exit 1
934 ;;
935 esac
936done
937
garciadeblas0bc87522021-10-20 22:16:17 +0200938source $OSM_DEVOPS/common/all_funcs
garciadeblas6c66abf2018-05-16 14:46:19 +0200939
garciadeblas0bc87522021-10-20 22:16:17 +0200940[ -z "${DEBUG_INSTALL}" ] || DEBUG Debug is on
941[ -n "$SHOWOPTS" ] && dump_vars && exit 0
942
943# Uninstall if "--uninstall"
944if [ -n "$UNINSTALL" ]; then
945 if [ -n "$CHARMED" ]; then
garciadeblas4d89c372021-11-25 11:57:18 +0100946 ${OSM_DEVOPS}/installers/charmed_uninstall.sh -R $RELEASE -r $REPOSITORY -u $REPOSITORY_BASE -D $OSM_DEVOPS -t $DOCKER_TAG "$@" || \
947 FATAL_TRACK charmed_uninstall "charmed_uninstall.sh failed"
garciadeblas0bc87522021-10-20 22:16:17 +0200948 else
garciadeblas4d89c372021-11-25 11:57:18 +0100949 ${OSM_DEVOPS}/installers/uninstall_osm.sh "$@" || \
950 FATAL_TRACK community_uninstall "uninstall_osm.sh failed"
garciadeblas0bc87522021-10-20 22:16:17 +0200951 fi
952 echo -e "\nDONE"
garciadeblasd8bc5c32018-05-09 17:37:56 +0200953 exit 0
954fi
955
garciadeblas28d71bd2023-06-07 23:06:50 +0200956# Installation starts here
957
958# Get README and create OSM_TRACK_INSTALLATION_ID
garciadeblasf407c452024-08-22 14:23:40 +0200959wget -q -O- https://osm-download.etsi.org/ftp/osm-16.0-sixteen/README.txt &> /dev/null
garciadeblas28d71bd2023-06-07 23:06:50 +0200960export OSM_TRACK_INSTALLATION_ID="$(date +%s)-$(head /dev/urandom | tr -dc A-Za-z0-9 | head -c 16)"
961
962# Get OS info to be tracked
963os_distro=$(lsb_release -i 2>/dev/null | awk '{print $3}')
964echo $os_distro
965os_release=$(lsb_release -r 2>/dev/null | awk '{print $2}')
966echo $os_release
967os_info="${os_distro}_${os_release}"
968os_info="${os_info// /_}"
969
Dominik Fleischmann5e4a7512020-03-06 14:05:06 +0100970if [ -n "$CHARMED" ]; then
garciadeblas250b0b62024-01-22 13:30:59 +0100971 # Charmed installation
Mark Beierl70d6f3a2022-12-12 09:00:59 -0500972 sudo snap install jq || FATAL "Could not install jq (snap package). Make sure that snap works"
beierlmce7b4602022-04-13 08:19:40 -0400973 ${OSM_DEVOPS}/installers/charmed_install.sh --tag $OSM_DOCKER_TAG "$@" || \
garciadeblas4d89c372021-11-25 11:57:18 +0100974 FATAL_TRACK charmed_install "charmed_install.sh failed"
garciadeblasf407c452024-08-22 14:23:40 +0200975 wget -q -O- https://osm-download.etsi.org/ftp/osm-16.0-sixteen/README2.txt &> /dev/null
garciadeblas0bc87522021-10-20 22:16:17 +0200976 echo -e "\nDONE"
977 exit 0
garciadeblas250b0b62024-01-22 13:30:59 +0100978elif [ -n "$INSTALL_TO_OPENSTACK" ]; then
979 # Installation to Openstack
garciadeblas0bc87522021-10-20 22:16:17 +0200980 install_to_openstack $OPENSTACK_OPENRC_FILE_OR_CLOUD $OPENSTACK_PUBLIC_NET_NAME $OPENSTACK_ATTACH_VOLUME
981 echo -e "\nDONE"
982 exit 0
garciadeblas250b0b62024-01-22 13:30:59 +0100983else
984 # Community_installer
garciadeblas250b0b62024-01-22 13:30:59 +0100985 # Special cases go first
garciadeblas9bae86f2024-05-31 17:15:18 +0200986 if [ -n "$INSTALL_ONLY" ]; then
garciadeblasf7a207d2025-01-30 15:54:08 +0100987 setup_external_ip
garciadeblasef3f37c2024-05-31 17:30:48 +0200988 [ -n "$INSTALL_ONLY_DOCKER_CE" ] && install_docker_ce
989 [ -n "$INSTALL_ONLY_K8S_CLUSTER" ] && install_k8s_cluster
garciadeblas9bae86f2024-05-31 17:15:18 +0200990 [ -n "$INSTALL_K8S_MONITOR" ] && install_k8s_monitoring
garciadeblasef3f37c2024-05-31 17:30:48 +0200991 [ -n "$INSTALL_ONLY_DEPLOY_OSM" ] && deploy_osm
garciadeblas9bae86f2024-05-31 17:15:18 +0200992 echo -e "\nDONE" && exit 0
993 fi
garciadeblas250b0b62024-01-22 13:30:59 +0100994 # This is where installation starts
995 install_osm
996 echo -e "\nDONE"
997 exit 0
garciadeblas0bc87522021-10-20 22:16:17 +0200998fi