Merge pull request #510 from TNO/prepare-for-release-1.2.5

Prepare for release 1.2.5

Author: bnouwt

README.md

@@ -71,7 +71,7 @@ The easiest way to start a Knowledge Engine runtime is with Docker:
 ```bash
 docker run \
 	-p 8280:8280 \
-	ghcr.io/tno/knowledge-engine/smart-connector:1.2.4
+	ghcr.io/tno/knowledge-engine/smart-connector:1.2.5
 ```
 
 The Knowledge Engine runtime is now available to use via the REST API at base URL `http://localhost:8280/rest` on your host machine.
@@ -93,7 +93,7 @@ docker run \
   -p 8081:8081 \
   -e KD_URL=https://knowledge-directory.example.org \
   -e KE_RUNTIME_EXPOSED_URL=https://your-domain.example.org:8081 \
-  ghcr.io/tno/knowledge-engine/smart-connector:1.2.4
+  ghcr.io/tno/knowledge-engine/smart-connector:1.2.5
 ```
 
 ### Running with Java
@@ -111,7 +111,7 @@ export KE_RUNTIME_EXPOSED_URL=https://your-domain.example.org:8081
 # Start it. The argument (8280) denotes the port number at which it
 # will listen for connections to the Knowledge Engine REST API.
 java -jar -Dorg.slf4j.simpleLogger.logFile=smart-connector.log \
-  smart-connector-rest-dist-1.2.4-with-dependencies.jar 8280
+  smart-connector-rest-dist-1.2.5-with-dependencies.jar 8280
 ```
 
 The JAR can be retrieved by compiling the project:
@@ -205,17 +205,17 @@ These are instructions on what to do when we release a new version of the knowle
 5. Build and push the new Docker images to GitLab:
 
 ```bash
-docker buildx build ./smart-connector-rest-dist --platform linux/arm64,linux/amd64 --tag docker-registry.inesctec.pt/interconnect/knowledge-engine/smart-connector-rest-dist:1.2.4 --push
-docker buildx build ./knowledge-directory --platform linux/arm64,linux/amd64 --tag docker-registry.inesctec.pt/interconnect/knowledge-engine/knowledge-directory:1.2.4 --push
-docker buildx build ./admin-ui --platform linux/arm64,linux/amd64 --tag docker-registry.inesctec.pt/interconnect/knowledge-engine/admin-ui:1.2.4 --push
+docker buildx build ./smart-connector-rest-dist --platform linux/arm64,linux/amd64 --tag docker-registry.inesctec.pt/interconnect/knowledge-engine/smart-connector-rest-dist:1.2.5 --push
+docker buildx build ./knowledge-directory --platform linux/arm64,linux/amd64 --tag docker-registry.inesctec.pt/interconnect/knowledge-engine/knowledge-directory:1.2.5 --push
+docker buildx build ./admin-ui --platform linux/arm64,linux/amd64 --tag docker-registry.inesctec.pt/interconnect/knowledge-engine/admin-ui:1.2.5 --push
 ```
 
 6. Build and push the new Docker images to GitHub:
 
 ```bash
-docker buildx build ./smart-connector-rest-dist --platform linux/arm64,linux/amd64 --tag ghcr.io/tno/knowledge-engine/smart-connector:1.2.4 --push
-docker buildx build ./knowledge-directory --platform linux/arm64,linux/amd64 --tag ghcr.io/tno/knowledge-engine/knowledge-directory:1.2.4 --push
-docker buildx build ./admin-ui --platform linux/arm64,linux/amd64 --tag ghcr.io/tno/knowledge-engine/admin-ui:1.2.4 --push
+docker buildx build ./smart-connector-rest-dist --platform linux/arm64,linux/amd64 --tag ghcr.io/tno/knowledge-engine/smart-connector:1.2.5 --push
+docker buildx build ./knowledge-directory --platform linux/arm64,linux/amd64 --tag ghcr.io/tno/knowledge-engine/knowledge-directory:1.2.5 --push
+docker buildx build ./admin-ui --platform linux/arm64,linux/amd64 --tag ghcr.io/tno/knowledge-engine/admin-ui:1.2.5 --push
 ```
 
 7. Prepare the next SNAPSHOT version and make a commit for that too.
