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
7 # http://www.apache.org/licenses/LICENSE-2.0
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.
20 JUJU_AGENT_VERSION
=2.9.43
21 K8S_CLOUD_NAME
="k8s-cloud"
22 KUBECTL
="microk8s.kubectl"
24 OSMCLIENT_VERSION
=latest
25 IMAGES_OVERLAY_FILE
=~
/.osm
/images-overlay.yaml
26 PASSWORD_OVERLAY_FILE
=~
/.osm
/password-overlay.yaml
27 PATH
=/snap
/bin
:${PATH}
28 OSM_DEVOPS
="$( cd "$
( dirname "${BASH_SOURCE[0]}" )"/.. &> /dev/null && pwd )"
30 PLA_OVERLAY_FILE
=~
/.osm
/pla-overlay.yaml
32 if [ -f ${OSM_DEVOPS}/common
/all_funcs
] ; then
33 source ${OSM_DEVOPS}/common
/all_funcs
38 function FATAL_TRACK
(){
46 OSM_HA_BUNDLE
=ch
:osm-ha
47 CHARMHUB_CHANNEL
=latest
/beta
50 function check_arguments
(){
51 while [ $# -gt 0 ] ; do
53 --bundle) BUNDLE
="$2" ;;
54 --overlay) OVERLAY
="$2" ;;
55 --k8s) KUBECFG
="$2" ;;
56 --vca) CONTROLLER
="$2" ;;
57 --small-profile) INSTALL_NOLXD
=y
;;
58 --lxd) LXD_CLOUD
="$2" ;;
59 --lxd-cred) LXD_CREDENTIALS
="$2" ;;
60 --microstack) MICROSTACK
=y
;;
61 --ha) BUNDLE
=$OSM_HA_BUNDLE ;;
63 --registry) REGISTRY_INFO
="$2" ;;
64 --only-vca) ONLY_VCA
=y
;;
65 --pla) INSTALL_PLA
=y
;;
70 # echo $BUNDLE $KUBECONFIG $LXDENDPOINT
73 function install_snaps
(){
74 if [ ! -v KUBECFG
]; then
76 sudo snap
install microk8s
--classic --channel=${MICROK8S_VERSION}/stable ||
77 FATAL_TRACK k8scluster
"snap install microk8s ${MICROK8S_VERSION}/stable failed"
78 sudo usermod
-a -G microk8s
`whoami`
79 # Workaround bug in calico MTU detection
80 if [ ${DEFAULT_IF_MTU} -ne 1500 ] ; then
81 sudo mkdir
-p /var
/lib
/calico
82 sudo
ln -sf /var
/snap
/microk8s
/current
/var
/lib
/calico
/mtu
/var
/lib
/calico
/mtu
84 sudo
cat /var
/snap
/microk8s
/current
/args
/kube-apiserver |
grep advertise-address ||
(
85 echo "--advertise-address $DEFAULT_IP" | sudo
tee -a /var
/snap
/microk8s
/current
/args
/kube-apiserver
86 sg
${KUBEGRP} -c microk8s.stop
87 sg
${KUBEGRP} -c microk8s.start
90 sudo chown
-f -R `whoami` ~
/.kube
91 sg
${KUBEGRP} -c "microk8s status --wait-ready"
92 KUBECONFIG
=~
/.osm
/microk8s-config.yaml
93 sg
${KUBEGRP} -c "microk8s config" |
tee ${KUBECONFIG}
94 track k8scluster k8scluster_ok
97 sudo snap
install kubectl
--classic
98 export KUBECONFIG
=${KUBECFG}
101 sudo snap
install juju
--classic --channel=$JUJU_VERSION/stable ||
102 FATAL_TRACK juju
"snap install juju ${JUJU_VERSION}/stable failed"
106 function bootstrap_k8s_lxd
(){
107 [ -v CONTROLLER
] && ADD_K8S_OPTS
="--controller ${CONTROLLER}" && CONTROLLER_NAME
=$CONTROLLER
108 [ ! -v CONTROLLER
] && ADD_K8S_OPTS
="--client" && BOOTSTRAP_NEEDED
="yes" && CONTROLLER_NAME
="osm-vca"
110 if [ -v BOOTSTRAP_NEEDED
]; then
111 CONTROLLER_PRESENT
=$
(juju controllers
2>/dev
/null|
grep ${CONTROLLER_NAME} |
wc -l)
112 if [ $CONTROLLER_PRESENT -ge 1 ]; then
114 Threre is already a VCA present with the installer reserved name of "${CONTROLLER_NAME}".
115 You may either explicitly use this VCA with the "--vca ${CONTROLLER_NAME}" option, or remove it
118 juju destroy-controller --release-storage --destroy-all-models -y ${CONTROLLER_NAME}
120 Please retry the installation once this conflict has been resolved.
122 FATAL_TRACK bootstrap_k8s
"VCA already present"
125 CONTROLLER_PRESENT
=$
(juju controllers
2>/dev
/null|
grep ${CONTROLLER_NAME} |
wc -l)
126 if [ $CONTROLLER_PRESENT -le 0 ]; then
128 Threre is no VCA present with the name "${CONTROLLER_NAME}". Please specify a VCA
129 that exists, or remove the --vca ${CONTROLLER_NAME} option.
131 Please retry the installation with one of the solutions applied.
133 FATAL_TRACK bootstrap_k8s
"Requested VCA not present"
137 if [ -v KUBECFG
]; then
138 cat $KUBECFG | juju add-k8s
$K8S_CLOUD_NAME $ADD_K8S_OPTS
139 [ -v BOOTSTRAP_NEEDED
] && juju bootstrap
$K8S_CLOUD_NAME $CONTROLLER_NAME \
140 --config controller-service-type
=loadbalancer \
141 --agent-version=$JUJU_AGENT_VERSION
143 sg
${KUBEGRP} -c "echo ${DEFAULT_IP}-${DEFAULT_IP} | microk8s.
enable metallb
"
144 sg ${KUBEGRP} -c "microk8s.
enable ingress
"
145 sg ${KUBEGRP} -c "microk8s.
enable hostpath-storage dns
"
147 start_time="$
(date -u +%s
)"
151 if [[ $(( now - start_time )) -gt $TIME_TO_WAIT ]];then
152 echo "Microk8s storage failed to
enable"
153 sg ${KUBEGRP} -c "microk8s.status
"
154 FATAL_TRACK bootstrap_k8s "Microk8s storage failed to
enable"
156 storage_status=`sg ${KUBEGRP} -c "microk8s.status
-a storage
"`
157 if [[ $storage_status == "enabled
" ]]; then
163 [ ! -v BOOTSTRAP_NEEDED ] && sg ${KUBEGRP} -c "microk8s.config
" | juju add-k8s $K8S_CLOUD_NAME $ADD_K8S_OPTS
164 [ -v BOOTSTRAP_NEEDED ] && sg ${KUBEGRP} -c \
165 "juju bootstrap microk8s
$CONTROLLER_NAME --config controller-service-type
=loadbalancer
--agent-version=$JUJU_AGENT_VERSION" \
166 && K8S_CLOUD_NAME=microk8s
168 track bootstrap_k8s bootstrap_k8s_ok
170 if [ ! -v INSTALL_NOLXD ]; then
171 if [ -v LXD_CLOUD ]; then
172 if [ ! -v LXD_CREDENTIALS ]; then
173 echo "The installer needs the LXD server certificate
if the LXD is external
"
174 FATAL_TRACK bootstrap_lxd "No LXD certificate supplied
"
177 LXDENDPOINT=$DEFAULT_IP
178 LXD_CLOUD=~/.osm/lxd-cloud.yaml
179 LXD_CREDENTIALS=~/.osm/lxd-credentials.yaml
180 # Apply sysctl production values for optimal performance
181 sudo cp /usr/share/osm-devops/installers/60-lxd-production.conf /etc/sysctl.d/60-lxd-production.conf
184 sudo apt-get remove --purge -y liblxc1 lxc-common lxcfs lxd lxd-client
185 snap info lxd | grep installed > /dev/null
186 if [ $? -eq 0 ]; then
187 sudo snap refresh lxd --channel $LXD_VERSION/stable
189 sudo snap install lxd --channel $LXD_VERSION/stable
192 sudo usermod -a -G lxd `whoami`
193 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"
194 sg lxd -c "lxd waitready
"
196 cat << EOF > $LXD_CLOUD
200 auth-types: [certificate]
201 endpoint: "https
://$LXDENDPOINT:8443"
203 ssl-hostname-verification: false
205 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
"
206 cat << EOF > $LXD_CREDENTIALS
210 auth-type: certificate
211 server-cert: /var/snap/lxd/common/lxd/server.crt
212 client-cert: ~/.osm/client.crt
213 client-key: ~/.osm/client.key
215 lxc config trust add local: ~/.osm/client.crt
218 juju add-cloud -c $CONTROLLER_NAME lxd-cloud $LXD_CLOUD --force
219 juju add-credential -c $CONTROLLER_NAME lxd-cloud -f $LXD_CREDENTIALS
220 sg lxd -c "lxd waitready
"
221 juju controller-config features=[k8s-operators]
222 track bootstrap_lxd bootstrap_lxd_ok
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
233 REGISTRY_URL=${registry_parts[0]}
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]}
241 # Ensure the URL ends with a /
242 case $REGISTRY_URL in
244 *) REGISTRY_URL=${REGISTRY_URL}/
248 echo "Creating OSM model
"
249 if [ -v KUBECFG ]; then
250 juju add-model $MODEL_NAME $K8S_CLOUD_NAME
252 sg ${KUBEGRP} -c "juju add-model
$MODEL_NAME $K8S_CLOUD_NAME"
254 echo "Deploying OSM with charms
"
256 if [ -v REGISTRY_URL ]; then
257 [ ! -v TAG ] && TAG='latest'
259 [ -v TAG ] && generate_images_overlay && images_overlay="--overlay $IMAGES_OVERLAY_FILE"
261 if [ -v OVERLAY ]; then
262 extra_overlay="--overlay $OVERLAY"
264 echo "Creating Password Overlay
"
266 generate_password_overlay && secret_overlay="--overlay $PASSWORD_OVERLAY_FILE"
268 [ -n "$INSTALL_PLA" ] && create_pla_overlay && pla_overlay="--overlay $PLA_OVERLAY_FILE"
270 if [ -v BUNDLE ]; then
271 juju deploy --trust --channel $CHARMHUB_CHANNEL -m $MODEL_NAME $BUNDLE $images_overlay $extra_overlay $secret_overlay $pla_overlay
273 juju deploy --trust --channel $CHARMHUB_CHANNEL -m $MODEL_NAME $OSM_BUNDLE $images_overlay $extra_overlay $secret_overlay $pla_overlay
276 if [ ! -v KUBECFG ]; then
277 API_SERVER=${DEFAULT_IP}
279 API_SERVER=$(kubectl config view --minify | grep server | cut -f 2- -d ":" | tr -d " ")
280 proto="$
(echo $API_SERVER |
grep :// |
sed -e's,^\(.*://\).*,\1,g')"
281 url="$
(echo ${API_SERVER/$proto/})"
282 user="$
(echo $url |
grep @ | cut
-d@
-f1)"
283 hostport="$
(echo ${url/$user@/} | cut
-d/ -f1)"
284 API_SERVER="$
(echo $hostport |
sed -e 's,:.*,,g')"
286 # Configure VCA Integrator
287 if [ ! -v INSTALL_NOLXD ]; then
290 lxd-cloud=lxd-cloud:lxd-cloud \
291 controllers="`cat ~/.local/share/juju/controllers.yaml`" \
292 accounts="`cat ~/.local/share/juju/accounts.yaml`" \
293 public-key="`cat ~/.local/share/juju/ssh/juju_id_rsa.pub`"
297 controllers="`cat ~/.local/share/juju/controllers.yaml`" \
298 accounts="`cat ~/.local/share/juju/accounts.yaml`" \
299 public-key="`cat ~/.local/share/juju/ssh/juju_id_rsa.pub`"
301 # Expose OSM services
302 juju config -m $MODEL_NAME nbi external-hostname=nbi.${API_SERVER}.nip.io
303 juju config -m $MODEL_NAME ng-ui external-hostname=ui.${API_SERVER}.nip.io
304 juju config -m $MODEL_NAME grafana site_url=https://grafana.${API_SERVER}.nip.io
305 juju config -m $MODEL_NAME prometheus site_url=https://prometheus.${API_SERVER}.nip.io
307 echo "Waiting
for deployment to finish...
"
309 grafana_leader=`juju status -m $MODEL_NAME grafana | grep "*" | cut -d "*" -f 1`
310 grafana_admin_password=`juju run -m $MODEL_NAME --unit $grafana_leader "echo \\$GF_SECURITY_ADMIN_PASSWORD"`
311 juju config -m $MODEL_NAME mon grafana-password=$grafana_admin_password
313 echo "OSM with charms deployed
"
316 function check_osm_deployed() {
318 start_time="$
(date -u +%s
)"
319 total_service_count=15
320 [ -n "$INSTALL_PLA" ] && total_service_count=$((total_service_count + 1))
324 service_count=$(juju status --format json -m $MODEL_NAME | jq '.applications[]."application-status
".current' | grep active | wc -l)
325 echo "$service_count / $total_service_count services active
"
326 if [ $service_count -eq $total_service_count ]; then
329 if [ $service_count -ne $previous_count ]; then
330 previous_count=$service_count
331 start_time="$
(date -u +%s
)"
334 if [[ $(( now - start_time )) -gt $TIME_TO_WAIT ]];then
335 echo "Timed out waiting
for OSM services to become ready
"
336 FATAL_TRACK deploy_osm "Timed out waiting
for services to become ready
"
342 function generate_password_overlay() {
344 web_config_password=`openssl rand -hex 16`
346 keystone_db_password=`openssl rand -hex 16`
347 keystone_admin_password=`openssl rand -hex 16`
348 keystone_service_password=`openssl rand -hex 16`
350 mariadb_password=`openssl rand -hex 16`
351 mariadb_root_password=`openssl rand -hex 16`
352 cat << EOF > /tmp/password-overlay.yaml
356 web_config_password: $web_config_password
359 keystone-db-password: $keystone_db_password
360 admin-password: $keystone_admin_password
361 service-password: $keystone_service_password
364 password: $mariadb_password
365 root_password: $mariadb_root_password
367 mv /tmp/password-overlay.yaml $PASSWORD_OVERLAY_FILE
370 function create_pla_overlay(){
371 echo "Creating PLA Overlay
"
372 [ $BUNDLE == $OSM_HA_BUNDLE ] && scale=3 || scale=1
373 cat << EOF > /tmp/pla-overlay.yaml
377 channel: latest/stable
383 image: opensourcemano/pla:testing-daily
390 mv /tmp/pla-overlay.yaml $PLA_OVERLAY_FILE
393 function generate_images_overlay(){
394 echo "applications
:" > /tmp/images-overlay.yaml
396 charms_with_resources="nbi lcm mon pol ng-ui ro
"
397 [ -n "$INSTALL_PLA" ] && charms_with_resources+=" pla
"
398 for charm in $charms_with_resources; do
399 cat << EOF > /tmp/${charm}_registry.yaml
400 registrypath: ${REGISTRY_URL}opensourcemano/${charm}:$TAG
402 if [ ! -z "$REGISTRY_USERNAME" ] ; then
403 echo username: $REGISTRY_USERNAME >> /tmp/${charm}_registry.yaml
404 echo password: $REGISTRY_PASSWORD >> /tmp/${charm}_registry.yaml
407 cat << EOF >> /tmp/images-overlay.yaml
410 ${charm}-image: /tmp/${charm}_registry.yaml
414 ch_charms_with_resources="keystone
"
415 for charm in $ch_charms_with_resources; do
416 cat << EOF > /tmp/${charm}_registry.yaml
417 registrypath: ${REGISTRY_URL}opensourcemano/${charm}:$TAG
419 if [ ! -z "$REGISTRY_USERNAME" ] ; then
420 echo username: $REGISTRY_USERNAME >> /tmp/${charm}_registry.yaml
421 echo password: $REGISTRY_PASSWORD >> /tmp/${charm}_registry.yaml
424 cat << EOF >> /tmp/images-overlay.yaml
427 ${charm}-image: /tmp/${charm}_registry.yaml
432 mv /tmp/images-overlay.yaml $IMAGES_OVERLAY_FILE
435 function refresh_osmclient_snap() {
436 osmclient_snap_install_refresh refresh
439 function install_osm_client_snap() {
440 osmclient_snap_install_refresh install
443 function osmclient_snap_install_refresh() {
444 channel_preference="stable candidate beta edge
"
445 for channel in $channel_preference; do
446 echo "Trying to
install osmclient from channel
$OSMCLIENT_VERSION/$channel"
447 sudo snap $1 osmclient --channel $OSMCLIENT_VERSION/$channel 2> /dev/null && echo osmclient snap installed && break
450 function install_osmclient() {
451 snap info osmclient | grep -E ^installed: && refresh_osmclient_snap || install_osm_client_snap
454 function add_local_k8scluster() {
455 osm --all-projects vim-create \
456 --name _system-osm-vim \
457 --account_type dummy \
458 --auth_url http://dummy \
459 --user osm --password osm --tenant osm \
460 --description "dummy
" \
461 --config '{management_network_name: mgmt}'
462 tmpfile=$(mktemp --tmpdir=${HOME})
463 cp ${KUBECONFIG} ${tmpfile}
464 osm --all-projects k8scluster-add \
466 --vim _system-osm-vim \
467 --k8s-nets '{"net1
": null}' \
469 --description "OSM Internal Cluster
" \
474 function install_microstack() {
475 sudo snap install microstack --beta --devmode
477 CHECK=$(microstack.openstack server list)
478 if [ $? -ne 0 ] ; then
479 if [[ $CHECK == *"not initialized
"* ]]; then
480 echo "Setting MicroStack dashboard to listen to port
8080"
481 sudo snap set microstack config.network.ports.dashboard=8080
482 echo "Initializing MicroStack. This can take several minutes
"
483 sudo microstack.init --auto --control
487 sudo snap alias microstack.openstack openstack
489 echo "Updating default security group
in MicroStack to allow all access
"
491 for i in $(microstack.openstack security group list | awk '/default/{ print $2 }'); do
492 for PROTO in icmp tcp udp ; do
493 echo " $PROTO ingress
"
494 CHECK=$(microstack.openstack security group rule create $i --protocol $PROTO --remote-ip 0.0.0.0/0 2>&1)
495 if [ $? -ne 0 ] ; then
496 if [[ $CHECK != *"409"* ]]; then
497 echo "Error creating ingress rule
for $PROTO"
504 microstack.openstack network show osm-ext &>/dev/null
505 if [ $? -ne 0 ]; then
506 echo "Creating osm-ext network with router to bridge to MicroStack external network
"
507 microstack.openstack network create --enable --no-share osm-ext
508 microstack.openstack subnet create osm-ext-subnet --network osm-ext --dns-nameserver 8.8.8.8 \
509 --subnet-range 172.30.0.0/24
510 microstack.openstack router create external-router
511 microstack.openstack router add subnet external-router osm-ext-subnet
512 microstack.openstack router set --external-gateway external external-router
515 microstack.openstack image list | grep ubuntu20.04 &> /dev/null
516 if [ $? -ne 0 ] ; then
517 echo "Fetching Ubuntu
20.04 image and upLoading to MicroStack
"
518 wget -q -O- https://cloud-images.ubuntu.com/focal/current/focal-server-cloudimg-amd64.img \
519 | microstack.openstack image create --public --container-format=bare \
520 --disk-format=qcow2 ubuntu20.04 | grep status
523 if [ ! -f ~/.ssh/microstack ]; then
524 ssh-keygen -t rsa -N "" -f ~/.ssh/microstack
525 microstack.openstack keypair create --public-key ~/.ssh/microstack.pub microstack
528 echo "Creating VIM microstack-site
in OSM
"
529 . /var/snap/microstack/common/etc/microstack.rc
532 --name microstack-site \
533 --user "$OS_USERNAME" \
534 --password "$OS_PASSWORD" \
535 --auth_url "$OS_AUTH_URL" \
536 --tenant "$OS_USERNAME" \
537 --account_type openstack \
538 --config='{use_floating_ip: True,
541 management_network_name: osm-ext}'
544 DEFAULT_IF=`ip route list match 0.0.0.0 | awk '{print $5; exit}'`
545 DEFAULT_IP=`ip -o -4 a |grep ${DEFAULT_IF}|awk '{split($4,a,"/"); print a[1]; exit}'`
546 DEFAULT_IF_MTU=`ip a show ${DEFAULT_IF} | grep mtu | awk '{print $5}'`
552 if [ -v ONLY_VCA ]; then
555 lxdcloud=lxd-cloud:lxd-cloud
556 controllers="`cat $HOME/.local/share/juju/controllers.yaml`"
557 accounts="`cat $HOME/.local/share/juju/accounts.yaml`"
558 publickey="`cat $HOME/.local/share/juju/ssh/juju_id_rsa.pub`"
559 echo "Use the following
command to register the installed VCA to your OSM VCA integrator charm
"
560 echo -e " juju config vca
\\\n k8s-cloud
=$k8scloud \\\n lxd-cloud
=$lxdcloud \\\n controllers
=$controllers \\\n accounts
=$accounts \\\n public-key
=$publickey"
561 track deploy_osm deploy_vca_only_ok
564 track deploy_osm deploy_osm_services_k8s_ok
566 track osmclient osmclient_ok
567 export OSM_HOSTNAME=$(juju config -m $MODEL_NAME nbi external-hostname):443
568 export OSM_PASSWORD=$keystone_admin_password
571 track final_ops add_local_k8scluster_ok
572 if [ -v MICROSTACK ]; then
574 track final_ops install_microstack_ok
577 echo "Your installation is now complete
, follow these steps
for configuring the osmclient
:"
579 echo "1. Create the OSM_HOSTNAME environment variable with the NBI IP
"
581 echo "export OSM_HOSTNAME
=$OSM_HOSTNAME"
582 echo "export OSM_PASSWORD
=$OSM_PASSWORD"
584 echo "2. Add the previous commands to your .bashrc
for other Shell sessions
"
586 echo "echo \"export OSM_HOSTNAME
=$OSM_HOSTNAME\" >> ~
/.bashrc
"
587 echo "echo \"export OSM_PASSWORD
=$OSM_PASSWORD\" >> ~
/.bashrc
"
589 echo "3. Login OSM GUI by using admin password
: $OSM_PASSWORD"