installers/charmed_install.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 # set -eux
  17
  18 LXD_VERSION=4.0
  19 JUJU_VERSION=2.9
  20 JUJU_AGENT_VERSION=2.9.17
  21 K8S_CLOUD_NAME="k8s-cloud"
  22 KUBECTL="microk8s.kubectl"
  23 MICROK8S_VERSION=1.20
  24 OSMCLIENT_VERSION=10.0
  25 IMAGES_OVERLAY_FILE=~/.osm/images-overlay.yaml
  26 PATH=/snap/bin:${PATH}
  27
  28 MODEL_NAME=osm
  29
  30 # Latest bundles using old mongodb-k8s
  31 # OSM_BUNDLE=cs:osm-68
  32 # OSM_HA_BUNDLE=cs:osm-ha-54
  33 # The charm store does not support referencing charms from CharmHub,
  34 # therefore we will point to the local bundles until we migrate all
  35 # charms to CharmHub.
  36 OSM_BUNDLE=/usr/share/osm-devops/installers/charm/bundles/osm/bundle.yaml
  37 OSM_HA_BUNDLE=/usr/share/osm-devops/installers/charm/bundles/osm-ha/bundle.yaml
  38 TAG=testing-daily
  39
  40 function check_arguments(){
  41     while [ $# -gt 0 ] ; do
  42         case $1 in
  43             --bundle) BUNDLE="$2" ;;
  44             --overlay) OVERLAY="$2" ;;
  45             --k8s) KUBECFG="$2" ;;
  46             --vca) CONTROLLER="$2" ;;
  47             --lxd) LXD_CLOUD="$2" ;;
  48             --lxd-cred) LXD_CREDENTIALS="$2" ;;
  49             --microstack) MICROSTACK=y ;;
  50             --ha) BUNDLE=$OSM_HA_BUNDLE ;;
  51             --tag) TAG="$2" ;;
  52             --registry) REGISTRY_INFO="$2" ;;
  53             --only-vca) ONLY_VCA=y ;;
  54         esac
  55         shift
  56     done
  57
  58     # echo $BUNDLE $KUBECONFIG $LXDENDPOINT
  59 }
  60
  61 function install_snaps(){
  62     if [ ! -v KUBECFG ]; then
  63         sudo snap install microk8s --classic --channel=${MICROK8S_VERSION}/stable
  64         sudo cat /var/snap/microk8s/current/args/kube-apiserver | grep advertise-address || (
  65                 echo "--advertise-address $DEFAULT_IP" | sudo tee -a /var/snap/microk8s/current/args/kube-apiserver
  66                 microk8s.stop
  67                 microk8s.start
  68             )
  69         sudo usermod -a -G microk8s `whoami`
  70         mkdir -p ~/.kube
  71         sudo chown -f -R `whoami` ~/.kube
  72         KUBEGRP="microk8s"
  73         sg ${KUBEGRP} -c "microk8s status --wait-ready"
  74         KUBECONFIG=~/.osm/microk8s-config.yaml
  75         sg ${KUBEGRP} -c "microk8s config" | tee ${KUBECONFIG}
  76     else
  77         KUBECTL="kubectl"
  78         sudo snap install kubectl --classic
  79         export KUBECONFIG=${KUBECFG}
  80         KUBEGRP=$(id -g -n)
  81     fi
  82     sudo snap install juju --classic --channel=$JUJU_VERSION/stable
  83 }
  84
  85 function bootstrap_k8s_lxd(){
  86     [ -v CONTROLLER ] && ADD_K8S_OPTS="--controller ${CONTROLLER}" && CONTROLLER_NAME=$CONTROLLER
  87     [ ! -v CONTROLLER ] && ADD_K8S_OPTS="--client" && BOOTSTRAP_NEEDED="yes" && CONTROLLER_NAME="osm-vca"
  88
  89     if [ -v BOOTSTRAP_NEEDED ]; then
  90         CONTROLLER_PRESENT=$(juju controllers 2>/dev/null| grep ${CONTROLLER_NAME} | wc -l)
  91         if [ $CONTROLLER_PRESENT -ge 1 ]; then
  92             cat << EOF
  93 Threre is already a VCA present with the installer reserved name of "${CONTROLLER_NAME}".
  94 You may either explicitly use this VCA with the "--vca ${CONTROLLER_NAME}" option, or remove it
  95 using this command:
  96
  97    juju destroy-controller --release-storage --destroy-all-models -y ${CONTROLLER_NAME}
  98
  99 Please retry the installation once this conflict has been resolved.
 100 EOF
 101             exit 1
 102         fi
 103     else
 104         CONTROLLER_PRESENT=$(juju controllers 2>/dev/null| grep ${CONTROLLER_NAME} | wc -l)
 105         if [ $CONTROLLER_PRESENT -le 0 ]; then
 106             cat << EOF
 107 Threre is no VCA present with the name "${CONTROLLER_NAME}".  Please specify a VCA
 108 that exists, or remove the --vca ${CONTROLLER_NAME} option.
 109
 110 Please retry the installation with one of the solutions applied.
 111 EOF
 112             exit 1
 113         fi
 114     fi
 115
 116     if [ -v KUBECFG ]; then
 117         cat $KUBECFG | juju add-k8s $K8S_CLOUD_NAME $ADD_K8S_OPTS
 118         [ -v BOOTSTRAP_NEEDED ] && juju bootstrap $K8S_CLOUD_NAME $CONTROLLER_NAME \
 119             --config controller-service-type=loadbalancer \
 120             --agent-version=$JUJU_AGENT_VERSION
 121     else
 122         sg ${KUBEGRP} -c "echo ${DEFAULT_IP}-${DEFAULT_IP} | microk8s.enable metallb"
 123         sg ${KUBEGRP} -c "microk8s.enable ingress"
 124         sg ${KUBEGRP} -c "microk8s.enable storage dns"
 125         TIME_TO_WAIT=30
 126         start_time="$(date -u +%s)"
 127         while true
 128         do
 129             now="$(date -u +%s)"
 130             if [[ $(( now - start_time )) -gt $TIME_TO_WAIT ]];then
 131                 echo "Microk8s storage failed to enable"
 132                 sg ${KUBEGRP} -c "microk8s.status"
 133                 exit 1
 134             fi
 135             storage_status=`sg ${KUBEGRP} -c "microk8s.status -a storage"`
 136             if [[ $storage_status == "enabled" ]]; then
 137                 break
 138             fi
 139             sleep 1
 140         done
 141
 142         [ ! -v BOOTSTRAP_NEEDED ] && sg ${KUBEGRP} -c "microk8s.config" | juju add-k8s $K8S_CLOUD_NAME $ADD_K8S_OPTS
 143         [ -v BOOTSTRAP_NEEDED ] && sg ${KUBEGRP} -c \
 144             "juju bootstrap microk8s $CONTROLLER_NAME --config controller-service-type=loadbalancer --agent-version=$JUJU_AGENT_VERSION" \
 145             && K8S_CLOUD_NAME=microk8s
 146     fi
 147
 148     if [ -v LXD_CLOUD ]; then
 149         if [ ! -v LXD_CREDENTIALS ]; then
 150             echo "The installer needs the LXD server certificate if the LXD is external"
 151             exit 1
 152         fi
 153     else
 154         LXDENDPOINT=$DEFAULT_IP
 155         LXD_CLOUD=~/.osm/lxd-cloud.yaml
 156         LXD_CREDENTIALS=~/.osm/lxd-credentials.yaml
 157         # Apply sysctl production values for optimal performance
 158         sudo cp /usr/share/osm-devops/installers/60-lxd-production.conf /etc/sysctl.d/60-lxd-production.conf
 159         sudo sysctl --system
 160         # Install LXD snap
 161         sudo apt-get remove --purge -y liblxc1 lxc-common lxcfs lxd lxd-client
 162         sudo snap install lxd --channel $LXD_VERSION/stable
 163         # Configure LXD
 164         sudo usermod -a -G lxd `whoami`
 165         cat /usr/share/osm-devops/installers/lxd-preseed.conf | sed 's/^config: {}/config:\n  core.https_address: '$LXDENDPOINT':8443/' | sg lxd -c "lxd init --preseed"
 166         sg lxd -c "lxd waitready"
 167         DEFAULT_MTU=$(ip addr show $DEFAULT_IF | perl -ne 'if (/mtu\s(\d+)/) {print $1;}')
 168         sg lxd -c "lxc profile device set default eth0 mtu $DEFAULT_MTU"
 169         sg lxd -c "lxc network set lxdbr0 bridge.mtu $DEFAULT_MTU"
 170
 171         cat << EOF > $LXD_CLOUD
 172 clouds:
 173   lxd-cloud:
 174     type: lxd
 175     auth-types: [certificate]
 176     endpoint: "https://$LXDENDPOINT:8443"
 177     config:
 178       ssl-hostname-verification: false
 179 EOF
 180         openssl req -nodes -new -x509 -keyout ~/.osm/client.key -out ~/.osm/client.crt -days 365 -subj "/C=FR/ST=Nice/L=Nice/O=ETSI/OU=OSM/CN=osm.etsi.org"
 181         local server_cert=`cat /var/snap/lxd/common/lxd/server.crt | sed 's/^/        /'`
 182         local client_cert=`cat ~/.osm/client.crt | sed 's/^/        /'`
 183         local client_key=`cat ~/.osm/client.key | sed 's/^/        /'`
 184
 185         cat << EOF > $LXD_CREDENTIALS
 186 credentials:
 187   lxd-cloud:
 188     lxd-cloud:
 189       auth-type: certificate
 190       server-cert: |
 191 $server_cert
 192       client-cert: |
 193 $client_cert
 194       client-key: |
 195 $client_key
 196 EOF
 197         lxc config trust add local: ~/.osm/client.crt
 198     fi
 199
 200     juju add-cloud -c $CONTROLLER_NAME lxd-cloud $LXD_CLOUD --force
 201     juju add-credential -c $CONTROLLER_NAME lxd-cloud -f $LXD_CREDENTIALS
 202     sg lxd -c "lxd waitready"
 203     juju controller-config features=[k8s-operators]
 204 }
 205
 206 function wait_for_port(){
 207     SERVICE=$1
 208     INDEX=$2
 209     TIME_TO_WAIT=30
 210     start_time="$(date -u +%s)"
 211     while true
 212     do
 213         now="$(date -u +%s)"
 214         if [[ $(( now - start_time )) -gt $TIME_TO_WAIT ]];then
 215             echo "Failed to expose external ${SERVICE} interface port"
 216             exit 1
 217         fi
 218
 219         if [ $(sg ${KUBEGRP} -c "${KUBECTL} get ingresses.networking -n osm -o json | jq -r '.items[$INDEX].metadata.name'") == ${SERVICE} ] ; then
 220             break
 221         fi
 222         sleep 1
 223     done
 224 }
 225
 226 function deploy_charmed_osm(){
 227     if [ -v REGISTRY_INFO ] ; then
 228         registry_parts=(${REGISTRY_INFO//@/ })
 229         if [ ${#registry_parts[@]} -eq 1 ] ; then
 230             # No credentials supplied
 231             REGISTRY_USERNAME=""
 232             REGISTRY_PASSWORD=""
 233             REGISTRY_URL=${registry_parts[0]}
 234         else
 235             credentials=${registry_parts[0]}
 236             credential_parts=(${credentials//:/ })
 237             REGISTRY_USERNAME=${credential_parts[0]}
 238             REGISTRY_PASSWORD=${credential_parts[1]}
 239             REGISTRY_URL=${registry_parts[1]}
 240         fi
 241         # Ensure the URL ends with a /
 242         case $REGISTRY_URL in
 243             */) ;;
 244             *) REGISTRY_URL=${REGISTRY_URL}/
 245         esac
 246     fi
 247
 248     echo "Creating OSM model"
 249     if [ -v KUBECFG ]; then
 250         juju add-model $MODEL_NAME $K8S_CLOUD_NAME
 251     else
 252         sg ${KUBEGRP} -c "juju add-model $MODEL_NAME $K8S_CLOUD_NAME"
 253     fi
 254     echo "Deploying OSM with charms"
 255     images_overlay=""
 256     if [ -v REGISTRY_URL ]; then
 257        [ ! -v TAG ] && TAG='latest'
 258     fi
 259     [ -v TAG ] && generate_images_overlay && images_overlay="--overlay $IMAGES_OVERLAY_FILE"
 260
 261     if [ -v OVERLAY ]; then
 262         extra_overlay="--overlay $OVERLAY"
 263     fi
 264
 265     if [ -v BUNDLE ]; then
 266         juju deploy -m $MODEL_NAME $BUNDLE --overlay ~/.osm/vca-overlay.yaml $images_overlay $extra_overlay
 267     else
 268         juju deploy -m $MODEL_NAME $OSM_BUNDLE --overlay ~/.osm/vca-overlay.yaml $images_overlay $extra_overlay
 269     fi
 270
 271     if [ ! -v KUBECFG ]; then
 272         API_SERVER=${DEFAULT_IP}
 273     else
 274         API_SERVER=$(kubectl config view --minify | grep server | cut -f 2- -d ":" | tr -d " ")
 275         proto="$(echo $API_SERVER | grep :// | sed -e's,^\(.*://\).*,\1,g')"
 276         url="$(echo ${API_SERVER/$proto/})"
 277         user="$(echo $url | grep @ | cut -d@ -f1)"
 278         hostport="$(echo ${url/$user@/} | cut -d/ -f1)"
 279         API_SERVER="$(echo $hostport | sed -e 's,:.*,,g')"
 280     fi
 281     # Expose OSM services
 282     juju config -m $MODEL_NAME nbi site_url=https://nbi.${API_SERVER}.nip.io
 283     juju config -m $MODEL_NAME ng-ui site_url=https://ui.${API_SERVER}.nip.io
 284     juju config -m $MODEL_NAME grafana site_url=https://grafana.${API_SERVER}.nip.io
 285     juju config -m $MODEL_NAME prometheus site_url=https://prometheus.${API_SERVER}.nip.io
 286
 287     echo "Waiting for deployment to finish..."
 288     check_osm_deployed
 289     grafana_leader=`juju status -m $MODEL_NAME grafana | grep "*" | cut -d "*" -f 1`
 290     grafana_admin_password=`juju run -m $MODEL_NAME --unit $grafana_leader "echo \\$GF_SECURITY_ADMIN_PASSWORD"`
 291     juju config -m $MODEL_NAME mon grafana_password=$grafana_admin_password
 292     check_osm_deployed
 293     echo "OSM with charms deployed"
 294 }
 295
 296 function check_osm_deployed() {
 297     TIME_TO_WAIT=600
 298     start_time="$(date -u +%s)"
 299     total_service_count=14
 300     previous_count=0
 301     while true
 302     do
 303         service_count=$(juju status -m $MODEL_NAME | grep kubernetes | grep active | wc -l)
 304         echo "$service_count / $total_service_count services active"
 305         if [ $service_count -eq $total_service_count ]; then
 306             break
 307         fi
 308         if [ $service_count -ne $previous_count ]; then
 309             previous_count=$service_count
 310             start_time="$(date -u +%s)"
 311         fi
 312         now="$(date -u +%s)"
 313         if [[ $(( now - start_time )) -gt $TIME_TO_WAIT ]];then
 314             echo "Timed out waiting for OSM services to become ready"
 315             exit 1
 316         fi
 317         sleep 10
 318     done
 319 }
 320
 321 function create_overlay() {
 322     sudo snap install jq
 323     sudo snap install yq
 324     local HOME=/home/$USER
 325     local vca_user=$(cat $HOME/.local/share/juju/accounts.yaml | yq e .controllers.$CONTROLLER_NAME.user - )
 326     local vca_secret=$(cat $HOME/.local/share/juju/accounts.yaml | yq e .controllers.$CONTROLLER_NAME.password - )
 327     local vca_host=$(cat $HOME/.local/share/juju/controllers.yaml | yq e .controllers.$CONTROLLER_NAME.api-endpoints[0] - | cut -d ":" -f 1)
 328     local vca_port=$(cat $HOME/.local/share/juju/controllers.yaml | yq e .controllers.$CONTROLLER_NAME.api-endpoints[0] - | cut -d ":" -f 2)
 329     local vca_pubkey=\"$(cat $HOME/.local/share/juju/ssh/juju_id_rsa.pub)\"
 330     local vca_cloud="lxd-cloud"
 331     # Get the VCA Certificate
 332     local vca_cacert=$(cat $HOME/.local/share/juju/controllers.yaml | yq e .controllers.$CONTROLLER_NAME.ca-cert - | base64 | tr -d \\n)
 333
 334     # Calculate the default route of this machine
 335     local DEFAULT_IF=`ip route list match 0.0.0.0 | awk '{print $5}'`
 336
 337     # Generate a new overlay.yaml, overriding any existing one
 338     cat << EOF > /tmp/vca-overlay.yaml
 339 applications:
 340   lcm:
 341     options:
 342       vca_user: $vca_user
 343       vca_secret: $vca_secret
 344       vca_host: $vca_host
 345       vca_port: $vca_port
 346       vca_pubkey: $vca_pubkey
 347       vca_cacert: $vca_cacert
 348       vca_cloud: $vca_cloud
 349       vca_k8s_cloud: $K8S_CLOUD_NAME
 350   mon:
 351     options:
 352       vca_user: $vca_user
 353       vca_secret: $vca_secret
 354       vca_host: $vca_host
 355       vca_cacert: $vca_cacert
 356 EOF
 357     mv /tmp/vca-overlay.yaml ~/.osm/
 358     OSM_VCA_HOST=$vca_host
 359 }
 360
 361 function generate_images_overlay(){
 362     echo "applications:" > /tmp/images-overlay.yaml
 363
 364     charms_with_resources="nbi lcm mon pol ng-ui ro pla keystone"
 365     for charm in $charms_with_resources; do
 366         cat << EOF > /tmp/${charm}_registry.yaml
 367 registrypath: ${REGISTRY_URL}opensourcemano/${charm}:$TAG
 368 EOF
 369         if [ ! -z "$REGISTRY_USERNAME" ] ; then
 370             echo username: $REGISTRY_USERNAME >> /tmp/${charm}_registry.yaml
 371             echo password: $REGISTRY_PASSWORD >> /tmp/${charm}_registry.yaml
 372         fi
 373
 374         cat << EOF >> /tmp/images-overlay.yaml
 375   ${charm}:
 376     resources:
 377       image: /tmp/${charm}_registry.yaml
 378
 379 EOF
 380     done
 381
 382     mv /tmp/images-overlay.yaml $IMAGES_OVERLAY_FILE
 383 }
 384
 385 function refresh_osmclient_snap() {
 386     osmclient_snap_install_refresh refresh
 387 }
 388
 389 function install_osm_client_snap() {
 390     osmclient_snap_install_refresh install
 391 }
 392
 393 function osmclient_snap_install_refresh() {
 394     channel_preference="stable candidate beta edge"
 395     for channel in $channel_preference; do
 396         echo "Trying to install osmclient from channel $OSMCLIENT_VERSION/$channel"
 397         sudo snap $1 osmclient --channel $OSMCLIENT_VERSION/$channel 2> /dev/null && echo osmclient snap installed && break
 398     done
 399 }
 400 function install_osmclient() {
 401     snap info osmclient | grep -E ^installed: && refresh_osmclient_snap || install_osm_client_snap
 402 }
 403
 404 function add_local_k8scluster() {
 405     osm --all-projects vim-create \
 406       --name _system-osm-vim \
 407       --account_type dummy \
 408       --auth_url http://dummy \
 409       --user osm --password osm --tenant osm \
 410       --description "dummy" \
 411       --config '{management_network_name: mgmt}'
 412     tmpfile=$(mktemp --tmpdir=${HOME})
 413     cp ${KUBECONFIG} ${tmpfile}
 414     osm --all-projects k8scluster-add \
 415       --creds ${tmpfile} \
 416       --vim _system-osm-vim \
 417       --k8s-nets '{"net1": null}' \
 418       --version '1.19' \
 419       --description "OSM Internal Cluster" \
 420       _system-osm-k8s
 421     rm -f ${tmpfile}
 422 }
 423
 424 function install_microstack() {
 425     sudo snap install microstack --classic --beta
 426     sudo microstack.init --auto
 427     wget https://cloud-images.ubuntu.com/releases/16.04/release/ubuntu-16.04-server-cloudimg-amd64-disk1.img -P ~/.osm/
 428     microstack.openstack image create \
 429     --public \
 430     --disk-format qcow2 \
 431     --container-format bare \
 432     --file ~/.osm/ubuntu-16.04-server-cloudimg-amd64-disk1.img \
 433     ubuntu1604
 434     ssh-keygen -t rsa -N "" -f ~/.ssh/microstack
 435     microstack.openstack keypair create --public-key ~/.ssh/microstack.pub microstack
 436     export OSM_HOSTNAME=`juju status -m $MODEL_NAME --format json | jq -rc '.applications."nbi".address'`
 437     osm vim-create --name microstack-site \
 438     --user admin \
 439     --password keystone \
 440     --auth_url http://10.20.20.1:5000/v3 \
 441     --tenant admin \
 442     --account_type openstack \
 443     --config='{security_groups: default,
 444         keypair: microstack,
 445         project_name: admin,
 446         user_domain_name: default,
 447         region_name: microstack,
 448         insecure: True,
 449         availability_zone: nova,
 450     version: 3}'
 451 }
 452
 453 DEFAULT_IF=`ip route list match 0.0.0.0 | awk '{print $5; exit}'`
 454 DEFAULT_IP=`ip -o -4 a |grep ${DEFAULT_IF}|awk '{split($4,a,"/"); print a[1]; exit}'`
 455
 456 check_arguments $@
 457 mkdir -p ~/.osm
 458 install_snaps
 459 bootstrap_k8s_lxd
 460 create_overlay
 461 if [ -v ONLY_VCA ]; then
 462     HOME=/home/$USER
 463     vca_user=$(cat $HOME/.local/share/juju/accounts.yaml | yq e .controllers.$CONTROLLER_NAME.user - )
 464     vca_secret=$(cat $HOME/.local/share/juju/accounts.yaml | yq e .controllers.$CONTROLLER_NAME.password - )
 465     vca_host=$(cat $HOME/.local/share/juju/controllers.yaml | yq e .controllers.$CONTROLLER_NAME.api-endpoints[0] - | cut -d ":" -f 1)
 466     vca_port=$(cat $HOME/.local/share/juju/controllers.yaml | yq e .controllers.$CONTROLLER_NAME.api-endpoints[0] - | cut -d ":" -f 2)
 467     vca_pubkey=\"$(cat $HOME/.local/share/juju/ssh/juju_id_rsa.pub)\"
 468     vca_cloud="lxd-cloud"
 469     vca_cacert=$(cat $HOME/.local/share/juju/controllers.yaml | yq e .controllers.$CONTROLLER_NAME.ca-cert - | base64 | tr -d \\n)
 470     hostname=`cat /etc/hostname`
 471
 472     echo "Use the following command to register the installed VCA to your OSM:"
 473     echo -e "  osm vca-add --endpoints $vca_host:$vca_port \\\n         --user $vca_user \\\n         --secret $vca_secret \\\n         --cacert $vca_cacert \\\n         --lxd-cloud lxd-cloud \\\n         --lxd-credentials lxd-cloud \\\n         --k8s-cloud microk8s \\\n         --k8s-credentials microk8s\\\n         $hostname-vca"
 474 else
 475     deploy_charmed_osm
 476     install_osmclient
 477     export OSM_HOSTNAME=$(juju config -m $MODEL_NAME nbi site_url | sed "s/http.*\?:\/\///"):443
 478     sleep 10
 479     add_local_k8scluster
 480     if [ -v MICROSTACK ]; then
 481         install_microstack
 482     fi
 483
 484     echo "Your installation is now complete, follow these steps for configuring the osmclient:"
 485     echo
 486     echo "1. Create the OSM_HOSTNAME environment variable with the NBI IP"
 487     echo
 488     echo "export OSM_HOSTNAME=$OSM_HOSTNAME"
 489     echo
 490     echo "2. Add the previous command to your .bashrc for other Shell sessions"
 491     echo
 492     echo "echo \"export OSM_HOSTNAME=$OSM_HOSTNAME\" >> ~/.bashrc"
 493     echo
 494     echo "DONE"
 495 fi
 496