feature : introduce a new property DOCKER_COMPOSE_HOST_VOLUME_CHECK to check if the host folder or file exists

Author: patternhelloworld

.env.example.local

@@ -53,6 +53,7 @@ GOOD_APP_HEALTH_CHECK_PATTERN=xxx
 DOCKER_COMPOSE_ENVIRONMENT={"XDEBUG_CONFIG":"idekey=IDE_DEBUG","PHP_IDE_CONFIG":"serverName=laravel-crud-boilerplate"}
 DOCKER_BUILD_ARGS={}
 DOCKER_COMPOSE_NGINX_SELECTIVE_VOLUMES=[]
+DOCKER_COMPOSE_HOST_VOLUME_CHECK=false
 
 NGINX_CLIENT_MAX_BODY_SIZE=50M
 

.env.example.real

@@ -58,7 +58,8 @@ DOCKER_BUILD_ARGS={}
 DOCKER_COMPOSE_REAL_SELECTIVE_VOLUMES=[]
 # This is added on docker-compose-${project_name}-nginx.yml
 DOCKER_COMPOSE_NGINX_SELECTIVE_VOLUMES=["./shared/nginx-error-logs:/var/log/nginx"]
-
+# Check if the host folder or file exists
+DOCKER_COMPOSE_HOST_VOLUME_CHECK=false
 
 NGINX_CLIENT_MAX_BODY_SIZE=50M
 

.env.java.local

@@ -48,6 +48,7 @@ DOCKER_COMPOSE_ENVIRONMENT={"TZ":"Asia/Seoul"}
 # docker exec -it CONTAINER_NAME cat /var/log/env_build_args.log
 DOCKER_BUILD_ARGS={"DOCKER_BUILDKIT":"1","PROJECT_ROOT_IN_CONTAINER":"/var/www/server/spring-sample-h-auth","APP_ENV":"local"}
 DOCKER_COMPOSE_NGINX_SELECTIVE_VOLUMES=[]
+DOCKER_COMPOSE_HOST_VOLUME_CHECK=false
 
 NGINX_CLIENT_MAX_BODY_SIZE=50M
 

.env.java.real

@@ -50,6 +50,7 @@ DOCKER_COMPOSE_ENVIRONMENT={"TZ":"Asia/Seoul"}
 DOCKER_BUILD_ARGS={"DOCKER_BUILDKIT":"1","PROJECT_ROOT_IN_CONTAINER":"/var/www/server/spring-sample-h-auth","APP_ENV":"production"}
 DOCKER_COMPOSE_REAL_SELECTIVE_VOLUMES=["./samples/spring-sample-h-auth/logs:/var/www/files"]
 DOCKER_COMPOSE_NGINX_SELECTIVE_VOLUMES=["./shared/nginx-error-logs:/var/log/nginx"]
+DOCKER_COMPOSE_HOST_VOLUME_CHECK=false
 
 NGINX_CLIENT_MAX_BODY_SIZE=50M
 

.env.java.real.commercial.ssl.sample

