Add a check (with timeout) for the database to exist before starting the TE process.

Add diagnostics to TE and SM startup logging.

Update README.

Add comments to .env file.

Author: NikTJ777

README.md

@@ -3,7 +3,7 @@ Docker compose files for starting a nuodb database on the local host.
 
 These docker compose files will create:
 * a new docker network specifically for this database;
-* separate AP (admin), TE, and SM containers for the NuoDB processes;
+* separate AP (admin), TE, and SM containers for each NuoDB process;
 * a separate CD (collector) container for each engine container - to enable NuoDB Insights;
 * an influxdb and grafana container to host the NuoDB Insights dashboards.
 
@@ -16,5 +16,14 @@ Note that the container names will have the `project` name embedded - which is t
    - if you want to use the a specific SQL engine, you will need an image that supports that engine;
    - if you want to access the database from outside the `docker network` then set `EXTERNAL_ADDRESS`
      -- either in the `.env` file, _or_ by setting `EXTERNAL_ADDRESS` on the `docker-compose up` command-line;
+   - if you want to import initial state from a backup into the new database, set `IMPORT_SOURCE` to a path
+     on the _local_ machine. The SM container will mount this file as a volume and extract (untar) it into the
+     archive dir prior to starting the SM process;
+     (only if the archive dir is empty - so the SM container can be stopped and restarted without being reinitialised.)
+     -- if you have set `IMPORT_SOURCE` _and_ it is a large file that takes multiple minutes to extract, you _may_ need to
+        set `STARTUP_TIMEOUT` to a larger value, to stop the starup from timeing our _before_ the IMPORT has completed.
 3. create and start the nuodb database with `docker-compose up -d`;
 4. stop and delete everything with `docker-compose down`;
+
+To specify env vars on the command-line, specify them _before_ the `docker-compose` command.
+Ex: `IMPORT_SOURCE=./mydb.bak.tgz STARTUP_TIMEOUT=300 docker-compose up -d`

nuodb/.env

@@ -2,23 +2,33 @@
 # default ENV VAR values
 #
 
-NUODB_VERSION=nuodb/nuodb-ce:4.1.2.vee-4
+NUODB_IMAGE=nuodb/nuodb-ce:4.1.2.vee-4
 
-DB_NAME=bryo
+DB_NAME=demo
 DB_USER=dba
-DB_PASSWORD=secret
+DB_PASSWORD=dba
 ENGINE_MEM=1Gi
 SQL_ENGINE=vee
 
+# Set to a larger value if SM startup takes unusually long
+# - for example if IMPORT_SOURCE (see below) is a large file that takes multiple minutes to extract.
+STARTUP_TIMEOUT=60
+
+# Uncomment and set, or set on the docker-compose command-line to add further engine options
+# ENGINE_OPTIONS=
+
+# normally this is left unset, causing the default to be used.
+ARCHIVE_PATH=
+
+# set IMPORT_SOURCE to the path of a LOCAL file on the host where docker-compose is being run.
+# It will be mounted from that location into the SM container, from where it will be extracted
+# and used as the initial state of the database.
 IMPORT_SOURCE=
 IMPORT_LEVEL=1
 IMPORT_PATH=/var/opt/nuodb/import.tz
-# Set the max time that an archive IMPORT operation could take default=600000 (10 minutes)
-# - this configures the engine startup timeout to be at least this long
-# MAX_IMPORT_TIME_MS=
 
 PEER_ADDRESS=nuoadmin1
 NUOCMD_API_SERVER=nuoadmin1:8888
 
-# Uncomment, or provide on the command-line to enable external access to the database
+# Uncomment and set, or set on the docker-compose command-line to enable external access to the database
 # EXTERNAL_ADDRESS=

nuodb/docker-compose.yaml

@@ -1,7 +1,7 @@
 version: '3'
 services:
   nuoadmin1:
-    image: $NUODB_VERSION
+    image: $NUODB_IMAGE
     environment:
       NUODB_DOMAIN_ENTRYPOINT: $PEER_ADDRESS
     hostname: $PEER_ADDRESS
@@ -11,47 +11,73 @@ services:
     command:
     - "nuoadmin"
     - "--"
-    - "pendingProcessTimeout=${MAX_IMPORT_TIME_MS:-600000}"
+    - "pendingProcessTimeout=${STARTUP_TIMEOUT:-60}000"
     - "pendingReconnectTimeout=90000"
     - "thrift.message.max=1073741824"
     - "processLivenessCheckSec=30"
 
   sm:
-    image: $NUODB_VERSION
+    image: $NUODB_IMAGE
     environment:
       # push the current resolved value of the VAR
       NUOCMD_API_SERVER:
+      ARCHIVE_DIR: ${ARCHIVE_PATH:-/var/opt/nuodb/archive}
+      DB_OPTIONS: "mem ${ENGINE_MEM:-1Gi} execution-engine ${SQL_ENGINE:-vee} ${ENGINE_OPTIONS:-}"
     hostname: sm1
     depends_on:
       - nuoadmin1
     volumes:
       - ${IMPORT_SOURCE:-./.env}:${IMPORT_PATH:-/var/tmp/env}
