xunliu commented on code in PR #103:
URL:
https://github.com/apache/gravitino-playground/pull/103#discussion_r1835359865
##########
playground.sh:
##########
@@ -18,44 +18,107 @@
# 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
)"
+playgroundRuntimeName="gravitino-playground"
+runtime=""
+
+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:linux >/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] Docker 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
- echo "ERROR: No docker service environment found. Please install
docker-compose."
- exit
+ # 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] Docker disk check passed: ${availableSpaceGB} GB available."
+ else
+ echo "[ERROR] Docker 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] Docker RAM check passed: ${totalRamGB} GB available."
+ else
+ echo "[ERROR] Docker 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] Docker CPU check passed: ${cpuCores} cores available."
+ else
+ echo "[ERROR] Docker CPU check failed: Only ${cpuCores} cores available,
${requiredCpuCores} cores or more required."
+ exit 1
+ fi
+}
+
+testK8s() {
+ echo "[INFO] Testing K8s environment..."
+ kubectl cluster-info
Review Comment:
I think we need to check if there exists `kubectl` first.
##########
playground.sh:
##########
@@ -64,140 +127,277 @@ checkHelm() {
if [ $isExist ]; then
true # Placeholder, do nothing
else
- echo "ERROR: Helm command not found, Please install helm v3."
+ echo "[ERROR] Helm check failed: Helm command not found, Please install
helm v3."
exit
fi
# check version
# version will be like:
# Version:"v3.15.2"
regex="Version:\"(v[0-9]\.[0-9]+\.[0-9])\""
version=$(helm version)
Review Comment:
I think we needs check if exist `helm` first.
##########
playground.sh:
##########
@@ -64,140 +127,277 @@ checkHelm() {
if [ $isExist ]; then
true # Placeholder, do nothing
else
- echo "ERROR: Helm command not found, Please install helm v3."
+ echo "[ERROR] Helm check failed: Helm command not found, Please install
helm v3."
exit
fi
# check version
# version will be like:
# Version:"v3.15.2"
regex="Version:\"(v[0-9]\.[0-9]+\.[0-9])\""
version=$(helm version)
- echo "$version"
if [[ $version =~ $regex ]]; then
major_version="${BASH_REMATCH[1]}"
- echo "$major_version"
+ echo "[INFO] Helm version: ${major_version}"
if [[ $major_version =~ "v3" ]]; then
- echo "INFO: helm check PASS."
+ echo "[INFO] Helm check passed."
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)
+checkK8sDisk() {
+ local nodeName=$(kubectl get nodes -o jsonpath='{.items[0].metadata.name}')
+ local availableStorage=$(kubectl get node ${nodeName} -o
jsonpath='{.status.allocatable.ephemeral-storage}')
+
+ # Check if the available storage value was retrieved
+ if [ -z "${availableStorage}" ]; then
+ echo "[ERROR] K8s disk check failed: Could not determine available
ephemeral storage on node ${nodeName}."
+ exit 1
fi
- if [ -z "${openPort}" ]; then
- echo "INFO: Port $port is ok."
+
+ # Convert storage from bytes to GB
+ local availableSpaceGB=$((${availableStorage} / 1024 / 1024 / 1024))
+
+ if [ "${availableSpaceGB}" -ge "${requiredDiskSpaceGB}" ]; then
+ echo "[INFO] K8s disk check passed: ${availableSpaceGB} GB available on
node ${nodeName}."
else
- echo "ERROR: Port $port is in use. Please check it."
+ echo "[ERROR] K8s disk check failed: Only ${availableSpaceGB} GB available
on node ${nodeName}, ${requiredDiskSpaceGB} GB or more required."
+ exit 1
+ fi
+}
+
+checkK8sRam() {
+ local nodeName=$(kubectl get nodes -o jsonpath='{.items[0].metadata.name}')
+ local totalRamKi=$(kubectl get node ${nodeName} -o
jsonpath='{.status.allocatable.memory}' | sed 's/Ki//')
+ local totalRamGB=$((${totalRamKi} / 1024 / 1024))
+
+ if [ "${totalRamGB}" -ge "${requiredRamGB}" ]; then
+ echo "[INFO] K8s RAM check passed: ${totalRamGB} GB available on node
${nodeName}."
+ else
+ echo "[ERROR] K8s RAM check failed: Only ${totalRamGB} GB available on
node ${nodeName}, ${requiredRamGB} GB or more required."
+ exit 1
+ fi
+}
+
+checkK8sCpu() {
+ local nodeName=$(kubectl get nodes -o jsonpath='{.items[0].metadata.name}')
+ local cpuCores=$(kubectl get node ${nodeName} -o
jsonpath='{.status.allocatable.cpu}' | sed 's/m//')
+
+ if [ "${cpuCores}" -ge "${requiredCpuCores}" ]; then
+ echo "[INFO] K8s CPU check passed: ${cpuCores} cores available on node
${nodeName}."
+ else
+ echo "[ERROR] K8s CPU check failed: Only ${cpuCores} cores available on
node ${nodeName}, ${requiredCpuCores} cores or more required."
+ exit 1
+ fi
+}
+
+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 [ ${#usedPorts[@]} -gt 0 ]; then
+ echo "[ERROR] Ports in use: ${usedPorts[*]}"
+ echo "[ERROR] Please check the ports."
+ exit 1
+ fi
+}
+
+checkRuntime() {
+ runtime=""
+
+ echo "[INFO] Checking runtime: ${runtime}"
+ # Check if Docker is available
+ local dockerAvailable=false
+ if command -v docker >/dev/null 2>&1; then
+ dockerAvailable=true
+ fi
+
+ # Check if kubectl is available
+ local k8sAvailable=false
+ if command -v kubectl >/dev/null 2>&1; then
+ k8sAvailable=true
+ fi
+
+ # If no runtime is available
+ if [ "${dockerAvailable}" = false ] && [ "${k8sAvailable}" = false ]; then
+ echo "[ERROR] No runtime found. Please install Docker or Kubernetes."
exit 1
fi
+
+ # If both are available, let user choose
+ if [ "${dockerAvailable}" = true ] && [ "${k8sAvailable}" = true ]; then
+ read -p "Both Docker and K8s are available. Which runtime would you like
to use? [docker/k8s] (default: docker): " choice
+
+ case "$choice" in
+ k8s)
+ echo "[INFO] Using K8s runtime."
+ runtime="k8s"
+ ;;
+ docker | "") # Empty input defaults to docker
+ echo "[INFO] Using Docker runtime."
+ runtime="docker"
+ ;;
+ *)
+ echo "[ERROR] Invalid choice. Using default: docker."
+ runtime="docker"
+ ;;
+ esac
+ return
+ fi
+
+ # If only Docker is available
+ if [ "${dockerAvailable}" = true ]; then
+ runtime="docker"
+ return
+ fi
+
+ # If only K8s is available
+ if [ "${k8sAvailable}" = true ]; then
+ runtime="k8s"
+ return
+ fi
+}
+
+checkCurrentRuntime() {
+ runtime=""
+
+ # Check if gravitino-playground is running in Docker
+ if command -v docker >/dev/null 2>&1; then
+ if docker compose ls | grep -q "${playgroundRuntimeName}"; then
+ echo "[INFO] gravitino-playground is running in Docker."
+ runtime="docker"
+ return
+ fi
+ fi
+
+ # Check if gravitino-playground is running in K8s
+ if command -v kubectl >/dev/null 2>&1; then
+ if kubectl get namespace "${playgroundRuntimeName}" >/dev/null 2>&1; then
+ if kubectl -n "${playgroundRuntimeName}" get pods | grep -q "Running";
then
+ echo "[INFO] gravitino-playground is running in Kubernetes."
+ runtime="k8s"
+ return
+ fi
+ fi
+ 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
+ checkCurrentRuntime
+ if [ -n "${runtime}" ]; then
+ echo "[ERROR] Playground is already running in ${runtime}. Please stop it
first."
+ exit 1
+ fi
+
+ checkRuntime
+ checkPortsInUse
+
+ case "${runtime}" in
k8s)
testK8s
checkHelm
+ checkK8sDisk
+ checkK8sRam
+ checkK8sCpu
;;
docker)
testDocker
- checkCompose
- ports=(8090 9001 3307 19000 19083 60070 13306 15342 18080 18888 19090
13000)
- for port in "${ports[@]}"; do
- checkPortInUse ${port}
- done
+ checkDockerCompose
+ checkDockerDisk
+ checkDockerRam
+ checkDockerCpu
;;
esac
- 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
- case "$runtime" in
+ case "${runtime}" in
k8s)
- helm upgrade --install gravitino-playground ./helm-chart/ \
- --create-namespace --namespace gravitino-playground \
+ helm upgrade --install ${playgroundRuntimeName} ./helm-chart/ \
+ --create-namespace --namespace ${playgroundRuntimeName} \
--set projectRoot=$(pwd)
;;
docker)
- logSuffix=$(date +%Y%m%d%H%m%s)
- docker-compose up --detach
Review Comment:
`docker-compose` or `docker compose`？
My macOS only have `docker-compose`.
`docker compose` is Linux OS?
Please check it.
Maybe you needs to check operation OS, and add different process.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
