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.34
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
/edge
/paas
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 sudo
cat /var
/snap
/microk8s
/current
/args
/kube-apiserver |
grep advertise-address ||
(
80 echo "--advertise-address $DEFAULT_IP" | sudo
tee -a /var
/snap
/microk8s
/current
/args
/kube-apiserver
81 sg
${KUBEGRP} -c microk8s.stop
82 sg
${KUBEGRP} -c microk8s.start
85 sudo chown
-f -R `whoami` ~
/.kube
86 sg
${KUBEGRP} -c "microk8s status --wait-ready"
87 KUBECONFIG
=~
/.osm
/microk8s-config.yaml
88 sg
${KUBEGRP} -c "microk8s config" |
tee ${KUBECONFIG}
89 track k8scluster k8scluster_ok
92 sudo snap
install kubectl
--classic
93 export KUBECONFIG
=${KUBECFG}
96 sudo snap
install juju
--classic --channel=$JUJU_VERSION/stable ||
97 FATAL_TRACK juju
"snap install juju ${JUJU_VERSION}/stable failed"
101 function bootstrap_k8s_lxd
(){
102 [ -v CONTROLLER
] && ADD_K8S_OPTS
="--controller ${CONTROLLER}" && CONTROLLER_NAME
=$CONTROLLER
103 [ ! -v CONTROLLER
] && ADD_K8S_OPTS
="--client" && BOOTSTRAP_NEEDED
="yes" && CONTROLLER_NAME
="osm-vca"
105 if [ -v BOOTSTRAP_NEEDED
]; then
106 CONTROLLER_PRESENT
=$
(juju controllers
2>/dev
/null|
grep ${CONTROLLER_NAME} |
wc -l)
107 if [ $CONTROLLER_PRESENT -ge 1 ]; then
109 Threre is already a VCA present with the installer reserved name of "${CONTROLLER_NAME}".
110 You may either explicitly use this VCA with the "--vca ${CONTROLLER_NAME}" option, or remove it
113 juju destroy-controller --release-storage --destroy-all-models -y ${CONTROLLER_NAME}
115 Please retry the installation once this conflict has been resolved.
117 FATAL_TRACK bootstrap_k8s
"VCA already present"
120 CONTROLLER_PRESENT
=$
(juju controllers
2>/dev
/null|
grep ${CONTROLLER_NAME} |
wc -l)
121 if [ $CONTROLLER_PRESENT -le 0 ]; then
123 Threre is no VCA present with the name "${CONTROLLER_NAME}". Please specify a VCA
124 that exists, or remove the --vca ${CONTROLLER_NAME} option.
126 Please retry the installation with one of the solutions applied.
128 FATAL_TRACK bootstrap_k8s
"Requested VCA not present"
132 if [ -v KUBECFG
]; then
133 cat $KUBECFG | juju add-k8s
$K8S_CLOUD_NAME $ADD_K8S_OPTS
134 [ -v BOOTSTRAP_NEEDED
] && juju bootstrap
$K8S_CLOUD_NAME $CONTROLLER_NAME \
135 --config controller-service-type
=loadbalancer \
136 --agent-version=$JUJU_AGENT_VERSION
138 sg
${KUBEGRP} -c "echo ${DEFAULT_IP}-${DEFAULT_IP} | microk8s.
enable metallb
"
139 sg ${KUBEGRP} -c "microk8s.
enable ingress
"
140 sg ${KUBEGRP} -c "microk8s.
enable storage dns
"
142 start_time="$
(date -u +%s
)"
146 if [[ $(( now - start_time )) -gt $TIME_TO_WAIT ]];then
147 echo "Microk8s storage failed to
enable"
148 sg ${KUBEGRP} -c "microk8s.status
"
149 FATAL_TRACK bootstrap_k8s "Microk8s storage failed to
enable"
151 storage_status=`sg ${KUBEGRP} -c "microk8s.status
-a storage
"`
152 if [[ $storage_status == "enabled
" ]]; then
158 [ ! -v BOOTSTRAP_NEEDED ] && sg ${KUBEGRP} -c "microk8s.config
" | juju add-k8s $K8S_CLOUD_NAME $ADD_K8S_OPTS
159 [ -v BOOTSTRAP_NEEDED ] && sg ${KUBEGRP} -c \
160 "juju bootstrap microk8s
$CONTROLLER_NAME --config controller-service-type
=loadbalancer
--agent-version=$JUJU_AGENT_VERSION" \
161 && K8S_CLOUD_NAME=microk8s
163 track bootstrap_k8s bootstrap_k8s_ok
165 if [ ! -v INSTALL_NOLXD ]; then
166 if [ -v LXD_CLOUD ]; then
167 if [ ! -v LXD_CREDENTIALS ]; then
168 echo "The installer needs the LXD server certificate
if the LXD is external
"
169 FATAL_TRACK bootstrap_lxd "No LXD certificate supplied
"
172 LXDENDPOINT=$DEFAULT_IP
173 LXD_CLOUD=~/.osm/lxd-cloud.yaml
174 LXD_CREDENTIALS=~/.osm/lxd-credentials.yaml
175 # Apply sysctl production values for optimal performance
176 sudo cp /usr/share/osm-devops/installers/60-lxd-production.conf /etc/sysctl.d/60-lxd-production.conf
179 sudo apt-get remove --purge -y liblxc1 lxc-common lxcfs lxd lxd-client
180 snap info lxd | grep installed > /dev/null
181 if [ $? -eq 0 ]; then
182 sudo snap refresh lxd --channel $LXD_VERSION/stable
184 sudo snap install lxd --channel $LXD_VERSION/stable
187 sudo usermod -a -G lxd `whoami`
188 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"
189 sg lxd -c "lxd waitready
"
190 DEFAULT_MTU=$(ip addr show $DEFAULT_IF | perl -ne 'if (/mtu\s(\d+)/) {print $1;}')
191 sg lxd -c "lxc profile device
set default eth0 mtu
$DEFAULT_MTU"
192 sg lxd -c "lxc network
set lxdbr0 bridge.mtu
$DEFAULT_MTU"
194 cat << EOF > $LXD_CLOUD
198 auth-types: [certificate]
199 endpoint: "https
://$LXDENDPOINT:8443"
201 ssl-hostname-verification: false
203 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
"
204 cat << EOF > $LXD_CREDENTIALS
208 auth-type: certificate
209 server-cert: /var/snap/lxd/common/lxd/server.crt
210 client-cert: ~/.osm/client.crt
211 client-key: ~/.osm/client.key
213 lxc config trust add local: ~/.osm/client.crt
216 juju add-cloud -c $CONTROLLER_NAME lxd-cloud $LXD_CLOUD --force
217 juju add-credential -c $CONTROLLER_NAME lxd-cloud -f $LXD_CREDENTIALS
218 sg lxd -c "lxd waitready
"
219 juju controller-config features=[k8s-operators]
220 track bootstrap_lxd bootstrap_lxd_ok
224 function deploy_charmed_osm(){
225 if [ -v REGISTRY_INFO ] ; then
226 registry_parts=(${REGISTRY_INFO//@/ })
227 if [ ${#registry_parts[@]} -eq 1 ] ; then
228 # No credentials supplied
231 REGISTRY_URL=${registry_parts[0]}
233 credentials=${registry_parts[0]}
234 credential_parts=(${credentials//:/ })
235 REGISTRY_USERNAME=${credential_parts[0]}
236 REGISTRY_PASSWORD=${credential_parts[1]}
237 REGISTRY_URL=${registry_parts[1]}
239 # Ensure the URL ends with a /
240 case $REGISTRY_URL in
242 *) REGISTRY_URL=${REGISTRY_URL}/
246 echo "Creating OSM model
"
247 if [ -v KUBECFG ]; then
248 juju add-model $MODEL_NAME $K8S_CLOUD_NAME
250 sg ${KUBEGRP} -c "juju add-model
$MODEL_NAME $K8S_CLOUD_NAME"
252 echo "Deploying OSM with charms
"
254 if [ -v REGISTRY_URL ]; then
255 [ ! -v TAG ] && TAG='latest'
257 [ -v TAG ] && generate_images_overlay && images_overlay="--overlay $IMAGES_OVERLAY_FILE"
259 if [ -v OVERLAY ]; then
260 extra_overlay="--overlay $OVERLAY"
262 echo "Creating Password Overlay
"
264 generate_password_overlay && secret_overlay="--overlay $PASSWORD_OVERLAY_FILE"
266 [ -n "$INSTALL_PLA" ] && create_pla_overlay && pla_overlay="--overlay $PLA_OVERLAY_FILE"
268 if [ -v BUNDLE ]; then
269 juju deploy --trust --channel $CHARMHUB_CHANNEL -m $MODEL_NAME $BUNDLE $images_overlay $extra_overlay $secret_overlay $pla_overlay
271 juju deploy --trust --channel $CHARMHUB_CHANNEL -m $MODEL_NAME $OSM_BUNDLE $images_overlay $extra_overlay $secret_overlay $pla_overlay
274 if [ ! -v KUBECFG ]; then
275 API_SERVER=${DEFAULT_IP}
277 API_SERVER=$(kubectl config view --minify | grep server | cut -f 2- -d ":" | tr -d " ")
278 proto="$
(echo $API_SERVER |
grep :// |
sed -e's,^\(.*://\).*,\1,g')"
279 url="$
(echo ${API_SERVER/$proto/})"
280 user="$
(echo $url |
grep @ | cut
-d@
-f1)"
281 hostport="$
(echo ${url/$user@/} | cut
-d/ -f1)"
282 API_SERVER="$
(echo $hostport |
sed -e 's,:.*,,g')"
284 # Configure VCA Integrator
285 if [ ! -v INSTALL_NOLXD ]; then
288 lxd-cloud=lxd-cloud:lxd-cloud \
289 controllers="`cat ~/.local/share/juju/controllers.yaml`" \
290 accounts="`cat ~/.local/share/juju/accounts.yaml`" \
291 public-key="`cat ~/.local/share/juju/ssh/juju_id_rsa.pub`"
295 controllers="`cat ~/.local/share/juju/controllers.yaml`" \
296 accounts="`cat ~/.local/share/juju/accounts.yaml`" \
297 public-key="`cat ~/.local/share/juju/ssh/juju_id_rsa.pub`"
299 # Expose OSM services
300 juju config -m $MODEL_NAME nbi external-hostname=nbi.${API_SERVER}.nip.io
301 juju config -m $MODEL_NAME ng-ui external-hostname=ui.${API_SERVER}.nip.io
302 juju config -m $MODEL_NAME grafana site_url=https://grafana.${API_SERVER}.nip.io
303 juju config -m $MODEL_NAME prometheus site_url=https://prometheus.${API_SERVER}.nip.io
305 echo "Waiting
for deployment to finish...
"
307 grafana_leader=`juju status -m $MODEL_NAME grafana | grep "*" | cut -d "*" -f 1`
308 grafana_admin_password=`juju run -m $MODEL_NAME --unit $grafana_leader "echo \\$GF_SECURITY_ADMIN_PASSWORD"`
309 juju config -m $MODEL_NAME mon grafana-password=$grafana_admin_password
311 echo "OSM with charms deployed
"
314 function check_osm_deployed() {
316 start_time="$
(date -u +%s
)"
317 total_service_count=16
318 [ -n "$INSTALL_PLA" ] && total_service_count=$((total_service_count + 1))
322 service_count=$(juju status --format json -m $MODEL_NAME | jq '.applications[]."application-status
".current' | grep active | wc -l)
323 echo "$service_count / $total_service_count services active
"
324 if [ $service_count -eq $total_service_count ]; then
327 if [ $service_count -ne $previous_count ]; then
328 previous_count=$service_count
329 start_time="$
(date -u +%s
)"
332 if [[ $(( now - start_time )) -gt $TIME_TO_WAIT ]];then
333 echo "Timed out waiting
for OSM services to become ready
"
334 FATAL_TRACK deploy_osm "Timed out waiting
for services to become ready
"
340 function generate_password_overlay() {
342 web_config_password=`openssl rand -hex 16`
344 keystone_db_password=`openssl rand -hex 16`
345 keystone_admin_password=`openssl rand -hex 16`
346 keystone_service_password=`openssl rand -hex 16`
348 mariadb_password=`openssl rand -hex 16`
349 mariadb_root_password=`openssl rand -hex 16`
350 cat << EOF > /tmp/password-overlay.yaml
354 web_config_password: $web_config_password
357 keystone-db-password: $keystone_db_password
358 admin-password: $keystone_admin_password
359 service-password: $keystone_service_password
362 password: $mariadb_password
363 root_password: $mariadb_root_password
365 mv /tmp/password-overlay.yaml $PASSWORD_OVERLAY_FILE
368 function create_pla_overlay(){
369 echo "Creating PLA Overlay
"
370 [ $BUNDLE == $OSM_HA_BUNDLE ] && scale=3 || scale=1
371 cat << EOF > /tmp/pla-overlay.yaml
375 channel: latest/stable
381 image: opensourcemano/pla:testing-daily
388 mv /tmp/pla-overlay.yaml $PLA_OVERLAY_FILE
391 function generate_images_overlay(){
392 echo "applications
:" > /tmp/images-overlay.yaml
394 charms_with_resources="nbi lcm mon pol ng-ui ro
"
395 [ -n "$INSTALL_PLA" ] && charms_with_resources+=" pla
"
396 for charm in $charms_with_resources; do
397 cat << EOF > /tmp/${charm}_registry.yaml
398 registrypath: ${REGISTRY_URL}opensourcemano/${charm}:$TAG
400 if [ ! -z "$REGISTRY_USERNAME" ] ; then
401 echo username: $REGISTRY_USERNAME >> /tmp/${charm}_registry.yaml
402 echo password: $REGISTRY_PASSWORD >> /tmp/${charm}_registry.yaml
405 cat << EOF >> /tmp/images-overlay.yaml
408 ${charm}-image: /tmp/${charm}_registry.yaml
412 ch_charms_with_resources="keystone
"
413 for charm in $ch_charms_with_resources; do
414 cat << EOF > /tmp/${charm}_registry.yaml
415 registrypath: ${REGISTRY_URL}opensourcemano/${charm}:$TAG
417 if [ ! -z "$REGISTRY_USERNAME" ] ; then
418 echo username: $REGISTRY_USERNAME >> /tmp/${charm}_registry.yaml
419 echo password: $REGISTRY_PASSWORD >> /tmp/${charm}_registry.yaml
422 cat << EOF >> /tmp/images-overlay.yaml
425 ${charm}-image: /tmp/${charm}_registry.yaml
430 mv /tmp/images-overlay.yaml $IMAGES_OVERLAY_FILE
433 function refresh_osmclient_snap() {
434 osmclient_snap_install_refresh refresh
437 function install_osm_client_snap() {
438 osmclient_snap_install_refresh install
441 function osmclient_snap_install_refresh() {
442 channel_preference="stable candidate beta edge
"
443 for channel in $channel_preference; do
444 echo "Trying to
install osmclient from channel
$OSMCLIENT_VERSION/$channel"
445 sudo snap $1 osmclient --channel $OSMCLIENT_VERSION/$channel 2> /dev/null && echo osmclient snap installed && break
448 function install_osmclient() {
449 snap info osmclient | grep -E ^installed: && refresh_osmclient_snap || install_osm_client_snap
452 function add_local_k8scluster() {
453 osm --all-projects vim-create \
454 --name _system-osm-vim \
455 --account_type dummy \
456 --auth_url http://dummy \
457 --user osm --password osm --tenant osm \
458 --description "dummy
" \
459 --config '{management_network_name: mgmt}'
460 tmpfile=$(mktemp --tmpdir=${HOME})
461 cp ${KUBECONFIG} ${tmpfile}
462 osm --all-projects k8scluster-add \
464 --vim _system-osm-vim \
465 --k8s-nets '{"net1
": null}' \
467 --description "OSM Internal Cluster
" \
472 function install_microstack() {
473 sudo snap install microstack --beta --devmode
475 CHECK=$(microstack.openstack server list)
476 if [ $? -ne 0 ] ; then
477 if [[ $CHECK == *"not initialized
"* ]]; then
478 echo "Setting MicroStack dashboard to listen to port
8080"
479 sudo snap set microstack config.network.ports.dashboard=8080
480 echo "Initializing MicroStack. This can take several minutes
"
481 sudo microstack.init --auto --control
485 sudo snap alias microstack.openstack openstack
487 echo "Updating default security group
in MicroStack to allow all access
"
489 for i in $(microstack.openstack security group list | awk '/default/{ print $2 }'); do
490 for PROTO in icmp tcp udp ; do
491 echo " $PROTO ingress
"
492 CHECK=$(microstack.openstack security group rule create $i --protocol $PROTO --remote-ip 0.0.0.0/0 2>&1)
493 if [ $? -ne 0 ] ; then
494 if [[ $CHECK != *"409"* ]]; then
495 echo "Error creating ingress rule
for $PROTO"
502 microstack.openstack network show osm-ext &>/dev/null
503 if [ $? -ne 0 ]; then
504 echo "Creating osm-ext network with router to bridge to MicroStack external network
"
505 microstack.openstack network create --enable --no-share osm-ext
506 microstack.openstack subnet create osm-ext-subnet --network osm-ext --dns-nameserver 8.8.8.8 \
507 --subnet-range 172.30.0.0/24
508 microstack.openstack router create external-router
509 microstack.openstack router add subnet external-router osm-ext-subnet
510 microstack.openstack router set --external-gateway external external-router
513 microstack.openstack image list | grep ubuntu20.04 &> /dev/null
514 if [ $? -ne 0 ] ; then
515 echo "Fetching Ubuntu
20.04 image and upLoading to MicroStack
"
516 wget -q -O- https://cloud-images.ubuntu.com/focal/current/focal-server-cloudimg-amd64.img \
517 | microstack.openstack image create --public --container-format=bare \
518 --disk-format=qcow2 ubuntu20.04 | grep status
521 if [ ! -f ~/.ssh/microstack ]; then
522 ssh-keygen -t rsa -N "" -f ~/.ssh/microstack
523 microstack.openstack keypair create --public-key ~/.ssh/microstack.pub microstack
526 echo "Creating VIM microstack-site
in OSM
"
527 . /var/snap/microstack/common/etc/microstack.rc
530 --name microstack-site \
531 --user "$OS_USERNAME" \
532 --password "$OS_PASSWORD" \
533 --auth_url "$OS_AUTH_URL" \
534 --tenant "$OS_USERNAME" \
535 --account_type openstack \
536 --config='{use_floating_ip: True,
539 management_network_name: osm-ext}'
542 DEFAULT_IF=`ip route list match 0.0.0.0 | awk '{print $5; exit}'`
543 DEFAULT_IP=`ip -o -4 a |grep ${DEFAULT_IF}|awk '{split($4,a,"/"); print a[1]; exit}'`
549 if [ -v ONLY_VCA ]; then
552 lxdcloud=lxd-cloud:lxd-cloud
553 controllers="`cat $HOME/.local/share/juju/controllers.yaml`"
554 accounts="`cat $HOME/.local/share/juju/accounts.yaml`"
555 publickey="`cat $HOME/.local/share/juju/ssh/juju_id_rsa.pub`"
556 echo "Use the following
command to register the installed VCA to your OSM VCA integrator charm
"
557 echo -e " juju config vca
\\\n k8s-cloud
=$k8scloud \\\n lxd-cloud
=$lxdcloud \\\n controllers
=$controllers \\\n accounts
=$accounts \\\n public-key
=$publickey"
558 track deploy_osm deploy_vca_only_ok
561 track deploy_osm deploy_osm_services_k8s_ok
563 track osmclient osmclient_ok
564 export OSM_HOSTNAME=$(juju config -m $MODEL_NAME nbi external-hostname):443
565 export OSM_PASSWORD=$keystone_admin_password
568 track final_ops add_local_k8scluster_ok
569 if [ -v MICROSTACK ]; then
571 track final_ops install_microstack_ok
574 echo "Your installation is now complete
, follow these steps
for configuring the osmclient
:"
576 echo "1. Create the OSM_HOSTNAME environment variable with the NBI IP
"
578 echo "export OSM_HOSTNAME
=$OSM_HOSTNAME"
579 echo "export OSM_PASSWORD
=$OSM_PASSWORD"
581 echo "2. Add the previous commands to your .bashrc
for other Shell sessions
"
583 echo "echo \"export OSM_HOSTNAME
=$OSM_HOSTNAME\" >> ~
/.bashrc
"
584 echo "echo \"export OSM_PASSWORD
=$OSM_PASSWORD\" >> ~
/.bashrc
"
586 echo "3. Login OSM GUI by using admin password
: $OSM_PASSWORD"