diff --git a/README.md b/README.md index 78e69398a..3fb5fa7e2 100644 --- a/README.md +++ b/README.md @@ -75,7 +75,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.0 + ghcr.io/tno/knowledge-engine/smart-connector:1.3.1 ``` The Knowledge Engine runtime is now available to use via the REST API at base URL `http://localhost:8280/rest` on your host machine. @@ -97,7 +97,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.0 + ghcr.io/tno/knowledge-engine/smart-connector:1.3.1 ``` ### Running with Java @@ -115,7 +115,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.0-with-dependencies.jar 8280 + smart-connector-rest-dist-1.3.1-with-dependencies.jar 8280 ``` The JAR can be retrieved by compiling the project: @@ -221,7 +221,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.0, make sure you have `git checkout 1.3.0` the tag `1.3.0`. 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.3.1, make sure you have `git checkout 1.3.1` the tag `1.3.1`. 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. @@ -235,13 +235,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.0.jar:dependency/*" eu.knowledge.engine.rest.Main 8280 +java -Dorg.slf4j.simpleLogger.logFile=ke.log -cp "smart-connector-rest-dist-1.3.1.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.0.jar:dependency/*" eu.knowledge.engine.rest.Main 8280 > ke.log +nohup java -cp "smart-connector-rest-dist-1.3.1.jar:dependency/*" eu.knowledge.engine.rest.Main 8280 > ke.log ``` ### Starting the Knowledge Engine in distributed mode diff --git a/admin-ui/src/main/resources/openapi-admin-ui.yaml b/admin-ui/src/main/resources/openapi-admin-ui.yaml index 5be523bb9..e4fa8a1c1 100644 --- a/admin-ui/src/main/resources/openapi-admin-ui.yaml +++ b/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.0 + version: 1.3.1 paths: /rest/admin/sc/all/{include-meta}: diff --git a/docs/docs/distributed_mode.md b/docs/docs/distributed_mode.md index 3714681e6..231fca05a 100644 --- a/docs/docs/distributed_mode.md +++ b/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.0.jar:dependency/*" eu.knowledge.engine.knowledgedirectory.Main 8080 +java -Dorg.slf4j.simpleLogger.logFile=kd.log -cp "knowledge-directory-1.3.1.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.0.jar:dependency/*" eu.knowledge.engine.rest.Main 8280 +java -Dorg.slf4j.simpleLogger.logFile=ke.log -cp "smart-connector-rest-dist-1.3.1.jar:dependency/*" eu.knowledge.engine.rest.Main 8280 ``` ### Using Basic Authentication to secure data exchange diff --git a/docs/docs/get-started/knowledge-directory.md b/docs/docs/get-started/knowledge-directory.md index 54f589187..8bdc29a9a 100644 --- a/docs/docs/get-started/knowledge-directory.md +++ b/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.0.jar:dependency/*" eu.knowledge.engine.knowledgedirectory.Main 8080 +java -Dorg.slf4j.simpleLogger.logFile=kd.log -cp "knowledge-directory-1.3.1.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. diff --git a/docs/docs/get-started/smart-connector.md b/docs/docs/get-started/smart-connector.md index 945e0fcad..bc96a73e6 100644 --- a/docs/docs/get-started/smart-connector.md +++ b/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.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.3.0/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.3.1/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.1/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.0.jar:dependency/*" eu.knowledge.engine.rest.Main 8280 +java -Dorg.slf4j.simpleLogger.logFile=ke.log -cp "smart-connector-rest-dist-1.3.1.jar:dependency/*" eu.knowledge.engine.rest.Main 8280 ``` diff --git a/examples/anomaly-detection/docker-compose.yml b/examples/anomaly-detection/docker-compose.yml index 9f3c3fca5..b43428cdc 100644 --- a/examples/anomaly-detection/docker-compose.yml +++ b/examples/anomaly-detection/docker-compose.yml @@ -1,10 +1,10 @@ services: knowledge-directory: - image: ghcr.io/tno/knowledge-engine/knowledge-directory:1.3.0 + image: ghcr.io/tno/knowledge-engine/knowledge-directory:1.3.1 #ANOMALY DETECTION anomaly-detection-ker: - image: ghcr.io/tno/knowledge-engine/smart-connector:1.3.1-SNAPSHOT + image: ghcr.io/tno/knowledge-engine/smart-connector:1.3.1 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.1-SNAPSHOT + image: ghcr.io/tno/knowledge-engine/smart-connector:1.3.1 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.1-SNAPSHOT + image: ghcr.io/tno/knowledge-engine/smart-connector:1.3.1 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.1-SNAPSHOT + image: ghcr.io/tno/knowledge-engine/smart-connector:1.3.1 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.1-SNAPSHOT + image: ghcr.io/tno/knowledge-engine/smart-connector:1.3.1 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.1-SNAPSHOT + image: ghcr.io/tno/knowledge-engine/smart-connector:1.3.1 environment: KE_RUNTIME_PORT: 8081 KE_RUNTIME_EXPOSED_URL: http://converter-ker:8081 diff --git a/examples/authentication/docker-compose.yml b/examples/authentication/docker-compose.yml index d45781ebc..f07b6308e 100644 --- a/examples/authentication/docker-compose.yml +++ b/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.0 + image: ghcr.io/tno/knowledge-engine/knowledge-directory:1.3.1 runtime-1: - image: ghcr.io/tno/knowledge-engine/smart-connector:1.3.0 + image: ghcr.io/tno/knowledge-engine/smart-connector:1.3.1 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.0 + image: ghcr.io/tno/knowledge-engine/smart-connector:1.3.1 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 diff --git a/examples/multiple-runtimes/docker-compose.yml b/examples/multiple-runtimes/docker-compose.yml index f11eec0b2..8238865bf 100644 --- a/examples/multiple-runtimes/docker-compose.yml +++ b/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.0 + image: ghcr.io/tno/knowledge-engine/knowledge-directory:1.3.1 # 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.0 + image: ghcr.io/tno/knowledge-engine/smart-connector:1.3.1 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.0 + image: ghcr.io/tno/knowledge-engine/smart-connector:1.3.1 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.0 + image: ghcr.io/tno/knowledge-engine/smart-connector:1.3.1 environment: KE_RUNTIME_PORT: 8081 KE_RUNTIME_EXPOSED_URL: http://runtime-3:8081 diff --git a/examples/reasoner/docker-compose.yml b/examples/reasoner/docker-compose.yml index feee11fb3..664c3bb7c 100644 --- a/examples/reasoner/docker-compose.yml +++ b/examples/reasoner/docker-compose.yml @@ -1,6 +1,6 @@ services: knowledge-engine: - image: ghcr.io/tno/knowledge-engine/smart-connector:1.3.0 + image: ghcr.io/tno/knowledge-engine/smart-connector:1.3.1 kb1: build: ../common/asking_kb environment: diff --git a/examples/rest-api/docker-compose.yml b/examples/rest-api/docker-compose.yml index acb337e41..fc06f7fe1 100644 --- a/examples/rest-api/docker-compose.yml +++ b/examples/rest-api/docker-compose.yml @@ -1,6 +1,6 @@ services: knowledge-engine: - image: ghcr.io/tno/knowledge-engine/smart-connector:1.3.0 + image: ghcr.io/tno/knowledge-engine/smart-connector:1.3.1 healthcheck: test: wget http://localhost:8280/rest/sc -O /dev/null interval: 1s diff --git a/examples/runtime-tests/docker-compose.yml b/examples/runtime-tests/docker-compose.yml index e904da21d..6bf573a79 100644 --- a/examples/runtime-tests/docker-compose.yml +++ b/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.3.0 + image: ghcr.io/tno/knowledge-engine/knowledge-directory:1.3.1 # 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.0 + image: ghcr.io/tno/knowledge-engine/smart-connector:1.3.1 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.0 + image: ghcr.io/tno/knowledge-engine/smart-connector:1.3.1 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.0 + image: ghcr.io/tno/knowledge-engine/smart-connector:1.3.1 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.3.0 + image: ghcr.io/tno/knowledge-engine/smart-connector:1.3.1 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.3.0 + image: ghcr.io/tno/knowledge-engine/smart-connector:1.3.1 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.3.0 + image: ghcr.io/tno/knowledge-engine/smart-connector:1.3.1 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.3.0 + image: ghcr.io/tno/knowledge-engine/smart-connector:1.3.1 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.3.0 + image: ghcr.io/tno/knowledge-engine/smart-connector:1.3.1 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. diff --git a/examples/unreachable-runtimes/docker-compose.yml b/examples/unreachable-runtimes/docker-compose.yml index 88449fcd8..8c3c06039 100644 --- a/examples/unreachable-runtimes/docker-compose.yml +++ b/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.3.0 + image: ghcr.io/tno/knowledge-engine/knowledge-directory:1.3.1 ports: - "8282:8282" diff --git a/pom.xml b/pom.xml index 40fb19cd1..2952d385b 100644 --- a/pom.xml +++ b/pom.xml @@ -78,7 +78,7 @@ 2.19.0 17 17 - 1.3.1-SNAPSHOT + 1.3.1 diff --git a/smart-connector-rest-server/src/main/resources/openapi-sc.yaml b/smart-connector-rest-server/src/main/resources/openapi-sc.yaml index 94014cb7a..6f948d2d5 100644 --- a/smart-connector-rest-server/src/main/resources/openapi-sc.yaml +++ b/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.3.1-SNAPSHOT + version: 1.3.1 paths: /sc: