Skip to content

Commit b29d65d

Browse files
author
Han Kruiger
committed
Merge branch 'prepare-1.1.2' into 'master'
prepare version 1.1.2 See merge request interconnect/knowledge-engine!324
2 parents eb62210 + bdc2e03 commit b29d65d

File tree

4 files changed

+16
-16
lines changed

4 files changed

+16
-16
lines changed

README.md

+11-11
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ With the API specification, you will be able to:
3030
In the [`client_example` package](./smart-connector-rest-server/src/main/java/eu/interconnectproject/knowledge_engine/rest/api/client_example), there are several examples of clients written in Java.
3131

3232
## How to administer the REST API
33-
To start a new instance of the REST API knowledge engine version 1.1.1, make sure you have `git checkout 1.1.1` the tag `1.1.1`. Now make sure you run the `mvn clean install` command successfully from the root of the repository.
33+
To start a new instance of the REST API knowledge engine version 1.1.2, make sure you have `git checkout 1.1.2` the tag `1.1.2`. Now make sure you run the `mvn clean install` command successfully from the root of the repository.
3434

3535
### Starting the Knowledge Engine in local mode
3636
When no additional configuration parameters are provided, the Knowledge Engine will be 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 on other machines.
@@ -46,13 +46,13 @@ cd smart-connector-rest-dist/target
4646
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):
4747

4848
```bash
49-
java -Dorg.slf4j.simpleLogger.logFile=ke.log -cp "smart-connector-rest-dist-1.1.1.jar:dependency/*" eu.knowledge.engine.rest.Main 8280
49+
java -Dorg.slf4j.simpleLogger.logFile=ke.log -cp "smart-connector-rest-dist-1.1.2.jar:dependency/*" eu.knowledge.engine.rest.Main 8280
5050
```
5151

5252
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):
5353

5454
```bash
55-
nohup java -cp "smart-connector-rest-dist-1.1.1.jar:dependency/*" eu.knowledge.engine.rest.Main 8280 > ke.log
55+
nohup java -cp "smart-connector-rest-dist-1.1.2.jar:dependency/*" eu.knowledge.engine.rest.Main 8280 > ke.log
5656
```
5757

5858
### Starting the Knowledge Engine in distributed mode
@@ -63,7 +63,7 @@ First of all, you need to start a Knowledge Directory. The desired port number f
6363
```bash
6464
cd knowledge-directory/target/
6565

66-
java -Dorg.slf4j.simpleLogger.logFile=kd.log -cp "knowledge-directory-1.1.1.jar:dependency/*" eu.knowledge.engine.knowledgedirectory.Main 8080
66+
java -Dorg.slf4j.simpleLogger.logFile=kd.log -cp "knowledge-directory-1.1.2.jar:dependency/*" eu.knowledge.engine.knowledgedirectory.Main 8080
6767
```
6868

6969
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).
@@ -86,7 +86,7 @@ export KD_URL=http://localhost:8080
8686
export KE_RUNTIME_EXPOSED_URL=http://localhost:8081
8787
export KE_RUNTIME_PORT=8081
8888

89-
java -Dorg.slf4j.simpleLogger.logFile=ke.log -cp "smart-connector-rest-dist-1.1.1.jar:dependency/*" eu.knowledge.engine.rest.Main 8280
89+
java -Dorg.slf4j.simpleLogger.logFile=ke.log -cp "smart-connector-rest-dist-1.1.2.jar:dependency/*" eu.knowledge.engine.rest.Main 8280
9090
```
9191

9292
As explained in the local mode section, nohup can be used to run the process in the background.
@@ -101,12 +101,12 @@ These are instructions on what to do when we release a new version of the knowle
101101
2. Make a commit for the release, and tag it with `git tag {x}.{y}.{z}` in GitLab.
102102
3. `mvn deploy` (for this you need `Deploy-Token` configured in your Maven's `settings.xml`)
103103
4. Build and push the new docker images:
104-
- `docker build ./smart-connector-rest-dist -t docker-registry.inesctec.pt/interconnect/knowledge-engine/smart-connector-rest-dist:1.1.1`
105-
- `docker build ./knowledge-directory -t docker-registry.inesctec.pt/interconnect/knowledge-engine/knowledge-directory:1.1.1`
106-
- `docker build ./admin-ui -t docker-registry.inesctec.pt/interconnect/knowledge-engine/admin-ui:1.1.1`
107-
- `docker push docker-registry.inesctec.pt/interconnect/knowledge-engine/smart-connector-rest-dist:1.1.1`
108-
- `docker push docker-registry.inesctec.pt/interconnect/knowledge-engine/knowledge-directory:1.1.1`
109-
- `docker push docker-registry.inesctec.pt/interconnect/knowledge-engine/admin-ui:1.1.1`
104+
- `docker build ./smart-connector-rest-dist -t docker-registry.inesctec.pt/interconnect/knowledge-engine/smart-connector-rest-dist:1.1.2`
105+
- `docker build ./knowledge-directory -t docker-registry.inesctec.pt/interconnect/knowledge-engine/knowledge-directory:1.1.2`
106+
- `docker build ./admin-ui -t docker-registry.inesctec.pt/interconnect/knowledge-engine/admin-ui:1.1.2`
107+
- `docker push docker-registry.inesctec.pt/interconnect/knowledge-engine/smart-connector-rest-dist:1.1.2`
108+
- `docker push docker-registry.inesctec.pt/interconnect/knowledge-engine/knowledge-directory:1.1.2`
109+
- `docker push docker-registry.inesctec.pt/interconnect/knowledge-engine/admin-ui:1.1.2`
110110
5. Prepare the next SNAPSHOT version and make a commit for that too.
111111

112112
## Running the REST server in Docker

distributed-example/docker-compose.yml

+3-3
Original file line numberDiff line numberDiff line change
@@ -2,21 +2,21 @@ 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: docker-registry.inesctec.pt/interconnect/knowledge-engine/knowledge-directory:1.1.1
5+
image: docker-registry.inesctec.pt/interconnect/knowledge-engine/knowledge-directory:1.1.2
66

77
# These two services are separate 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: docker-registry.inesctec.pt/interconnect/knowledge-engine/smart-connector-rest-dist:1.1.1
11+
image: docker-registry.inesctec.pt/interconnect/knowledge-engine/smart-connector-rest-dist:1.1.2
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
ports:
1717
- 8280:8280
1818
runtime-2:
19-
image: docker-registry.inesctec.pt/interconnect/knowledge-engine/smart-connector-rest-dist:1.1.1
19+
image: docker-registry.inesctec.pt/interconnect/knowledge-engine/smart-connector-rest-dist:1.1.2
2020
environment:
2121
KE_RUNTIME_PORT: 8081 # The port that the KE uses to listen for inter-KE-runtime communication.
2222
KE_RUNTIME_EXPOSED_URL: http://runtime-2:8081 # The URL where the runtime is available for inter-runtime communication from the outside.

pom.xml

+1-1
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@
7373
<properties>
7474
<maven.compiler.source>11</maven.compiler.source>
7575
<maven.compiler.target>11</maven.compiler.target>
76-
<revision>1.1.2-SNAPSHOT</revision>
76+
<revision>1.1.2</revision>
7777
</properties>
7878

7979
<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.2-SNAPSHOT
10+
version: 1.1.2
1111

1212
paths:
1313
/sc:

0 commit comments

Comments
 (0)