Skip to content

Commit

Permalink
Optomize startup script
Browse files Browse the repository at this point in the history
  • Loading branch information
@orenccl
orenccl committed Nov 8, 2024
1 parent 8f08175 commit f13393f
Showing 1 changed file with 149 additions and 73 deletions.
222 changes: 149 additions & 73 deletions playground.sh
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,44 +18,104 @@
# under the License.
#

set -x

playground_dir="$(dirname "${BASH_SOURCE-$0}")"
playground_dir="$(
cd "${playground_dir}" >/dev/null
cd "${playground_dir}" >/dev/null || exit 1
pwd
)"

requiredDiskSpaceGB=25
requiredRamGB=8
requiredCpuCores=2
requiredPorts=(8090 9001 3307 19000 19083 60070 13306 15342 18080 18888 19090 13000)

testDocker() {
echo "INFO: Testing Docker environment by running hello-world..."
docker run --pull always hello-world >/dev/null 2>&1
echo "[INFO] Testing Docker environment by running hello-world..."
# Use always to test network connection
docker run --rm --pull always hello-world:latest >/dev/null 2>&1

if [ $? -eq 0 ]; then
echo "INFO: Docker is working correctly!"
echo "[INFO] Docker check passed: Docker is working correctly!"
else
echo "ERROR: There was an issue running the hello-world container. Please check your Docker installation."
echo "[ERROR] Docker check failed: There was an issue running the hello-world container. Please check your Docker installation."
exit 1
fi
}