@@ -232,7 +232,7 @@ docker buildx build ./admin-ui --platform linux/arm64,linux/amd64 --tag ghcr.io/
 10. Inform mailing list(s) (and [the blog](https://www.knowledge-engine.eu/blog/)) about the new release.
 
 ## (advanced) Administering a Knowledge Engine runtime
-To start a new instance of the REST API knowledge engine version 1.2.4, make sure you have `git checkout 1.2.4` the tag `1.2.4`. Now make sure you run the `mvn clean install` command successfully from the root of the repository.
+To start a new instance of the REST API knowledge engine version 1.2.5, make sure you have `git checkout 1.2.5` the tag `1.2.5`. Now make sure you run the `mvn clean install` command successfully from the root of the repository.
 
 ### Starting the Knowledge Engine in local mode
 When no additional configuration parameters are provided, the Knowledge Engine will by default run in local mode. This means you can create multiple smart connectors that can communicate with each other through the REST API, but the Knowledge Engine will not connect to a knowledge directory and will not be able to connect with smart connectors running in other runtimes.
@@ -246,13 +246,13 @@ cd smart-connector-rest-dist/target
 Finally, start the server (note that you can configure a log file by including the `-Dorg.slf4j.simpleLogger.logFile=ke.log` system property to the JVM):
 
 ```bash
-java -Dorg.slf4j.simpleLogger.logFile=ke.log -cp "smart-connector-rest-dist-1.2.4.jar:dependency/*" eu.knowledge.engine.rest.Main 8280
+java -Dorg.slf4j.simpleLogger.logFile=ke.log -cp "smart-connector-rest-dist-1.2.5.jar:dependency/*" eu.knowledge.engine.rest.Main 8280
 ```
 
 If you want to run in it in the background, you can use the `nohup` linux command (which does not use the simpleLogger configuration system property, but redirects the standard err/out):
 
 ```bash
-nohup java -cp "smart-connector-rest-dist-1.2.4.jar:dependency/*" eu.knowledge.engine.rest.Main 8280 > ke.log
+nohup java -cp "smart-connector-rest-dist-1.2.5.jar:dependency/*" eu.knowledge.engine.rest.Main 8280 > ke.log
 ```
 
 ### Starting the Knowledge Engine in distributed mode

admin-ui/src/main/resources/openapi-admin-ui.yaml

@@ -5,7 +5,7 @@ info:
   description:
     This API provides information on Knowledge Engine Runtimes (todo), Smart Connectors, Knowledge Bases, and Knowledge
     Interactions in a Knowledge Engine Network.
-  version: 1.2.4
+  version: 1.2.5
 
 paths:
   /rest/admin/sc/all/{include-meta}:

docs/docs/distributed_mode.md

@@ -20,7 +20,7 @@ First of all, you need to start a knowledge directory. The desired port number f
 ```bash
 cd knowledge-directory/target/
 
-java -Dorg.slf4j.simpleLogger.logFile=kd.log -cp "knowledge-directory-1.2.4.jar:dependency/*" eu.knowledge.engine.knowledgedirectory.Main 8080
+java -Dorg.slf4j.simpleLogger.logFile=kd.log -cp "knowledge-directory-1.2.5.jar:dependency/*" eu.knowledge.engine.knowledgedirectory.Main 8080
 ```
 
 The `nohup` command can be used to run the process in the background. On overview of the registered Knowledge Engine runtimes can be found on `http://localhost:8080/ker/` (or another host or port if you desire).
@@ -43,7 +43,7 @@ export KD_URL=http://localhost:8080
 export KE_RUNTIME_EXPOSED_URL=http://localhost:8081
 export KE_RUNTIME_PORT=8081
 
-java -Dorg.slf4j.simpleLogger.logFile=ke.log -cp "smart-connector-rest-dist-1.2.4.jar:dependency/*" eu.knowledge.engine.rest.Main 8280
+java -Dorg.slf4j.simpleLogger.logFile=ke.log -cp "smart-connector-rest-dist-1.2.5.jar:dependency/*" eu.knowledge.engine.rest.Main 8280
 ```
 
 ### Using Basic Authentication to secure data exchange

docs/docs/get-started/smart-connector.md

@@ -25,7 +25,7 @@ export KD_URL=http://localhost:8080
 export KE_RUNTIME_EXPOSED_URL=http://localhost:8081
 export KE_RUNTIME_PORT=8081
 
-java -Dorg.slf4j.simpleLogger.logFile=ke.log -cp "smart-connector-rest-dist-1.2.4.jar:dependency/*" eu.knowledge.engine.rest.Main 8280
+java -Dorg.slf4j.simpleLogger.logFile=ke.log -cp "smart-connector-rest-dist-1.2.5.jar:dependency/*" eu.knowledge.engine.rest.Main 8280
 ```
 
 </TabItem>

docs/docs/quickstart.md

@@ -14,7 +14,7 @@ Start the Knowledge Directory on ports 8080:
 ```bash
 cd knowledge-directory/target/
 
-java -Dorg.slf4j.simpleLogger.logFile=kd.log -cp "knowledge-directory-1.2.4.jar:dependency/*" eu.knowledge.engine.knowledgedirectory.Main 8080
+java -Dorg.slf4j.simpleLogger.logFile=kd.log -cp "knowledge-directory-1.2.5.jar:dependency/*" eu.knowledge.engine.knowledgedirectory.Main 8080
 ```
 You can of course run the Knowledge Directory on another port by replacing 8080 by your preferred port number.
 
@@ -27,7 +27,7 @@ export KD_URL=http://localhost:8080
 export KE_RUNTIME_EXPOSED_URL=http://localhost:8081
 export KE_RUNTIME_PORT=8081
 
-java -Dorg.slf4j.simpleLogger.logFile=ke.log -cp "smart-connector-rest-dist-1.2.4.jar:dependency/*" eu.knowledge.engine.rest.Main 8280
+java -Dorg.slf4j.simpleLogger.logFile=ke.log -cp "smart-connector-rest-dist-1.2.5.jar:dependency/*" eu.knowledge.engine.rest.Main 8280
 ```
 
 ## Registering Knowledge Interactions

examples/authentication/docker-compose.yml

@@ -9,15 +9,15 @@ services:
     depends_on:
       - knowledge-directory
   knowledge-directory:
-    image: ghcr.io/tno/knowledge-engine/knowledge-directory:1.2.4
+    image: ghcr.io/tno/knowledge-engine/knowledge-directory:1.2.5
   runtime-1:
-    image: ghcr.io/tno/knowledge-engine/smart-connector:1.2.4
+    image: ghcr.io/tno/knowledge-engine/smart-connector:1.2.5
     environment:
       KE_RUNTIME_PORT: 8081 # The port that the KE uses to listen for inter-KE-runtime communication.
       KD_URL: http://thisisausername:thisisapassword@nginx/kd
       KE_RUNTIME_EXPOSED_URL: http://thisisausername:thisisapassword@nginx/ker1
   runtime-2:
-    image: ghcr.io/tno/knowledge-engine/smart-connector:1.2.4
+    image: ghcr.io/tno/knowledge-engine/smart-connector:1.2.5
     environment:
       KE_RUNTIME_PORT: 8081 # The port that the KE uses to listen for inter-KE-runtime communication.
       KD_URL: http://thisisausername:thisisapassword@nginx/kd

examples/multiple-runtimes/docker-compose.yml

@@ -2,25 +2,25 @@ services:
   # This is the knowledge directory, facilitating discovery between different
   # runtimes. It exposes its service over port 8282.
   knowledge-directory:
-    image: ghcr.io/tno/knowledge-engine/knowledge-directory:1.2.4
+    image: ghcr.io/tno/knowledge-engine/knowledge-directory:1.2.5
 
   # These services are seperate Knowledge Engine runtime, which can host
   # multiple smart connectors. Note that the REST API port is a DIFFERENT port
   # number than the ones configured below. It is still the default 8280.
   runtime-1:
-    image: ghcr.io/tno/knowledge-engine/smart-connector:1.2.4
+    image: ghcr.io/tno/knowledge-engine/smart-connector:1.2.5
     environment: 
       KE_RUNTIME_PORT: 8081 # The port that the KE uses to listen for inter-KE-runtime communication.
       KE_RUNTIME_EXPOSED_URL: http://runtime-1:8081 # The URL where the runtime is available for inter-runtime communication from the outside.
       KD_URL: http://knowledge-directory:8282
   runtime-2:
-    image: ghcr.io/tno/knowledge-engine/smart-connector:1.2.4
+    image: ghcr.io/tno/knowledge-engine/smart-connector:1.2.5
     environment: 
       KE_RUNTIME_PORT: 8081
       KE_RUNTIME_EXPOSED_URL: http://runtime-2:8081
       KD_URL: http://knowledge-directory:8282
   runtime-3:
-    image: ghcr.io/tno/knowledge-engine/smart-connector:1.2.4
+    image: ghcr.io/tno/knowledge-engine/smart-connector:1.2.5
     environment: 
       KE_RUNTIME_PORT: 8081
       KE_RUNTIME_EXPOSED_URL: http://runtime-3:8081

examples/reasoner/docker-compose.yml

@@ -1,6 +1,6 @@
 services:
   knowledge-engine:
-    image: ghcr.io/tno/knowledge-engine/smart-connector:1.2.4
+    image: ghcr.io/tno/knowledge-engine/smart-connector:1.2.5
   kb1:
     build: ../common/asking_kb
     environment:

examples/rest-api/docker-compose.yml

@@ -1,6 +1,6 @@
 services:
   knowledge-engine:
-    image: ghcr.io/tno/knowledge-engine/smart-connector:1.2.4
+    image: ghcr.io/tno/knowledge-engine/smart-connector:1.2.5
     healthcheck:
       test: curl -f http://localhost:8280/rest/sc
       interval: 1s

examples/runtime-tests/docker-compose.yml

@@ -2,25 +2,25 @@ services:
   # This is the knowledge directory, facilitating discovery between different
   # runtimes. It exposes its service over port 8282.
   knowledge-directory:
-    image: ghcr.io/tno/knowledge-engine/knowledge-directory:1.2.4
+    image: ghcr.io/tno/knowledge-engine/knowledge-directory:1.2.5
 
   # These services are seperate Knowledge Engine runtime, which can host
   # multiple smart connectors. Note that the REST API port is a DIFFERENT port
   # number than the ones configured below. It is still the default 8280.
   runtime-1:
-    image: ghcr.io/tno/knowledge-engine/smart-connector:1.2.4
+    image: ghcr.io/tno/knowledge-engine/smart-connector:1.2.5
     environment: 
       KE_RUNTIME_PORT: 8081 # The port that the KE uses to listen for inter-KE-runtime communication.
       KE_RUNTIME_EXPOSED_URL: http://runtime-1:8081 # The URL where the runtime is available for inter-runtime communication from the outside.
       KD_URL: http://knowledge-directory:8282
   runtime-2:
-    image: ghcr.io/tno/knowledge-engine/smart-connector:1.2.4
+    image: ghcr.io/tno/knowledge-engine/smart-connector:1.2.5
     environment: 
       KE_RUNTIME_PORT: 8081
       KE_RUNTIME_EXPOSED_URL: http://runtime-2:8081
       KD_URL: http://knowledge-directory:8282
   runtime-3:
-    image: ghcr.io/tno/knowledge-engine/smart-connector:1.2.4
+    image: ghcr.io/tno/knowledge-engine/smart-connector:1.2.5
     environment: 
       KE_RUNTIME_PORT: 8081
       KE_RUNTIME_EXPOSED_URL: http://runtime-3:8081
@@ -83,7 +83,7 @@ services:
           }
         ]
   broken-1:
-    image: ghcr.io/tno/knowledge-engine/smart-connector:1.2.4
+    image: ghcr.io/tno/knowledge-engine/smart-connector:1.2.5
     environment: 
       KE_RUNTIME_PORT: 8081 # The port that the KE uses to listen for inter-KE-runtime communication.
       KE_RUNTIME_EXPOSED_URL: runtime-3:8081 # The 'http://' part of the URL with a port is missing.
@@ -102,7 +102,7 @@ services:
       KB_DATA: |
         []
   broken-2:
-    image: ghcr.io/tno/knowledge-engine/smart-connector:1.2.4
+    image: ghcr.io/tno/knowledge-engine/smart-connector:1.2.5
     environment: 
       KE_RUNTIME_PORT: 8081 # The port that the KE uses to listen for inter-KE-runtime communication.
       KE_RUNTIME_EXPOSED_URL: 3test.runtime.nl:8081 # The 'http://' part of the URL with a port is missing and the first character is numeric.
@@ -121,7 +121,7 @@ services:
       KB_DATA: |
         []
   broken-3:
-    image: ghcr.io/tno/knowledge-engine/smart-connector:1.2.4
+    image: ghcr.io/tno/knowledge-engine/smart-connector:1.2.5
     environment: 
       KE_RUNTIME_PORT: 8081 # The port that the KE uses to listen for inter-KE-runtime communication.
       KE_RUNTIME_EXPOSED_URL: 3test.runtime.nl # The 'http://' part of the URL without a port is missing and the first character is numeric.
@@ -140,7 +140,7 @@ services:
       KB_DATA: |
         []
   broken-4:
-    image: ghcr.io/tno/knowledge-engine/smart-connector:1.2.4
+    image: ghcr.io/tno/knowledge-engine/smart-connector:1.2.5
     environment: 
       KE_RUNTIME_PORT: 8081 # The port that the KE uses to listen for inter-KE-runtime communication.
       KE_RUNTIME_EXPOSED_URL: http://runtime-3:8081/ # The URL ends with a '/'
@@ -159,7 +159,7 @@ services:
       KB_DATA: |
         []
   broken-5:
-    image: ghcr.io/tno/knowledge-engine/smart-connector:1.2.4
+    image: ghcr.io/tno/knowledge-engine/smart-connector:1.2.5
     environment: 
       KE_RUNTIME_PORT: 8081 # The port that the KE uses to listen for inter-KE-runtime communication.
       KE_RUNTIME_EXPOSED_URL: runtime-3 # The 'http://' part of the URL without a port is missing.

examples/unreachable-runtimes/docker-compose.yml

@@ -2,7 +2,7 @@ services:
   # This is the knowledge directory, facilitating discovery between different
   # runtimes. It exposes its service over port 8282.
   knowledge-directory:
-    image: ghcr.io/tno/knowledge-engine/knowledge-directory:1.2.4
+    image: ghcr.io/tno/knowledge-engine/knowledge-directory:1.2.5
     ports:
      - "8282:8282"
 

pom.xml

@@ -74,7 +74,7 @@
 		<java.version>17</java.version>
 		<maven.compiler.source>17</maven.compiler.source>
 		<maven.compiler.target>17</maven.compiler.target>
-		<revision>1.2.5-SNAPSHOT</revision>
+		<revision>1.2.5</revision>
 	</properties>
 
 	<dependencyManagement>

smart-connector-rest-server/src/main/resources/openapi-sc.yaml

@@ -7,7 +7,7 @@ info:
     Interactions are (un)registered and data is exchanged. Each Smart Connector
     is coupled with a Knowledge Base Id, so every rest call uses this Knowledge
     Base Id to identify yourself.
-  version: 1.2.5-SNAPSHOT
+  version: 1.2.5
 
 paths:
   /sc: