Version 18.2.0 - 18.03.2024

Highlights

Server-side resolving of references is now supported. This allows multiple documents that reference each other (also transitively) to be queried in a single request, For details, please refer to the documentation.

New features

ID Description

CAAS-2313

Added support for server-side resolving of references.

Version 18.1.3 - 13.03.2024

Fixed issues

ID Description

CAAS-2335

Updated MongoDB to version 6.0.14.

Version 18.1.1 - 07.03.2024

Fixed issues

ID Description

CAAS-2326

Improved performance of GraphQL queries and increased default cache duration of GraphQL applications from 10 to 60 seconds (configuration parameter graphql.app-def-cache-ttl).

Version 18.1.0 - 04.03.2024

New features

ID Description

CAAS-2107

RESTHeart has been extended by a component that generates trace ids for incoming requests if there is no identifier present in the headers. If restApi.additionalConfigOverrides./tracingHeaderGenerator/enabled: true is set in your custom-values.yaml, an x-b3-traceid will be logged and sent as a header in the response.

Version 18.0.5 - 01.03.2024

Fixed issues

ID Description

CAAS-2243

Improved GraphQL chapters of the documentation.

Version 18.0.4 - 29.02.2024

Fixed issues

ID Description

CAAS-2254

Improved internal infrastructure.

Version 18.0.3 - 23.02.2024

Fixed issues

ID Description

CAAS-2324

Metrics adjusted in version 18.0.0 are now actually only collected at database level.

Version 18.0.2 - 20.02.2024

Fixed issues

ID Description

PX-276

Improved internal infrastructure.

Version 18.0.1 - 13.02.2024

Fixed issues

ID Description

CAAS-2039

Improved internal infrastructure.

Version 18.0.0 - 09.02.2024

Update Notice

The URL of the REST API metrics endpoint has been changed. If you use the metrics endpoint directly (instead of via the ServiceMonitor), you must change the URL from /_metrics to /_logic/metrics.

In addition, the metrics are now all collected exclusively at database level; configuration is no longer supported by the new endpoint. If you use the parameter restApi.additionalConfigOverrides./mongo/metrics-gathering-level in your custom-values.yaml it must now have the value OFF. Otherwise the REST API will no longer start. We recommend removing the parameter.

New features

ID Description

CAAS-2308

The REST API metrics endpoint has been moved from /_metrics to /_logic/metrics. The k8s ServiceMonitor has been adjusted accordingly.

In addition, metrics can now only be collected at database level.

RESTHeart has been updated to version 7.7.4.

Version 17.9.0 - 06.02.2024

New features

ID Description

CAAS-2267

Updated RestHeart to 7.7.1. GraphQL queries now abort after 30 seconds. This can be configured in the custom helm values using the parameter restApi.additionalConfigOverrides./graphql/query-time-limit: 30000.

Also the official communication on the Apikey format was updated. Check version 15.4.0 for more details on this.

Version 17.8.1 - 26.01.2024

New features

ID Description

CAAS-2309

Improved robustness of the setup endpoint for eventual consistency error conditions.

Version 17.8.0 - 18.01.2024

New features

ID Description

CAAS-2269

Improved error messages when checking permissions of aggregation requests.

Version 17.7.2 - 12.01.2024

Fixed issues

ID Description

CAAS-2297

Improved internal infrastructure.

Version 17.7.1 - 11.01.2024

Fixed issues

ID Description

CAAS-2296

Updating various dependencies.

Version 17.7.0 - 08.01.2024

New features

ID Description

CAAS-2294

RESTHeart has been updated to version 7.6.5.

Version 17.6.1 - 12.12.2023

Fixed issues

ID Description

PX-282

Improved internal infrastructure.

Version 17.6.0 - 04.12.2023

New features

ID Description

PX-264

Updating various dependencies.

Version 17.5.0 - 17.11.2023

New features

ID Description

CAAS-2222

The GRAPHQL stages $ifvar and $ifarg have been added.

Version 17.4.0 - 14.11.2023

New features

ID Description

CAAS-2260

RESTHeart has been updated to version 7.6.1.

Version 17.3.2 - 13.11.2023

Fixed issues

ID Description

CAAS-2259

Added resource limits to MongoDB init containers. Improved documentation about horizontal scaling of MongoDB.

Version 17.3.1 - 06.11.2023

Fixed issues

ID Description

CAAS-2255

Updated MongoDB to version 6.0.11.

Version 17.3.0 - 03.11.2023

New features

ID Description

CAAS-2256

When using multiple Ingress hosts, each host is now defined within its own Ingress definition. You can now also define custom annotations per host in the custom values.

Version 17.2.1 - 31.10.2023

Fixed issues

ID Description

CAAS-2238

Now properly validates permissions of simplified { $merge: <collection> } aggregation stages instead of just rejecting the request.

Version 17.2.0 - 25.10.2023

New features

ID Description

CAAS-2233

Added Prometheus Alert for increased 4xx error rate of WRITE requests.

Version 17.1.3 - 18.10.2023

Fixed issues

ID Description

CAAS-2239

RESTHeart has been updated to version 7.5.2.

CAAS-2248

The caas Helm chart now supports pre-release versions of Kubernetes 1.19 or later.

Version 17.1.2 - 17.10.2023

Fixed issues

ID Description

CAAS-2230

Fixed a problem where it was impossible to create local ApiKey with the same id as the global master ApiKey.

Version 17.1.1 - 13.10.2023

Fixed issues

ID Description

CAAS-2252

RESTHeart has been updated to version 7.5.0.

Version 17.1.0 - 10.10.2023

BROKEN RELEASE - DO NOT USE!

Version 17.0.5 - 11.09.2023

Fixed issues

ID Description

CAAS-2197

Small improvements in the Grafana dashboards.

Version 17.0.4 - 29.08.2023

Fixed issues

ID Description

CAAS-2221

Small improvements in the Grafana dashboards.

Version 17.0.3 - 24.08.2023

New features

ID Description

CAAS-2181

Extended reference docs of GraphQL apps and added tutorial for creating and using GraphQL apps.

Version 17.0.2 - 21.08.2023

Fixed issues

ID Description

CAAS-703

Changing the master API key in the custom helm values now automatically deletes the previous configured API key. Same applies to the metrics API key.

In addition, it is no longer possible to change the API key for metrics via the REST API.

Also, RESTHeart was updated to version 7.4.6.

Version 17.0.1 - 15.08.2023

Fixed issues

ID Description

CAAS-2219

At startup, some validation operations are now executed asynchronously to improve initialization time.

Version 17.0.0 - 09.08.2023

Update Notice

CAUTION: This version contains two breaking changes:

  • The Helm charts caas and caas-common are no longer compatible to Helm 2. This change completes the previous announcement for deprecation and removal of the Helm 2 support. You are not affected by this change if you already use Helm 3 to deploy CaaS.

    If you are affected by this change, please refer to the official Helm migration guide for how to upgrade from Helm 2 to Helm 3.

  • The Helm chart caas now requires at least Kubernetes version 1.19.0. For more information regarding the system requirements for CaaS see chapter System requirements of the Technical Data Sheet.

    • This change includes the removal of the Helm values restApi.ingress.apiVersionOverride and restApi.ingressPreview.apiVersionOverride, which were previously needed to establish compatibility for Kubernetes versions below 1.19 for the Ingress resources.

New features

ID Description

CAAS-1274

Removed the support for Helm 2 and Kubernetes <1.19.

Version 16.20.1 - 08.08.2023

Fixed issues

ID Description

CAAS-2215

Fixed a problem where creating an API Key immediately after db creation could result in 500 responses due to eventual consistency. Fixed an issue where syntactically invalid GraphQL queries were answered with 500 instead of 400. Updated RESTHeart to version 7.4.5.

Version 16.20.0 - 04.08.2023

New features

ID Description

CAAS-2182

Reading an API key from the Authorization header with the old format (apikey="..") no longer logs a warning.

Version 16.19.0 - 03.08.2023

New features

ID Description

CAAS-2196

Improved the tenant setup API endpoint.

Version 16.18.6 - 31.07.2023

Fixed issues

ID Description

CAAS-2206

Fixed issues of the queries of GraphQL panels of the Grafana dashboards.

Version 16.18.5 - 26.07.2023

Fixed issues

ID Description

CAAS-1475

Fixed an issue in the internal infrastructure.

Version 16.18.4 - 24.07.2023

Fixed issues

ID Description

CAAS-1475

Fixed an issue in the internal infrastructure.

Version 16.18.3 - 24.07.2023

New features

ID Description

CAAS-1475

