Require hexkit 3.5.0 (#27)

* Require hexkit 3.5.0

* Update config docs

* Update readme

.pre-commit-config.yaml

@@ -48,13 +48,13 @@ repos:
       - id: no-commit-to-branch
         args: [--branch, dev, --branch, int, --branch, main]
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.5.3
+    rev: v0.5.5
     hooks:
       - id: ruff
         args: [--fix, --exit-non-zero-on-fix]
       - id: ruff-format
   - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: v1.10.1
+    rev: v1.11.1
     hooks:
       - id: mypy
         args: [--no-warn-unused-ignores]

.pyproject_generation/pyproject_custom.toml

@@ -1,12 +1,12 @@
 [project]
 name = "mass"
-version = "2.0.1"
+version = "2.1.0"
 description = "Metadata Artifact Search Service  - A service for searching metadata artifacts and filtering results."
 dependencies = [
     "typer>=0.12",
     "ghga-service-commons[api]>=3.0.0",
     "ghga-event-schemas>=2.0.0",
-    "hexkit[mongodb,akafka]>=3.1.0",
+    "hexkit[mongodb,akafka]>=3.5.0",
 ]
 
 [project.urls]

README.md

@@ -32,21 +32,21 @@ We recommend using the provided Docker container.
 
 A pre-build version is available at [docker hub](https://hub.docker.com/repository/docker/ghga/mass):
 ```bash
-docker pull ghga/mass:2.0.1
+docker pull ghga/mass:2.1.0
 ```
 
 Or you can build the container yourself from the [`./Dockerfile`](./Dockerfile):
 ```bash
 # Execute in the repo's root dir:
-docker build -t ghga/mass:2.0.1 .
+docker build -t ghga/mass:2.1.0 .
 ```
 
 For production-ready deployment, we recommend using Kubernetes, however,
 for simple use cases, you could execute the service using docker
 on a single server:
 ```bash
 # The entrypoint is preconfigured:
-docker run -p 8080:8080 ghga/mass:2.0.1 --help
+docker run -p 8080:8080 ghga/mass:2.1.0 --help
 ```
 
 If you prefer not to use containers, you may install the service from source:
@@ -173,6 +173,21 @@ The service requires the following configuration parameters:
   ```
 
 
+- **`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`.
+
+
+  Examples:
+
+  ```json
+  1048576
+  ```
+
+
+  ```json
+  16777216
+  ```
+
+
 - **`db_connection_str`** *(string, format: password)*: MongoDB connection string. Might include credentials. For more information see: https://naiveskill.com/mongodb-connection-string/.
 
 

config_schema.json

@@ -47,7 +47,7 @@
     }
   },
   "additionalProperties": false,
-  "description": "Modifies the orginal Settings class provided by the user",
+  "description": "Modifies the original Settings class provided by the user",
   "properties": {
     "log_level": {
       "default": "INFO",
@@ -190,6 +190,17 @@
       "title": "Generate Correlation Id",
       "type": "boolean"
     },
+    "kafka_max_message_size": {
+      "default": 1048576,
+      "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.",
+      "examples": [
+        1048576,
+        16777216
+      ],
+      "exclusiveMinimum": 0,
+      "title": "Kafka Max Message Size",
+      "type": "integer"
+    },
     "db_connection_str": {
       "description": "MongoDB connection string. Might include credentials. For more information see: https://naiveskill.com/mongodb-connection-string/",
       "examples": [

example_config.yaml

@@ -9,6 +9,7 @@ db_name: metadata-store
 docs_url: /docs
 generate_correlation_id: true
 host: 127.0.0.1
+kafka_max_message_size: 1048576
 kafka_security_protocol: PLAINTEXT
 kafka_servers:
 - kafka:9092

pyproject.toml

@@ -21,13 +21,13 @@ classifiers = [
     "Intended Audience :: Developers",
 ]
 name = "mass"
-version = "2.0.1"
+version = "2.1.0"
 description = "Metadata Artifact Search Service  - A service for searching metadata artifacts and filtering results."
 dependencies = [
     "typer>=0.12",
     "ghga-service-commons[api]>=3.0.0",
     "ghga-event-schemas>=2.0.0",
-    "hexkit[mongodb,akafka]>=3.1.0",
+    "hexkit[mongodb,akafka]>=3.5.0",
 ]
 
 [project.license]