github/acrn-hypervisor
1
0
Fork 0
mirror of https://github.com/projectacrn/acrn-hypervisor.git synced 2025-06-03 04:39:50 +00:00
Code Issues Projects Releases Wiki Activity

Clean up language in the acrn_quick_setup script.

Browse Source 
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
This commit is contained in:
Deb Taylor 2019-11-06 19:56:43 -05:00 committed by deb-intel
parent 20c1ad1b3a
commit e68326dbe5
1 changed files with 56 additions and 56 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

112
doc/getting-started/acrn_quick_setup.sh
View File

@ -3,50 +3,50 @@
# SPDX-License-Identifier: BSD-3-Clause # SPDX-License-Identifier: BSD-3-Clause
# #
# This script provides a quick and automatic setup of the Service VM or User VM. # This script provides a quick and automatic setup of the Service VM or User VM.
# You should run this script with root privilege since it will modify various system parameters. # Run this script with root privilege since it will modify various system parameters.
# #
# Usages: # Usages:
# Upgrade Service VM to 31080 without reboot, it's highly recommended so that you can check configurations after upgrade Service VM. # Upgrade Service VM to 31080 without reboot; this is highly recommended so that you can check configurations after the upgrade Service VM.
# sudo <script> -s 31080 -d # sudo <script> -s 31080 -d
# Upgrade Service VM to 31080 with specified proxy server # Upgrade Service VM to 31080 with the specified proxy server
# sudo <script> -s 31080 -p <your proxy server>:<port> # sudo <script> -s 31080 -p <your proxy server>:<port>
# Upgrade User VM to 31080 with specified proxy server # Upgrade User VM to 31080 with the specified proxy server
# sudo <script> -u 31080 -p <your proxy server>:<port> # sudo <script> -u 31080 -p <your proxy server>:<port>
# Upgrade User VM to 31080 without downloading User VM image, you should put User VM image in /root directory previously. # Upgrade User VM to 31080 without downloading the User VM image; you should put the User VM image in the /root directory previously.
# sudo <script> -u 31080 -k # sudo <script> -u 31080 -k
function print_help() function print_help()
{ {
echo "Usage:" echo "Usage:"
echo "Launch this script as: sudo $0 -s 31470" echo "Launch this script as: sudo $0 -s 31470"
echo -e "\t-s to upgrade Service VM" echo -e "\t-s to upgrade the Service VM"
echo -e "\t-u to upgrade User VM" echo -e "\t-u to upgrade the User VM"
echo -e "\t-p to specify a proxy server (HTTPS)" echo -e "\t-p to specify a proxy server (HTTPS)"
echo -e "\t-m to use swupd mirror url" echo -e "\t-m to use the swupd mirror url"
echo -e "\t-k to skip downloading User VM; if enabled, you have to download User VM img firstly before upgrading, default is off" echo -e "\t-k to skip downloading the User VM; if enabled, you must download the User VM image before you upgrade. Default is off"
echo -e "\t-d to disable reboot device so that you can check the configurations after upgrading Service VM" echo -e "\t-d to disable the reboot device so that you can check configurations after you upgrade the Service VM"
echo -e "\t-i to set up Service VM with industry scenario" echo -e "\t-i to set up the Service VM with the industry scenario"
echo -e "\t-e to specify EFI System Partition (ESP), default: /dev/sda1" echo -e "\t-e to specify the EFI System Partition (ESP); default: /dev/sda1"
echo -e "\n\t<Note>:" echo -e "\n\t<Note>:"
echo -e "\tThis script is using /dev/sda1 as default EFI System Partition (ESP)." echo -e "\tThis script is using /dev/sda1 as the default EFI System Partition (ESP)."
echo -e "\tThe ESP may be different based on your hardware and then you should specify it directly with '-e' option." echo -e "\tThe ESP may be different based on your hardware; in this case, specify it directly with the '-e' option."
echo -e "\tIt will typically be something like /dev/mmcblk0p1 on platforms that have an on-board eMMC" echo -e "\tThis will typically be something like /dev/mmcblk0p1 on platforms that have an on-board eMMC"
echo -e "\tOr /dev/nvme0n1p1 if your system has a non-volatile storage media attached via a PCI Express (PCIe) bus (NVMe)." echo -e "\tOr /dev/nvme0n1p1 if your system has a non-volatile storage media attached via a PCI Express (PCIe) bus (NVMe)."
exit 1 exit 1
} }
# get clear linux version previously # get the previous Clear Linux version
source /etc/os-release source /etc/os-release
# switcher for download User VM function # switcher for downloading the User VM function
skip_download_uos=0 skip_download_uos=0
# switcher for disabling reboot device # switcher for disabling the reboot device
disable_reboot=0 disable_reboot=0
function upgrade_sos() function upgrade_sos()
{ {
# Check Service VM version # Check Service VM version
[[ `echo $sos_ver | awk '{print length($0)}'` -ne 5 ]] && echo "Please input right Service VM version to upgrade" && exit 1 [[ `echo $sos_ver | awk '{print length($0)}'` -ne 5 ]] && echo "Input the correct Service VM version to which to upgrade" && exit 1
[[ $VERSION_ID -gt $sos_ver ]] && echo "You're trying to install an older version of Clear Linux." && exit 1 [[ $VERSION_ID -gt $sos_ver ]] && echo "You are attempting to install an older version of Clear Linux." && exit 1
echo "Upgrading Service VM..." echo "Upgrading Service VM..."
@ -58,22 +58,22 @@ function upgrade_sos()
# set default scenario name # set default scenario name
scenario=sdc scenario=sdc
# setup mirror and proxy url while specified with m and p options # set up mirror and proxy url while specified with m and p options
[[ -n $mirror ]] && echo "Setting swupd mirror to: $mirror" && swupd mirror -s $mirror [[ -n $mirror ]] && echo "Setting swupd mirror to: $mirror" && swupd mirror -s $mirror
[[ -n $proxy ]] && echo "Setting proxy to: $proxy" && export https_proxy=$proxy [[ -n $proxy ]] && echo "Setting proxy to: $proxy" && export https_proxy=$proxy
# Check EFI path exists. # Check that the EFI path exists.
[[ ! -b $efi_partition ]] && echo "Please set the right EFI System partition firstly." && exit 1 [[ ! -b $efi_partition ]] && echo "Set the right EFI System partition first." && exit 1
partition=`echo $efi_partition | sed 's/1$//g;s/p$//g'` partition=`echo $efi_partition | sed 's/1$//g;s/p$//g'`
echo "Disable auto update..." echo "Disable auto update..."
swupd autoupdate --disable 2>/dev/null swupd autoupdate --disable 2>/dev/null
# Compare with current clear linux and skip upgrade Service VM if get the same version. # Compare with the current Clear linux and skip the upgrade Service VM if you get the same version.
if [[ $VERSION_ID -eq $sos_ver ]]; then if [[ $VERSION_ID -eq $sos_ver ]]; then
echo "Clear Linux version $sos_ver is already installed. Continuing to setup Service VM..." echo "Clear Linux version $sos_ver is already installed. Continuing to set up the Service VM..."
else else
echo "Upgrading Clear Linux version from $VERSION_ID to $sos_ver ..." echo "Upgrading the Clear Linux version from $VERSION_ID to $sos_ver ..."
swupd repair --picky -V $sos_ver 2>/dev/null swupd repair --picky -V $sos_ver 2>/dev/null
fi fi
@ -104,16 +104,16 @@ function upgrade_sos()
exit 1 exit 1
fi fi
cp -a $acrn_efi_path /mnt/EFI/acrn/acrn.efi cp -a $acrn_efi_path /mnt/EFI/acrn/acrn.efi
if [[ $? -ne 0 ]]; then echo "Fail to copy $acrn_efi_path" && exit 1; fi if [[ $? -ne 0 ]]; then echo "Failed to copy $acrn_efi_path" && exit 1; fi
new_kernel=`ls /usr/lib/kernel/org*sos* -tl | head -n1 | awk -F'/' '{print $5}'` new_kernel=`ls /usr/lib/kernel/org*sos* -tl | head -n1 | awk -F'/' '{print $5}'`
echo "Getting latest Service OS kernel version: $new_kernel" echo "Getting the latest Service OS kernel version: $new_kernel"
echo "Add default (5 seconds) boot wait time." echo "Add the default (5 seconds) boot wait time."
clr-boot-manager set-timeout 5 || { echo "Fail to add default boot wait time" && exit 1; } clr-boot-manager set-timeout 5 || { echo "Failed to add the default boot wait time" && exit 1; }
clr-boot-manager update clr-boot-manager update
echo "Set $new_kernel as default boot kernel." echo "Set $new_kernel as the default boot kernel."
clr-boot-manager set-kernel $new_kernel || { echo "Fail to set $new_kernel as default boot kernel." && exit 1; } clr-boot-manager set-kernel $new_kernel || { echo "Failed to set $new_kernel as the default boot kernel." && exit 1; }
# Rename Clear-linux-iot-lts2018-sos conf to acrn.conf # Rename Clear-linux-iot-lts2018-sos conf to acrn.conf
conf_directory=/mnt/loader/entries/ conf_directory=/mnt/loader/entries/
@ -122,40 +122,40 @@ function upgrade_sos()
{ echo "${conf_directory}${conf}.conf does not exist." && exit 1; } { echo "${conf_directory}${conf}.conf does not exist." && exit 1; }
sed -i 2"s/$conf/acrn/" /mnt/loader/loader.conf sed -i 2"s/$conf/acrn/" /mnt/loader/loader.conf
echo "Check ACRN efi boot event" echo "Check the ACRN efi boot event"
check_acrn_bootefi=`efibootmgr | grep ACRN | wc -l` check_acrn_bootefi=`efibootmgr | grep ACRN | wc -l`
if [[ "$check_acrn_bootefi" -ge 1 ]]; then if [[ "$check_acrn_bootefi" -ge 1 ]]; then
echo "Clean all ACRN efi boot event" echo "Clean all ACRN efi boot events"
efibootmgr | grep ACRN | cut -d'*' -f1 | cut -d't' -f2 | xargs -i efibootmgr -b {} -B >/dev/null efibootmgr | grep ACRN | cut -d'*' -f1 | cut -d't' -f2 | xargs -i efibootmgr -b {} -B >/dev/null
fi fi
echo "Check linux bootloader event" echo "Check the Linux bootloader event"
number=$(expr `efibootmgr | grep 'Linux bootloader' | wc -l` - 1) number=$(expr `efibootmgr | grep 'Linux bootloader' | wc -l` - 1)
if [[ $number -ge 1 ]]; then if [[ $number -ge 1 ]]; then
echo "Clean all Linux bootloader event" echo "Clean all Linux bootloader events"
efibootmgr | grep 'Linux bootloader' | cut -d'*' -f1 | cut -d't' -f2 | head -n$number | xargs -i efibootmgr -b {} -B >/dev/null efibootmgr | grep 'Linux bootloader' | cut -d'*' -f1 | cut -d't' -f2 | head -n$number | xargs -i efibootmgr -b {} -B >/dev/null
fi fi
echo "Add new ACRN efi boot event, uart is disabled by default." echo "Add new ACRN efi boot events; uart is disabled by default."
set -x set -x
efibootmgr -c -l "\EFI\acrn\acrn.efi" -d $partition -p 1 -L "ACRN" -u "uart=disabled" >/dev/null efibootmgr -c -l "\EFI\acrn\acrn.efi" -d $partition -p 1 -L "ACRN" -u "uart=disabled" >/dev/null
{ set +x; } 2>/dev/null { set +x; } 2>/dev/null
echo "Service OS setup done!" echo "Service OS setup is complete!"
else else
echo "Fail to upgrade Service VM to $sos_ver." echo "Failed to upgrade the Service VM to $sos_ver."
echo "Please try upgrade Service VM with this command:" echo "Upgrade the Service VM with this command:"
echo "swupd update -V $sos_ver" echo "swupd update -V $sos_ver"
exit 1 exit 1
fi fi
umount /mnt umount /mnt
sync sync
[[ $disable_reboot == 0 ]] && echo "Rebooting Service OS to take effects." && reboot -f [[ $disable_reboot == 0 ]] && echo "Rebooting the Service OS to take effect." && reboot -f
} }
function upgrade_uos() function upgrade_uos()
{ {
# Check User VM version # Check User VM version
[[ `echo $uos_ver | awk '{print length($0)}'` -ne 5 ]] && echo "Please input right User VM version to upgrade" && exit 1 [[ `echo $uos_ver | awk '{print length($0)}'` -ne 5 ]] && echo "Input the correct User VM version to which to upgrade" && exit 1
echo "Upgrading User VM..." echo "Upgrading User VM..."
@ -163,17 +163,17 @@ function upgrade_uos()
uos_image_link="https://download.clearlinux.org/releases/$uos_ver/clear/clear-$uos_ver-kvm.img.xz" uos_image_link="https://download.clearlinux.org/releases/$uos_ver/clear/clear-$uos_ver-kvm.img.xz"
# Set proxy if needed. # Set proxy if needed.
[[ -n $proxy ]] && echo "Setting proxy to: $proxy" && export https_proxy=$proxy [[ -n $proxy ]] && echo "Setting the proxy to: $proxy" && export https_proxy=$proxy
# Corrupt script if /mnt is already mounted. # Corrupt script if /mnt is already mounted.
if [[ ! -z `findmnt /mnt -n` ]]; then if [[ ! -z `findmnt /mnt -n` ]]; then
echo "/mnt is already mounted, please unmount it if you want to continue upgrade User VM." echo "/mnt is already mounted; unmount it if you want to continue upgrading the User VM."
exit 1 exit 1
fi fi
# Do upgrade User VM process. # Do upgrade User VM process.
if [[ $skip_download_uos != 1 ]]; then if [[ $skip_download_uos != 1 ]]; then
cd ~ cd ~
echo "Downloading User VM image: $uos_image_link" echo "Downloading the User VM image: $uos_image_link"
curl $uos_image_link -o clear-$uos_ver-kvm.img.xz curl $uos_image_link -o clear-$uos_ver-kvm.img.xz
if [[ $? -ne 0 ]]; then if [[ $? -ne 0 ]]; then
echo "Download User VM failed." echo "Download User VM failed."
@ -186,7 +186,7 @@ function upgrade_uos()
uos_img=$(find ~/ -name clear-$uos_ver-kvm.img) uos_img=$(find ~/ -name clear-$uos_ver-kvm.img)
if [[ -f $uos_img ]] && [[ -f $uos_img.xz ]]; then echo "Moving $uos_img to $uos_img.old."; mv $uos_img $uos_img.old; fi if [[ -f $uos_img ]] && [[ -f $uos_img.xz ]]; then echo "Moving $uos_img to $uos_img.old."; mv $uos_img $uos_img.old; fi
if [[ ! -f $uos_img_xz ]] && [[ ! -f $uos_img ]]; then if [[ ! -f $uos_img_xz ]] && [[ ! -f $uos_img ]]; then
echo "You should download User VM clear-$uos_ver-kvm.img.xz file firstly." && exit 1 echo "Download the User VM clear-$uos_ver-kvm.img.xz file first." && exit 1
fi fi
if [[ -f $uos_img_xz ]]; then if [[ -f $uos_img_xz ]]; then
echo "Unxz User VM file: $uos_img_xz" echo "Unxz User VM file: $uos_img_xz"
@ -194,14 +194,14 @@ function upgrade_uos()
uos_img=`echo $uos_img_xz | sed 's/.xz$//g'` uos_img=`echo $uos_img_xz | sed 's/.xz$//g'`
fi fi
echo "Get User VM image: $uos_img" echo "Get the User VM image: $uos_img"
uos_loop_device=`losetup -f -P --show $uos_img` uos_loop_device=`losetup -f -P --show $uos_img`
mount ${uos_loop_device}p3 /mnt || { echo "Fail to mount User VM rootfs partition" && exit 1; } mount ${uos_loop_device}p3 /mnt || { echo "Failed to mount the User VM rootfs partition" && exit 1; }
mount ${uos_loop_device}p1 /mnt/boot || { echo "Fail to mount User VM EFI partition" && exit 1; } mount ${uos_loop_device}p1 /mnt/boot || { echo "Failed to mount the User VM EFI partition" && exit 1; }
echo "Install kernel-iot-lts2018 to $uos_img" echo "Install kernel-iot-lts2018 to $uos_img"
swupd bundle-add --path=/mnt kernel-iot-lts2018 || { echo "Fail to install kernel-iot-lts2018" && exit 1; } swupd bundle-add --path=/mnt kernel-iot-lts2018 || { echo "Failed to install kernel-iot-lts2018" && exit 1; }
echo "Configure kernel-ios-lts2018 as $uos_img default boot kernel" echo "Configure kernel-ios-lts2018 as $uos_img default boot kernel"
uos_kernel_conf=`ls -t /mnt/boot/loader/entries/ | grep Clear-linux-iot-lts2018 | head -n1` uos_kernel_conf=`ls -t /mnt/boot/loader/entries/ | grep Clear-linux-iot-lts2018 | head -n1`
@ -214,9 +214,9 @@ function upgrade_uos()
cp -r /usr/share/acrn/samples/nuc/launch_uos.sh ~/launch_uos_$uos_ver.sh cp -r /usr/share/acrn/samples/nuc/launch_uos.sh ~/launch_uos_$uos_ver.sh
sed -i "s/\(virtio-blk.*\)\/home\/clear\/uos\/uos.img/\1$(echo $uos_img | sed "s/\//\\\\\//g")/" ~/launch_uos_$uos_ver.sh sed -i "s/\(virtio-blk.*\)\/home\/clear\/uos\/uos.img/\1$(echo $uos_img | sed "s/\//\\\\\//g")/" ~/launch_uos_$uos_ver.sh
[[ -z `grep $uos_img ~/launch_uos_$uos_ver.sh` ]] && echo "Fail to replace uos image in launch script: ~/launch_uos_$uos_ver.sh" && exit 1 [[ -z `grep $uos_img ~/launch_uos_$uos_ver.sh` ]] && echo "Failed to replace the User VM image in the launch script: ~/launch_uos_$uos_ver.sh" && exit 1
echo "Upgrade User VM done..." echo "Upgrade User VM complete..."
echo "Now you can run this command to start User VM..." echo "Run this command to start the User VM..."
echo "sudo /root/launch_uos_$uos_ver.sh" echo "sudo /root/launch_uos_$uos_ver.sh"
exit exit
} }
@ -249,8 +249,8 @@ do
done done
# Check args # Check args
[[ $EUID -ne 0 ]] && echo "You have to run script as root." && exit 1 [[ $EUID -ne 0 ]] && echo "You must run the script as root." && exit 1
[[ -z $1 ]] && print_help [[ -z $1 ]] && print_help
[[ -z $efi_partition ]] && efi_partition=/dev/sda1 || echo "Setting EFI System partition to: $efi_partition..." [[ -z $efi_partition ]] && efi_partition=/dev/sda1 || echo "Setting the EFI System partition to: $efi_partition..."
[[ -n $sos_ver && -n $uos_ver ]] && echo "You should select upgrading Service VM or User VM" && exit 1 [[ -n $sos_ver && -n $uos_ver ]] && echo "Select upgrading the Service VM or the User VM" && exit 1
[[ -n $uos_ver ]] && upgrade_uos || upgrade_sos [[ -n $uos_ver ]] && upgrade_uos || upgrade_sos