testK8s() {
echo "Testing K8s environment ..."
kubectl cluster-info
if [ $? -eq 0 ]; then
echo "INFO: K8s is working correctly!"
checkDockerCompose() {
isExist=$(which docker-compose)

if [ ${isExist} ]; then
echo "[INFO] Docker compose check passed: Docker compose is working correctly!"
else
echo "ERROR: There was an issue running kubectl cluster-info, please check you K8s cluster."
echo "[ERROR] Docker compose check failed: No docker service environment found. Please install docker-compose."
exit 1
fi
}

checkDockerDisk() {
# Step 1: Get Docker Root Directory
local dockerRootDir="$(docker info 2>/dev/null | grep "Docker Root Dir" | awk '{print $NF}')"

checkCompose() {
isExist=$(which docker-compose)
if [ $isExist ]; then
true # Placeholder, do nothing
# Step 2: Check if the Docker directory exists
if [ -z "${dockerRootDir}" ]; then
echo "[ERROR] Disk check failed: Docker is not running or Docker Root Directory not found."
exit 1
fi

local availableSpaceKB

if [ -d "${dockerRootDir}" ]; then
# Check available space in the Docker directory's partition
availableSpaceKB=$(df --output=avail "${dockerRootDir}" | awk 'NR==2 {print $1}')
else
# Check available space in the root partition if the directory doesn't exist (special case for WSL)
availableSpaceKB=$(df --output=avail / | awk 'NR==2 {print $1}')
fi

# Step 3: Check if available space is greater than required
local availableSpaceGB=$((${availableSpaceKB} / 1024 / 1024))

if [ "${availableSpaceGB}" -ge "${requiredDiskSpaceGB}" ]; then
echo "[INFO] Disk check passed: ${availableSpaceGB} GB available."
else
echo "[ERROR] Disk check failed: ${availableSpaceGB} GB available, ${requiredDiskSpaceGB} GB or more required."
exit 1
fi
}

checkDockerRam() {
local totalRamBytes=$(docker info --format '{{.MemTotal}}')
# Convert from bytes to GB
local totalRamGB=$((totalRamBytes / 1024 / 1024 / 1024))

if [ "${totalRamGB}" -ge "${requiredRamGB}" ]; then
echo "[INFO] RAM check passed: ${totalRamGB} GB available."
else
echo "[ERROR] RAM check failed: Only ${totalRamGB} GB available, ${requiredRamGB} GB or more required."
exit 1
fi
}

checkDockerCpu() {
local cpuCores=$(docker info --format '{{.NCPU}}')

if [ "${cpuCores}" -ge "${requiredCpuCores}" ]; then
echo "[INFO] CPU check passed: ${cpuCores} cores available."
else
echo "[ERROR] CPU check failed: Only ${cpuCores} cores available, ${requiredCpuCores} cores or more required."
exit 1
fi
}

testK8s() {
echo "[INFO] Testing K8s environment ..."
kubectl cluster-info
if [ $? -eq 0 ]; then
echo "[INFO] K8s is working correctly!"
else
echo "ERROR: No docker service environment found. Please install docker-compose."
exit
echo "[ERROR] There was an issue running kubectl cluster-info, please check you K8s cluster."
exit 1
fi
}

Expand All @@ -64,7 +124,7 @@ checkHelm() {
if [ $isExist ]; then
true # Placeholder, do nothing
else
echo "ERROR: Helm command not found, Please install helm v3."
echo "[ERROR] Helm command not found, Please install helm v3."
exit
fi
# check version
Expand All @@ -77,50 +137,71 @@ checkHelm() {
major_version="${BASH_REMATCH[1]}"
echo "$major_version"
if [[ $major_version =~ "v3" ]]; then
echo "INFO: helm check PASS."
echo "[INFO] helm check PASS."
return
else
echo "ERROR: Please install helm v3"
echo "[ERROR] Please install helm v3"
exit
fi
fi
}

checkPortInUse() {
local port=$1
if [[ "$(uname)" == "Darwin" ]]; then
openPort=$(lsof -i :$port -sTCP:LISTEN)
elif [[ "$(uname)" == "Linux" ]]; then
openPort=$(sudo lsof -i :$port -sTCP:LISTEN)
checkPortsInUse() {
local usedPorts=()
local availablePorts=()

for port in "${requiredPorts[@]}"; do
if [[ "$(uname)" == "Darwin" ]]; then
openPort=$(lsof -i :${port} -sTCP:LISTEN)
# Use sudo only when necessary
elif [[ "$(uname)" == "Linux" ]]; then
openPort=$(sudo lsof -i :${port} -sTCP:LISTEN)
fi

if [ -z "${openPort}" ]; then
availablePorts+=("${port}")
else
usedPorts+=("${port}")
fi
done

echo "[INFO] Port status check results:"

if [ ${#availablePorts[@]} -gt 0 ]; then
echo "[INFO] Available ports: ${availablePorts[*]}"
fi
if [ -z "${openPort}" ]; then
echo "INFO: Port $port is ok."
else
echo "ERROR: Port $port is in use. Please check it."

if [ ${#usedPorts[@]} -gt 0 ]; then
echo "[ERROR] Ports in use: ${usedPorts[*]}"
echo "[ERROR] Please check the ports."
exit 1
fi
}

start() {
echo "INFO: Starting the playground..."
echo "[INFO] Starting the playground..."
echo "[INFO] The playground requires ${requiredCpuCores} CPU cores, ${requiredRamGB} GB of RAM, and ${requiredDiskSpaceGB} GB of disk storage to operate efficiently."

case "$runtime" in
k8s)
testK8s
checkHelm
;;
docker)
testDocker
checkCompose
ports=(8090 9001 3307 19000 19083 60070 13306 15342 18080 18888 19090 13000)
for port in "${ports[@]}"; do
checkPortInUse ${port}
done
;;
esac
if [ "${skipChecks}" == false ]; then
case "$runtime" in
k8s)
testK8s
checkHelm
;;
docker)
testDocker
checkDockerCompose
checkDockerDisk
checkDockerRam
checkDockerCpu

checkPortsInUse
;;
esac
fi

cd ${playground_dir}
echo "Preparing packages..."
cd ${playground_dir} || exit 1
echo "[INFO] Preparing packages..."
./init/spark/spark-dependency.sh
./init/gravitino/gravitino-dependency.sh
./init/jupyter/jupyter-dependency.sh
Expand All @@ -132,10 +213,10 @@ start() {
--set projectRoot=$(pwd)
;;
docker)
logSuffix=$(date +%Y%m%d%H%m%s)
logSuffix=$(date +%Y%m%d%H%M%s)
docker-compose up --detach
docker compose logs -f >${playground_dir}/playground-${logSuffix}.log 2>&1 &
echo "Check log details: ${playground_dir}/playground-${logSuffix}.log"
echo "[INFO] Check log details: ${playground_dir}/playground-${logSuffix}.log"
;;
esac
}
Expand All @@ -152,16 +233,16 @@ status() {
}

stop() {
echo "INFO: Stopping the playground..."
echo "[INFO] Stopping the playground..."

case "$runtime" in
k8s)
helm uninstall --namespace gravitino-playground gravitino-playground
helm uninstall --namespace gravitino-playground gravitino-playground
;;
docker)
docker-compose down
if [ $? -eq 0 ]; then
echo "INFO: Playground stopped!"
echo "[INFO] Playground stopped!"
fi
;;
esac
Expand All @@ -177,27 +258,22 @@ docker)
runtime="docker";
;;
*)
echo "ERROR: please specify which runtime you want to use, available runtime: [docker|k8s]"
echo "ERROR: please specify which runtime you want to use, available runtime: [docker|k8s]"
esac

skipChecks=false

case "$3" in
--skip-checks)
skipChecks=true;
;;
-s)
skipChecks=true;
;;
esac

case "$2" in
start)
if [[ "$3" == "-y" ]]; then
input="y"
else
echo "The playground requires 2 CPU cores, 8 GB of RAM, and 25 GB of disk storage to operate efficiently."
read -r -p "Confirm the requirement is available in your OS [Y/n]:" input
fi
case $input in
[yY][eE][sS] | [yY]) ;;
[nN][oO] | [nN])
exit 0
;;
*)
echo "ERROR: Invalid input!"
exit 1
;;
esac
start
;;
status)
Expand All @@ -207,7 +283,7 @@ stop)
stop
;;
*)
echo "Usage: $0 [k8s|docker] [start | status | stop]"
echo "Usage: $0 [k8s|docker] [start|status|stop] [--skip-checks|-s]"
exit 1
;;
esac
esac

0 comments on commit f13393f

Please sign in to comment.