Releases: awslabs/garnet-framework
1.5.1
1.5.0
[1.5.0] - 2025-08-18
This version fixes bugs, introduces new features with potential breaking changes, and improves performance. Users can raise issues in the GitHub issues section if any problems occur.
Performance Optimizations
- Implemented IRI compaction caching to improve temporal query performance
- Enhanced subscription service with type-based entity filtering
Enhancements
- Updated Scorpio Broker to version 5.0.93 with performance and functionality improvements
- Upgraded Quarkus framework to version 3.24.5 with improved stability and performance
New Features
- Garnet Private Notification Endpoint: Added direct SQS integration alongside existing REST API Gateway for improved scalability:
- Users can now configure
garnet:notificationendpoints for subscription notifications - Notifications are sent directly to a dedicated SQS queue using the same AWS IoT Core MQTT topics mechanism for consumption
- Users can now configure
Deprecated
- Smart Data Models Context: The
context.jsonldfile is deprecated and should no longer be used as it can conflict with NGSI-LD core context.
Upgrade Notes
- Existing subscriptions continue to work unchanged
1.4.3
1.4.2
[1.4.2] - 2025-05-28
Bug Fixes
- Updated Scorpio Broker to version 5.0.92
- Fixed context resolution issue affecting transitions between concentrated and distributed architectures
- Improved handling of external context URLs with robust fallback mechanism
- Enhanced error handling and logging for context resolution
1.4.1
[1.4.1] - 2025-05-20
This new version includes enhancements to key components, bug fixes, and new integration features.
Enhancements
- Enhanced the datalake component to transmit normalized entity versions including system attributes, providing more comprehensive data for analysis
- Updated Scorpio Broker to version 5.0.91
- Improved stability of the subscriptions component
- Added multi-architecture support for seamless transitions between concentrated and distributed deployments:
- Implemented intelligent context resolution with configurable fallback mechanism
- Ensured backward compatibility for existing subscriptions when changing architectures
- Added context caching for improved performance
New Features
- Added synchronization from AWS IoT to the context broker:
- The system now listens to AWS IoT Core event messages and automatically updates the context broker
- Creation, deletion, or updates of AWS IoT Things now trigger corresponding entity changes in the context broker using the AwsIotThing type
- Similar lifecycle management for AWS IoT Thing Groups creates or updates entities using the AwsIotThingGroup type
1.4.0
[1.4.0] - 2025-02-19
We've implemented significant architectural changes in this release to improve cost efficiency and scalability.
The documentation has been updated to reflect these changes and provides detailed guidance on using the new architecture and features.
Major Changes
-
Redesigned Architecture and Stack
- Complete architectural overhaul
- New stack implementation
-
Simplified Architecture Configuration
- Replaced sizing options with direct choice between Concentrated and Distributed architectures
- Moved detailed configuration parameters to architecture.ts for better clarity and control
-
Context Broker Update
- Upgraded Scorpio Broker to version (5.0.90)
-
Improved Ingestion Process
- Eliminated AWS IoT Device Shadow dependency
- Implemented direct ingestion via deployment-provided queue
- Added automatic context broker updates using batch operation upsert
- Delivered more cost-effective and scalable solution
-
Database Engine Update
- Aurora Serverless v2 upgraded to PostgreSQL v16.6
-
Streamlined Data Lake Integration
- Direct Kinesis Firehose integration for data lake delivery
- Created more efficient data pipeline by removing IoT rule dependency
-
API and Data Model Changes
- Removing the Garnet JSON-LD context
- Deprecation of IoT API
- Authorization now enforced with a token (provided as output of CloudFormation stack)
- JSON-LD context change: AWS IoT thing is now referenced as AwsIotThing
-
NGSI-LD Type for Things changed. Now AWS IoT thing is AwsIotThing.
Required Actions
Users will need to:
- Update their ingestion workflows to use the new queue for ingesting
- Migrate any AWS IoT Device Shadow dependencies
1.3.0
[1.3.0] - 2024-05-07
This new version fixes a bug we had due to the use of SQS in Scorpio Broker for fanning out messages. This led to missing messages in the datalake, the temporal storage and the subscriptions.
[1.3.0] - Added
- SNS for fanning out messages to dedicated SQS queues per service.
- VPC endpoints for SNS and SQS
[1.3.0] - Changed
- Updated Aurora serverless v2 engine version to Postgresql v15.5
1.2.0
This releases fixes some bugs, introduces new features and potential breaking changes.
- Distributed architecture. You can now deploy Garnet using the microservice version of Scorpio Broker.
- T-shirt Sizing for deployment. You can now choose the size of the deployment between Small and Xlarge depending on your workload.