1. Version 2.13.8 - 21.08.2020

Fixed issues

ID Description

CAAS-1296

Enabled streaming of media again to lower memory consumption when transferring media to CaaS.

2. Version 2.13.3 - 24.07.2020

New features

ID Description

CAAS-1334

Deprecation of method CaaSService#createCaaSConnection(ServiceConfiguration, Supplier<Boolean>) and introduction of replacement CaaSService#createCaaSConnection(ServiceConfiguration).

3. Version 2.13.0

Update Notice

This version of the CaaS FSM requires the use of FirstSpirit in version 2020-06 or higher.

Fixed issues

ID Description

CAAS-1280

Fixed URLs not to be NULL when the FirstSpirit "Json" object in template is used in combination with the preview eventing.

CAAS-1121

Due to closed FirstSpirit connections, the preview eventing functioned unreliably in some cases. This problem has been solved and requires the use of FirstSpirit 2020-06 or higher.

New features

ID Description

CAAS-1268

The module is now only built with Java 11 and Target Level 1.8.

4. Version 2.12.30

Update Notice

This version makes use of a new feature in the REST API. With this feature, the deployment into CaaS runs more smoothly in situations where database/collection need to be created for the first time. Please use CaaS platform version >= 2.11.39 to benefit from this.

Fixed issues

ID Description

CAAS-1301

Previously, exceptions occurring on some elements during a scheduled deployment to CaaS broke the sending pipeline. Now sending of elements continues, unless an unrecoverable error occurs.

CAAS-1148

Improved handling of initial database/collection creation when deploying data to CaaS. The improvement will only be effective if the platform is used in version 2.11.39 (or greater).

5. Version 2.12.27

Fixed issues

ID Description

CAAS-1285

Fixed not replaced placeholder for minimal FirstSpirit server version in technical datasheet of CaaS module.

CAAS-1276

Fixed backpressure issues when generating CaaS messages to avoid overloading the HTTP client and reaching the connection limit.

CAAS-1272

Fixed preview media handling in case CaaS platform redirecting ingress is used as preview CaaS endpoint.

CAAS-1271

Fixed memory / thread leak in schedule execution.

CAAS-1169

Fixed URL encoding of remote media in case a schedule is used to publish preview data to CaaS.

New features

ID Description

CAAS-1286

Improved logging and error handling in case media is null during processing.

6. Version 2.12.19

Fixed issues

ID Description

CAAS-1256

Added an optional parameter to Initialize CaaS Generation action in order to be able to prefix local media paths with a slash, in case media is not sent to CaaS. Please refer to the documentation for more information.

7. Version 2.12.15

Fixed issues

ID Description

CAAS-1237

The delta generation of data sets has been optimized for content projections with one record per page. This option can be enabled in the job configuration. Please refer to the documentation for more information.

CAAS-1225

Added missing cleanup of an adapter instance to prevent resource leaks

8. Version 2.12.12

Fixed issues

ID Description

CAAS-1251

The connection check now shows the correct error messages for HTTP 401 and HTTP 403 responses from the CaaS platform.

CAAS-1221

Deleted datasets are now correctly processed by the delta generation.

CAAS-1216

Preview eventing can now handle the renaming of PageRefs' UID. This is the default behaviour when creating new content in Content Creator.

CAAS-1180

Creation of a document/asset will now be aborted when the required database or collection could not be created.

New features

ID Description

CAAS-1140

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-1139

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

9. Version 2.12.2

Fixed issues

ID Description

CAAS-1161

Updated the chapter about generation

New features

ID Description

CAAS-953

Opening project component no longer causes exceptions when CaaS service has not been configured

10. Version 2.3.1

Fixed issues

ID Description

CAAS-822

Performance optimization in action CaaS DeltaGeneration

11. Version 2.11.1

Fixed issues

ID Description

CAAS-1124

Fixed NPE with null IdProvider in preview

New features

ID Description

CAAS-1130

Removed gson module dependency from server scope

12. Version 2.10.4

Fixed issues

ID Description

CAAS-1116

Fixed ReportGenerationResultListener output in case no messages were generated.

13. Version 2.10.2

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-1103

Fixed deleting media assets for delta deployments.

CAAS-920

The Preview-CaaS connection check in the project component no longer needs a selected template set and language.

New features

ID Description

CAAS-1083

The CaaS module and the CaaS platform were separated internally

14. 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 module. However, for historical reasons, the release notes for the Caas module and platform, which were previously combined, are still listed below this note.

15. 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.

16. 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.

17. 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.

18. 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.

19. 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

20. 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.

21. 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.

22. 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

23. 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

24. 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

25. 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

26. Version 2.2.5

Fixed issues

ID Description

CAAS-865

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

27. 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.

28. 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)

29. 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".

30. 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.

31. 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!

32. 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

33. 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

34. 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

35. 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

36. 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

37. 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

38. 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.

39. 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

40. 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

41. 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

42. 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 /.

43. 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

44. 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

45. 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

46. Version 1.3.24

Fixed issues

ID Description

CAAS-459

Improved timeout behaviour with third party firewalls

47. 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

48. 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.

49. 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.

50. 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

51. 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

52. 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

53. 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.

54. 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

55. 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

56. 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 e-Spirit 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

57. 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

58. 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

59. Version 1.3.10

New features

ID Description

CAAS-304

Added a new default config for a better cluster performance.

60. 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

61. 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

62. Version 1.3.7

Update Notice

The update of the REST interface changes a few configuration files. If you use a custom configuration, it could be required to change it.

Compatibility

Product Version(s) Notice

FirstSpirit

5.2

-

Fixed issues

ID Category Description

CAAS-305

REST interface

Updated REST interface

CAAS-294

Admin interface

Splitted admin-webapp from caas-rest-api and moved admin-webapp to seperate container.

63. Version 1.3.6

Compatibility

Product Version(s) Notice

FirstSpirit

5.2

-

Fixed issues

ID Category Description

CAAS-298

Admin interface

Responsive loading of CaaS content

CAAS-232

Admin interface

Fixed a bug that would cause an error message to reappear when correctly logging in after the auth-token expired

CAAS-251

Admin interface

Proper rendering of empty collections

New features

ID Category Description

CAAS-259

Documentation

Modified chapter error analysis

CAAS-303

Documentation

Modified chapter 4.3.1

64. Version 1.3.5

Compatibility

Product Version(s) Notice

FirstSpirit

5.2

-

Fixed issues

ID Category Description

CAAS-271

Documentation

Modified description of using the selfsigned certificate

65. Version 1.3.4

Update Notice With this version the REST interface has been updated which affects the JSON documents devilered by it.

Furthermore the interal users of the docker containers changed. Only if the access rights of the volumens on the host system has been changed manually, this may cause problems.

For further details please refer to the MigrationGuide.

Compatibility

Product Version(s) Notice

FirstSpirit

5.2

-

Fixed issues

ID Category Description

CAAS-286

Module

Extended exception handling for file extension processing

CAAS-253

Docker Container

introduced users for execution of services inside the docker containers

CAAS-258

REST interface

updated REST interface

CAAS-237

Admin interface

Display of CaaS version in footer fixed

66. Version 1.3.3

Compatibility

Product Version(s) Notice

FirstSpirit

5.2

-

New features

ID Category Description

CAAS-270

Logging

Changed log level of adapter from ERROR to INFO

67. Version 1.3.2

Update Notice
With this version the used CaaS instance can be configured in the generation task. Contrary to previous versions, one FirstSpirit server can therefore adress several CaaS instances.

Furthermore the cluster mode has been optimized. The optimization uses functionalities of Docker 1.13. Therefore a Docker update to version 1.13 is required with this Caas version. The standalone installation for Linux is not affected by these changes.

Compatibility

Product Version(s) Notice

FirstSpirit

5.2

-

Fixed issues

ID Category Description

CAAS-264

Documentation

Renamed the paramter messageTimeout to waitInMillis

CAAS-241

Documentation

Modified description of the CAAS_REPO_ADDITIONS parameter

CAAS-244

Module

External references in SiteStore do not create CaaS-Messages anymore

CAAS-275

Documentation

changed template set image

New features

ID Category Description

CAAS-94

Installer

Startup script must not be run as root

CAAS-231

Configuration

The CaaS used instance can be configured in the generation task.

CAAS-268

Docker Container

The docker containers now use OpenJDK instead of Oracle JDK.

68. Version 1.3.1

Compatibility

Product Version(s) Notice

FirstSpirit

5.2

-

Fixed issues

ID Category Description

CAAS-204

Module

Removed automatic testing of service configuration on save

CAAS-235

Docker Container

change the log-levels via logback.xml (REST API and adapter)

CAAS-249

License

Improved license management

New features

ID Category Description

CAAS-98

Documentation

Updated the description of the components

CAAS-130

Documentation

Added new chapter about modifying and deleting content

CAAS-242

Documentation

Added new english translation

69. Version 1.3.0

Compatibility

Product Version(s) Notice

FirstSpirit

5.2

-

Fixed issues

ID Category Description

CAAS-50

Admin interface

Fixed redirection problem for Edge and IE

CAAS-193

Module

Fixed CaaSPath parsing issue

CAAS-218

Admin interface

IE CSS issue fixed

CAAS-234

Metrics

Fixed display of REST API metrics

New features

ID Category Description

CAAS-59

Docker Container

All services log to the console

CAAS-173

Delivery

KeyStores updated

CAAS-177

Metrics

Metrics for the REST interface and http reporting added

CAAS-200

Admin interface

Added browser for documents from CaaS

CAAS-212

Admin interface

Migration to Angular2

CAAS-215

Documentation

Added notes in the Migration Guide concerning the modified Caas bus port

CAAS-185

Documentation

Update of Caas-Bus added to documentation

CAAS-191

Metrics

Metrics for the CaaS Bus and http reporting added

CAAS-165

Docker Container

MongoDB in cluster mode

CAAS-229

Docker Container

Configuration option for the MongoDB URL addedd

CAAS-156

Documentation

Information to recreate the master key added

CAAS-213

Documentation

Added chapter for using the CaaS stack with docker in Windows

CAAS-220

Docker Container

Health Check of Docker Containers added

CAAS-223

Documentation

Minor changes regarding formatting and grammar

CAAS-211

Admin interface

Added inline editing of API keys

70. Version 1.2.1

Update Notice
With this version the links for adding the SSL keystores and licence has changed in the configuration file of the docker containers. If the CaaS stack is already in use within the docker context, the links in the docker-compose.yml has to be changed.

Compatibility

Product Version(s) Notice

FirstSpirit

5.2

-

Fixed issues

ID Category Description

CAAS-201

Module

Name of store element added to dialog

CAAS-205

Module

Log message of module update fixed

New features

ID Category Description

CAAS-166

Docker Documentation

Modified information regarding the SSL configuration

71. Version 1.2.0

Update Notice
This version removes the dependency to the UX-Bridge module so that the CaaS can be run without the UX-Bridge. Updating to this version requires a migration of the CaaS stack, which is described in detail in the Migration Guide.

Compatibility

Product Version(s) Notice

FirstSpirit

5.2

-

Fixed issues

ID Category Description

CAAS-174

Generation

Media without resolution produced a NPE

CAAS-178

Generation

Incorrect media asset ids

CAAS-179

Generation

Incorrect resolution handling for media asset ids

CAAS-183

Docker Documentation

Modified information regarding the installation scripts

New features

ID Category Description

CAAS-143

Documentation

Migration Guide created

CAAS-155

Architecture

Removed dependency to the UX-Bridge module

CAAS-169

Metrics

Metrics for the CaaS adapter and http reporting added

72. Version 1.1.3

Compatibility

Product Version(s) Notice

FirstSpirit

5.2

-

Fixed issues

ID Category Description

CAAS-56

Standalone installer

Fixed error messages if commons daemon is missing.

CAAS-71

Generation

Added support for URL prefixes.

CAAS-108

Standalone installer

Added checks for the java version in the standalone installer.

New features

ID Category Description

CAAS-116

Admin interface

Changes to the CaaS Admin Interface.

CAAS-131

Documentation

Replaced some images.

CAAS-160

Documentation

Added English documentation.

CAAS-168

Documentation

Minor documentation changes.

73. Version 1.1.2

Compatibility

Product Version(s) Notice

FirstSpirit

5.2

-

New features

ID Category Description

CAAS-162

Documentation

Added a short discription of Docker Volume-Mappings to the documentation.

74. Version 1.1.1

Compatibility

Product Version(s) Notice

FirstSpirit

5.2

-

Fixed issues

ID Category Description

CAAS-120

Delta generation

Support for deletion operations on data sources.

New features

ID Category Description

CAAS-134

Generation

Common schema for document id generation.

CAAS-147

Documentation

Customized documentation for docker delivery.

CAAS-152

Documentation

Customized documentation for needed software for installation.

CAAS-159

Delivery

Delivery of license information about used software packages.

CAAS-161

Documentation

Customized documentation for referencing media.

75. Help

The Technical Support of the e-Spirit AG 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.

76. Disclaimer

This document is provided for information purposes only. e-Spirit 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. e-Spirit 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.