+
+    ## NOTE: use '$$' for any variable that is to be evaluated at runtime IN THE SHELL.
+    # Any variable with a single '$' is resolved by docker-compose and written literally into the command string.
     command:
       - "sh"
       - "-c"
       - |
-        if [ -n "$IMPORT_SOURCE" -a -f $IMPORT_PATH -a ! -f /var/opt/nuodb/archive/1.atm ]; then
-           echo "Importing from $IMPORT_PATH into /var/opt/nuodb/archive..."
-           tar xf $IMPORT_PATH --strip-components ${IMPORT_LEVEL:-1} -C /var/opt/nuodb/archive || exit 98
-           nuodocker restore archive --origin-dir /var/opt/nuodb/archive --restore-dir /var/opt/nuodb/archive --db-name $DB_NAME --clean-metadata || exit 99
+        if [ -n "$IMPORT_SOURCE" -a -f "$IMPORT_PATH" -a ! -f $$ARCHIVE_DIR/1.atm ]; then
+           echo "Importing from $IMPORT_PATH into $$ARCHIVE_DIR..."
+           tar xf $IMPORT_PATH --strip-components ${IMPORT_LEVEL:-1} -C $$ARCHIVE_DIR || exit 98
+           find $$ARCHIVE_DIR -name '1.*'
+           nuodocker restore archive --origin-dir $$ARCHIVE_DIR --restore-dir $$ARCHIVE_DIR --db-name $DB_NAME --clean-metadata || exit 99
         fi
-        nuodocker start sm --db-name "$DB_NAME" --server-id "$PEER_ADDRESS" --dba-user "$DB_USER" --dba-password "$DB_PASSWORD" --options "alt-address sm1" --database-options "mem ${ENGINE_MEM:-1Gi} execution-engine ${SQL_ENGINE:-vee}"
+        nuodocker start sm --db-name "$DB_NAME" --server-id "$PEER_ADDRESS" --dba-user "$DB_USER" --dba-password "$DB_PASSWORD" --options "alt-address sm1" --database-options "$$DB_OPTIONS"
 
   te1:
-    image: $NUODB_VERSION
+    image: $NUODB_IMAGE
     environment:
       # push the current resolved value of the VAR
       NUOCMD_API_SERVER:
+      STARTUP_TIMEOUT: ${STARTUP_TIMEOUT:-90}
     hostname: te1
     depends_on:
       - nuoadmin1
       - sm
     ports:
       - 48006:48006
-    command: [ "nuodocker", "start", "te", "--db-name", "$DB_NAME", "--server-id", "$PEER_ADDRESS", "--options", "alt-address ${EXTERNAL_ADDRESS:-te1}" ]
+
+    ## NOTE: use '$$' for any variable that is to be evaluated at runtime IN THE SHELL.
+    # Any variable with a single '$' is resolved by docker-compose and written literally into the command string.
+    command:
+      - "sh"
+      - "-c"
+      - |
+        sleepTime=0
+        sleepQuantum=30
+        while [ -z "$$(nuocmd get database --db-name $DB_NAME)" -o $$? -ne 0 ] ; do
+          if [ $$sleepTime -ge $$STARTUP_TIMEOUT ]; then
+            echo "Timed out waiting for database startup ($$sleepTime sec)..."
+            exit 97
+          fi
+          echo "Waiting for confirmation that database $DB_NAME exists..."
+          sleep $$sleepQuantum
+          sleepTime=$$(( sleepTime + sleepQuantum ))
+          [ $$sleepQuantum -lt $$((STARTUP_TIMEOUT / 2)) ] && sleepQuantum=$$(( sleepQuantum + 30 ))
+        done
+        nuodocker start te --db-name "$DB_NAME" --server-id "$PEER_ADDRESS" --options "alt-address ${EXTERNAL_ADDRESS:-te1}"
 
   # te2:
-  #   image: $NUODB_VERSION
+  #   image: $NUODB_IMAGE
   #   environment:
   #     # push the current resolved value of the VAR
   #     NUOCMD_API_SERVER:
@@ -72,6 +98,7 @@ services:
       # - "8082:8082"
     volumes:
       - ./conf/initdb.sh:/docker-entrypoint-initdb.d/initdb.sh
+
   nuocd-sm:
     image: nuodb/nuodb-collector:latest
     depends_on:
@@ -82,6 +109,7 @@ services:
       INFLUXURL: http://influxdb:8086
       NUOCD_HOSTNAME: sm1
     pid: 'service:sm'
+
   nuocd-te1:
     image: nuodb/nuodb-collector:latest
     depends_on:
@@ -92,6 +120,7 @@ services:
       INFLUXURL: http://influxdb:8086
       NUOCD_HOSTNAME: te1
     pid: 'service:te1'
+
   # nuocd-te2:
   #   image: nuodb/nuodb-collector:latest
   #   depends_on:
@@ -114,6 +143,7 @@ services:
       - ./provisioning:/etc/grafana/provisioning
     ports:
       - "3000:3000"
+
   # ycsb-demo:
   #   image: nuodb/ycsb:latest
   #   depends_on: