From 76d4ce0f3aae0d8fa6070df8f7050e717e05fba9 Mon Sep 17 00:00:00 2001 From: Barry Nouwt Date: Fri, 13 Oct 2023 08:45:48 +0200 Subject: [PATCH] Prepare for release. --- README.md | 24 +++++++++---------- .../src/main/resources/openapi-admin-ui.yaml | 2 +- docs/04_distributed_mode.md | 4 ++-- examples/authentication/docker-compose.yml | 6 ++--- examples/multiple-runtimes/docker-compose.yml | 8 +++---- examples/reasoner/docker-compose.yml | 2 +- examples/rest-api/docker-compose.yml | 2 +- .../unreachable-runtimes/docker-compose.yml | 2 +- pom.xml | 2 +- .../src/main/resources/openapi-sc.yaml | 2 +- 10 files changed, 27 insertions(+), 27 deletions(-) diff --git a/README.md b/README.md index 22c1ad59..f5aab820 100644 --- a/README.md +++ b/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.1 + ghcr.io/tno/knowledge-engine/smart-connector:1.2.2 ``` 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.1 + ghcr.io/tno/knowledge-engine/smart-connector:1.2.2 ``` ### 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.1-with-dependencies.jar 8280 + smart-connector-rest-dist-1.2.2-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.1 --push -docker buildx build ./knowledge-directory --platform linux/arm64,linux/amd64 --tag docker-registry.inesctec.pt/interconnect/knowledge-engine/knowledge-directory:1.2.1 --push -docker buildx build ./admin-ui --platform linux/arm64,linux/amd64 --tag docker-registry.inesctec.pt/interconnect/knowledge-engine/admin-ui:1.2.1 --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.2 --push +docker buildx build ./knowledge-directory --platform linux/arm64,linux/amd64 --tag docker-registry.inesctec.pt/interconnect/knowledge-engine/knowledge-directory:1.2.2 --push +docker buildx build ./admin-ui --platform linux/arm64,linux/amd64 --tag docker-registry.inesctec.pt/interconnect/knowledge-engine/admin-ui:1.2.2 --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.1 --push -docker buildx build ./knowledge-directory --platform linux/arm64,linux/amd64 --tag ghcr.io/tno/knowledge-engine/knowledge-directory:1.2.1 --push -docker buildx build ./admin-ui --platform linux/arm64,linux/amd64 --tag ghcr.io/tno/knowledge-engine/admin-ui:1.2.1 --push +docker buildx build ./smart-connector-rest-dist --platform linux/arm64,linux/amd64 --tag ghcr.io/tno/knowledge-engine/smart-connector:1.2.2 --push +docker buildx build ./knowledge-directory --platform linux/arm64,linux/amd64 --tag ghcr.io/tno/knowledge-engine/knowledge-directory:1.2.2 --push +docker buildx build ./admin-ui --platform linux/arm64,linux/amd64 --tag ghcr.io/tno/knowledge-engine/admin-ui:1.2.2 --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.1, make sure you have `git checkout 1.2.1` the tag `1.2.1`. 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.2, make sure you have `git checkout 1.2.2` the tag `1.2.2`. 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.1.jar:dependency/*" eu.knowledge.engine.rest.Main 8280 +java -Dorg.slf4j.simpleLogger.logFile=ke.log -cp "smart-connector-rest-dist-1.2.2.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.1.jar:dependency/*" eu.knowledge.engine.rest.Main 8280 > ke.log +nohup java -cp "smart-connector-rest-dist-1.2.2.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 93baa872..0e3e0e12 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.0.1-SNAPSHOT + version: 1.2.2 paths: /rest/admin/sc/all/{include-meta}: diff --git a/docs/04_distributed_mode.md b/docs/04_distributed_mode.md index 601bbfb2..604e70c7 100644 --- a/docs/04_distributed_mode.md +++ b/docs/04_distributed_mode.md @@ -16,7 +16,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.1.jar:dependency/*" eu.knowledge.engine.knowledgedirectory.Main 8080 +java -Dorg.slf4j.simpleLogger.logFile=kd.log -cp "knowledge-directory-1.2.2.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). @@ -39,7 +39,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.1.jar:dependency/*" eu.knowledge.engine.rest.Main 8280 +java -Dorg.slf4j.simpleLogger.logFile=ke.log -cp "smart-connector-rest-dist-1.2.2.jar:dependency/*" eu.knowledge.engine.rest.Main 8280 ``` ### Using Basic Authentication to secure data exchange diff --git a/examples/authentication/docker-compose.yml b/examples/authentication/docker-compose.yml index fd49c4d7..75fd046d 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.2.1 + image: ghcr.io/tno/knowledge-engine/knowledge-directory:1.2.2 runtime-1: - image: ghcr.io/tno/knowledge-engine/smart-connector:1.2.1 + image: ghcr.io/tno/knowledge-engine/smart-connector:1.2.2 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.1 + image: ghcr.io/tno/knowledge-engine/smart-connector:1.2.2 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 dfe7818f..f02a3626 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.2.1 + image: ghcr.io/tno/knowledge-engine/knowledge-directory:1.2.2 # 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.1 + image: ghcr.io/tno/knowledge-engine/smart-connector:1.2.2 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.1 + image: ghcr.io/tno/knowledge-engine/smart-connector:1.2.2 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.1 + image: ghcr.io/tno/knowledge-engine/smart-connector:1.2.2 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 c5a23a29..c9bd43e3 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.2.1 + image: ghcr.io/tno/knowledge-engine/smart-connector:1.2.2 kb1: build: ../common/asking_kb environment: diff --git a/examples/rest-api/docker-compose.yml b/examples/rest-api/docker-compose.yml index 54743264..483a0c2d 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.2.1 + image: ghcr.io/tno/knowledge-engine/smart-connector:1.2.2 healthcheck: test: curl -f http://localhost:8280/rest/sc interval: 1s diff --git a/examples/unreachable-runtimes/docker-compose.yml b/examples/unreachable-runtimes/docker-compose.yml index 8ee4629e..2498873f 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.2.1 + image: ghcr.io/tno/knowledge-engine/knowledge-directory:1.2.2 # These services are seperate Knowledge Engine runtime, which can host # multiple smart connectors. Note that the REST API port is a DIFFERENT port diff --git a/pom.xml b/pom.xml index 174bebd5..7de073f1 100644 --- a/pom.xml +++ b/pom.xml @@ -74,7 +74,7 @@ 17 17 17 - 1.2.2-SNAPSHOT + 1.2.2 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 f683791f..e93730f9 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.2.2-SNAPSHOT + version: 1.2.2 paths: /sc: