1
1
# Kuksa Databroker
2
2
3
+ ## Table of contents
4
+
5
+ <!-- TOC generated by https://luciopaiva.com/markdown-toc/ with 2 levels -->
6
+
3
7
- [ Kuksa Databroker] ( #kuksa-databroker )
4
8
- [ Intro] ( #intro )
5
9
- [ Relation to the COVESA Vehicle Signal Specification (VSS)] ( #relation-to-the-covesa-vehicle-signal-specification-vss )
6
- - [ Building] ( #building )
7
- - [ Build all] ( #build-all )
8
- - [ Build all release] ( #build-all-release )
9
- - [ Running] ( #running )
10
- - [ Broker] ( #databroker )
11
- - [ Test the broker - run client/cli] ( #test-the-databroker )
12
- - [ Kuksa Data Broker Query Syntax] ( #data-broker-query-syntax )
13
- - [ Configuration] ( #configuration )
14
- - [ Build and run databroker container] ( #build-and-run-databroker )
10
+ - [ Building KUKSA.val Databroker] ( #building-kuksaval-databroker )
11
+ - [ Running KUKSA.val Databroker] ( #running-kuksaval-databroker )
12
+ - [ Test the Databroker using CLI] ( #test-the-databroker-using-cli )
13
+ - [ KUKSA.val Databroker Configuration] ( #kuksaval-databroker-configuration )
14
+ - [ Run Databroker test cases] ( #run-databroker-test-cases )
15
+ - [ Build and run Databroker using Docker] ( #build-and-run-databroker-using-docker )
15
16
- [ Limitations] ( #limitations )
16
17
- [ GRPC overview] ( #grpc-overview )
17
18
- [ GRPC Interfaces] ( #grpc-interfaces )
@@ -78,12 +79,14 @@ OPTIONS:
78
79
```
79
80
80
81
Before starting KUKSA.val Databroker you must decide if you want to use TLS for incoming connections or not.
81
- It is is recommended to use TLS and the you must provide server key by ` --tls-private-key `
82
- and server certificate by ` --tls-cert ` . If you want to run without TLS you must give ` --insecure ` .
82
+ It is is recommended to use TLS and then you must provide server key by ` --tls-private-key `
83
+ and server certificate by ` --tls-cert ` . If you do not give those arguments KUKSA.val Databroker will only accept
84
+ insecure connections. The default behavior may change in the future, so if you want insecure connections it is
85
+ recommended to use the ` --insecure ` argument.
83
86
84
87
* Note: Unless stated otherwise, the examples below show KUKSA.val Databroker running in insecure mode!*
85
88
86
- Run the broker in insecure mode with:
89
+ Run the Databroker in insecure mode with:
87
90
88
91
` cargo run --bin databroker -- --insecure `
89
92
@@ -190,7 +193,7 @@ WHERE
190
193
Subscription is now running in the background. Received data is identified by [1].
191
194
```
192
195
193
- ### Configuration
196
+ ## KUKSA.val Databroker Configuration
194
197
195
198
| parameter | default value | cli parameter | environment variable | description |
196
199
| ----------------| ---------------| ------------------| -----------------------------------| ----------------------------------------------|
@@ -200,10 +203,10 @@ Subscription is now running in the background. Received data is identified by [1
200
203
| listen_port | 55555 | --port | KUKSA_DATA_BROKER_PORT | Listen for rpc calls |
201
204
| jwt_public_key | <no active > | --jwt-public-key | <no active > | Public key used to verify JWT access tokens |
202
205
| tls_cert | <no active > | --tls-cert | <no active > | TLS certificate file (.pem) |
203
- | tls_private_key | <no active > | --tls-private-key | <no active > | TLS private key file (.pem ) |
204
- | insecure | <no active > | --insecure | <no active > | Allow insecure connections |
206
+ | tls_private_key | <no active > | --tls-private-key | <no active > | TLS private key file (.key ) |
207
+ | insecure | <no active > | --insecure | <no active > | Allow insecure connections (default unless tls_cert and tls_private_key given) |
205
208
206
- To change the default configuration use the arguments during startup see [ run section] ( #running ) or environment variables.
209
+ To change the default configuration use the arguments during startup see [ run section] ( #running-kuksaval-databroker ) or environment variables.
207
210
208
211
## Run Databroker test cases
209
212
@@ -237,6 +240,7 @@ tar -czvf databroker_x86_64.tar.gz \
237
240
target/release/examples/perf_setter \
238
241
target/release/examples/perf_subscriber
239
242
```
243
+
240
244
``` shell
241
245
# For aarch64
242
246
tar -czvf databroker_aarch64.tar.gz \
@@ -245,12 +249,15 @@ tar -czvf databroker_aarch64.tar.gz \
245
249
target/aarch64-unknown-linux-gnu/release/examples/perf_setter \
246
250
target/aarch64-unknown-linux-gnu/release/examples/perf_subscriber
247
251
```
252
+
248
253
To build the image execute following commands from root directory as context.
254
+
249
255
``` shell
250
256
docker build -f kuksa_databroker/Dockerfile -t databroker:< tag> .
251
257
```
252
258
253
259
Use following command if buildplatform is required
260
+
254
261
``` shell
255
262
DOCKER_BUILDKIT=1 docker build -f kuksa_databroker/Dockerfile -t databroker:< tag> .
256
263
```
0 commit comments