Improve sample compose file and tweak docs to match

Author: YaytayAtWork

pom.xml

@@ -426,7 +426,7 @@
         <plugin>
           <groupId>org.apache.maven.plugins</groupId>
           <artifactId>maven-dependency-plugin</artifactId>
-          <version>3.7.0</version>
+          <version>3.7.1</version>
           <executions>
             <execution>
               <id>copy-dependencies</id>

query-engine/docs/Authentication.adoc

@@ -69,4 +69,5 @@ OpenID Connect is configured using the xref:Parameters/uk.co.spudsoft.query.main
 Any number of xref:Parameters/uk.co.spudsoft.query.main.AuthEndpoint.adoc[authentication endpoints] may be configured.
 When a user attempts to login (which will happen on first access to the UI if xref:Parameters/uk.co.spudsoft.query.main.SessionConfig.adoc#requireSession[requireSession] is set) they will be presented with a list of all the auth endpoints to choose from.
 
-After authenticating with their chosen provider the generated JWT will be stored in the Query Engine database and a random cookie (configured at xref:Parameters/uk.co.spudsoft.query.main.SessionConfig.adoc#sessionCookie[sessionCookie]) will be generated to refer to it.
+After authenticating with their chosen provider the generated JWT will be stored in the Query Engine database and a random cookie (configured at xref:Parameters/uk.co.spudsoft.query.main.SessionConfig.adoc#sessionCookie[sessionCookie]) will be generated to refer to it.
+

query-engine/docs/Configuration.adoc

@@ -24,8 +24,8 @@ The rules of environment variables in Linux shells can cause problems in some si
 In order to avoid conflict with other variables, only variables with the prefix "query-engine" (or "QUERY_ENGINE") will be considered.
 Thus either of these environment variables can be used for setting the password for accessing the persistence data source:
 
-** QUERY_ENGINE.PERSISTENCE_DATASOURCE_USER_PASSWORD
-** query-engine.persistence.dataSource.user.password
+  * QUERY_ENGINE.PERSISTENCE_DATASOURCE_USER_PASSWORD
+  * query-engine.persistence.dataSource.user.password
 
 * System properties
 

query-engine/docs/Getting Started.adoc

@@ -2,6 +2,19 @@
 
 The quickest way to get a feel for the Query Engine is to use the link:query-engine-compose.yml[compose file].
 
+For consistency this document assumes you are using Linux or WSL, very similar commands should work on Windows.
+
+Download that file and save it to a new directory.
+Open a shell and CD to that directory, then run:
+
+```bash
+docker compose -f query-engine-compose.yml -p query-engine up -d
+```
+
+Then navigate to http://localhost:2000/ in your favourite browser.
+
+== Details
+
 This compose file needs to be run on a single container host (i.e. not Swarm or Kubernetes) with localhost ports 2000-2003 free (as well as the ports required by Jaeger: 5775/udp, 6831/udp, 6832/udp, 5778, 4317, 4318, 16686, 14268).
 It spawns five containers: MySQL, Microsoft SQL Server, PostgreSQL, Jaeger all-in-one and Query Engine in link:pass:[Design Mode/Design Mode.html][Design Mode].
 
@@ -32,6 +45,9 @@ For real use this volume should point to a git (or other SCM) repository for you
 Putting this behaviour together means that when the Query Engine starts using the provided compose file it is a demonstrable system that can be
 experienced with minimal additional work.
 
+NOTE: Although the system deployed is fully operational the History section of the UI will not return any data because you have not logged in.
+The data is recorded and you are encouraged to have a look at the mysql database (localhost:2001/test, credentials are in the compose file) to see it.
+
 [frame=none,cols="1,6,1",grid=none]
 |===
 

query-engine/docs/query-engine-compose.yml

@@ -1,21 +1,27 @@
-version: "3.8"
-
 services:
   mysql:
     image: mysql:8.3
     command: mysqld --default-authentication-plugin=mysql_native_password --skip-log-bin
     ports:
     - 2001:3306
+    healthcheck:
+      test: ["CMD", "mysqladmin" ,"ping", "-h", "localhost"]
+      timeout: 20s
+      retries: 10
     environment:
       MYSQL_ROOT_PASSWORD: T0p-Secret
       MYSQL_USER: user
       MYSQL_PASSWORD: T0p-Secret
       MYSQL_DATABASE: test
-  
+
   mssql:
     image: mcr.microsoft.com/mssql/server:2022-latest
     ports:
     - 2002:1433
+    healthcheck:
+      test: ["CMD-SHELL", "/opt/mssql-tools/bin/sqlcmd -S localhost -U sa -P 'T0p-Secret' -Q 'SELECT 1' || exit 1"]
+      timeout: 20s
+      retries: 10
     environment:
       ACCEPT_EULA: Y
       SA_PASSWORD: T0p-Secret
@@ -25,15 +31,23 @@ services:
     ports:
     - 2003:5432
     command: postgres -c log_min_duration_statement=0
+    healthcheck:
+      test: ["CMD", "pg_isready", "-d", "public"]
+      timeout: 20s
+      retries: 10
     environment:
       POSTGRES_PASSWORD: T0p-Secret
       POSTGRES_USER: postgres
       POSTGRES_DB: test
-  
+
   jaeger:
     image: jaegertracing/all-in-one:1.56
     environment:
       COLLECTOR_OTLP_ENABLED: true
+    healthcheck:
+      test: ["CMD", "/go/bin/all-in-one-linux", "status"]
+      timeout: 20s
+      retries: 10
     ports:
     - 5775:5775/udp
     - 6831:6831/udp
@@ -43,13 +57,22 @@ services:
     - 4318:4318
     - 16686:16686
     - 14268:14268
-      
+
   query-engine:
-    image: ghcr.io/yaytay/query-engine-design-mode:0.0.36-3-main
+    image: ghcr.io/yaytay/query-engine-design-mode:0.0.37-main
     ports:
     - 2000:8080
     volumes:
     - ./pipelines:/var/query-engine
+    depends_on:
+      mysql:
+        condition: service_healthy
+      mssql:
+        condition: service_healthy
+      postgresql:
+        condition: service_healthy
+      jaeger:
+        condition: service_healthy
     environment:
     - query-engine.httpServerOptions.port=8080
     - query-engine.logging.level.uk=DEBUG
@@ -62,7 +85,7 @@ services:
     - query-engine.persistence.retryIncrementMs=500
     - query-engine.jwt.acceptableIssuerRegexes[0]=.*
     - query-engine.tracing.serviceName=query-engine2
-    - query-engine.tracing.protocol=otlphttp    
+    - query-engine.tracing.protocol=otlphttp
     - query-engine.tracing.url=http://jaeger:4318/v1/traces
     - query-engine.sampleDataLoads[0].url=mysql://query-engine-mysql-1:3306/test
     - query-engine.sampleDataLoads[0].adminUser.username=user
@@ -76,4 +99,4 @@ services:
     - query-engine.baseConfigPath=/var/query-engine
     - query-engine.outputCacheDir=/var/cache/query-engine
     - query-engine.processors.tempDir=/tmp/query-engine
-    
+

query-engine/src/main/java/uk/co/spudsoft/query/main/Version.java

@@ -34,7 +34,7 @@ public final class Version {
   /**
    * The project version, as set in the Maven pom.xml.
    */
-  public static final String MAVEN_PROJECT_VERSION = "0.0.36-3-main";
+  public static final String MAVEN_PROJECT_VERSION = "0.0.37-main";
 
   private Version() {
   }