Merge pull request #767 from TNO/prepare_for_release

Prepare for release.

Author: bnouwt

README.md

@@ -76,7 +76,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.3.2
+	ghcr.io/tno/knowledge-engine/smart-connector:1.4.0
 ```
 
 The Knowledge Engine runtime is now available to use via the REST API at base URL `http://localhost:8280/rest` on your host machine.
@@ -98,7 +98,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.3.2
+  ghcr.io/tno/knowledge-engine/smart-connector:1.4.0
 ```
 
 ### Running with Java
@@ -116,7 +116,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.3.2-with-dependencies.jar 8280
+  smart-connector-rest-dist-1.4.0-with-dependencies.jar 8280
 ```
 
 The JAR can be retrieved by compiling the project:
@@ -227,7 +227,7 @@ These are instructions on what to do when we release a new version of the knowle
 The code conventions of the knowledge-engine can be found in the `/ide` folder in the Eclipse IDE format. The format can often also be imported in other Java IDEs like IntelliJ, VSCode or Netbeans.
 
 ## (advanced) Administering a Knowledge Engine runtime
-To start a new instance of the REST API knowledge engine version 1.3.2, make sure you have `git checkout 1.3.2` the tag `1.3.2`. 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.4.0, make sure you have `git checkout 1.4.0` the tag `1.4.0`. 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.
@@ -241,13 +241,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.3.2.jar:dependency/*" eu.knowledge.engine.rest.Main 8280
+java -Dorg.slf4j.simpleLogger.logFile=ke.log -cp "smart-connector-rest-dist-1.4.0.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.3.2.jar:dependency/*" eu.knowledge.engine.rest.Main 8280 > ke.log
+nohup java -cp "smart-connector-rest-dist-1.4.0.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.3.2
+  version: 1.4.0
 
 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.3.2.jar:dependency/*" eu.knowledge.engine.knowledgedirectory.Main 8080
+java -Dorg.slf4j.simpleLogger.logFile=kd.log -cp "knowledge-directory-1.4.0.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.3.2.jar:dependency/*" eu.knowledge.engine.rest.Main 8280
+java -Dorg.slf4j.simpleLogger.logFile=ke.log -cp "smart-connector-rest-dist-1.4.0.jar:dependency/*" eu.knowledge.engine.rest.Main 8280
 ```
 
 ### Using Basic Authentication to secure data exchange

docs/docs/get-started/knowledge-directory.md

@@ -8,6 +8,6 @@ You can start the Knowledge Directory on ports 8080 with the available JAR:
 ```bash
 cd knowledge-directory/target/
 
-java -Dorg.slf4j.simpleLogger.logFile=kd.log -cp "knowledge-directory-1.3.2.jar:dependency/*" eu.knowledge.engine.knowledgedirectory.Main 8080
+java -Dorg.slf4j.simpleLogger.logFile=kd.log -cp "knowledge-directory-1.4.0.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.

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

@@ -9,7 +9,7 @@ import TabItem from '@theme/TabItem';
 This page describes how to connect to an (existing) Knowledge Network using a Smart Connector.
 
 To connect to a Knowledge Network, you need a Knowledge Engine Runtime (KER).
-Every KER in distributed mode consists of two APIs: [Knowledge Engine Developer REST API](https://github.com/TNO/knowledge-engine/blob/1.3.2/smart-connector-rest-server/src/main/resources/openapi-sc.yaml) and the [Inter-Knowledge Engine Runtime API](https://github.com/TNO/knowledge-engine/blob/1.3.2/smart-connector/src/main/resources/openapi-inter-ker.yaml).
+Every KER in distributed mode consists of two APIs: [Knowledge Engine Developer REST API](https://github.com/TNO/knowledge-engine/blob/1.4.0/smart-connector-rest-server/src/main/resources/openapi-sc.yaml) and the [Inter-Knowledge Engine Runtime API](https://github.com/TNO/knowledge-engine/blob/1.4.0/smart-connector/src/main/resources/openapi-inter-ker.yaml).
 The former is started on port `8280` by default, and you use this API to register your Knowledge Base and Knowledge Interactions.
 The latter API is meant for internal communication between KERs and you do not need to use it yourself.
 However, you do need to make sure this API is reachable for other KERs in the Knowledge Network.
@@ -62,7 +62,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.3.2.jar:dependency/*" eu.knowledge.engine.rest.Main 8280
+java -Dorg.slf4j.simpleLogger.logFile=ke.log -cp "smart-connector-rest-dist-1.4.0.jar:dependency/*" eu.knowledge.engine.rest.Main 8280
 ```
 
 </TabItem>

examples/anomaly-detection/docker-compose.yml

@@ -1,10 +1,10 @@
 services:
   knowledge-directory:
-    image: ghcr.io/tno/knowledge-engine/knowledge-directory:1.3.2
+    image: ghcr.io/tno/knowledge-engine/knowledge-directory:1.4.0
 
   #ANOMALY DETECTION
   anomaly-detection-ker:
-    image: ghcr.io/tno/knowledge-engine/smart-connector:1.3.2
+    image: ghcr.io/tno/knowledge-engine/smart-connector:1.4.0
     environment:
       KE_RUNTIME_PORT: 8081
       KE_RUNTIME_EXPOSED_URL: http://anomaly-detection-ker:8081
@@ -30,7 +30,7 @@ services:
 
   #SENSOR1
   sensor1-ker:
-    image: ghcr.io/tno/knowledge-engine/smart-connector:1.3.2
+    image: ghcr.io/tno/knowledge-engine/smart-connector:1.4.0
     environment:
       KE_RUNTIME_PORT: 8081
       KE_RUNTIME_EXPOSED_URL: http://sensor1-ker:8081
@@ -64,7 +64,7 @@ services:
   
   #SENSOR2
   sensor2-ker:
-    image: ghcr.io/tno/knowledge-engine/smart-connector:1.3.2
+    image: ghcr.io/tno/knowledge-engine/smart-connector:1.4.0
     environment:
       KE_RUNTIME_PORT: 8081
       KE_RUNTIME_EXPOSED_URL: http://sensor2-ker:8081
@@ -98,7 +98,7 @@ services:
 
   #SENSOR3
   sensor3-ker:
-    image: ghcr.io/tno/knowledge-engine/smart-connector:1.3.2
+    image: ghcr.io/tno/knowledge-engine/smart-connector:1.4.0
     environment:
       KE_RUNTIME_PORT: 8081
       KE_RUNTIME_EXPOSED_URL: http://sensor3-ker:8081
@@ -130,7 +130,7 @@ services:
           }
         ]
   building-ker:
-    image: ghcr.io/tno/knowledge-engine/smart-connector:1.3.2
+    image: ghcr.io/tno/knowledge-engine/smart-connector:1.4.0
     environment:
       KE_RUNTIME_PORT: 8081
       KE_RUNTIME_EXPOSED_URL: http://building-ker:8081
@@ -164,7 +164,7 @@ services:
           }
         ]
   converter-ker:
-    image: ghcr.io/tno/knowledge-engine/smart-connector:1.3.2
+    image: ghcr.io/tno/knowledge-engine/smart-connector:1.4.0
     environment:
       KE_RUNTIME_PORT: 8081
       KE_RUNTIME_EXPOSED_URL: http://converter-ker:8081

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.3.2
+    image: ghcr.io/tno/knowledge-engine/knowledge-directory:1.4.0
   runtime-1:
-    image: ghcr.io/tno/knowledge-engine/smart-connector:1.3.2
+    image: ghcr.io/tno/knowledge-engine/smart-connector:1.4.0
     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.3.2
+    image: ghcr.io/tno/knowledge-engine/smart-connector:1.4.0
     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/edc-example/README.md

@@ -53,8 +53,8 @@ One knowledge base asks for information and the other two provide an answer to t
 ### Executing the example
 Execute the following steps to run the example:
 1. In this project, execute a `mvn clean install`.
-2. In the `knowledge-directory` directory in this project, execute `docker build . -t testkd:1.3.3-SNAPSHOT`.
-3. In the `smart-connector-rest-dist` directory in this project, execute `docker build . -t testsc:1.3.3-SNAPSHOT`.
+2. In the `knowledge-directory` directory in this project, execute `docker build . -t testkd:1.4.0`.
+3. In the `smart-connector-rest-dist` directory in this project, execute `docker build . -t testsc:1.4.0`.
 4. In the `examples/edc-example` directory in this project, execute `docker compose build`. 
 5. In the `examples/edc-example` directory in this project, execute `docker compose up -d tke-edc-one tke-edc-two tke-edc-three`. This starts three EDC-IDS Connectors.
 6. Wait around 10 seconds to give the EDC Connectors time to finish setting up. Then, execute `docker compose up -d` to start three KERs, three linked Knowledge Bases and a Knowledge Directory.

examples/edc-example/docker-compose.yml

@@ -3,15 +3,15 @@ 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.3.3-SNAPSHOT
+    image: ghcr.io/tno/knowledge-engine/knowledge-directory:1.4.0
     networks:
       - tke-edc-manager_default
 
   # 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.3.3-SNAPSHOT
+    image: ghcr.io/tno/knowledge-engine/smart-connector:1.4.0
     networks:
       - tke-edc-manager_default
     environment:
@@ -28,7 +28,7 @@ services:
     depends_on:
       - tke-edc-one
   runtime-2:
-    image: ghcr.io/tno/knowledge-engine/smart-connector:1.3.3-SNAPSHOT
+    image: ghcr.io/tno/knowledge-engine/smart-connector:1.4.0
     networks:
       - tke-edc-manager_default
     environment:
@@ -45,7 +45,7 @@ services:
     depends_on:
       - tke-edc-two
   runtime-3:
-    image: ghcr.io/tno/knowledge-engine/smart-connector:1.3.3-SNAPSHOT
+    image: ghcr.io/tno/knowledge-engine/smart-connector:1.4.0
     networks:
       - tke-edc-manager_default
     environment:

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.3.2
+    image: ghcr.io/tno/knowledge-engine/knowledge-directory:1.4.0
 
   # 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.3.2
+    image: ghcr.io/tno/knowledge-engine/smart-connector:1.4.0
     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.3.2
+    image: ghcr.io/tno/knowledge-engine/smart-connector:1.4.0
     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.3.2
+    image: ghcr.io/tno/knowledge-engine/smart-connector:1.4.0
     environment: 
       KE_RUNTIME_PORT: 8081
       KE_RUNTIME_EXPOSED_URL: http://runtime-3:8081