You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
For production-ready deployment, we recommend using Kubernetes, however,
29
29
for simple use cases, you could execute the service using docker
30
30
on a single server:
31
31
```bash
32
32
# The entrypoint is preconfigured:
33
-
docker run -p 8080:8080 ghga/access-request-service:5.1.0 --help
33
+
docker run -p 8080:8080 ghga/access-request-service:5.1.1 --help
34
34
```
35
35
36
36
If you prefer not to use containers, you may install the service from source:
@@ -156,7 +156,7 @@ The service requires the following configuration parameters:
156
156
```
157
157
158
158
159
-
- <aid="properties/kafka_max_message_size"></a>**`kafka_max_message_size`***(integer)*: The largest message size that can be transmitted, in bytes. Only services that have a need to send/receive larger messages should set this. Exclusive minimum: `0`. Default: `1048576`.
159
+
- <aid="properties/kafka_max_message_size"></a>**`kafka_max_message_size`***(integer)*: The largest message size that can be transmitted, in bytes, before compression. Only services that have a need to send/receive larger messages should set this. When used alongside compression, this value can be set to something greater than the broker's `message.max.bytes` field, which effectively concerns the compressed message size. Exclusive minimum: `0`. Default: `1048576`.
160
160
161
161
162
162
Examples:
@@ -171,6 +171,42 @@ The service requires the following configuration parameters:
171
171
```
172
172
173
173
174
+
- <aid="properties/kafka_compression_type"></a>**`kafka_compression_type`**: The compression type used for messages. Valid values are: None, gzip, snappy, lz4, and zstd. If None, no compression is applied. This setting is only relevant for the producer and has no effect on the consumer. If set to a value, the producer will compress messages before sending them to the Kafka broker. If unsure, zstd provides a good balance between speed and compression ratio. Default: `null`.
175
+
176
+
-**Any of**
177
+
178
+
- <aid="properties/kafka_compression_type/anyOf/0"></a>*string*: Must be one of: `["gzip", "snappy", "lz4", "zstd"]`.
- <aid="properties/kafka_max_retries"></a>**`kafka_max_retries`***(integer)*: The maximum number of times to immediately retry consuming an event upon failure. Works independently of the dead letter queue. Minimum: `0`. Default: `0`.
Copy file name to clipboardExpand all lines: config_schema.json
+27-1Lines changed: 27 additions & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -145,7 +145,7 @@
145
145
},
146
146
"kafka_max_message_size": {
147
147
"default": 1048576,
148
-
"description": "The largest message size that can be transmitted, in bytes. Only services that have a need to send/receive larger messages should set this.",
148
+
"description": "The largest message size that can be transmitted, in bytes, before compression. Only services that have a need to send/receive larger messages should set this. When used alongside compression, this value can be set to something greater than the broker's `message.max.bytes` field, which effectively concerns the compressed message size.",
149
149
"examples": [
150
150
1048576,
151
151
16777216
@@ -154,6 +154,32 @@
154
154
"title": "Kafka Max Message Size",
155
155
"type": "integer"
156
156
},
157
+
"kafka_compression_type": {
158
+
"anyOf": [
159
+
{
160
+
"enum": [
161
+
"gzip",
162
+
"snappy",
163
+
"lz4",
164
+
"zstd"
165
+
],
166
+
"type": "string"
167
+
},
168
+
{
169
+
"type": "null"
170
+
}
171
+
],
172
+
"default": null,
173
+
"description": "The compression type used for messages. Valid values are: None, gzip, snappy, lz4, and zstd. If None, no compression is applied. This setting is only relevant for the producer and has no effect on the consumer. If set to a value, the producer will compress messages before sending them to the Kafka broker. If unsure, zstd provides a good balance between speed and compression ratio.",
174
+
"examples": [
175
+
null,
176
+
"gzip",
177
+
"snappy",
178
+
"lz4",
179
+
"zstd"
180
+
],
181
+
"title": "Kafka Compression Type"
182
+
},
157
183
"kafka_max_retries": {
158
184
"default": 0,
159
185
"description": "The maximum number of times to immediately retry consuming an event upon failure. Works independently of the dead letter queue.",
0 commit comments