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.22
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}
32 OSM_HA_BUNDLE
=ch
:osm-ha
33 CHARMHUB_CHANNEL
=latest
/edge
36 function check_arguments
(){
37 while [ $# -gt 0 ] ; do
39 --bundle) BUNDLE
="$2" ;;
40 --overlay) OVERLAY
="$2" ;;
41 --k8s) KUBECFG
="$2" ;;
42 --vca) CONTROLLER
="$2" ;;
43 --lxd) LXD_CLOUD
="$2" ;;
44 --lxd-cred) LXD_CREDENTIALS
="$2" ;;
45 --microstack) MICROSTACK
=y
;;
46 --ha) BUNDLE
=$OSM_HA_BUNDLE ;;
48 --registry) REGISTRY_INFO
="$2" ;;
49 --only-vca) ONLY_VCA
=y
;;
54 # echo $BUNDLE $KUBECONFIG $LXDENDPOINT
57 function install_snaps
(){
58 if [ ! -v KUBECFG
]; then
59 sudo snap
install microk8s
--classic --channel=${MICROK8S_VERSION}/stable
60 sudo
cat /var
/snap
/microk8s
/current
/args
/kube-apiserver |
grep advertise-address ||
(
61 echo "--advertise-address $DEFAULT_IP" | sudo
tee -a /var
/snap
/microk8s
/current
/args
/kube-apiserver
65 sudo usermod
-a -G microk8s
`whoami`
67 sudo chown
-f -R `whoami` ~
/.kube
69 sg
${KUBEGRP} -c "microk8s status --wait-ready"
70 KUBECONFIG
=~
/.osm
/microk8s-config.yaml
71 sg
${KUBEGRP} -c "microk8s config" |
tee ${KUBECONFIG}
74 sudo snap
install kubectl
--classic
75 export KUBECONFIG
=${KUBECFG}
78 sudo snap
install juju
--classic --channel=$JUJU_VERSION/stable
81 function bootstrap_k8s_lxd
(){
82 [ -v CONTROLLER
] && ADD_K8S_OPTS
="--controller ${CONTROLLER}" && CONTROLLER_NAME
=$CONTROLLER
83 [ ! -v CONTROLLER
] && ADD_K8S_OPTS
="--client" && BOOTSTRAP_NEEDED
="yes" && CONTROLLER_NAME
="osm-vca"
85 if [ -v BOOTSTRAP_NEEDED
]; then
86 CONTROLLER_PRESENT
=$
(juju controllers
2>/dev
/null|
grep ${CONTROLLER_NAME} |
wc -l)
87 if [ $CONTROLLER_PRESENT -ge 1 ]; then
89 Threre is already a VCA present with the installer reserved name of "${CONTROLLER_NAME}".
90 You may either explicitly use this VCA with the "--vca ${CONTROLLER_NAME}" option, or remove it
93 juju destroy-controller --release-storage --destroy-all-models -y ${CONTROLLER_NAME}
95 Please retry the installation once this conflict has been resolved.
100 CONTROLLER_PRESENT
=$
(juju controllers
2>/dev
/null|
grep ${CONTROLLER_NAME} |
wc -l)
101 if [ $CONTROLLER_PRESENT -le 0 ]; then
103 Threre is no VCA present with the name "${CONTROLLER_NAME}". Please specify a VCA
104 that exists, or remove the --vca ${CONTROLLER_NAME} option.
106 Please retry the installation with one of the solutions applied.
112 if [ -v KUBECFG
]; then
113 cat $KUBECFG | juju add-k8s
$K8S_CLOUD_NAME $ADD_K8S_OPTS
114 [ -v BOOTSTRAP_NEEDED
] && juju bootstrap
$K8S_CLOUD_NAME $CONTROLLER_NAME \
115 --config controller-service-type
=loadbalancer \
116 --agent-version=$JUJU_AGENT_VERSION
118 sg
${KUBEGRP} -c "echo ${DEFAULT_IP}-${DEFAULT_IP} | microk8s.
enable metallb
"
119 sg ${KUBEGRP} -c "microk8s.
enable ingress
"
120 sg ${KUBEGRP} -c "microk8s.
enable storage dns
"
122 start_time="$
(date -u +%s
)"
126 if [[ $(( now - start_time )) -gt $TIME_TO_WAIT ]];then
127 echo "Microk8s storage failed to
enable"
128 sg ${KUBEGRP} -c "microk8s.status
"
131 storage_status=`sg ${KUBEGRP} -c "microk8s.status
-a storage
"`
132 if [[ $storage_status == "enabled
" ]]; then
138 [ ! -v BOOTSTRAP_NEEDED ] && sg ${KUBEGRP} -c "microk8s.config
" | juju add-k8s $K8S_CLOUD_NAME $ADD_K8S_OPTS
139 [ -v BOOTSTRAP_NEEDED ] && sg ${KUBEGRP} -c \
140 "juju bootstrap microk8s
$CONTROLLER_NAME --config controller-service-type
=loadbalancer
--agent-version=$JUJU_AGENT_VERSION" \
141 && K8S_CLOUD_NAME=microk8s
144 if [ -v LXD_CLOUD ]; then
145 if [ ! -v LXD_CREDENTIALS ]; then
146 echo "The installer needs the LXD server certificate
if the LXD is external
"
150 LXDENDPOINT=$DEFAULT_IP
151 LXD_CLOUD=~/.osm/lxd-cloud.yaml
152 LXD_CREDENTIALS=~/.osm/lxd-credentials.yaml
153 # Apply sysctl production values for optimal performance
154 sudo cp /usr/share/osm-devops/installers/60-lxd-production.conf /etc/sysctl.d/60-lxd-production.conf
157 sudo apt-get remove --purge -y liblxc1 lxc-common lxcfs lxd lxd-client
158 sudo snap install lxd --channel $LXD_VERSION/stable
160 sudo usermod -a -G lxd `whoami`
161 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"
162 sg lxd -c "lxd waitready
"
163 DEFAULT_MTU=$(ip addr show $DEFAULT_IF | perl -ne 'if (/mtu\s(\d+)/) {print $1;}')
164 sg lxd -c "lxc profile device
set default eth0 mtu
$DEFAULT_MTU"
165 sg lxd -c "lxc network
set lxdbr0 bridge.mtu
$DEFAULT_MTU"
167 cat << EOF > $LXD_CLOUD
171 auth-types: [certificate]
172 endpoint: "https
://$LXDENDPOINT:8443"
174 ssl-hostname-verification: false
176 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
"
177 local server_cert=`cat /var/snap/lxd/common/lxd/server.crt | sed 's/^/ /'`
178 local client_cert=`cat ~/.osm/client.crt | sed 's/^/ /'`
179 local client_key=`cat ~/.osm/client.key | sed 's/^/ /'`
181 cat << EOF > $LXD_CREDENTIALS
185 auth-type: certificate
193 lxc config trust add local: ~/.osm/client.crt
196 juju add-cloud -c $CONTROLLER_NAME lxd-cloud $LXD_CLOUD --force
197 juju add-credential -c $CONTROLLER_NAME lxd-cloud -f $LXD_CREDENTIALS
198 sg lxd -c "lxd waitready
"
199 juju controller-config features=[k8s-operators]
202 function wait_for_port(){
206 start_time="$
(date -u +%s
)"
210 if [[ $(( now - start_time )) -gt $TIME_TO_WAIT ]];then
211 echo "Failed to expose external
${SERVICE} interface port
"
215 if [ $(sg ${KUBEGRP} -c "${KUBECTL} get ingresses.networking -n osm -o json | jq -r '.items[$INDEX].metadata.name'") == ${SERVICE} ] ; then
222 function deploy_charmed_osm(){
223 if [ -v REGISTRY_INFO ] ; then
224 registry_parts=(${REGISTRY_INFO//@/ })
225 if [ ${#registry_parts[@]} -eq 1 ] ; then
226 # No credentials supplied
229 REGISTRY_URL=${registry_parts[0]}
231 credentials=${registry_parts[0]}
232 credential_parts=(${credentials//:/ })
233 REGISTRY_USERNAME=${credential_parts[0]}
234 REGISTRY_PASSWORD=${credential_parts[1]}
235 REGISTRY_URL=${registry_parts[1]}
237 # Ensure the URL ends with a /
238 case $REGISTRY_URL in
240 *) REGISTRY_URL=${REGISTRY_URL}/
244 echo "Creating OSM model
"
245 if [ -v KUBECFG ]; then
246 juju add-model $MODEL_NAME $K8S_CLOUD_NAME
248 sg ${KUBEGRP} -c "juju add-model
$MODEL_NAME $K8S_CLOUD_NAME"
250 echo "Deploying OSM with charms
"
252 if [ -v REGISTRY_URL ]; then
253 [ ! -v TAG ] && TAG='latest'
255 [ -v TAG ] && generate_images_overlay && images_overlay="--overlay $IMAGES_OVERLAY_FILE"
257 if [ -v OVERLAY ]; then
258 extra_overlay="--overlay $OVERLAY"
260 echo "Creating Password Overlay
"
262 generate_password_overlay && secret_overlay="--overlay $PASSWORD_OVERLAY_FILE"
264 if [ -v BUNDLE ]; then
265 juju deploy --trust --channel $CHARMHUB_CHANNEL -m $MODEL_NAME $BUNDLE --overlay ~/.osm/vca-overlay.yaml $images_overlay $extra_overlay $secret_overlay
267 juju deploy --trust --channel $CHARMHUB_CHANNEL -m $MODEL_NAME $OSM_BUNDLE --overlay ~/.osm/vca-overlay.yaml $images_overlay $extra_overlay $secret_overlay
270 if [ ! -v KUBECFG ]; then
271 API_SERVER=${DEFAULT_IP}
273 API_SERVER=$(kubectl config view --minify | grep server | cut -f 2- -d ":" | tr -d " ")
274 proto="$
(echo $API_SERVER |
grep :// |
sed -e's,^\(.*://\).*,\1,g')"
275 url="$
(echo ${API_SERVER/$proto/})"
276 user="$
(echo $url |
grep @ | cut
-d@
-f1)"
277 hostport="$
(echo ${url/$user@/} | cut
-d/ -f1)"
278 API_SERVER="$
(echo $hostport |
sed -e 's,:.*,,g')"
280 # Expose OSM services
281 juju config -m $MODEL_NAME nbi site_url=https://nbi.${API_SERVER}.nip.io
282 juju config -m $MODEL_NAME ng-ui site_url=https://ui.${API_SERVER}.nip.io
283 juju config -m $MODEL_NAME grafana site_url=https://grafana.${API_SERVER}.nip.io
284 juju config -m $MODEL_NAME prometheus site_url=https://prometheus.${API_SERVER}.nip.io
286 echo "Waiting
for deployment to finish...
"
288 grafana_leader=`juju status -m $MODEL_NAME grafana | grep "*" | cut -d "*" -f 1`
289 grafana_admin_password=`juju run -m $MODEL_NAME --unit $grafana_leader "echo \\$GF_SECURITY_ADMIN_PASSWORD"`
290 juju config -m $MODEL_NAME mon grafana_password=$grafana_admin_password
292 echo "OSM with charms deployed
"
295 function check_osm_deployed() {
297 start_time="$
(date -u +%s
)"
298 total_service_count=14
302 service_count=$(juju status -m $MODEL_NAME | grep kubernetes | grep active | wc -l)
303 echo "$service_count / $total_service_count services active
"
304 if [ $service_count -eq $total_service_count ]; then
307 if [ $service_count -ne $previous_count ]; then
308 previous_count=$service_count
309 start_time="$
(date -u +%s
)"
312 if [[ $(( now - start_time )) -gt $TIME_TO_WAIT ]];then
313 echo "Timed out waiting
for OSM services to become ready
"
320 function generate_password_overlay() {
322 web_config_password=`openssl rand -base64 16`
324 keystone_db_password=`openssl rand -base64 16`
325 keystone_admin_password=`openssl rand -base64 16`
326 keystone_service_password=`openssl rand -base64 16`
328 mariadb_password=`openssl rand -hex 16`
329 mariadb_root_password=`openssl rand -hex 16`
330 cat << EOF > /tmp/password-overlay.yaml
334 web_config_password: $web_config_password
337 keystone-db-password: $keystone_db_password
338 admin-password: $keystone_admin_password
339 service-password: $keystone_service_password
342 password: $mariadb_password
343 root_password: $mariadb_root_password
345 mv /tmp/password-overlay.yaml $PASSWORD_OVERLAY_FILE
348 function create_overlay() {
351 local HOME=/home/$USER
352 local vca_user=$(cat $HOME/.local/share/juju/accounts.yaml | yq e .controllers.$CONTROLLER_NAME.user - )
353 local vca_secret=$(cat $HOME/.local/share/juju/accounts.yaml | yq e .controllers.$CONTROLLER_NAME.password - )
354 local vca_host=$(cat $HOME/.local/share/juju/controllers.yaml | yq e .controllers.$CONTROLLER_NAME.api-endpoints[0] - | cut -d ":" -f 1)
355 local vca_port=$(cat $HOME/.local/share/juju/controllers.yaml | yq e .controllers.$CONTROLLER_NAME.api-endpoints[0] - | cut -d ":" -f 2)
356 local vca_pubkey=\"$(cat $HOME/.local/share/juju/ssh/juju_id_rsa.pub)\"
357 local vca_cloud="lxd-cloud
"
358 # Get the VCA Certificate
359 local vca_cacert=$(cat $HOME/.local/share/juju/controllers.yaml | yq e .controllers.$CONTROLLER_NAME.ca-cert - | base64 | tr -d \\n)
361 # Calculate the default route of this machine
362 local DEFAULT_IF=`ip route list match 0.0.0.0 | awk '{print $5}'`
364 # Generate a new overlay.yaml, overriding any existing one
365 cat << EOF > /tmp/vca-overlay.yaml
370 vca_secret: $vca_secret
373 vca_pubkey: $vca_pubkey
374 vca_cacert: $vca_cacert
375 vca_cloud: $vca_cloud
376 vca_k8s_cloud: $K8S_CLOUD_NAME
380 vca_secret: $vca_secret
382 vca_cacert: $vca_cacert
384 mv /tmp/vca-overlay.yaml ~/.osm/
385 OSM_VCA_HOST=$vca_host
388 function generate_images_overlay(){
389 echo "applications
:" > /tmp/images-overlay.yaml
391 charms_with_resources="nbi lcm mon pol ng-ui ro pla
"
392 for charm in $charms_with_resources; do
393 cat << EOF > /tmp/${charm}_registry.yaml
394 registrypath: ${REGISTRY_URL}opensourcemano/${charm}:$TAG
396 if [ ! -z "$REGISTRY_USERNAME" ] ; then
397 echo username: $REGISTRY_USERNAME >> /tmp/${charm}_registry.yaml
398 echo password: $REGISTRY_PASSWORD >> /tmp/${charm}_registry.yaml
401 cat << EOF >> /tmp/images-overlay.yaml
404 image: /tmp/${charm}_registry.yaml
408 ch_charms_with_resources="keystone
"
409 for charm in $ch_charms_with_resources; do
410 cat << EOF > /tmp/${charm}_registry.yaml
411 registrypath: ${REGISTRY_URL}opensourcemano/${charm}:$TAG
413 if [ ! -z "$REGISTRY_USERNAME" ] ; then
414 echo username: $REGISTRY_USERNAME >> /tmp/${charm}_registry.yaml
415 echo password: $REGISTRY_PASSWORD >> /tmp/${charm}_registry.yaml
418 cat << EOF >> /tmp/images-overlay.yaml
421 ${charm}-image: /tmp/${charm}_registry.yaml
426 mv /tmp/images-overlay.yaml $IMAGES_OVERLAY_FILE
429 function refresh_osmclient_snap() {
430 osmclient_snap_install_refresh refresh
433 function install_osm_client_snap() {
434 osmclient_snap_install_refresh install
437 function osmclient_snap_install_refresh() {
438 channel_preference="stable candidate beta edge
"
439 for channel in $channel_preference; do
440 echo "Trying to
install osmclient from channel
$OSMCLIENT_VERSION/$channel"
441 sudo snap $1 osmclient --channel $OSMCLIENT_VERSION/$channel 2> /dev/null && echo osmclient snap installed && break
444 function install_osmclient() {
445 snap info osmclient | grep -E ^installed: && refresh_osmclient_snap || install_osm_client_snap
448 function add_local_k8scluster() {
449 osm --all-projects vim-create \
450 --name _system-osm-vim \
451 --account_type dummy \
452 --auth_url http://dummy \
453 --user osm --password osm --tenant osm \
454 --description "dummy
" \
455 --config '{management_network_name: mgmt}'
456 tmpfile=$(mktemp --tmpdir=${HOME})
457 cp ${KUBECONFIG} ${tmpfile}
458 osm --all-projects k8scluster-add \
460 --vim _system-osm-vim \
461 --k8s-nets '{"net1
": null}' \
463 --description "OSM Internal Cluster
" \
468 function install_microstack() {
470 sudo snap install microstack --beta --devmode
472 CHECK=$(microstack.openstack server list)
473 if [ $? -ne 0 ] ; then
474 if [[ $CHECK == *"not initialized
"* ]]; then
475 echo "Setting MicroStack dashboard to listen to port
8080"
476 sudo snap set microstack config.network.ports.dashboard=8080
477 echo "Initializing MicroStack. This can take several minutes
"
478 sudo microstack.init --auto --control
482 sudo snap alias microstack.openstack openstack
484 echo "Updating default security group
in MicroStack to allow all access
"
486 for i in $(microstack.openstack security group list | awk '/default/{ print $2 }'); do
487 for PROTO in icmp tcp udp ; do
488 echo " $PROTO ingress
"
489 CHECK=$(microstack.openstack security group rule create $i --protocol $PROTO --remote-ip 0.0.0.0/0 2>&1)
490 if [ $? -ne 0 ] ; then
491 if [[ $CHECK != *"409"* ]]; then
492 echo "Error creating ingress rule
for $PROTO"
499 microstack.openstack network show osm-ext &>/dev/null
500 if [ $? -ne 0 ]; then
501 echo "Creating osm-ext network with router to bridge to MicroStack external network
"
502 microstack.openstack network create --enable --no-share osm-ext
503 microstack.openstack subnet create osm-ext-subnet --network osm-ext --dns-nameserver 8.8.8.8 \
504 --subnet-range 172.30.0.0/24
505 microstack.openstack router create external-router
506 microstack.openstack router add subnet external-router osm-ext-subnet
507 microstack.openstack router set --external-gateway external external-router
510 microstack.openstack image list | grep ubuntu20.04 &> /dev/null
511 if [ $? -ne 0 ] ; then
512 echo "Fetching Ubuntu
20.04 image and upLoading to MicroStack
"
513 wget -q -O- https://cloud-images.ubuntu.com/focal/current/focal-server-cloudimg-amd64.img \
514 | microstack.openstack image create --public --container-format=bare \
515 --disk-format=qcow2 ubuntu20.04 | grep status
518 if [ ! -f ~/.ssh/microstack ]; then
519 ssh-keygen -t rsa -N "" -f ~/.ssh/microstack
520 microstack.openstack keypair create --public-key ~/.ssh/microstack.pub microstack
523 echo "Creating VIM microstack-site
in OSM
"
524 . /var/snap/microstack/common/etc/microstack.rc
527 --name microstack-site \
528 --user "$OS_USERNAME" \
529 --password "$OS_PASSWORD" \
530 --auth_url "$OS_AUTH_URL" \
531 --tenant "$OS_USERNAME" \
532 --account_type openstack \
533 --config='{use_floating_ip: True,
536 management_network_name: osm-ext}'
539 DEFAULT_IF=`ip route list match 0.0.0.0 | awk '{print $5; exit}'`
540 DEFAULT_IP=`ip -o -4 a |grep ${DEFAULT_IF}|awk '{split($4,a,"/"); print a[1]; exit}'`
547 if [ -v ONLY_VCA ]; then
549 vca_user=$(cat $HOME/.local/share/juju/accounts.yaml | yq e .controllers.$CONTROLLER_NAME.user - )
550 vca_secret=$(cat $HOME/.local/share/juju/accounts.yaml | yq e .controllers.$CONTROLLER_NAME.password - )
551 vca_host=$(cat $HOME/.local/share/juju/controllers.yaml | yq e .controllers.$CONTROLLER_NAME.api-endpoints[0] - | cut -d ":" -f 1)
552 vca_port=$(cat $HOME/.local/share/juju/controllers.yaml | yq e .controllers.$CONTROLLER_NAME.api-endpoints[0] - | cut -d ":" -f 2)
553 vca_pubkey=\"$(cat $HOME/.local/share/juju/ssh/juju_id_rsa.pub)\"
554 vca_cloud="lxd-cloud
"
555 vca_cacert=$(cat $HOME/.local/share/juju/controllers.yaml | yq e .controllers.$CONTROLLER_NAME.ca-cert - | base64 | tr -d \\n)
556 hostname=`cat /etc/hostname`
558 echo "Use the following
command to register the installed VCA to your OSM
:"
559 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"
563 export OSM_HOSTNAME=$(juju config -m $MODEL_NAME nbi site_url | sed "s
/http.
*\?:\
/\
///"):443
564 export OSM_PASSWORD=$keystone_admin_password
567 if [ -v MICROSTACK ]; then
571 echo "Your installation is now complete
, follow these steps
for configuring the osmclient
:"
573 echo "1. Create the OSM_HOSTNAME environment variable with the NBI IP
"
575 echo "export OSM_HOSTNAME
=$OSM_HOSTNAME"
576 echo "export OSM_PASSWORD
=$OSM_PASSWORD"
578 echo "2. Add the previous commands to your .bashrc
for other Shell sessions
"
580 echo "echo \"export OSM_HOSTNAME
=$OSM_HOSTNAME\" >> ~
/.bashrc
"
581 echo "echo \"export OSM_PASSWORD
=$OSM_PASSWORD\" >> ~
/.bashrc
"
583 echo "3. Login OSM GUI by using admin password
: $OSM_PASSWORD"