@@ -51,7 +51,7 @@ DOCKER_BUILD_ARGS={"DOCKER_BUILDKIT":"1","PROJECT_ROOT_IN_CONTAINER":"/var/www/s
 # 3) ''/var/web/project/spring-sample-h-auth' is here as well. The thing is you should locate 'application.properties', 'logback-spring.xml', 'yourdomain.com.jks' on the './src/main/resource' folder.
 DOCKER_COMPOSE_REAL_SELECTIVE_VOLUMES=["/var/web/files/spring-sample-h-auth:/var/www/files","/var/web/project/spring-sample-h-auth/src/main/resources:/var/www/server/spring-sample-h-auth/src/main/resources"]
 DOCKER_COMPOSE_NGINX_SELECTIVE_VOLUMES=["/var/web/files/nginx/spring-sample-h-auth/logs:/var/log/nginx"]
-
+DOCKER_COMPOSE_HOST_VOLUME_CHECK=false
 
 NGINX_CLIENT_MAX_BODY_SIZE=50M
 

.env.node.local

@@ -45,6 +45,7 @@ GOOD_APP_HEALTH_CHECK_PATTERN=docs
 DOCKER_COMPOSE_ENVIRONMENT={"MONGODB_URL":"mongodb://host.docker.internal:27017/node-boilerplate","NODE_ENV":"development"}
 DOCKER_BUILD_ARGS={}
 DOCKER_COMPOSE_NGINX_SELECTIVE_VOLUMES=[]
+DOCKER_COMPOSE_HOST_VOLUME_CHECK=false
 
 NGINX_CLIENT_MAX_BODY_SIZE=50M
 

.env.php.local

@@ -49,7 +49,7 @@ DOCKER_COMPOSE_ENVIRONMENT={"XDEBUG_CONFIG":"idekey=IDE_DEBUG","PHP_IDE_CONFIG":
 # docker exec -it CONTAINER_NAME cat /var/log/env_build_args.log
 DOCKER_BUILD_ARGS={"SAMPLE":"YAHOO","SAMPLE2":"YAHOO2"}
 DOCKER_COMPOSE_NGINX_SELECTIVE_VOLUMES=[]
-
+DOCKER_COMPOSE_HOST_VOLUME_CHECK=false
 
 NGINX_CLIENT_MAX_BODY_SIZE=50M
 

.env.php.real

@@ -52,6 +52,7 @@ DOCKER_BUILD_ARGS={"SAMPLE":"YAHOO","SAMPLE2":"YAHOO2","shared_volume_group_id":
 # For SSL, the host folder is recommended to be './.docker/ssl' to be synchronized with 'docker-compose-nginx-original.yml'
 DOCKER_COMPOSE_REAL_SELECTIVE_VOLUMES=["./shared/app-error-logs:/var/www/app/storage/logs","./.docker/ssl:/etc/apache2/ssl"]
 DOCKER_COMPOSE_NGINX_SELECTIVE_VOLUMES=["./shared/nginx-error-logs:/var/log/nginx"]
+DOCKER_COMPOSE_HOST_VOLUME_CHECK=false
 
 NGINX_CLIENT_MAX_BODY_SIZE=50M
 

README.md

@@ -145,7 +145,7 @@ graph TD;
 | yq                                    | 4.35.1           | Manual            | Use v4.35.1 instead of the latest version. The lastest version causes a parsing error                                          |
 | consul (docker image)                 | 1.14.11          | Auto              | An error occurred due to a payload format issue while the lastest version of it was communicating with gliderlabs/registrator. |
 | gliderlabs/registrator (docker image) | master           | Auto              |                                                                                                                                |
-| nginx (docker image)                  | latest           | Auto              | Considering changing it to a certain version, but until now no issues have been detected.                                      |
+| nginx (docker image)                  | 1.25.4           | Auto              | Considering changing it to a certain version, but until now no issues have been detected.                                      |
 | docker                                | 24~27            | Manual            | I think too old versions could cause problems, and the lastest version v27.x causes only a warning message.                    |
 | docker-compose                        | 2                | Manual            | I think too old versions could cause problems, and the v2 is recommended.                                                      |
 
@@ -327,7 +327,8 @@ APP_ENV=real
 
 # The 'real' setting requires defining 'DOCKER_COMPOSE_REAL_SELECTIVE_VOLUMES'.
 DOCKER_COMPOSE_REAL_SELECTIVE_VOLUMES=["/my-host/files/:/in-container/files", "/my-host/java-spring-project/src/main/resources:/in-container/java-spring-project/src/main/resources"]
-
+# Check if the host folder or file exists
+DOCKER_COMPOSE_HOST_VOLUME_CHECK=false
 # If APP_ENV is set to 'local', as specified in 'docker-compose-app-local-original.yml', synchronize your entire project as follows: "HOST_ROOT_LOCATION:PROJECT_LOCATION".
 # [IMPORTANT] If this is set to true, Nginx will be restarted, resulting in a short downtime. 
 # This option should be used when upgrading the Runner. See the "Upgrade" section below.

documents/Deploy-React-Project-with-DBGR.md

@@ -76,7 +76,8 @@
     DOCKER_COMPOSE_REAL_SELECTIVE_VOLUMES=["/var/projects/your-app/.docker/nginx/app.conf.ctmpl:/etc/nginx-template/app.conf.ctmpl","/var/projects/files/your-app/logs:/var/log/nginx"]
     # [IMPORTANT] Run mkdir -p /var/projects/files/nginx/logs on your host machine
     DOCKER_COMPOSE_NGINX_SELECTIVE_VOLUMES=["/var/projects/files/nginx/logs:/var/log/nginx"]
-    
+    DOCKER_COMPOSE_HOST_VOLUME_CHECK=false
+  
     NGINX_CLIENT_MAX_BODY_SIZE=50M
     
     USE_MY_OWN_APP_YML=false

use-app.sh

@@ -72,10 +72,31 @@ apply_docker_compose_environment_onto_app_yaml(){
 
 }
 
+check_docker_compose_real_host_volumes_directories() {
+
+    local volumes=$(echo "${docker_compose_real_selective_volumes[@]}" | tr -d '[]"')
+
+    for volume in ${volumes}
+    do
+        # Extract the local directory path before the colon (:)
+        local_dir="${volume%%:*}"
+
+        # Check if the directory or file exists
+        if [[ ! -f "$local_dir" && ! -d "$local_dir" ]]; then
+            echo "[ERROR] The local path '$local_dir' specified in DOCKER_COMPOSE_REAL_SELECTIVE_VOLUMES does not exist. Exiting..."
+            exit 1
+        fi
+    done
+}
+
 apply_docker_compose_volumes_onto_app_real_yaml(){
 
    check_yq_installed
 
+   if [[ ${docker_compose_host_volume_check} == 'true' ]]; then
+      check_docker_compose_real_host_volumes_directories
+   fi
+
    echo "[NOTICE] DOCKER_COMPOSE_REAL_SELECTIVE_VOLUMES on .env is now being applied to docker-${orchestration_type}-${project_name}-real.yml."
 
    if [[ ${orchestration_type} == 'stack' ]]; then

use-common.sh

@@ -22,7 +22,7 @@ display_planned_transition() {
     echo "  Current State (${current_state})"
     echo "─────────────────────────────"
     echo "              |"
-    echo "     >> Transition planned <<"
+    echo "  >> Transition planned <<"
     echo "              v"
     echo "─────────────────────────────"
     echo "  Target State (${target_state})"
@@ -41,7 +41,7 @@ display_immediate_transition() {
     echo "  Current State (${current_state})"
     echo "─────────────────────────────"
     echo "              |"
-    echo "    >> Immediate Transition <<"
+    echo "  >> Immediate Transition <<"
     echo "              v"
     echo "─────────────────────────────"
     echo "  Target State (${target_state})"
@@ -135,6 +135,7 @@ cache_non_dependent_global_vars() {
   fi
 
   docker_compose_nginx_selective_volumes=$(get_value_from_env "DOCKER_COMPOSE_NGINX_SELECTIVE_VOLUMES")
+  docker_compose_host_volume_check=$(get_value_from_env "DOCKER_COMPOSE_HOST_VOLUME_CHECK")
 
   docker_layer_corruption_recovery=$(get_value_from_env "DOCKER_LAYER_CORRUPTION_RECOVERY")
 

use-nginx.sh

@@ -26,10 +26,33 @@ apply_ports_onto_nginx_yaml(){
      done
 
 }
+
+check_docker_compose_nginx_host_volumes_directories() {
+
+    local volumes=$(echo "${docker_compose_nginx_selective_volumes[@]}" | tr -d '[]"')
+
+    for volume in ${volumes}
+    do
+        # Extract the local directory path before the colon (:)
+        local_dir="${volume%%:*}"
+
+        # Check if the directory or file exists
+        if [[ ! -f "$local_dir" && ! -d "$local_dir" ]]; then
+            echo "[ERROR] The local path '$local_dir' specified in DOCKER_COMPOSE_NGINX_SELECTIVE_VOLUMES does not exist. Exiting..."
+            exit 1
+        fi
+    done
+}
+
+
 apply_docker_compose_volumes_onto_app_nginx_yaml(){
 
    check_yq_installed
 
+    if [[ ${docker_compose_host_volume_check} == 'true' ]]; then
+       check_docker_compose_nginx_host_volumes_directories
+    fi
+
    echo "[NOTICE] DOCKER_COMPOSE_NGINX_SELECTIVE_VOLUMES on .env is now being applied to docker-compose-${project_name}-nginx.yml."
 
     for volume in "${docker_compose_nginx_selective_volumes[@]}"
@@ -293,7 +316,7 @@ nginx_down(){
 nginx_up(){
 
    echo "[NOTICE] Up NGINX Container."
-   PROJECT_NAME=${project_name} docker-compose -f docker-compose-${project_name}-nginx.yml up -d || echo "[ERROR] Critical - ${project_name}-nginx UP failure"
+   PROJECT_NAME=${project_name} docker-compose -f docker-compose-${project_name}-nginx.yml up -d || echo "[ERROR] Critical - ${project_name}-nginx UP failure."
 
 }