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