v2.0.0
OSML CDK Constructs v2.0.0
This release introduces significant refactoring and enhancements to the osml-cdk-constructs package to support a more streamlined and maintainable configuration and deployment process. Instructions for how to leverage the changes for this release can be found in the associated changes in the guidance repository
Key Changes:
- Introduction of
BaseConfigClass: A newBaseConfigclass has been implemented to serve as a foundation for all configuration classes, promoting code reuse and reducing redundancy. - Creation of Configuration Classes: Specific configuration classes (
MESMEndpointConfig,OSMLTestImageryConfig,MEContainerConfig, etc.) have been added, encapsulating properties and default values, thereby simplifying component setup. - Centralization of Context Values: Configuration values are now managed via
cdk.context.json, allowing for centralized, consistent context handling across all components. - Consolidation of Resources: Resources for each component have been condensed into single stacks, making the deployment process more straightforward and reducing complexity.
- Reusable Constructs: Introduced shared constructs, such as
OSMLContainer, to handle common tasks like container deployment to ECR, ensuring consistency and reducing code duplication. - Extended TSDoc Comments: Updated TSDoc comments to be more comprehensive and normalized across the package.
- Removed Tile Server DLQ: Updated the
OSMLTileServerDataplaneto remove the DLQ table update lambda as it is no longer needed by the application.
Breaking Changes:
This update introduces a breaking change for the osml-cdk-constructs package. The refactoring includes significant alterations to how configuration and deployment are managed, with the introduction of new configuration classes, centralized context handling through the cdk.context.json file, and the consolidation of resources into single stacks. As a result, existing projects that rely on previous versions of the package will require updates to align with the new configuration structure and deployment processes. Careful attention is needed when upgrading to ensure compatibility and successful deployment.
Limitations:
N/A
New Dependency:
N/A
Pull Requests Merged
- feat: optimizing deployment framework by @drduhe in #138
- fix: rename sync to sink by @markveerman in #142
- fix: optimizing deployments by @drduhe in #140
- ci: version bump to v2.0.0 by @drduhe in #139
New Contributors
- @markveerman made their first contribution in #142
Full Changelog: v1.13.2...v2.0.0
