Skip to content

Commit 8fb5110

Browse files
author
Han Kruiger
committed
Merge branch 'prepare-1.2.0' into 'master'
Prepare 1.2.0 See merge request interconnect/knowledge-engine!368
2 parents c52e619 + 831a2da commit 8fb5110

File tree

7 files changed

+22
-22
lines changed

7 files changed

+22
-22
lines changed

README.md

+11-11
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ The easiest way to start a Knowledge Engine runtime is with Docker:
7171
```bash
7272
docker run \
7373
-p 8280:8280 \
74-
ghcr.io/tno/knowledge-engine/smart-connector:1.1.3
74+
ghcr.io/tno/knowledge-engine/smart-connector:1.2.0
7575
```
7676

7777
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 \
9393
-p 8081:8081 \
9494
-e KD_URL=https://knowledge-directory.example.org \
9595
-e KE_RUNTIME_EXPOSED_URL=https://your-domain.example.org:8081 \
96-
ghcr.io/tno/knowledge-engine/smart-connector:1.1.3
96+
ghcr.io/tno/knowledge-engine/smart-connector:1.2.0
9797
```
9898

9999
### Running with Java
@@ -111,7 +111,7 @@ export KE_RUNTIME_EXPOSED_URL=https://your-domain.example.org:8081
111111
# Start it. The argument (8280) denotes the port number at which it
112112
# will listen for connections to the Knowledge Engine REST API.
113113
java -jar -Dorg.slf4j.simpleLogger.logFile=smart-connector.log \
114-
smart-connector-rest-dist-1.1.3-with-dependencies.jar 8280
114+
smart-connector-rest-dist-1.2.0-with-dependencies.jar 8280
115115
```
116116

117117
The JAR can be retrieved by compiling the project:
@@ -202,14 +202,14 @@ These are instructions on what to do when we release a new version of the knowle
202202
3. `mvn deploy` (for this you need `Deploy-Token` or `Private-Token` configured in your Maven's `settings.xml`, see [GitLab's documentation on this](https://docs.gitlab.com/ee/user/packages/maven_repository/#authenticate-to-the-package-registry-with-maven))
203203
4. Build and push the new Docker images:
204204
```bash
205-
docker buildx build ./smart-connector-rest-dist --platform linux/arm64,linux/amd64 --tag ghcr.io/tno/knowledge-engine/smart-connector:1.1.3 --push
206-
docker buildx build ./knowledge-directory --platform linux/arm64,linux/amd64 --tag ghcr.io/tno/knowledge-engine/knowledge-directory:1.1.3 --push
207-
docker buildx build ./admin-ui --platform linux/arm64,linux/amd64 --tag ghcr.io/tno/knowledge-engine/admin-ui:1.1.3 --push
205+
docker buildx build ./smart-connector-rest-dist --platform linux/arm64,linux/amd64 --tag ghcr.io/tno/knowledge-engine/smart-connector:1.2.0 --push
206+
docker buildx build ./knowledge-directory --platform linux/arm64,linux/amd64 --tag ghcr.io/tno/knowledge-engine/knowledge-directory:1.2.0 --push
207+
docker buildx build ./admin-ui --platform linux/arm64,linux/amd64 --tag ghcr.io/tno/knowledge-engine/admin-ui:1.2.0 --push
208208
```
209209
5. Prepare the next SNAPSHOT version and make a commit for that too.
210210

211211
## (advanced) Administering a Knowledge Engine runtime
212-
To start a new instance of the REST API knowledge engine version 1.1.3, make sure you have `git checkout 1.1.3` the tag `1.1.3`. Now make sure you run the `mvn clean install` command successfully from the root of the repository.
212+
To start a new instance of the REST API knowledge engine version 1.2.0, make sure you have `git checkout 1.2.0` the tag `1.2.0`. Now make sure you run the `mvn clean install` command successfully from the root of the repository.
213213

214214
### Starting the Knowledge Engine in local mode
215215
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.
@@ -223,13 +223,13 @@ cd smart-connector-rest-dist/target
223223
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):
224224

225225
```bash
226-
java -Dorg.slf4j.simpleLogger.logFile=ke.log -cp "smart-connector-rest-dist-1.1.3.jar:dependency/*" eu.knowledge.engine.rest.Main 8280
226+
java -Dorg.slf4j.simpleLogger.logFile=ke.log -cp "smart-connector-rest-dist-1.2.0.jar:dependency/*" eu.knowledge.engine.rest.Main 8280
227227
```
228228

229229
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):
230230

231231
```bash
232-
nohup java -cp "smart-connector-rest-dist-1.1.3.jar:dependency/*" eu.knowledge.engine.rest.Main 8280 > ke.log
232+
nohup java -cp "smart-connector-rest-dist-1.2.0.jar:dependency/*" eu.knowledge.engine.rest.Main 8280 > ke.log
233233
```
234234

235235
### Starting the Knowledge Engine in distributed mode
@@ -242,7 +242,7 @@ First of all, you need to start a knowledge directory. The desired port number f
242242
```bash
243243
cd knowledge-directory/target/
244244

245-
java -Dorg.slf4j.simpleLogger.logFile=kd.log -cp "knowledge-directory-1.1.3.jar:dependency/*" eu.knowledge.engine.knowledgedirectory.Main 8080
245+
java -Dorg.slf4j.simpleLogger.logFile=kd.log -cp "knowledge-directory-1.2.0.jar:dependency/*" eu.knowledge.engine.knowledgedirectory.Main 8080
246246
```
247247

248248
As explained in the local mode section, `nohup` 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).
@@ -265,7 +265,7 @@ export KD_URL=http://localhost:8080
265265
export KE_RUNTIME_EXPOSED_URL=http://localhost:8081
266266
export KE_RUNTIME_PORT=8081
267267

268-
java -Dorg.slf4j.simpleLogger.logFile=ke.log -cp "smart-connector-rest-dist-1.1.3.jar:dependency/*" eu.knowledge.engine.rest.Main 8280
268+
java -Dorg.slf4j.simpleLogger.logFile=ke.log -cp "smart-connector-rest-dist-1.2.0.jar:dependency/*" eu.knowledge.engine.rest.Main 8280
269269
```
270270

271271
As explained in the local mode section, `nohup` can be used to run the process in the background.

examples/authentication/docker-compose.yml

+3-3
Original file line numberDiff line numberDiff line change
@@ -9,15 +9,15 @@ services:
99
depends_on:
1010
- knowledge-directory
1111
knowledge-directory:
12-
image: ghcr.io/tno/knowledge-engine/knowledge-directory:1.1.4-SNAPSHOT
12+
image: ghcr.io/tno/knowledge-engine/knowledge-directory:1.2.0
1313
runtime-1:
14-
image: ghcr.io/tno/knowledge-engine/smart-connector:1.1.4-SNAPSHOT
14+
image: ghcr.io/tno/knowledge-engine/smart-connector:1.2.0
1515
environment:
1616
KE_RUNTIME_PORT: 8081 # The port that the KE uses to listen for inter-KE-runtime communication.
1717
KD_URL: http://thisisausername:thisisapassword@nginx/kd
1818
KE_RUNTIME_EXPOSED_URL: http://thisisausername:thisisapassword@nginx/ker1
1919
runtime-2:
20-
image: ghcr.io/tno/knowledge-engine/smart-connector:1.1.4-SNAPSHOT
20+
image: ghcr.io/tno/knowledge-engine/smart-connector:1.2.0
2121
environment:
2222
KE_RUNTIME_PORT: 8081 # The port that the KE uses to listen for inter-KE-runtime communication.
2323
KD_URL: http://thisisausername:thisisapassword@nginx/kd

examples/multiple-runtimes/docker-compose.yml

+4-4
Original file line numberDiff line numberDiff line change
@@ -2,25 +2,25 @@ services:
22
# This is the knowledge directory, facilitating discovery between different
33
# runtimes. It exposes its service over port 8282.
44
knowledge-directory:
5-
image: ghcr.io/tno/knowledge-engine/knowledge-directory:1.1.3
5+
image: ghcr.io/tno/knowledge-engine/knowledge-directory:1.2.0
66

77
# These services are seperate Knowledge Engine runtime, which can host
88
# multiple smart connectors. Note that the REST API port is a DIFFERENT port
99
# number than the ones configured below. It is still the default 8280.
1010
runtime-1:
11-
image: ghcr.io/tno/knowledge-engine/smart-connector:1.1.3
11+
image: ghcr.io/tno/knowledge-engine/smart-connector:1.2.0
1212
environment:
1313
KE_RUNTIME_PORT: 8081 # The port that the KE uses to listen for inter-KE-runtime communication.
1414
KE_RUNTIME_EXPOSED_URL: http://runtime-1:8081 # The URL where the runtime is available for inter-runtime communication from the outside.
1515
KD_URL: http://knowledge-directory:8282
1616
runtime-2:
17-
image: ghcr.io/tno/knowledge-engine/smart-connector:1.1.3
17+
image: ghcr.io/tno/knowledge-engine/smart-connector:1.2.0
1818
environment:
1919
KE_RUNTIME_PORT: 8081
2020
KE_RUNTIME_EXPOSED_URL: http://runtime-2:8081
2121
KD_URL: http://knowledge-directory:8282
2222
runtime-3:
23-
image: ghcr.io/tno/knowledge-engine/smart-connector:1.1.3
23+
image: ghcr.io/tno/knowledge-engine/smart-connector:1.2.0
2424
environment:
2525
KE_RUNTIME_PORT: 8081
2626
KE_RUNTIME_EXPOSED_URL: http://runtime-3:8081

examples/rest-api/docker-compose.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
services:
22
knowledge-engine:
3-
image: ghcr.io/tno/knowledge-engine/smart-connector:1.1.3
3+
image: ghcr.io/tno/knowledge-engine/smart-connector:1.2.0
44
healthcheck:
55
test: curl -f http://localhost:8280/rest/sc
66
interval: 1s

pom.xml

+1-1
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@
7474
<java.version>17</java.version>
7575
<maven.compiler.source>17</maven.compiler.source>
7676
<maven.compiler.target>17</maven.compiler.target>
77-
<revision>1.1.4-SNAPSHOT</revision>
77+
<revision>1.2.0</revision>
7878
</properties>
7979

8080
<dependencyManagement>

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ info:
77
Interactions are (un)registered and data is exchanged. Each Smart Connector
88
is coupled with a Knowledge Base Id, so every rest call uses this Knowledge
99
Base Id to identify yourself.
10-
version: 1.1.4-SNAPSHOT
10+
version: 1.2.0
1111

1212
paths:
1313
/sc:

smart-connector/src/main/java/eu/knowledge/engine/smartconnector/runtime/messaging/KnowledgeDirectoryConnection.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ public class KnowledgeDirectoryConnection {
3939

4040
private final static Logger LOG = org.slf4j.LoggerFactory.getLogger(KnowledgeDirectoryConnection.class);
4141

42-
private static final String PROTOCOL_VERSION = "1.0.0-SNAPSHOT";
42+
private static final String PROTOCOL_VERSION = "1.0.0";
4343

4444
public static enum State {
4545
UNREGISTERED, REGISTERED, INTERRUPTED, STOPPING, STOPPED

0 commit comments

Comments
 (0)