Each release of the CaaS platform is now immediately made available in the download area for customers. In addition, the "Content as a Service" product documentation can now be found within the CaaS platform project in the online documentation (https://docs.e-spirit.com/).

Version 16.18.2 - 13.07.2023

New features

ID Description

CAAS-2176

Added Grafana dashboards that show trends over a longer time period.

Version 16.18.1 - 10.07.2023

Fixed issues

ID Description

PX-248

Improved internal infrastructure.

Version 16.18.0 - 28.06.2023

New features

ID Description

CAAS-1870

Improved Grafana dashboards and Prometheus alerts.

Version 16.17.1 - 28.06.2023

Fixed issues

ID Description

PX-247

RESTHeart has been updated to version 7.4.1.

Version 16.17.0 - 27.06.2023

New features

ID Description

CAAS-2080

Added collection and visualization of new GraphQL query metrics.

Version 16.16.0 - 21.06.2023

New features

ID Description

CAAS-2174

Added new /_logic/metrics-caas endpoint that contains additional metrics on top of the standard RESTHeart ones. Currently contains request and response size metrics per database. The collection of these additional metrics is disabled by default.

Version 16.15.0 - 01.06.2023

New features

ID Description

CAAS-2011

Added new Grafana dashboard that gives a better overview of multiple MongoDB deployments.

Fixed issues

ID Description

CAAS-2161

Improved internal documentation.

Version 16.14.0 - 31.05.2023

New features

ID Description

CAAS-1969

Improved Grafana dashboards.

Version 16.13.0 - 26.05.2023

New features

ID Description

CAAS-2170

Improved validation when creating/updating GraphQL apps.

Version 16.12.1 - 26.05.2023

Fixed issues

ID Description

CAAS-2138

Improved documentation of API keys.

Version 16.12.0 - 23.05.2023

New features

ID Description

CAAS-2005

Support for GraphQL aggregations.

Version 16.11.0 - 15.05.2023

New features

ID Description

CAAS-2153

RESTHeart has been updated to version 7.4.0.

Version 16.10.1 - 10.05.2023

Fixed issues

ID Description

CAAS-2133

Removed Master API key from Helm chart usage notes (NOTES.txt).

Version 16.10.0 - 09.05.2023

New features

ID Description

CAAS-2133

Added option to configure additional deployment matchLabels in helm chart values.

Version 16.9.1 - 08.05.2023

Fixed issues

ID Description

CAAS-1864

In the Grafana dashboards OPTIONS requests are no longer counted in the WRITE statistics. Restart Prometheus Rules now only count restarts over 2 days, instead of 7, to reduce unnecessary alerts after an issue has already been resolved.

Version 16.9.0 - 05.05.2023

New features

ID Description

CAAS-1982

Internal improvement of the setup endpoint.

Version 16.8.0 - 26.04.2023

Update Notice

This update can only be applied to the CaaS platform as of version 16.4.2, as it includes MongoDB version 6.0. This is an absolutely necessary step for the MongoDB upgrade!

With this CaaS Platform version, the featureCompatibilityVersion is raised to the 6.0, which implicitly triggers a replSetReconfig and which performs the upgrade without any downtime in the Kubernetes stack.

More information can be obtained from the MongoDB documentation:

New features

ID Description

CAAS-2120

The value of the featureCompatibilityVersion has been raised to 6.0 to trigger the MongoDB update without downtime in the Kubernetes stack.

Version 16.7.2 - 20.04.2023

Fixed issues

ID Description

CAAS-2079

Added additional tests.

Version 16.7.1 - 20.04.2023

Update Notice

A wrong behaviour was fixed in RESTHeart: when calling an aggregation using a $merge or $out stage, the output incorrectly contained all result documents of the aggregation. As of this version, an empty array is returned, which is the correct behaviour.

Please check if you need to make any adjustments to the use of your aggregations due to the corrected behaviour.

Fixed issues

ID Description

CAAS-2144

Updated RESTHeart version to 7.3.5. In addition, interceptors accessing the request body have been changed so that their execution point is only after authentication.

Version 16.7.0 - 13.04.2023

New features

ID Description

CAAS-2127

GraphQL applications can now be created/updated using file uploads. The API endpoints https://REST-HOST:PORT/<tenant>/gql-apps/* accept a multipart request body (multipart/form-data) as an alternative to a JSON request body (application/json).

More information is available in the chapter Create/update GraphQL applications of the documentation.

Version 16.6.1 - 12.04.2023

Fixed issues

ID Description

CAAS-2149

Extension of the update notice for version 16.3.0.

Version 16.6.0 - 12.04.2023

New features

ID Description

CAAS-2031

Improving internal infrastructure.

Version 16.5.4 - 31.03.2023

Fixed issues

ID Description

CAAS-2135

Updated RESTHeart to version 7.3.3. This version comes with improved logging and speed during the start up process.

Version 16.5.3 - 28.03.2023

New features

ID Description

CAAS-2122

Improved internal infrastructure.

Version 16.5.2 - 24.03.2023

New features

ID Description

CAAS-2101

Improved protection of resources that should not be modifiable via the REST API. In particular, it is now no longer possible to delete the global GraphQL collection.

Version 16.5.1 - 09.03.2023

Fixed issues

ID Description

CAAS-2131

Fixed occasional crashloop during mongo pod startup due to race condition.

Version 16.5.0 - 09.03.2023

New features

ID Description

CAAS-2129

Updated RESTHeart to version 7.3.2

Version 16.4.4 - 08.03.2023

Fixed issues

ID Description

PX-222

Updating the used Gradle and Kotlin versions.

Version 16.4.3 - 03.03.2023

New features

ID Description

CAAS-2123

Added documentation for troubleshooting a file upload error caused by orphaned file chunks.

Version 16.4.2 - 03.03.2023

Fixed issues

ID Description

CAAS-2126

Fixed a bug introduced in 16.3.0 where the REST API pods failed to start if the value of the new Helm attribute restApi.additionalConfigOverrides remained empty.

Fixed a bug introduced in 16.4.0 where the MongoDB replicaset was not configured correctly on a new deployment.

Version 16.4.0 - 01.03.2023

Update Notice

You must have installed CaaS in at least version 14.2.0 to upgrade to 16.4.x. This is an absolutely necessary step for the MongoDB upgrade!

Compatibility changes of MongoDB

In general, you should check that all applications accessing the CaaS can handle the MongoDB compatibility changes in version 6.0. For a detailed listing of these changes, see the MongoDB documentation.

MongoDB featureCompatibilityVersion

After updating the CaaS to 16.4, the MongoDB will run in version 6.0 and with the parameter featureCompatibilityVersion set to the value 5.0. The update to the new MongoDB version and updating the featureCompatibilityVersion are kept separate on purpose. This value will be set to 6.0 in a subsequent release in order to be able to perform the update properly without downtime in the Kubernetes stack. More information can be found here:

New features

ID Description

CAAS-2119

Upgraded MongoDB from 5.0.6 to 6.0.4 The featureCompatibilityVersion is still set to 5.0 and will be updated with an upcoming release.

Version 16.3.0 - 01.03.2023

Update Notice

In the Helm chart, a change was made to the parameter credentials.caasRepoAdditions: the escaping of special characters is omitted and is no longer permitted as of this version. Accordingly, the escape characters in the Helm values have been removed. If you have overwritten credentials.caasRepoAdditions in your custom-values.yaml, an adjustment is absolutely necessary.

Additionally, this version introduced a bug in the Helm chart, which is fixed from version 16.4.2. For more details, see the release notes for the version.

New features

ID Description

CAAS-2074

Updated RESTHeart to version 7.2.7

Version 16.2.5 - 23.02.2023

New features

ID Description

CAAS-2100

Improved internal infrastructure.

Fixed issues

ID Description

CAAS-2116

Improve logging of errors caused by validating database names.

Version 16.2.4 - 23.02.2023

New features

ID Description

CAAS-2121

Improved multi-tenant and multi-deployment overview Grafana dashboards.

Version 16.2.3 - 22.02.2023

Fixed issues

ID Description

CAAS-2110

Fixed a bug in the ImmutabilityInterceptor that could be triggered by a POST request to update multiple documents.

Version 16.2.2 - 15.02.2023

Fixed issues

ID Description

CAAS-2108

Grafana dashboard "CaaS System Status" is now compatible with Kubernetes v1.19.

Version 16.2.1 - 14.02.2023

New features

ID Description

CAAS-2115

Improved internal infrastructure.

Version 16.2.0 - 14.02.2023

New features

ID Description

CAAS-1978

RESTHeart has been extended by a component that can enrich log outputs with additional information. Currently, this extension is only available for our SaaS offer.

Version 16.1.2 - 03.02.2023

Fixed issues

ID Description

CAAS-2093

API keys are now the only valid authentication method when creating or removing tenant specific GraphQL applications.

Version 16.1.1 - 01.02.2023

Fixed issues

ID Description

PX-228

Updated dependencies.

Version 16.1.0 - 17.01.2023

New features

ID Description

CAAS-2103

Updated the RESTHeart license.

Version 16.0.0 - 13.01.2023

Update Notice

The basic auth user metrics was replaced by an api key. Please be sure to update all usage of that user, if any.

New features

ID Description

CAAS-1988

The metrics basic auth user was removed and replaced by an api key.

Version 15.5.1 - 12.01.2023

New features

ID Description

PX-225

Updated dependencies.

Version 15.5.0 - 11.01.2023

Update Notice

Usage of HTTP Basic Auth is deprecated and will be removed in the future. If you authenticate with the admin user, then please use the global master api key instead. HTTP Basic Auth is still supported up to and including 06/2023.

Update 06/2023: Basic Auth support is maintained until further notice.

New features

ID Description

CAAS-1986

Deprecation of HTTP Basic Auth mechanism for authentication.

Version 15.4.2 - 10.01.2023

Fixed issues

ID Description

CAAS-2091

Due to eventual consistency, requests to create a database and requests to create API keys via the setup endpoint could be answered with HTTP status 500 instead of 200 in rare cases. These problems have been fixed.

Version 15.4.1 - 10.01.2023

New features

ID Description

CAAS-2020

A new HTTP endpoint has been added to resynchronize all GraphQL apps in the global collection on demand.

This functionality can be triggered via a POST request at /_logic/sync-graphql-apps.

Fixed issues

ID Description

CAAS-2097

A bug related to deleting Tenant databases has been fixed. Installed GraphQL apps from the global gql-apps collection are now properly cleaned up.

Version 15.4.0 - 03.01.2023

Update Notice

The supported values for the Authorization header have been extended to include the standardized Bearer token format. The previously used proprietary format apikey="<key>" will be supported as well.

Please modify your client implementations to use the Bearer token format. Please refer to the documentation for more information.

New features

ID Description

CAAS-1987

Parsing of an API key from Authorization header has been changed to additionally support the standardized Bearer format.

Version 15.3.1 - 30.12.2022

Fixed issues

ID Description

CAAS-2098

Fixed flaky tests and minor issues in test code.

Version 15.3.0 - 30.12.2022

New features

ID Description

CAAS-2015

Updated the MongoDB Grafana dashboard to contain a value mapping to human-readable values for MongoDB replica state instead of numeric values. Further the stats in the top line use instant values now.

Version 15.2.6 - 27.12.2022

Fixed issues

ID Description

CAAS-2014

The alert threshold for MongoDB splitbrain alert was set to 5 minutes. The former value of 30 seconds may have lead to false positives when updating caas-platform deployments.

Version 15.2.5 - 16.12.2022

Fixed issues

ID Description

CAAS-2092

A bug was fixed in the internal infrastructure.

Version 15.2.4 - 14.12.2022

Fixed issues

ID Description

PX-221

Updated some dependencies

Version 15.2.3 - 17.11.2022

Fixed issues

ID Description

PX-209

A bug was fixed in the internal infrastructure.

Version 15.2.2 - 08.11.2022

Fixed issues

ID Description

CAAS-2078

Fixed a bug that caused the creation of GraphQL apps using the setup endpoint to fail when the gql-apps collection is missing.

Version 15.2.1 - 03.11.2022

Fixed issues

ID Description

CAAS-2059

Updated dependencies as well as RESTHeart to version 6.6.0 to fix CVE-2022-1259, CVE-2022-0084, and CVE-2022-42003.

Version 15.2.0 - 26.10.2022

New features

ID Description

CAAS-2044

GraphQL default and max page size limit is now configurable in the Helm chart.

Version 15.1.4 - 26.10.2022

Fixed issues

ID Description

PX-183

Improved internal infrastructure.

Version 15.1.3 - 17.10.2022

New features

ID Description

CAAS-1964

Internal improvements of the setup endpoint for databases which can now create GraphQL applications.

Version 15.1.2 - 12.10.2022

Fixed issues

ID Description

CAAS-2030

Extending the documentation about GraphQL.

Version 15.1.1 - 12.10.2022

Fixed issues

ID Description

CAAS-2035

Updated RESTHeart to version 6.5.2 for fixing various CVEs like CVE-2022-25857 and CVE-2022-37734. In addition, a limit on the result size for GraphQL queries now applies.

Version 15.1.0 - 21.09.2022

New features

ID Description

CAAS-2036

Updated RESTHeart version to 6.5.0

Fixed issues

ID Description

CAAS-1980

A GET request without a field on an aggregation now properly response with HTTP status 400 instead of 500.

CAAS-2021

The limit attribute in GraphQL queries will no longer be ignored.

CAAS-2036

Bug that prevented usage from GraphQL introspection queries is now fixed.

Version 15.0.0 - 14.09.2022

Update Notice

Please note that the change to the Helm chart no longer provides compatibility with Kubernetes versions below 1.21.

Compatibility with older Kubernetes versions below 1.21 can be achieved by setting restApi.podDisruptionBudget.apiVersionOverride as well as mongo.podDisruptionBudget.apiVersionOverride to the value "policy/v1beta1" in the custom-values.yaml file.

New features

ID Description

CAAS-1909

In the PodDisruptionBudget resources of the Helm chart, the API version has been updated to policy/v1, which is available as of Kubernetes version 1.21. Compatibility with earlier Kubernetes versions can still be established with appropriate specifications in custom-values.yaml.

CAAS-2010

API Keys can now be authorized exclusively to individual GraphQL endpoints.

Fixed issues

ID Description

CAAS-2023

Added a note about the page size limit of GraphQL queries in the documentation.

Version 14.10.0 - 25.08.2022

New features

ID Description

CAAS-1963

Added basic GraphQL support.

Version 14.9.3 - 17.08.2022

New features

ID Description

PX-197

Changed e-Spirit AG to Crownpeak Technology GmbH in the documentation.

Version 14.9.2 - 25.07.2022

Fixed issues

ID Description

CAAS-1996

Optimized cleanup of internal test resources.

Version 14.9.1 - 22.07.2022

Fixed issues

ID Description

CAAS-1977

Fixed a problem where calling an aggregation without providing the required variables returned HTTP 500 instead of 400.

Version 14.9.0 - 08.07.2022

New features

ID Description

CAAS-1937

Enhanced endpoint for simplified internal project setup to process api keys.

Version 14.8.4 - 08.07.2022

Fixed issues

ID Description

PX-178

Improvements of internal infrastructure.

Version 14.8.3 - 29.06.2022

Fixed issues

ID Description

CAAS-1971

Fixing the permissions for the use of the endpoint for simplified internal project setup.

Version 14.8.1 - 23.06.2022

Fixed issues

ID Description

CAAS-1967

Fixed a problem introduced in 14.6.1 where default aggregation variables were not resolved if explicit variables were part of the request.

Version 14.8.0 - 08.06.2022

New features

ID Description

CAAS-1339

Added endpoint for simplified internal project setup.

Version 14.7.3 - 07.06.2022

Fixed issues

ID Description

CAAS-1949

Fixed concurrency error when creating local apikeys collections.

Version 14.7.2 - 27.05.2022

Fixed issues

ID Description

CAAS-1931

Fixed error handling when dealing with whitespace in resource names and updated RESTHeart to version 6.3.4.

CAAS-1952

Added missing hints regarding default and max value for pagesize parameter configuration in documentation.

Version 14.7.1 - 27.05.2022

Fixed issues

ID Description

CAAS-1946

Fixed a problem where default variables could no longer be used in aggregations.

Version 14.7.0 - 24.05.2022

New features

ID Description

CAAS-1923

Updated RESTHeart to version 6.3.3. The new feature where requests can specify the read/write behavior against the DB is disabled by default.

Version 14.6.1 - 20.05.2022

Fixed issues

ID Description

CAAS-1928

Disabled mapReduce aggregation pipelines due to security considerations. Fixed a problem where aggregation pipelines could be used for privilege escalation.

Version 14.6.0 - 19.05.2022

New features

ID Description

CAAS-1881

Enabled management capabilities for api keys. To read or manage api keys, the used api key must have write permissions for corresponding apikeys collection.

Version 14.5.3 - 13.04.2022

Fixed issues

ID Description

CAAS-1897

Updated dependencies to solve CVE-2020-36518.

Version 14.5.2 - 08.04.2022

Fixed issues

ID Description

CAAS-1899

If critical initialization steps of the database cannot be executed, RESTHeart is now restarted automatically. This can be the case especially at the first start when the bootstrapping of MongoDB is not yet complete.

PX-176

Improved internal infrastructure.

Version 14.5.1 - 01.04.2022

Fixed issues

ID Description

CAAS-1898

Obsolete links to external sources have been updated in the documentation.

Version 14.5.0 - 31.03.2022

New features

ID Description

CAAS-1903

Added PodDisruptionBudget to caas-rest-api. Anti-affinity now ensures that caas-rest-api pods are distributed to different nodes if possible.

Version 14.4.2 - 28.03.2022

Fixed issues

ID Description

CAAS-1900

Adjusted sensitivity of CaaSRestAPIIncreasedErrorRate alert.

Version 14.4.1 - 28.03.2022

New features

ID Description

PX-173

Improved internal infrastructure.

Fixed issues

ID Description

PX-176

Improved internal infrastructure.

Version 14.4.0 - 16.03.2022

New features

ID Description

CAAS-1869

Updated RESTHeart to version 6.2.3.

Version 14.3.4 - 11.03.2022

New features

ID Description

CAAS-1848

Improved internal infrastructure.

Version 14.3.3 - 01.03.2022

New features

ID Description

CAAS-1845

Improved the internal infrastructure.

Version 14.3.2 - 15.02.2022

Highlights

Due to a bug in MongoDB, updating from MongoDB version 4.4.4 directly to 5.0.3 can lead to data inconsistencies. Therefore, we are retroactively releasing the additional platform version 9.4.1 with MongoDB 4.4.11, which provides a safe update path.

For customers still running their CaaS platform in versions 2.16.0 - 9.4.0, we strongly recommend updating to platform 9.4.1 before switching to platform 9.5.0.

For more information, please refer to the section on version 9.4.1.

Fixed issues

ID Description

CAAS-1851

Provision of additional version 9.4.1 as well as adjustment of the update note for CaaS platform version 9.5.0.

Version 14.3.1 - 15.02.2022

Fixed issues

ID Description

CAAS-1856

Fixed an example curl request (API Key creation) in the documentation.

Version 14.3.0 - 08.02.2022

New features

ID Description

CAAS-1839

Updated RESTHeart to version 6.2.0.

Version 14.2.0 - 07.02.2022

New features

ID Description

CAAS-1832

Upgraded MongoDB from 5.0.3 to 5.0.6

Version 14.1.0 - 01.02.2022

New features

ID Description

CAAS-1842

A Toleration has been added to the Helm chart to allow RESTHeart pods to be placed onto nodes with the taint NodeWithImpairedVolumes=true.

Fixed issues

ID Description

CAAS-1846

Updated RESTHeart to version 6.1.7 (upgrade logback to version 1.2.10 that fixes CVE-2021-42550)

Version 14.0.2 - 27.01.2022

Fixed issues

ID Description

CAAS-1805

Improved the alerts.

Version 14.0.1 - 25.01.2022

Fixed issues

ID Description

CAAS-1805

Improved the alerts.

Version 14.0.0 - 18.01.2022

Update Notice

This release includes breaking changes to existing Helm values of the CaaS Helm chart and the addition of new attributes.

Changes to existing values

The Helm attributes starting with monitoring.prometheus.alerts and monitoring.grafana have been moved to the new root node caas-common. The attributes are now accessible under the path caas-common.monitoring.prometheus.alerts and caas-common.monitoring.grafana.

If you have overwritten the default configuration of the chart with your own values and want to continue using them, you have to modify your custom-values.yaml accordingly.

Only the previously mentioned attributes have been moved and not the entire monitoring block.

Old path
monitoring:
  prometheus:
    alerts:
      prometheusRuleLabels:
        app: "prometheus-operator"
        release: "prometheus-operator"
      caas:
        enabled: true
        useAlphaAlerts: false
  grafana:
    dashboards:
      enabled: true
      configmapNamespace: ""
      configMapLabels: {}
Path with new root node
caas-common:
  monitoring:
    prometheus:
      alerts:
        prometheusRuleLabels:
          app: "prometheus-operator"
          release: "prometheus-operator"
        caas:
          enabled: true
          useAlphaAlerts: false
    grafana:
      dashboards:
        enabled: true
        configmapNamespace: "{{ .Release.Namespace }}"
        configMapLabels: {}

New attributes

In addition to that, the labels defined with the attribute caas-common.monitoring.prometheus.alerts.prometheusRuleLabels are no longer attached to individual alerts. Instead, the attribute caas-common.monitoring.prometheus.alerts.additionalAlertLabels can now be used for that.
The following code block shows an example on how to use this new value:

Defining an additional label for alerts
monitoring:
  prometheus:
    alerts:
      additionalAlertLabels:
        owner: "my-team"

Besides that, the new attribute caas-common.monitoring.prometheus.alerts.caas.targetNamespace was added to the Helm chart. It allows the configuration of one or more namespaces that are used by the Prometheus alerting rules. The namespace of the Helm release is used in default configuration.
The following configuration block shows an example on how to configure the Prometheus alerting rules to use all namespaces.

targetNamespace includes all namespaces
monitoring:
  prometheus:
    alerts:
      caas:
        targetNamespace: ".+"

New features

ID Description

CAAS-1805

The existing Prometheus alerts were improved and new ones were added. Additionally, there were breaking changes to the default configuration of the CaaS Helm chart.

Version 13.2.0 - 14.01.2022

New features

ID Description

CAAS-1836

Updated the RESTHeart license. Also, assigned a priority to each permission in the ACL to avoid WARN messages in the log upon startup.

Fixed issues

ID Description

CAAS-1807

Fixed a bug from version 13.1.0 which caused warnings in the log for requests against the metrics endpoint.

Version 13.1.0 - 11.01.2022

New features

ID Description

CAAS-1807

Added option to prohibit upload of binary data.

Version 13.0.2 - 03.01.2022

Fixed issues

ID Description

CAAS-1755

Improved Grafana dashboards.

Version 13.0.1 - 17.12.2021

Fixed issues

ID Description

PX-142

The chapters from the release notes are no longer numbered consecutively.

Version 13.0.0 - 16.12.2021

Update Notice

This release includes the previously announced discontinuation of the deprecated Docker Compose support, thus the Docker Compose configuration files that were previously contained within the file Docker/caas-docker-configuration-*.zip of the CaaS release bundle are no longer available.

Instead, we recommend using Kubernetes as a deployment platform. Please see chapter Installation and configuration of the documentation for more information regarding the installation and configuration of the CaaS platform using Kubernetes.

New features

ID Description

CAAS-1677

Discontinuation of the Docker Compose support.

Version 12.0.1 - 13.12.2021

New features

ID Description

PX-72

Improved the internal infrastructure.

Version 12.0.0 - 09.12.2021

Update Notice

This release includes the previously announced removal of the deprecated Admin Interface.

Effectively this means that the container image caas-admin-webapp is no longer part of the CaaS release bundle.

Additionally, all Helm values related to the Admin Interface have been removed from the Helm chart as well as all Kubernetes Resources related to the deployment of the Admin Interface.

For development purposes or administrative tasks we recommend using a REST client of your choice.

New features

ID Description

CAAS-1662

Discontinuation of the Admin Interface.

Version 11.0.0 - 01.12.2021

Update Notice

The Helm chart ingress resources now use the spec.ingressClassName attribute, which is available as of Kubernetes 1.18+. The deprecated kubernetes.io/ingress.class annotation has been removed in return. If you have Kubernetes >= 1.18 in use, no configuration of the Helm chart is required. To use the chart with older Kubernetes versions, you need to reintroduce the annotation and delete the attribute instead.

To do this, please set the following entries in custom-values.yaml:

restApi.ingress.annotations.kubernetes.io/ingress.class: "nginx"
restApi.ingress.ingressClassName: null
restApi.ingressPreview.annotations.kubernetes.io/ingress.class: "nginx"
restApi.ingressPreview.ingressClassName: null
adminWebapp.ingress.annotations.kubernetes.io/ingress.class: "nginx"
adminWebapp.ingress.ingressClassName: null

If you are not using NGINX, set a value appropriate for your environment.

New features

ID Description

CAAS-1818

In the ingress resources of the Helm chart, the deprecated annotation kubernetes.io/ingress.class has been removed. Instead, the class is specified using the attribute spec.ingressClassName, which is available as of Kubernetes version 1.18. Compatibility with previous Kubernetes versions can still be achieved with appropriate entries in custom-values.yaml.

Version 10.2.0 - 25.11.2021

New features

ID Description

CAAS-1698

Updated RESTHeart to version 6.1.3.

Version 10.1.1 - 15.11.2021

New features

ID Description

PX-115

Improvement of the internal build process.

Version 10.1.0 - 11.11.2021

Update Notice

As a prerequisite for this update, the CaaS platform must be installed in at least version 9.5.0!

Before carrying out the update, we recommend that you back up the data stored in MongoDB.

Configuration of the MongoDB featureCompatibilityVersion

After updating MongoDB to version 5.0, the parameter featureCompatibilityVersion is now also set to 5.0. In the Kubernetes stack the configuration is fully automated, but in the Docker stack this must be done manually.

Once the CaaS platform is running in version 10.1.0, please execute the following command:

docker exec -it docker_caas-mongo_1 mongo \
    -u $MONGO_INITDB_ROOT_USERNAME \
    -p $MONGO_INITDB_ROOT_PASSWORD \
    --authenticationDatabase admin \
    --eval "db.adminCommand( { setFeatureCompatibilityVersion: '5.0' } )"

Of course, please replace the placeholders with the credentials you have configured.

For more information, please also refer to the MongoDB-Documentation.

New features

ID Description

CAAS-1780

The MongoDB featureCompatibilityVersion is set to 5.0.

Version 10.0.0 - 29.10.2021

Update Notice

The ingress resources of the Helm chart now use the "stable" API version networking.k8s.io/v1, which is available in Kubernetes versions 1.19+. If you are using Kubernetes >= 1.19, no configuration of the Helm chart is required. To use the chart with older Kubernetes versions, the API version must be overridden.

In the custom-values.yaml, the fields restApi.ingress.apiVersionOverride and restApi.ingressPreview.apiVersionOverride are provided for this purpose.
The following values are to be used:

  • K8s 1.11 to 1.13: "extensions/v1beta1"

  • K8s 1.14 to 1.18: "extensions/v1beta1" or "networking.k8s.io/v1beta1".

New features

ID Description

CAAS-1784

The API version of all ingress resources of the Helm chart has been updated to networking.k8s.io/v1, which is available from Kubernetes version 1.19 onwards. A different API version can be set in the custom-values.yaml.

Version 9.7.1 - 22.10.2021

New features

ID Description

CAAS-1706

Changes to the internal infrastructure.

Version 9.7.0 - 21.10.2021

New features

ID Description

CAAS-1786

Updated RESTHeart to version 5.4.7. This version now correctly responds to requests with an invalid regex expression with HTTP 400 instead of 500.

Version 9.6.0 - 13.10.2021

New features

ID Description

CAAS-1794

It is now possible to configure the size of the buffer between container limit and JVM heap of the Rest API pods.

Version 9.5.0 - 13.10.2021

Update Notice

You must have installed the CaaS platform in version 9.4.1 to upgrade to 9.5.0. This is an absolutely necessary step for the MongoDB upgrade!

Compatibility changes of MongoDB

In general, you should check that all applications accessing the CaaS can handle the MongoDB compatibility changes in version 5.0. For a detailed listing of these changes, see the MongoDB documentation.

MongoDB featureCompatibilityVersion

After updating the CaaS platform to 9.5.0, the MongoDB will run in version 5.0 and with the parameter featureCompatibilityVersion set to the value 4.4. The update to the new MongoDB version and updating the featureCompatibilityVersion are kept separate on purpose. This value will be set to 5.0 in a subsequent release in order to be able to perform the update properly without downtime in the Kubernetes stack. More information can be found here:

New features

ID Description

CAAS-1757

Upgraded MongoDB from 4.4.4 to 5.0.3 The featureCompatibilityVersion is still set to 4.4 and will be updated with an upcoming release.

In addition, an update of RESTHeart to version 5.4.6 took place, which includes the MongoDB 5 driver.

Fixed issues

ID Description

CAAS-1757

Fixed a bug in version 9.3.0 where a lack of custom labels caused the helm install to fail.

Version 9.4.1 - 10.02.2022

Update Notice

It is absolutely necessary to install this release with MongoDB version 4.4.11 before updating to a higher version of MongoDB. Otherwise, data inconsistencies may occur due to a bug in MongoDB (see https://jira.mongodb.org/browse/WT-8395).

Fixed issues

ID Description

CAAS-1851

Providing hotfix release 9.4.1 with MongoDB version 4.4.11

Version 9.4.0 - 12.10.2021

New features

ID Description

CAAS-1771

The Helm chart was extended with several new Prometheus Alerting rules. These are deactivated by default.

Version 9.3.1 - 11.10.2021

Fixed issues

ID Description

PX-143

Improvements in internal infrastructure.

Version 9.3.0 - 11.10.2021

New features

ID Description

CAAS-1787

Added additional labels to pods and a way to add custom labels.

Version 9.2.5 - 06.10.2021

New features

ID Description

CAAS-1791

Edited the update notice regarding CaaS Platform version 2.14.0 from 11.08.2020.

Version 9.2.4 - 27.09.2021

Fixed issues

ID Description

PX-126

Improvements in the internal infrastructure.

Version 9.2.3 - 15.09.2021

Fixed issues

ID Description

master

Update policy Off of VerticalPodAutoscaler is no longer interpreted as false.

Version 9.2.2 - 13.09.2021

Fixed issues

ID Description

CAAS-1775

Updated RESTHeart to version 5.4.2 due to optimized memory consumption when loading documents from MongoDB.

Version 9.2.1 - 10.09.2021

New features

ID Description

CAAS-1754

Improved the internal test infrastructure.

Version 9.2.0 - 08.09.2021

New features

ID Description

CAAS-1763

Added VerticalPodAutoscaler for MongoDB to helm chart. It is now possible to set the resource requests of the mongo pods independently of the limits.

Version 9.1.0 - 06.09.2021

New features

ID Description

CAAS-1756

For Ingress resources of the Helm chart it is now possible to set the attribute spec.ingressClassName and to override the attribute apiVersion via Helm values. Currently, only the value networking.k8s.io/v1beta1 can be used for apiVersion.

Version 9.0.3 - 31.08.2021

New features

ID Description

CAAS-1741

Replaced deprecated annotation service.alpha.kubernetes.io/tolerate-unready-endpoints in caas-mongo service with spec.publishNotReadyAddresses attribute.

Version 9.0.2 - 26.08.2021

New features

ID Description

CAAS-1722

Improving the internal monitoring infrastructure.

Version 9.0.1 - 09.08.2021

New features

ID Description

CAAS-1736

Added documentation about indexes.

Version 9.0.0 - 28.07.2021

Update Notice

Please be sure to have version 7.2.0 installed, before upgrading to this version. If you upgrade from a version prior to 7.2.0 you won’t benefit from the automatic one-time API Key migration done with 7.2.0.

New features

ID Description

CAAS-1675

Removed code responsible for one-time migration of API Keys in version 7.2.0.

Version 8.3.4 - 05.07.2021

Fixed issues

ID Description

CAAS-1716

Added missing tenant query parameter to create short-lived security tokens to the change stream code example in the documentation.

Version 8.3.3 - 01.07.2021

Fixed issues

ID Description

CAAS-1693

Grafana dashboards were enhanced by a datasource variable to allow better compatibility across Grafana instances and setups. The data source can now be selected via a drop-down list.

Furthermore, the links to other dashboards on the "CaaS Overview" dashboard were corrected. In addition, panels on all dashboards were changed from the deprecated type "singlestat" to "stat" or "gauge".

Version 8.3.2 - 30.06.2021

Fixed issues

ID Description

CAAS-1439

Switched validating kubernetes resources during build process from Kubeval to Kubeconform.

Version 8.3.1 - 18.06.2021

Fixed issues

ID Description

CAAS-1701

Write accesses to the JSON schema for validating API keys or its collection are now correctly prevented.

Version 8.3.0 - 16.06.2021

New features

ID Description

CAAS-1684

Made filterOperatorsBlacklist feature of RESTHeart configurable in Helm chart. It is disabled by default, so you can opt in to configure it.

Version 8.2.0 - 15.06.2021

New features

ID Description

CAAS-744

A Kubernetes Pod Disruption Budget for MongoDB was added to CaaS Helm chart. You may opt out of this feature by disabling it in your custom-values.yaml. See official documentation for more information.

Version 8.1.7 - 15.06.2021

Fixed issues

ID Description

CAAS-1704

Fixed Rest API deployment specification to update one pod by another during updates. This is needed because of executing database migration / validation logic during updates.

Version 8.1.6 - 14.06.2021

Fixed issues

ID Description

CAAS-1642

Added a pre-stop hook to Rest API Pods, to be able to shift the traffic before the Pod gets stopped by Kubernetes. This fixes the unlikely situation of service outages, for example during updates.

Version 8.1.5 - 11.06.2021

New features

ID Description

CAAS-1613

For development purposes, instead of GKE, a Rancher-managed k8s cluster in AWS is now used.

Fixed issues

ID Description

CAAS-1691

Disabled the digest auth mechanism.

Version 8.1.4 - 08.06.2021

Fixed issues

ID Description

CAAS-1699

Updated RESTHeart to version 5.4.1 due to fixes of memory leaks in RESTHeart.

Version 8.1.3 - 08.06.2021

Fixed issues

ID Description

CAAS-1700

To optimize resource usage the liveness probe in Kubernetes was moved from metrics endpoint to more lightweight ping endpoint.

Version 8.1.2 - 07.06.2021

Fixed issues

ID Description

CAAS-1697

Fixed validation when creating a local api key already existing as global api key.

Version 8.1.1 - 04.06.2021

Fixed issues

ID Description

CAAS-1681

Added missing note regarding expected unit for memory limit configuration in values.yaml

Version 8.1.0 - 31.05.2021

New features

ID Description

CAAS-1683

Added option in Helm values to enable check for same tenant in subdomain and path to avoid cross tenant access.

Version 8.0.0 - 31.05.2021

Highlights

From now on API keys can be managed not only globally but also locally per database. This helps in scoping the API key permissions to that database. We highly recommend this strategy when using CaaS platform as a multitenant system, i.e. in combination wich CaaS Connect.

Please refer to the documentation for more information.

Update Notice

Due to the introduction of database-local API keys, the collection apikeys is created in every database. If you are already using a collection with this name in a database, you must first migrate it to a non-reserved name.

The /_logic/securetoken endpoint is now tenant scoped. Therefore, each request has to provide the required tenant query parameter.

New features

ID Description

CAAS-1337

Added support for database-local API keys.

Version 7.3.0 - 25.05.2021

Highlights

A new Grafana dashboard providing detailed information abput JVM metrics and status was added. If metrics are enabled in Helm chart, the new endpoint is automatically covered by Prometheus Service Monitor definition and the dashboard can be used.

New features

ID Description

CAAS-1574

Added endpoint and Grafana dashboard to provide JVM metrics in prometheus format.

Version 7.2.0 - 11.05.2021

Highlights

Since version 5.0.0, creation and editing of API keys are subject to the condition that _id and key must have the same value. Existing API keys were initially exempt from this rule. Starting from this version, API keys that do not comply with the rule are automatically determined and stored under a new _id.

Before each API key migration, a backup of the apikeys collection is created, with the backup collection name containing the current date and time for easier identification.

The migration logic will be removed in a future release.

Update Notice

If keys with contradictory permissions are found they cannot be migrated. In this rare case a log message prefix [ACTION REQUIRED] is written. Please watch the logs for these messages to migrate your keys manually.

New features

ID Description

CAAS-1630

Automatic migration of api keys not fulfilling _id == key condition, introduced with version 5.0.0.

Version 7.1.0 - 07.05.2021

Highlights

The Docker Compose stack was approved for development purposes only since 02/2020. It is now marked deprecated with immediate effect, and we recommend only using Kubernetes as an operating platform from now on.

Please note that no further bug fixes or features will be implemented on the Docker Compose configuration and the entire stack will be removed at the end of 2021.

New features

ID Description

CAAS-1676

Deprecation of the Docker Compose stack.

Version 7.0.0 - 07.05.2021

Highlights

The CaaS Admin Interface is marked deprecated with immediate effect and its deployment in the Helm chart and Docker Compose stack is disabled. Please note that there will be no further bugfixes or features implemented, and the CaaS Admin Interface will be removed by the end of 2021.

Update Notice

Deployment of the CaaS Admin Interface is disabled in the Helm chart due to deprecation. Instead, we recommend using a REST client of your choice to interact with the REST api, especially for maintaining API keys.
From now on, disabling the CaaS Admin Interface will no longer result in the automatic generation of credentials. Therefore, if you had already disabled the CaaS Admin Interface before, you must now maintain the webAdminUser and webAdminPassword values in the credentials block of custom-values.yaml. Otherwise, the default values of the chart apply.
If you want to continue using the CaaS Admin Interface, you must re-enable it in the custom-values.yaml of your Helm deployment.

The CaaS Admin Interface is also disabled in the Docker Compose stack. If you want to continue using it, you need to remove the comments in the docker-compose.yml.

New features

ID Description

CAAS-1660

Deprecation of the CaaS Admin Interface and deactivating the deployment by default.

Version 6.3.0 - 06.05.2021

New features

ID Description

CAAS-1667

In future, all migration notes can be found in the release notes document, so that the separate "Migration Guide" will no longer be maintained from now on.

Version 6.2.1 - 03.05.2021

Fixed issues

ID Description

CAAS-1666

Creation and editing of API keys was fixed in admin webapp. Additionally, loading API keys in admin webapp now uses pagesize=100 because paging is not implemented. Note that working with more than 100 API keys is not supported in admin webapp. Please use a REST client instead in such situations.

Version 6.2.0 - 29.04.2021

New features

ID Description

CAAS-1447

Documentation artifacts of caas platform were moved to a separate tile on the documentation landing page.

Version 6.1.3 - 23.04.2021

Fixed issues

ID Description

CAAS-1637

All explicit pagesize parameters were removed from calls made by the admin webapp.

Version 6.1.2 - 22.04.2021

Fixed issues

ID Description

CAAS-1654

Simplified internal test execution in dockerized CI environment.

Version 6.1.1 - 19.04.2021

Fixed issues

ID Description

CAAS-1570

Fixed security vulnerability when using security tokens in multitenant mode.

Version 6.1.0 - 15.04.2021

New features

ID Description

CAAS-1625

The initialization of the database was separated from its configuration and moved to the REST API container.

Version 6.0.2 - 14.04.2021

Fixed issues

ID Description

CAAS-1645

Fixed an API key validation bug that rejected PUT requests for API keys if the ID did not contain only alphanumeric characters, hyphen or underscore.

Version 6.0.1 - 12.04.2021

Fixed issues

ID Description

CAAS-1644

Fixed an API key validation bug that resulted in an HTTP 500 response instead of an HTTP 400 response if the key attribute value was missing.

Version 6.0.0 - 06.04.2021

Update Notice

Please note that the new default values for default-pagesize and max-pagesize have been reduced. This results in requests with explicitly set pagesize query parameter and a value greater than 100 being rejected with HTTP 400 bad request.

If you explicitly want or need responses with more than 100 documents, you can adjust these parameters in your custom-values.yaml accordingly.

New features

ID Description

CAAS-1540

Configuration options for the default-pagesize and max-pagesize parameters of RESTHeart instances have been introduced. The new default values are default-pagesize=20 and max-pagesize=100.

Version 5.0.0 - 06.04.2021

Update Notice

With this version, the platform is more restrictive with the creation of API keys. From now on, only PUT or POST requests will be accepted that meet the following guidelines:

  • Each POST request must also include the _id parameter, which must be the same as the key parameter sent at the same time.

  • Each PUT request must now point to an ID which must be the same as the key parameter.

This change ensures in the long run that it is no longer possible to create multiple API key entries with identical key parameters. This guarantees that an API key remains unique across the platform.

Existing API keys are not affected by this change and their functionality remains unchanged.

New features

ID Description

CAAS-1501

Extended validation of API keys creation and editing has been implemented.

Version 4.0.8 - 06.04.2021

Fixed issues

ID Description

CAAS-1624

Updated RESTHeart to version 5.3.4 due to fixes of security issues in RESTHeart.

Version 4.0.5 - 17.03.2021

Fixed issues

ID Description

CAAS-1609

Updated RESTHeart to version 5.3.3 due to fixes of security issues in RESTHeart.

Version 4.0.4 - 11.03.2021

Fixed issues

ID Description

CAAS-1583

It is now enforced that MongoDB runs as ReplicaSet when Rest-API instances are started. This may not be the case, especially when first booting into Kubernetes, since MongoDB is reachable during bootstrapping. For now, we will let the rest API instances fail to boot, so Kubernetes will restart the pods. A more sustainable solution will require some changes to the MongoDB configurations and will be deferred for now.

Version 4.0.3 - 11.03.2021

Fixed issues

ID Description

CAAS-1596

Updated RESTHeart to version 5.3.2 to avoid potential Exchange already complete errors.

Version 4.0.2 - 05.03.2021

Fixed issues

ID Description

CAAS-1468

The release process was adapted to internal changes.

Version 4.0.1 - 03.03.2021

Fixed issues

ID Description

CAAS-1468

The version endpoint of the Rest API now returns the correct release version again and not the version of the development state directly before the release.

Version 4.0.0 - 01.03.2021

Update Notice

Due to the upgrade to MongoDB 4.4.4, several changes had to be made to the Docker Compose configuration. All changes must be manually applied to existing configurations.

New features

ID Description

CAAS-1581

Upgraded MongoDB from 4.4.3 to 4.4.4.

Version 3.0.22 - 23.02.2021

Fixed issues

ID Description

CAAS-1538

Removed chapter Preview CaaS from the installation chapter of the documentation.

Version 3.0.21 - 22.02.2021

New features

ID Description

CAAS-1534

Added documentation regarding push notifications (change streams).

Version 3.0.20 - 18.02.2021

New features

ID Description

CAAS-1580

Updated the RESTHeart license

Version 3.0.18 - 17.02.2021

New features

ID Description

CAAS-1577

Upgraded MongoDB from 4.4 to 4.4.3.

Version 3.0.17 - 16.02.2021

Update Notice

The values for the _JAVA_OPTIONS variable in docker-compose.yml have been corrected and must be manually adjusted in existing installations.

Fixed issues

ID Description

CAAS-1476

To ensure a more stable operation, the JVM flags regarding the heap size in the Kubernetes stack were added and the existing configurations in the Docker stack were adjusted.

Version 3.0.16 - 16.02.2021

Update Notice

Caution, CAAS-1544 changed the Docker Compose configuration. Make sure you get the changes merged into your configuration by hand.

Besides, the rest-api container isn’t based on a distroless base image anymore.

Fixed issues

ID Description

CAAS-1544

Added Docker Compose integration and intensive tests for websocket support.

Version 3.0.14 - 11.02.2021

New features

ID Description

CAAS-1564

The short-lived security tokens can be created using any API key, irrespective of its permissions.

Version 3.0.11 - 01.02.2021

Fixed issues

ID Description

CAAS-1500

Updated RESTHeart to version 5.3.1. Creating a database that already exists with different case returns HTTP 409 Conflict instead of internal server error now.

Version 3.0.9 - 28.01.2021

New features

ID Description

CAAS-1532

Updated RESTHeart to version 5.2.0

Version 3.0.8 - 21.01.2021

Fixed issues

ID Description

CAAS-1512

Removal of WARN log output at rest API startup regarding outdated configuration syntax.

Version 3.0.4 - 19.01.2021

Fixed issues

ID Description

CAAS-1524

Removal of misleading WARN log output from ApiKeyAuthMechanism when authenticating with BasicAuth

Version 3.0.3 - 19.01.2021

Update Notice

The value credentials.caasSecureTokenEncryptionKey has been added to Helm Values. This must be overwritten by on-premise customers along with all other credentials.

New features

ID Description

CAAS-1433

Added support for short-lived security tokens that allow authentication via query parameter or cookie.

Version 3.0.0 - 11.12.2020

Update Notice

The endpoint PATCH /caas_admin/apikeys/{id} for the partial update of an API key is no longer available due to the introduced validations. The full update of an existing API key can still be performed using the PUT or POST endpoints.

New features

ID Description

CAAS-1469

Implemented enhanced validation of API keys: from now on it is no longer possible to create multiple API keys with same key value or to create an API key with duplicate URLs in its permissions array.

Version 2.17.0 - 10.12.2020

Update Notice

Creating and updating API keys is now validated against a JSON schema. Existing API keys are not affected by this as long as they are not changed. The schema can be accessed at /caas_admin/_schemas/apikeys.

The access to the internal caas_admin database has been more restricted. Reading all data contained in it is of course still allowed. However, write access has been limited to managing API keys. Thus, creating, altering or even deleting collections or the entire database itself is no longer possible. These changes primarily prevent a non-functioning CaaS platform due to damaged structures in the internal database.

New features

ID Description

CAAS-1132

All newly created or updated API keys are now validated against a JSON schema. In addition, write access to the internal database caas_admin via the Rest API is now much more restrictive.

Version 2.16.1 - 03.11.2020

Fixed issues

ID Description

CAAS-1457

The CaaS Overview Grafana Dashboard has been adjusted so that the selection of the time period is taken into account in the restarts displayed.

Version 2.16.0 - 02.11.2020

Update Notice

You must have installed CaaS platform version 2.15.0 running MongoDB version 4.4 to upgrade to CaaS platform 2.16. This is an absolutely necessary step for the MongoDB upgrade! For more information, see the Migration Guide.

New features

ID Description

CAAS-1342

The MongoDB featureCompatibilityVersion is set to 4.4. If you use the docker stack manual work is needed after the upgrade. For more information see the Migration Guide.

Version 2.15.0 - 11.09.2020

Update Notice

You must have installed CaaS in at least version 2.13.3 to upgrade to 2.15.x. This is an absolutely necessary step for the MongoDB upgrade! For more information, see the Migration Guide.

New features

ID Description

CAAS-1341

Upgraded MongoDB from 4.2 to 4.4. The featureCompatibilityVersion is still set to 4.2 and will be updated with an upcoming release.

Version 2.14.5 - 26.08.2020

New features

ID Description

CAAS-1386

The Rest API now shows 401 and 403 responses in the Prometheus metrics again.

Version 2.14.3 - 20.08.2020

Fixed issues

ID Description

CAAS-1390

Removal of the Security Proxy from the "Architecture" figure of the product documentation

Version 2.14.2 - 17.08.2020

New features

ID Description

CAAS-1379

Removal of the Ansi colors from the log outputs of RESTHeart

Version 2.14.1 - 11.08.2020

New features

ID Description

CAAS-1079

Added a Grafana dashboard for MongoDB to allow basic analysis regarding MongoDB status and possible issues.

Version 2.14.0 - 11.08.2020

Highlights

RESTHeart has been upgraded to version 5.1.4.

Update Notice

Starting with this version, the separate "Security Proxy" for authentication and authorization is no longer provided.

Furthermore, it is important to mention that due to RESTHeart licensing all past versions of the CaaS Platform are no longer executable as of 01.09.2021.

New features

ID Description

CAAS-1295

Updated RESTHeart to version 5.1.4

Version 2.13.3

Update Notice

You must have installed CaaS platform version 2.12.0 running MongoDB version 4.2 to upgrade to CaaS platform 2.13. This is an absolutely necessary step for the MongoDB upgrade! For more information, see the Migration Guide.

New features

ID Description

CAAS-1101

The MongoDB featureCompatibilityVersion is set to 4.2. If you use the docker stack manual work is needed after the upgrade. For more information see the Migration Guide.

Version 2.12.0

Update Notice

You must have installed CaaS in at least version 2.9.2 to upgrade to 2.12.x. This is an absolutely necessary step for the MongoDB upgrade! For more information, see the Migration Guide.

New features

ID Description

CAAS-1100

Upgraded MongoDB from 4.0 to 4.2. The featureCompatibilityVersion is still set to 4.0 and will be updated with an upcoming release.

Version 2.11.41

Fixed issues

ID Description

CAAS-1307

RESTHeart has been upgraded to version 4.1.17

CAAS-1303

Fixed the CPU limit unit of the container caas-rest-api-security in Helm chart default values.

CAAS-1284

Grafana Dashboards adjusted so that the selection of the period is taken into account in the displayed metrics.

New features

ID Description

CAAS-1288

Added an endpoint to get the version of caas-rest-api via HTTP at /_logic/version. This endpoint is secured and needs authentication. The admin and metrics user are both authorized to fetch this information.

Version 2.11.34

Highlights

The use of Helm 2 is no longer recommended with immediate effect. The Helm chart can already be installed with Helm 3, but is still compatible with Helm 2. However, in one of the coming releases the chart will only support Helm 3. Therefore, we recommend to migrate to Helm 3 immediately, for more information see e.g. the blog https://helm.sh/blog/migrate-from-helm-v2-to-helm-v3/.

Fixed issues

ID Description

CAAS-1259

Removal of Keystore and Truststore passwords from caas-docker.env as SSL support was removed in version 2.4.5.

New features

ID Description

CAAS-1242

Helm 3 is listed in our reference system. Helm 2 is about to be deprecated. Migration to Helm 3 is strongly recommended.

Version 2.11.28

Fixed issues

ID Description

CAAS-1270

To be compatible with Helm 3 the field "tillerVersion" was removed from the Helm chart. Helm 3.x is not yet actively supported, this is only a first preparation.

Version 2.11.23

Fixed issues

ID Description

CAAS-1229

Fixed resources in Helm default values block for caas-rest-api-security container.

CAAS-1165

Database or collection names containing double colons, backslashes or line feeds are now escaped correctly in the Prometheus metrics in the REST interface.

New features

ID Description

CAAS-1248

The versions listed in the Release Notes for the Platform were corrected.

CAAS-1246

To be compatible with Helm 3 the value for apiVersion was set explicitly in the Helm chart. Helm 3.x is not yet actively supported, this is only a first preparation.

CAAS-1235

The technical datasheet has been separated up and is now available for both CaaS module and CaaS Platform.

CAAS-1234

The documentation has been split up into separate documents for CaaS platform and CaaS module and has been slightly revised. In addition, a CaaS product documentation has been added, which serves as an introduction and refers to the separate documents.

CAAS-1176

Logging of TraceID header values has been added in the caas-rest-api-security container.

CAAS-1175

The Healthcheck endpoint URL has changed to /_logic/healthcheck in version 2.11.5, this was now fixed in the documentation and migration guide.

CAAS-1158

RESTheart has been upgraded to version 4.1.16

Version 2.11.5

Highlights

RESTheart has been upgraded to version 4.1.3 (platform edition). From now on, authentication and authorization are performed by a security proxy.

Update Notice

For installations for development purposes (docker-compose), you need to recreate that stack from scratch since changes to the database setup are necessary.

The example monitoring deployment were removed from CaaS Helm chart as it was not meant to be used in production. Please consider installing Prometheus Operator e.g. by using the official helm charts. This includes a much more comprehensive cluster monitoring setup. Please see the migration guide and documentation for more information.

The CaaS Grafana dashboards were converted to be multi-namespace capable.

Rest API Endpoints to API keys are now only accessible using Basic Auth. Even authenticated API Keys are not authorized to read from or write to the internal admin database. The Admin Webapp is not affected by this and works as before.

Fixed issues

ID Description

CAAS-1087

Requests that have been rejected because of missing or restricted credentials now correctly return 401 / 403 instead of just 401.

New features

ID Description

CAAS-1145

Nginx Configuration Snippet for Preview-CaaS Ingress is now part of the helm values.

CAAS-1078

RESTheart has been upgraded to version 4.1.3

CAAS-1009

Removed example monitoring deployment from CaaS Helm charts and made Grafana dashboards multi namespace capable.

CAAS-915

Access to the "caas_admin" database (and all its collections) is forbidden when authenticated with API key.

CAAS-395

Caas-Rest-Api now uses "distroless" containers to reduce attack surface.

Version 2.10.4

Fixed issues

ID Description

CAAS-1108

The Kubernetes ingress definition for the Preview CaaS now has its own values for annotations and Cert Manager / TLS instead of using the values of CaaS Ingress.

Version 2.10.0

Update Notice

The CaaS module and the CaaS platform were separated for internal development, but are currently still delivered together. As a result, the version numbers within the delivery are no longer the same and will evolve independently in the future.

Fixed issues

ID Description

CAAS-1055

The HTTPS service port was removed from kubernetes service definition for Rest-API as SSL support was removed in version 2.4.5.

New features

ID Description

CAAS-1083

The CaaS module and the CaaS platform were separated internally

Note on the version numbers

With the 2.10 release, the development of the CaaS module and the CaaS platform was separated internally. From this point on, the version numbers of these components also develop independently of each other.

As a result, the release notes in this document above this note are only listed for CaaS platform. However, for historical reasons, the release notes for the Caas module and platform, which were previously combined, are still listed below this note.

Version 2.9.2

Update Notice

You must have installed CaaS version 2.8.6 running MongoDB version 4.0 to upgrade to CaaS 2.9. This is an absolutely necessary step for the MongoDB upgrade!

Fixed issues

ID Description

CAAS-1099

Fixed missing read & execute rights for MongoDB bootstrap script in docker compose configuration.

New features

ID Description

CAAS-1039

The MongoDB featureCompatibilityVersion is set to 4.0. If you use the docker stack manual work is needed after the upgrade. For more information see the Migration Guide.

Version 2.8.6

Highlights

The Helm charts support activation of additional Ingress definitions in order to provide a Preview CaaS without deploying a second CaaS stack. To avoid mixing released and unreleased data, these Ingresses add the suffix "Preview" to the database name. After activating the Preview CaaS Ingresses you may configure the connection in the FirstSpirit project component. Please see the documentation for more information.

Update Notice

You must have installed CaaS version 2.7.9 to upgrade to 2.8.x. This is an absolutely necessary step for the MongoDB upgrade! For more information, see the Migration Guide.

Fixed issues

ID Description

CAAS-1084

Fixed Grafana board per CaaS database to display response times for 4xx/5xx responses.

CAAS-1082

In case of using a CaaS instance with a HTTP context path the CaaS service configuration in server manager no longer has to end with a '/'.

CAAS-1080

Fixed rendering of remote links of page refs in preview mode.

CAAS-1076

Transmit durations have been calculated incorrectly for cases where network calls have been retried

CAAS-1054

While in the CleanUp a 404 will now be an acceptable response to a delete request.

CAAS-1012

Check configuration dialog now displays the correct title depending on outcome

New features

ID Description

CAAS-1031

Additional Ingresses can be activated in the Helm charts to provide a Preview CaaS functionality without a second CaaS stack.

CAAS-1011

Upgraded MongoDB from 3.6.13 to 4.0.10. The featureCompatibilityVersion is still set to 3.6 and will be updated with an upcoming release.

Version 2.7.9

Highlights

The connection between the FirstSpirit module and the REST API was reimplemented to be more robust and faster. Additionally, the parallelism configuration in the service configuration has changed semantics: Instead of configuring parallelism on a per schedule basis, parallelism is now configured for the server’s scope and does only affect media processing.

Update Notice

You must have installed CaaS version 2.6.1 running MongoDB version 3.6 to upgrade to 2.7.x. This is an absolutely necessary step for the MongoDB upgrade!

Since the parallelism configuration in the service configuration has changed semantics, you should revisit your current configuration and adjust it according to the new semantics. Overriding configurations in the schedule (with the caasMaxParallelConnections parameter) are now rendered obsolete. Although they don’t cause warnings, you should remove them.

Fixed issues

ID Description

CAAS-1052

A Prometheus alert rule was added to detect possible MongoDB splitbrain situations based on MongoDB metrics introduced with CaaS 2.5.7.

CAAS-1051

Assets can be sent successfully to an HTTPS REST interface when proxy is used

CAAS-1049

In releases starting from 2.5.7, some publicly-available docker images were missing in the release zip files. They have been re-added.

CAAS-1048

Releases after and including 2.5.7 contained a bug that prevented installations without the monitoring stack, this has been fixed.

CAAS-997

The name of the caas-mongo persistent volume claim is now configurable in the helm chart values. Beware that the name for the persistent volume claim of an existing stateful set cannot be changed!

CAAS-838

CaaS-CleanUp no longer lags one generation behind.

New features

ID Description

CAAS-1041

Updated technical requirements section in the documentation.

CAAS-1038

The MongoDB featureCompatibilityVersion is set to 3.6. If you use the docker stack manual work is needed after the upgrade. For more information see the Migration Guide.

CAAS-946

The CaasConnection implementation was exchanged

CAAS-704

Removed the custom rest api ping endpoint (/_logic/metrics/ping) and adapted the kubernetes liveness probe to use the metrics endpount (/_metrics) instead.

Version 2.6.1

Update Notice

You must have installed version 2.5.7 to upgrade to 2.6.x. This is an absolutely necessary step for the MongoDB upgrade! For more information, see the Migration Guide.

Fixed issues

ID Description

CAAS-1025

Enhanced logging of FirstSpirit module.

New features

ID Description

CAAS-1040

The migration guide are now also available in english.

CAAS-1037

Upgraded RESTheart to version 3.10.1.

CAAS-891

Added exception handling if project language is deleted.

CAAS-670

Upgraded MongoDB from 3.4.19 to 3.6.13. The featureCompatibilityVersion is still set to 3.4 (in case of upgrades) and will be updated with an upcoming release.

Version 2.5.7

Highlights

We changed the normalization logic for CaaS project names, also known as CaaS database ids. From now on, special characters except non-leading underscores and dashes in project names will be removed, so that the resulting CaaS url doesn’t contain any other special characters anymore. Normalization of collection and document ids of CaaS urls may be interesting for you too, as from now on they too can only contain underscores and dashes. For further details, please take a look at the documentation.

Update Notice

Changing the normalization logic of all CaaS url components may lead to unwanted behavior in your project. Please read the corresponding documentation carefully and contact us, when you need help with a migration process.

The Kubernetes liveness probe for the MongoDB statefulset was deleted in order to allow the database longer startup and recovery times without the pods being killed by kubernetes. In addition custom Prometheus alerts can be enabled in the helm chart. Please see the documentation for more information.

If the cleanup task is configured to run in the case of errors, the execution is now suppressed if transmission errors exist. In the case of pure generation errors, the cleanup will still be executed. To force cleanup execution even in case of transmission errors set the property caasForceCleanupOnFailedItems to true.

Fixed issues

ID Description

CAAS-1029

Added missing executable flag to MongoDB bootstrap.sh in docker-compose stack.

CAAS-1017

Old project name normalization recovered

CAAS-902

Removed MongoDB liveness probe and added Prometheus alerts instead

CAAS-805

Reduced internal dependencies of metadata converter class.

New features

ID Description

CAAS-901

MongoDB Helm templates have been updated and the database’s featureCompatibilityVersion parameter has been set to "3.4" in preparation for upcoming MongoDB upgrades. Additionally, metrics support for MongoDB was added and can be activated in helm values.

CAAS-853

Added a possibility, to turn on the evaluation of FirstSpirit metadata template

CAAS-790

The cleanup task won’t execute deletions in case of transmission errors

Version 2.4.35

Fixed issues

ID Description

CAAS-1006

Recovered old class signatures

New features

ID Description

CAAS-250

Configuring the CaaS target database and collection in Site Architect is no longer possible for all projects users, but project administrators only.

Version 2.4.29

Highlights

The input components for custom url configurations now show where the parts of the resulting CaaS url do come from. Furthermore, when saving a configuration, only the exact user input is getting persisted - for example when no project name was given, the configuration doesn’t persist the current FirstSpirit project name but nothing. Url resolution does then later on automatically use the FirstSpirit project name from the context.

Fixed issues

ID Description

CAAS-989

More conservative resolution handling for url generation

CAAS-369

Persistence layer for url configurations got replaced.

New features

ID Description

CAAS-980

The admin web app can now be deactivated in the kubernetes stack, in case it is not needed.

CAAS-976

Prepared minimal OpenShift support

CAAS-808

The releasenotes are now also available in German.

CAAS-426

The helm chart now supports the configuration of Kubernetes network policies via the values file. By default, all policies are disabled, but can be enabled with a default configuration and adjusted as needed.

Version 2.4.21

Highlights

Operations with Kubernetes is no longer in "technical preview" state.

Fixed issues

ID Description

CAAS-940

Stored URLs have not been used when media has been deployed through standard FS mechanisms, but the rest has been deployed to CaaS

CAAS-836

Fixed a bug where data sets that contained media did not deploy that media in preview

New features

ID Description

CAAS-741

Upgraded RESTheart to version 3.9.0 allowing to scrape metrics per database and collection. A new Grafana dashboard was added to show these metrics.

CAAS-578

Reworked CaaS Documentation

Version 2.4.16

Update Notice

With this change, project administrators are now able to change the settings of the CaaS project component.

Using the UrlCreatorAgent API now requires at least the FirstSpirit version 2019-03.

Fixed issues

ID Description

CAAS-934

Schedule entries that deploy a preview state will only use the caas preview url factory if preview has been configured in the project app component

CAAS-931

Removed unneeded requests to create already existing assets.files collection.

CAAS-930

Some HTTP connections have erroneously been retried (such as on 403 answers). Retries are now limited to certain status codes.

CAAS-924

Fixed permissions in admin webapp container to allow usage of securityContext.runAsUser.

CAAS-919

Adjustment of the preview service so that no restart of the service is required to update the project configuration.

New features

ID Description

CAAS-888

Use of the new UrlCreatorAgent API

CAAS-881

CaaS module now supports JDK11 as runtime for FirstSpirit

CAAS-878

Remote media can now also be streamed from FirstSpirit during preview

Version 2.4.5

Update Notice

Please note that this update contains an update of the MongoDB version. As always with database updates, make sure you have a working backup before proceeding with the update.

The fields mongo.cpuRequest and mongo.memoryRequest from the Kubernetes helm chart configuration file values.yaml have been removed. The limits are used instead everywhere to get into the guraanteed QoS class. Check your values files in case you used different values for limits and requests in the past.

Please keep in mind, that it’s not possible to use custom URL factories in a CaaS schedule. If you use such a configuration in a schedule, the configuration is going to be overridden internally from now on and thus effectless.

If you have used the supplied certificates so far, you must now set up and manage them independently. More information can be found in the Docker or Kubernetes documentation.

With this release Kubernetes support will be limited to version 1.9.0 or higher

Fixed issues

ID Description

CAAS-914

Removed storage support (PVC) for Grafana as all dashboards and datasources are provisioned and Grafana should be stateless.

CAAS-913

Users could select url creators for media for CDN deployment that actually are unsupported, this is not possible anymore

CAAS-903

MongoDB has been updated to version 3.4.19

CAAS-900

Added date to default log pattern of REST interface.

CAAS-893

The formula for calculating the Wired Tiger cache size has been adapted to the version from the official documentation. As a result, MongoDB has a slightly larger cache available.

CAAS-847

Problems of internal queue handling of CaaS generation solved.

CAAS-814

CompletionStage is correctly completed now.

New features

ID Description

CAAS-918

Updated screenshots to reflect current project component GUI

CAAS-912

Parameters that are supplied in a schedule entry (e.g. "CaaS initialize") do not obey the case anymore. For example, it it possible to use "caasURL" now instead of "caasUrl" to set a new CaaS URL in a schedule.

CAAS-895

MongoDB pods now are always in the guaranteed QoS class to improve general database performance and reliability.

CAAS-862

Documentation extended with notes on scaling and error analysis of the MongoDB cluster as well as the health check of the rest API.

CAAS-819

Preview schedules can now use FirstSpirit preview URLs.

CAAS-768

Improved URL-Creation for preview URLs.

CAAS-665

This CaaS version eliminates the supplied self-signed SSL certificates.

CAAS-652

Changed liveness probe such that a stuck pod will not get any traffic for about 10 seconds before restarting, giving it a chance to come back to life.

CAAS-647

Setting path in webapp ingress will now configure its base url.

CAAS-460

Updated Kubernetes API version to apps/v1

Version 2.3.1

Update Notice

Url factories for media deployments are configured through their component names from now on, instead of their full qualified class names. Migration of existing configurations is done automatically, when corresponding components can be found on the server. For example if your project app configuration contains 'de.espirit.firstspirit.generate.AdvancedUrlFactory', it gets automatically changed to 'Advanced URLs' when the project app component is updated. For potential manual migrations, please keep in mind that the FirstSpirit server has to be restarted after the module was installed, in order to be able to update the project component.

We updated MongoDB from 3.4.10 to 3.4.17. See https://docs.mongodb.com/manual/release-notes/3.4-changelog for more information on the changes.

Furthermore, we plan to update the major version of MongoDB in one of the upcoming releases.

Fixed issues

ID Description

CAAS-882

Added connection check for preview service configuration (in the project app)

CAAS-873

Changed AdvancedUrlFactory default value in project app from class to component name.

CAAS-834

Now trimming inputs in config keys for whitespaces (API key, URLs, …​)

CAAS-832

Connection-Checks in caas service configuration now has improved failure handling and error messaging

CAAS-822

Performance optimization in action CaaS DeltaGeneration

CAAS-654

Changed all variable names in the env.js configuration file.

New features

ID Description

CAAS-864

Updated underlying software in the stack, mainly docker images

CAAS-856

Prometheus label for service monitor definitions is configurable now.

CAAS-727

Support for Horizontal Pod Autoscaler

Version 2.2.5

Fixed issues

ID Description

CAAS-865

Invalid JSON in channels lead to not deploying that content, and not throwing errors

Version 2.2.3

Highlights

The CaaS module can now be used on isolated FirstSpirit servers. Additionally, the JSON validation became stricter and lets schedules fail in some more cases of invalid data input.

Update Notice

If you use content projection to add entities to CaaS the generated URLs might change with this bugfix. In case the last page of content projection contained a single element only, the document URL was not generated correctly. Instead of generating a document name using the correct page offset, the entity key values were used. This was fixed now.

Fixed issues

ID Description

CAAS-844

Fixed deletion of entities in preview CaaS.

CAAS-833

Fixed updating preview CaaS content in case of entity creations and modifications.

CAAS-823

Fixed initialization of CaaS config dialog in Site Architect for PageRefs without stored configuration.

CAAS-809

Removed duplicate install scripts for docker images.

New features

ID Description

CAAS-705

Upgrade RESTheart to 3.5.0

CAAS-645

Added options to include prometheus and metric exporter deployments in helm charts. This requires an already installed and configured prometheus operator! Further information can be taken from CaaS Kubernetes documentation.

CAAS-640

Using new upsert functionality for media provided by RESTheart 3.5.0 to improve performance and stability for media deployments.

CAAS-533

Added options to include grafana deployment in helm charts. Further information can be taken from CaaS Kubernetes documentation.

CAAS-311

This module can now be used on isolated FirstSpirit servers.

Version 2.1.8

Fixed issues

ID Description

CAAS-811

Fixed problem that occurred only when configuring the caas service for a module that has been freshly installed (not updated)

Version 2.1.6

Update Notice

Breaking change: In the past, the FirstSpirit CaaS module deployed remote media to the REST API. This is not done anymore, remote media is instead directly linked to. Deployment of remote media now has to be handled by the remote project itself. Therefore, URLs to remote media should now be configured through the standard FirstSpirit mechanisms. Consult the documentation for more details.

Fixed issues

ID Description

CAAS-803

Fixed an issue where URLFactories that did not generate leading slashes lead to wrong URLs

CAAS-788

Corrects that the file names of the documentation are consistent

CAAS-773

Fixed deletion of PageRefs in preview context.

New features

ID Description

CAAS-416

Added functionality to disable media generation to CaaS to support CDN scenarios

CAAS-379

The obsolete endpoint "/_logics/metrics/metrics" has been removed from the REST interface. It has been superseded by the metrics endpoint reachable under "/_metrics".

Version 2.0.40

Fixed issues

ID Description

CAAS-767

Fixed: Deleting and moving sections did not trigger updates in CaaS for preview

CAAS-763

Upgraded async-http-client to 2.5.3

CAAS-762

More efficient connection handling implemented for preview.

CAAS-761

Fixed problem where parallel usage of OCM and schedule execution or parallel executions of multiple schedules lead to transmission problems

CAAS-389

Fixed version number in admin webapp footer to display the correct version information instead of placeholder.

New features

ID Description

CAAS-758

Changed the Admin Webapp to use Basic Auth with username and password instead of auth token in order to be able to remove the sticky session definition from Rest API ingress.

CAAS-584

Added recommendations for storage usage on mongo pods in technical datasheet.

Version 2.0.32

Fixed issues

ID Description

CAAS-755

Improving handling of async HTTP client to avoid leaked threads and reduce number of needed client instances.

CAAS-752

The pages overwrote each other in the case of a content-projection that generated multiple pages with more than one element per page. This has been fixed and the CaaS URL contains the element offset in order to be unique.

CAAS-751

External data sources from FirstSpirit did not work with the CaaS URL creator. This has been fixed.

CAAS-628

Fixed usage of multiple sequential generation tasks in a single CaaS deployment. Parallel generations do not work!

Version 2.0.22

Update Notice

Due to changes in FirstSpirit "Access denied to de.espirit.firstspirit.agency.ConnectionDelegatingSpecialistsBroker$ManagerBrokerImpl" warnings appeared during CaaS deployments. The usage of the internal APIs are changed to not trigger these warnings anymore. Therefore we from now on expect CaaS to run with a FirstSpirit server 2018-07 or newer. Older versions are not supported anymore!

Further information can be found in the migration guide.

New features

ID Description

CAAS-510

Changed FirstSpirit API Access

Version 2.0.21

Fixed issues

ID Description

CAAS-722

Fixed caching issue in TPP which caused URLs through remote connections to be outdated in some cases

CAAS-680

Closing the underlying HTTP client explicitly when not needed anymore.

New features

ID Description

CAAS-517

Added support for automatic SSL certificate issuing using an external cert-manager component in Kubernetes

Version 2.0.15

Fixed issues

ID Description

CAAS-719

Fixed wrong selection for preview mode in project app configuration

New features

ID Description

CAAS-714

Updated docs to reflect there is support for data sources with TPP

CAAS-712

Improved timeout handling of file and document transfers

CAAS-567

Re-added streaming for file transfers from FS to caas-rest-api

CAAS-550

The admin-webapp is now based on nginx 15.3 alpine docker image.

CAAS-287

The release process now automatically uses the most recent OpenJDK8 base image for the caas rest API docker image

Version 2.0.6

New features

ID Description

CAAS-564

Added option to override proxy uri in schedule and preview configuration.

CAAS-487

Enhanced internal code quality assurance.

CAAS-450

Using an asynchronous HTTP client for accessing REST API

Version 2.0.0

Highlights

From now on, the communication between FirstSpirit module and CaaS stack happens directly via http and without any further indirections.

This version adds the possibility to add HTTP proxy support to your module configuration in order to reach the REST API via a proxy.

Update Notice

It is no longer necessary to provide a copy of the fs-license.conf file for the rest-api component in both the docker-compose and kubernetes stack. For the FirstSpirit module, it is still necessary.

There have been many changes in this version of CaaS. Please refer to the migration guide to review what needs to be changed.

As previously announced, the standalone package won’t be supported anymore. Therefore it is removed from our future releases including this one.

Please keep in mind, that we also restructured our documentations and the standalone distribution will no longe be documented at all. The new main documentation is about using CaaS using Docker (or Kubernetes).

For migration purposes, take a look at the latest documentation regarding the stacks mentioned above.

The CaaS service configuration now has to be configured differently: Instead of a configuration for a connection to the message bus, the url to the REST api, as well as a valid API key has to be configured now.

Fixed issues

ID Description

CAAS-655

Handled possible NPE on collection cleanup.

CAAS-631

Attempt to save an existing file is no longer treated as an error

CAAS-627

Fixed issue with simultaneous schedule execution and preview service usage

CAAS-624

Documentation updates regarding webapp configuration using the docker stack

CAAS-616

Fixed an error that occurred for unconfigured deactivated projects while installing the module

CAAS-607

Fixed ordering of templateset names in preview CaaS configuration

CAAS-604

Removed synchronized creation of database and collection as no longer needed with RESTHeart 3.4.2

CAAS-603

Fixed problem where logging of the schedule results was inconsistent

CAAS-600

Added retry in case of connection error

CAAS-574

Fixed window width of CaaS service configuration

New features

ID Description

CAAS-672

The maximum body size configuration for the rest api ingress has been set to 100Mb.

CAAS-641

Improved migration guide

CAAS-621

Overriding the maximum number of parallel connections to Rest API is now possible in the schedule

CAAS-614

Showing fundamental information about CaaS after installation using helm.

CAAS-609

Added trace IDs to sent requests to Rest API

CAAS-608

Automatic preview service restart on project configuration change added.

CAAS-599

Added transmission time metrics for deployments to the module and report

CAAS-540

Improved license check behavior

CAAS-539

Upgrade to Restheart 3.4.2

CAAS-522

caas-gateway has been removed from the docker stack and a default configuration for a preview caas has been added

CAAS-495

Optimized internal message handling in FistSpirit module.

CAAS-489

Removed CaaS standalone distribution

CAAS-463

Implemented direct connection between module and REST api

CAAS-455

Added HTTP proxy support.

CAAS-452

CaaS bus and adapter have been completely removed

CAAS-449

Using multiple parallel connections to optimize data transfer from FirstSpirit to Rest API

CAAS-447

Merged adapter logic into FirstSpirit module.

CAAS-442

By defining an empty imagePullSecretName the declaration of imagePullSecrets is omitted

Version 1.3.35

Fixed issues

ID Description

CAAS-657

Removed unused admin webap configurations

CAAS-656

Preview generation now waits for complete revision commit on event.

CAAS-649

Fixed preview deployment behavior with wrong section revision

CAAS-648

Fixed preview generation of content projection on dataset changes

CAAS-644

Fixed asset loading for admin webapp in standalone operating mode

Version 1.3.32

Fixed issues

ID Description

CAAS-622

Fixes a bug in restheart that made some types of filter queries fail with a 400 (BAD REQUEST). Workaround for users of the older versions is to url-encode filter queries before sending them to the server.

Version 1.3.31

Fixed issues

ID Description

CAAS-617

imagePullPolicy for Kubernetes was missing in some cases - this has been fixed

CAAS-610

Avoid duplicate creation of assets during a single schedule.

CAAS-605

Added retry in case of connection error

CAAS-597

Added debug logging for persisted urls on save action

Version 1.3.30

Fixed issues

ID Description

CAAS-542

Changed ordering usage of k8s values restApi.host and restApi.ingress.host to make it possible to override the rest-api host usage in the admin webapp in case an ingress resource has been created.

New features

ID Description

CAAS-555

The admin webapp container does not need root privileges anymore

Version 1.3.29

Update Notice

Be sure to check the official release notes in case you have custom CaaS content and / or queries: https://github.com/SoftInstigate/restheart/releases

Fixed issues

ID Description

CAAS-523

Deleting API Keys directly without using any RESTHeart filter.

CAAS-520

Improved handling for problems with mongoDB journaling

CAAS-516

Fixed an issue that would sometimes cause apikeys to not be displayed correctly

CAAS-504

Removed authentication for OPTIONS request on _logic/license resource.

CAAS-482

Minor updates in Kubernetes and Docker documentation

CAAS-367

Improved error handling during license file check.

CAAS-148

"API-Key permissions are stored without trailing slash now

New features

ID Description

CAAS-508

Upgraded RESTHeart to version 3.3.1

CAAS-466

Lowered log level for metrics requests to generate less logs in the default case

CAAS-398

Restructured chapter regarding import of docker containers and docker compose configuration.

CAAS-238

added more data to the JSON response from /_logic/license

Version 1.3.28

Update Notice

The base path of the admin webapp has been changed from /caas to /.

For Kubernetes: Keep in mind that the service port has been changed from port 8080 to 80 in a previous release, too. The defined ingress currently uses features from nginx-ingress-controller. If you want to use the built-in ingress, you need to use that ingress controller. If you do not use the built-in ingress controller, you may need to fill the value restApi.host in your values.yaml to be able to connect to caas-rest-api from caas-admin-webapp. Make sure the provided URL is reachable for all users of the caas-admin-webapp.

Fixed issues

ID Description

CAAS-503

Renamed environment variables to avoid conflicts with those generated by Kubernetes

CAAS-500

Busybox Image was missing in previous releases and has now been added.

CAAS-498

An erroneous port mapping in the ingress definition for the admin webapp has been corrected.

New features

ID Description

CAAS-302

The admin webapp no ​​longer contains its own instance of the rest API, but now connects against the regular instances. The base path was changed from /caas to /.

Version 1.3.27

Highlights

The documentation for the technical preview of CaaS with Kubernetes is now also available in english.

New features

ID Description

CAAS-478

Empty CaaS Deployments lead to generation of a cleanup message now.

CAAS-423

Kubernetes technical preview documentation available in english

CAAS-282

Kubernetes: Added support for custom Ingress configuration in WebApp and Rest-Api

Version 1.3.26

Update Notice

If you are using CaaS with Kubernetes, please consider using this version instead of 1.3.25.

Fixed issues

ID Description

CAAS-484

Kubernetes: Fixed a bug with a wrong MongoDB version.

CAAS-468

updated migration guide to include the new licenses introduced with version 1.3.14

Version 1.3.25

Update Notice

CaaS on Kubernetes: The service of caas-webapp changed its ports from 8080 to 80 and 4443 to 443 (default ports for the protocols). You should now be able to not specify ports at all where they are used. Your old configurations (using 8080 or 4443) will not work anymore.

If you already use a custom cluster-key file (by replacing the default file), you now have put the content of your custom file into the values file. Keep in mind, that your custom cluster-key file won’t be used anymore from now on.

With this release Kubernetes support will be limited to version 1.8.0 or higher.

New features

ID Description

CAAS-473

Improved error logging in case a project does not include a single PageRef (which is not supported)

CAAS-465

Kubernetes: Changed WebApp Service ports (Ports 80/443 instead of 8080/4443)

CAAS-457

MongoDB Cluster-key is now configurable from values.yml instead of replacing a file.

CAAS-438

updated Kubernetes API version

CAAS-401

Kubernetes: Added support for pod annotations in values.yaml

Version 1.3.24

Fixed issues

ID Description

CAAS-459

Improved timeout behaviour with third party firewalls

Version 1.3.23

Fixed issues

ID Description

CAAS-456

Fixed connection problem between adapter and rest-api in kubernetes

CAAS-445

Changed liveness probe of the bus component to use the metrics endpoint.

New features

ID Description

CAAS-418

CaaS-Adapter: number of replicas is now configurable in the values.yaml

Version 1.3.22

Update Notice

The endpoint located at /_logic/metrics/threads is no longer accessible and will respond with a status of 404.

The service of caas-rest-api changed its ports from 8080 to 80 and 4443 to 443 (default ports for the protocols). You should now be able to not specify ports at all where they are used. Your old configurations (using 8080 or 4443) will not work anymore.

All CaaS components (including FS module) require Java 1.8

Fixed issues

ID Description

CAAS-413

Internal optimizations for memory usage

CAAS-406

Improvements in the kubernetes memory limits handling

CAAS-405

Kubernetes: Removed warnings about SSL handshake from caas-bus-logs. Changed some service ports (e.g. caas-rest-api resides on port 80/443 now instead of 8080/4443)

New features

ID Description

CAAS-420

Removed thread-dump metrics

CAAS-393

Improved support for kubernetes clusters with RBAC support and with special security contexts

CAAS-364

Bus now offers HTTP and HTTPS transports. This allows clients to tunnel over HTTP or HTTPS avoiding any firewall issues.

Version 1.3.21

Update Notice

The CaaS standalone installation will be removed from the distribution in the next minor release.

Variables CAAS_BUS_MAX_MEMORY and CAAS_BUS_MIN_MEMORY have been removed. Memory limits for the bus application are now defined using the _JAVA_OPTIONS flag.

Fixed issues

ID Description

CAAS-412

Metrics metadata use patch semantics now.

CAAS-391

Small documentation changes regarding the usage of FirstSpirit Third Party Preview

CAAS-362

Memory limits for all applications are now explicitly defined by "_JAVA_OPTIONS". Memory usage for all containers have been increased.

New features

ID Description

CAAS-415

CaaS standalone installation will be removed in the next minor release.

Version 1.3.20

Fixed issues

ID Description

CAAS-376

Fixed database timeout issues with third party firewalls

CAAS-360

Corrected counting of documents inside collections and increased maximal collection size from 100 to 500 in Admin Interface Browser

Version 1.3.19

Highlights

There is a technical preview available for CaaS in Kubernetes. Customers who want to install CaaS in Kubernetes can use the new helm chart for installation. Feedback is highly appreciated. The Kubernetes implementation replaces the old docker-compose-cluster configuration, which has ben removed and is not supported anymore.

Update Notice

  • CAAS_MASTER_API has been changed to CAAS_MASTER_API_KEY

  • We’re now using the official MongoDB docker image instead of a self-built one

New features

ID Description

CAAS-365

Added support for mongo-clusters in Kubernetes with Helm

Version 1.3.17

Fixed issues

ID Description

CAAS-373

Fixed error with wrong metadata in metrics hooks.

New features

ID Description

CAAS-382

CaaS documentation is now available online under https://docs.e-spirit.com/caas/ .

CAAS-299

caas-admin-webapp can now be configured using an external .js file

Version 1.3.16

Highlights

Configurable CaaS project names

It is now possible to change an element’s CaaS project, just like it was already possible for its collection name.

Third Party Preview integration support

By adding a project component it is now possible to make use of the FirstSpirit Eventing API. Using this project component means that each content change triggers a CaaS generation which deploys the current state of the project data into a Preview CaaS. Furthermore this feature allows you to integrate the FirstSpirit Party Preview which provides external app data in the FirstSpirit ContentCreator.

CaaS now supports metrics that allow to be used for monitoring and in some cases for autoscaling, see endpoint /_metrics on different levels.

New features

ID Description

CAAS-356

Made CaaS project names configurable

CAAS-349

Prepared backend for server events.

CAAS-273

Added finer grained metrics to CaaS.

Version 1.3.15

Highlights

CaaS can now be deployed in kubernetes via a helm chart, which makes installing and updating the stack much easier.

Update Notice

If you have installed CaaS in k8s using another method and want to switch to the helm variant, please uninstall the old stack beforehand. You can re-use the persistent volume claims of the mongo database - have a look at values.yaml from the helm chart for more information.

Fixed issues

ID Description

CAAS-233

MongoDB driver property "serverSelectionTimeout" is now configurable.

New features

ID Description

CAAS-355

Added helm chart for CaaS

CAAS-283

Changed healthchecks of the CaaS bus and REST interface components.

CAAS-214

Fixed wrong "waitInMillis" behavior

Version 1.3.14

Update Notice

As mentioned in the releasenotes of Content as a Service version 1.3.13, the new license file format is a strict requirement from the current version on. Please take a look at the releasenotes of 1.3.13 for further details.

New features

ID Description

CAAS-333

Changed license requirements and updated documentation

Version 1.3.13

Update Notice

Please note that CaaS requires a special license from the upcoming release on. If you are already using CaaS, please contact the Crownpeak Technology Technical Support, in order to receive an appropriate license. Please attach the license you currently use in CaaS (see also chapter 3.1.1 of the CaaS documentation) to the reqeust. As a new customer, you normally already received an appropriate license. To be on the safe side, please check the line in your license file that starts with license.SCOPE: If the value is SERVICE here, your license is up-to-date and appropriate. If not, please contact us.

Fixed issues

ID Description

CAAS-328

Enhanced error messages for missing project properties

New features

ID Description

CAAS-339

Added important update notice

Version 1.3.12

Fixed issues

ID Description

CAAS-332

Filename attribute not allowed in JSON documents

CAAS-222

CaaS Path reset to the defaults fixed

New features

ID Description

CAAS-344

added checks for reserved attribute names before sending a message to the CaaS

CAAS-158

added checks for json validity before sending a message to the CaaS

Version 1.3.11

Fixed issues

ID Description

CAAS-338

Prevent deployment of resources with starting underscore in their name

CAAS-316

fixed healthcheck on the caas-gateway docker container

CAAS-309

Remove logging of MongoDB passwords in bootstrap

New features

ID Description

CAAS-291

Added the possibility to set memory limits for the caas-bus and Java within the docker containers

Version 1.3.10

New features

ID Description

CAAS-304

Added a new default config for a better cluster performance.

Version 1.3.9

New features

ID Description

CAAS-293

New chapter in the German documentation about how to link between caas and static content

Version 1.3.8

Fixed issues

ID Description

CAAS-314

Modified Chapter 3.1.3 in the CaaS with Docker Documentation

New features

ID Description

CAAS-310

Updated German Documentation for CaaS with Docker

284. Help

The Technical Support of the Crownpeak Technology GmbH provides expert technical support covering any topic related to the FirstSpirit™ product. You can get and find more help concerning relevant topics in our community.

285. Disclaimer

This document is provided for information purposes only. Crownpeak Technology GmbH may change the contents hereof without notice. This document is not warranted to be error-free, nor subject to any other warranties or conditions, whether expressed orally or implied in law, including implied warranties and conditions of merchantability or fitness for a particular purpose. Crownpeak Technology GmbH specifically disclaims any liability with respect to this document and no contractual obligations are formed either directly or indirectly by this document. The technologies, functionality, services, and processes described herein are subject to change without notice.