diff --git a/.github/workflows/checklink.yml b/.github/workflows/checklink.yml index 2cc329b30..e69ec25e0 100644 --- a/.github/workflows/checklink.yml +++ b/.github/workflows/checklink.yml @@ -32,7 +32,7 @@ jobs: # For maximum backward compatibility with Hugo modules HUGO_ENVIRONMENT: production HUGO_ENV: production - run: hugo --environment GitHubPages -d $GITHUB_WORKSPACE/dist + run: hugo --environment GitHubPages -d $GITHUB_WORKSPACE/dist --buildFuture - name: Test HTML uses: wjdp/htmltest-action@master with: diff --git a/.gitignore b/.gitignore index 512c80e8c..c7cf7804a 100644 --- a/.gitignore +++ b/.gitignore @@ -1,4 +1,5 @@ - +docs/ +!docs/CNAME public/ resources/ node_modules/ diff --git a/.htmltest.yml b/.htmltest.yml index 5e76aaaa3..202525566 100644 --- a/.htmltest.yml +++ b/.htmltest.yml @@ -26,6 +26,7 @@ IgnoreURLs: - "https://jsonformatter.org/.*" - "https://www.newtonsoft.com/.*" - "https://.*/gov.uk/.*" +- "https://www.elastic.co/.*" IgnoreDirs: - "docs/?.*/_print/" - "docs/?.*/_shared/" diff --git a/content/en/blog/releases/2025.X/2025.1.md b/content/en/blog/releases/2025.X/2025.1.md index 4eb510a0d..3b10f5bb0 100644 --- a/content/en/blog/releases/2025.X/2025.1.md +++ b/content/en/blog/releases/2025.X/2025.1.md @@ -1,13 +1,13 @@ --- -title: "2024.11" -linkTitle: "2024.11" -date: 2024-12-02 +title: "2025.1" +linkTitle: "2025.1" +date: 2025-02-10 author: Paul Arnold ([@paulmarnold](https://twitter.com/paulmarnold)) --- ## Summary -The 2024.11 [Fast Track][] is now available. +The 2025.1 [Fast Track][] is now available. ## Download Artefacts @@ -17,7 +17,7 @@ Installation artefacts can be requested by raising a case in the [{{% ctx %}} Se ### Overview -2024.11 is the next [Fast Track][] release of {{% ctx %}} and improves on the [2024.9][] release in the following areas: +2025.1 is the next [Fast Track][] release of {{% ctx %}} and improves on the [2024.11][] release in the following areas: * Capability * Observability @@ -27,423 +27,358 @@ Installation artefacts can be requested by raising a case in the [{{% ctx %}} Se * Usability * Third-Party Support * Installation -* Upgrade -* Documentation -This release introduces multiple new features to the {{% ctx %}} platform: +{{% cr %}} +This release introduces the following new features to the {{% ctx %}} platform: -* The [Monitoring Service has been introduced][] that provides aggregated historical data about the platform. -* The [Operations Overview page][] has been added to {{% ctx %}} Gateway to provide a high-level view of the system's operations, which includes: - * Current Status - * Filters - * Flow graphs -* The [configuration for maximum query string length][] has been added to the {{% ctx %}} Gateway `web.config`. -* The [Cortex Interaction Portal can now be installed multiple times on the same machine][]. +* The user can now [create a new process from BPMN XML][] within [{{% ctx %}} Gateway][Gateway] +* An [Average Duration graph has been added][] to the Operations Overview page on [{{% ctx %}} Gateway][Gateway] -[Observability][] has been improved by [reducing the maximum size of Service Fabric Trace Logs][]. +All services have had the [default size of logs][] used for [Observability][] reduced to optimise disk usage. -The [Performance][] of the {{% ctx %}} has been improved by: +Work has been undertaken to [improve the performance][] of the [{{% ctx %}} Execution][{{% ctx %}} Execution Service] and [{{% ctx %}} Monitoring][{{% ctx %}} Monitoring Service] services. -* optimising [handling high volumes of executions more efficiently][] -* handling [session updates more reliably on slower systems][] +The [Service Fabric BackUpRestore service has been enabled][] to allow future [Scalability][] improvements such as disaster recovery features. -[Scalability][] has been enhanced by [increasing the header size limit for Service Fabric API Gateway][]. +[Security][] has been tightened on the [{{% ctx %}} Interaction Portal][Interaction Portal] by: -[Security][] has been tightened on {{% ctx %}} Gateway by: +* [Introducing security headers][] +* [Removing sensitive information from HTTP responses][] -* updating the [Content-security-policy directives][] -* introducing the [Permissions-Policy header][] -* removing the [X-XSS-PROTECTION header][] +[Usability][] has been enhanced by: -[Usability][] has been improved by [fixing the LiveView datetime picker styling issues][]. +* [Improving the user experience on the Operations Overview page][] +* [Adding the {{% ctx %}} Version to the Gateway logo tooltip][] +* [Redesigning the Semaphore API][Redesigning the Semaphore API] allowing easier management of Semaphores -[Third-party Support][] has been improved by: +[Third-party libraries has been updated][] on the {{% ctx %}} platform. -* adding a [Health Check API to Service Fabric API Gateway][] -* updating the following 3rd party libraries on {{% ctx %}} Gateway: - * Fuse - * jQuery - * jQuery UI - * Moment.js - * Stacktrace.js - -[Installation][] has been modified to: - -* [check for certificate friendly name][] -* [use PSDrive to improve compatibility][] -* [allow log file rotation for RabbitMQ logs][] -* [open ports for RabbitMQ Stream][] - -[Upgrade][] has been improved by: - -* [restoring files to pre-upgrade if the load balancer upgrade fails][] -* [aligning the timeout of the Register-ServiceFabricApplicationType command with other commands][] -* [changing the extension of the studio package created by the upgrade script][] -* [allow log file rotation for RabbitMQ logs][Upgrade - allow log file rotation for RabbitMQ logs] -* [opening ports for RabbitMQ Stream][Upgrade - opening ports for RabbitMQ Stream] - -Finally, the [Documentation][] includes updates related to: - -* [adding the encryption key to the built-in Load Balancer server][] -* [adding the Observability Compatibility table to release notes][] -* [updating the ports used by the platform][] +Finally, the [Installation][] has been improved by [adding an unblock script][] to the installation process. ### Components | Release Component | Version | Updated | Update Type | Breaking Change | Notes | |--------------------------------------------------------------------------------|---------------|---------|---------------|-----------------|--------| -| [{{% ctx %}} Innovation Core Application][] | 53.4.0.24460 | Yes | Minor | N/A | | -|     > [{{% ctx %}} API Gateway Service][] | 38.10.3.24460 | Yes | Minor | N/A | | -|     > [{{% ctx %}} Authorisation Service][] | 7.0.15.24460 | Yes | Patch | N/A | | -|     > [{{% ctx %}} Concurrency Management Service][] | 7.0.15.24460 | Yes | Patch | N/A | | -|     > [{{% ctx %}} Configuration Management Service][] | 7.0.15.24460 | Yes | Patch | N/A | | -|     > [{{% ctx %}} Data Storage Service][] | 9.0.26.24460 | Yes | Patch | N/A | | -|     > [{{% ctx %}} Execution Management Service][] | 7.0.17.24460 | Yes | Patch | N/A | | -|     > [{{% ctx %}} Licence Management Service][] | 7.0.15.24460 | Yes | Patch | N/A | | -|     > [{{% ctx %}} Listeners Service][] | 2.0.11.24460 | Yes | Patch | N/A | | -|     > [{{% ctx %}} Monitoring Service][] | 2.4.8.24460 | Yes | First Release | N/A | | -|     > [{{% ctx %}} Package Management Service][] | 11.0.15.24460 | Yes | Patch | N/A | | -|     > [{{% ctx %}} Provisioning Service][] | 13.1.15.24460 | Yes | Patch | N/A | | -|     > [{{% ctx %}} Scheduling Service][] | 7.0.21.24460 | Yes | Patch | N/A | | -|     > [{{% ctx %}} Triggers Service][] | 11.0.14.24460 | Yes | Patch | N/A | | -| [{{% ctx %}} Innovation Execution Application][] | 25.0.4.24460 | Yes | Major | No | Major changes occurred between internal development releases, however, these changes are not breaking between 2024.9 and 2024.11 | -|     > [{{% ctx %}} Execution Service][] | 25.0.4.24460 | Yes | Major | No | Major changes occurred between internal development releases, however, these changes are not breaking between 2024.9 and 2024.11 | -| [{{% ctx %}} Gateway][Gateway], including [{{% ctx %}} Studio][] | 12.11.0.24460 | Yes | Minor | N/A | | -| [{{% ctx %}} Blocks Package][Blocks] | 48.2.4.24460 | Yes | Patch | N/A | | -| [{{% ctx %}} Interaction Portal][Interaction Portal] | 3.0.1.24460 | Yes | Major | Yes | Major changes occurred between releases, these changes are related to support of multiple {{% ctx %}} Interaction Portal instances running on the same machine and are [breaking][Breaking - Added support for multiple instances of CORTEX Interaction Portal running on the same machine] | -| {{% ctx %}} App Server Install Scripts | 5.2.7.24470 | Yes | Patch | N/A | | -| {{% ctx %}} Web App Server Install Scripts | 8.1.2.24460 | Yes | Patch | N/A | | -| {{% ctx %}} Upgrade Scripts | 1.2.16.24460 | Yes | Patch | N/A | | +| [{{% ctx %}} Innovation Core Application][] | 56.1.4.25130 | Yes | Major | Potential | Major changes occurred between internal development releases, these changes are related to the [Semaphore API has been redesigned][Potential Breaking - Redesigned Semaphore API] causing changes to Semaphore API routes | +|     > [{{% ctx %}} API Gateway Service][] | 40.0.5.25130 | Yes | Major | Potential | Major changes occurred between internal development releases, these changes are related to the [Semaphore API has been redesigned][Potential Breaking - Redesigned Semaphore API] causing changes to Semaphore API routes | +|     > [{{% ctx %}} Authorisation Service][] | 7.0.18.25130 | Yes | Patch | N/A | | +|     > [{{% ctx %}} Concurrency Management Service][] | 7.3.3.25130 | Yes | Minor | N/A | | +|     > [{{% ctx %}} Configuration Management Service][] | 7.0.18.25130 | Yes | Patch | N/A | | +|     > [{{% ctx %}} Data Storage Service][] | 9.0.30.25130 | Yes | Patch | N/A | | +|     > [{{% ctx %}} Execution Management Service][] | 7.0.25.25130 | Yes | Patch | N/A | | +|     > [{{% ctx %}} Licence Management Service][] | 7.0.18.25130 | Yes | Patch | N/A | | +|     > [{{% ctx %}} Listeners Service][] | 3.0.3.25130 | Yes | Major | No | Major changes occurred between internal development releases, however, these changes are not breaking between 2024.11 and 2025.1 | +|     > [{{% ctx %}} Monitoring Service][] | 2.6.3.25130 | Yes | Minor | N/A | | +|     > [{{% ctx %}} Package Management Service][] | 11.0.22.25130 | Yes | Patch | N/A | | +|     > [{{% ctx %}} Provisioning Service][] | 14.0.6.25130 | Yes | Major | No | Major changes occurred between internal development releases, however, these changes are not breaking between 2024.11 and 2025.1 | +|     > [{{% ctx %}} Scheduling Service][] | 7.0.28.25130 | Yes | Patch | N/A | | +|     > [{{% ctx %}} Triggers Service][] | 11.0.20.25130 | Yes | Patch | N/A | | +| [{{% ctx %}} Innovation Execution Application][] | 25.3.7.25130 | Yes | Minor | N/A | | +|     > [{{% ctx %}} Execution Service][] | 25.3.7.25130 | Yes | Minor | N/A | | +| [{{% ctx %}} Gateway][Gateway], including [{{% ctx %}} Studio][] | 12.17.1.25130 | Yes | Minor | N/A | | +| [{{% ctx %}} Blocks Package][Blocks] | 48.3.0.25130 | Yes | Minor | N/A | | +| [{{% ctx %}} Interaction Portal][Interaction Portal] | 3.1.0.24470 | Yes | Minor | N/A | | +| {{% ctx %}} App Server Install Scripts | 5.2.9.25120 | Yes | Patch | N/A | | +| {{% ctx %}} Web App Server Install Scripts | 8.1.2.24460 | No | N/A | N/A | | +| {{% ctx %}} Upgrade Scripts | 1.2.18.25120 | Yes | Patch | N/A | | | {{% ctx %}} Licence Fingerprint Generator | 4.1.0.24360 | No | N/A | N/A | | | {{% ctx %}} Encryption Key Generator | 2.0.0.24350 | No | N/A | N/A | | | {{% ctx %}} Encryptor | 3.1.0.24330 | No | N/A | N/A | | -| {{% ctx %}} Flows Upgrader | 2.0.1.24450 | Yes | Patch | N/A | | +| {{% ctx %}} Flows Upgrader | 2.0.1.24450 | No | N/A | N/A | | | {{% ctx %}} Observability | 3.0.0 | No | N/A | N/A | | ### Features #### Capability -##### Introduced the Monitoring Service +##### Support for creating new process from templates -{{% ctx %}} now includes a Monitoring Service that provides aggregated historical data about the platform. -Currently, this includes data about executions of flows, which is surfaced within {{% ctx %}} Gateway on the Operations Overview page. +Within [{{% ctx %}} Gateway][Gateway], the user can now create a new process from a template. The currently supported templates are `Blank` and `BPMN XML`. -Affected Components: +For `BPMN XML`, the provided `XML` will be validated before being created, and must follow `BPMN XML 2.0` standards. -* [{{% ctx %}} Innovation Core Application][] - * [{{% ctx %}} API Gateway Service][] - * [{{% ctx %}} Execution Management Service][] - * [{{% ctx %}} Monitoring Service][] -* [{{% ctx %}} Innovation Execution Application][] - * [{{% ctx %}} Execution Service][] - -##### Introduced the Operations Overview page - -{{% ctx %}} Gateway now includes an Operations Overview page that displays important metrics about the platform's current status, as well as graphs rendering the aggregated historical data provided by the [Monitoring Service][{{% ctx %}} Monitoring Service]. +Once created, the process should contain all descriptions, blocks, and connections as defined in the `XML`, and should be properly spaced out. -The page has the following sections: - -* `Current Status`, which includes: - * License Consumption - * Cluster Health - * Running Executions -* `Filters`, that allow users to filter data based on the selected `Time Period`, `Package Names`, `Package Versions` and `Flows`. -* `Flows`, which contains graphs displaying the following data: - * Success rate - * Completed flows - * Errored flows +{{% alert title="Note" %}} +The generation of processes from `BPMN XML` template is currently limited and does not support all `BPMN XML 2.0` features. +If the `XML` contains unsupported features, the process will not be created and an error message will be displayed. +{{% /alert %}} Affected Components: * [{{% ctx %}} Gateway][Gateway] -##### Added configuration for maximum query string length +##### Added Average Duration graph to Operations Overview -With the introduction of the Operations Overview page, it is possible for the API used to return the aggregated data from the [Monitoring Service][{{% ctx %}} Monitoring Service], to exceed the default maximum number of characters allowed in the `query string` part of the URL. -{{% ctx %}} Gateway `web.config` now includes settings allowing the maximum number of characters to be increased from the default value of `8192`. -Currently, there is no documentation available on how to do this. For further assistance, please raise a case in the [{{% ctx %}} Service Portal][]. +The [{{% ctx %}} Gateway][Gateway]'s Operations Overview page now includes an `Average Duration` graph, which displays the average flow execution duration, as well as a graphs for the average duration over the specified time period. Affected Components: * [{{% ctx %}} Gateway][Gateway] +* [{{% ctx %}} Innovation Core Application][] + * [{{% ctx %}} API Gateway Service][] + * [{{% ctx %}} Execution Management Service][] + * [{{% ctx %}} Monitoring Service][] + * [{{% ctx %}} Package Management Service][] + * [{{% ctx %}} Provisioning Service][] + * [{{% ctx %}} Scheduling Service][] + * [{{% ctx %}} Triggers Service][] +* [{{% ctx %}} Innovation Execution Application][] + * [{{% ctx %}} Execution Service][] -##### Added support for multiple instances of the {{% ctx %}} Interaction Portal running on the same machine +#### Observability -The [{{% ctx %}} Interaction Portal][Interaction Portal] can now be installed multiple times on the same machine, each with its own configuration and data. +##### Reduced Service Default Log Sizes + +The default log sizes for the following services have now been reduced to improve disk usage. +{{% cr %}} +The new maximum disk usage is as follows: + +| Service | Original (in MB) | New (in MB) | +|--------------------------------------------------|------------------|-------------| +| [{{% ctx %}} API Gateway Service][] | 14,965 | 1,456 | +| [{{% ctx %}} Authorisation Service][] | 7,300 | 28 | +| [{{% ctx %}} Concurrency Management Service][] | 10,950 | 84 | +| [{{% ctx %}} Configuration Management Service][] | 365 | 28 | +| [{{% ctx %}} Data Storage Service][] | 10,950 | 84 | +| [{{% ctx %}} Execution Service][] | 25,550 | 2,800 | +| [{{% ctx %}} Execution Management Service][] | 10,950 | 84 | +| [{{% ctx %}} Licence Management Service][] | 365 | 28 | +| [{{% ctx %}} Listeners Service][] | 10,950 | 1,428 | +| [{{% ctx %}} Monitoring Service][] | 10,950 | 84 | +| [{{% ctx %}} Package Management Service][] | 7,300 | 28 | +| [{{% ctx %}} Provisioning Service][] | 365 | 28 | +| [{{% ctx %}} Scheduling Service][] | 10,950 | 84 | +| [{{% ctx %}} Triggers Service][] | 10,950 | 84 | +| **Total** | **133,590** | **6,329** | + +Log files retention and size are configurable, however there is currently no documentation available on how to do this. For further assistance, please raise a case in the [{{% ctx %}} Service Portal][]. Affected Components: -* [{{% ctx %}} Interaction Portal][Interaction Portal] +* [{{% ctx %}} Innovation Core Application][] + * [{{% ctx %}} API Gateway Service][] + * [{{% ctx %}} Authorisation Service][] + * [{{% ctx %}} Concurrency Management Service][] + * [{{% ctx %}} Configuration Management Service][] + * [{{% ctx %}} Data Storage Service][] + * [{{% ctx %}} Execution Management Service][] + * [{{% ctx %}} Licence Management Service][] + * [{{% ctx %}} Monitoring Service][] + * [{{% ctx %}} Package Management Service][] + * [{{% ctx %}} Provisioning Service][] + * [{{% ctx %}} Scheduling Service][] + * [{{% ctx %}} Triggers Service][] +* [{{% ctx %}} Innovation Execution Application][] + * [{{% ctx %}} Execution Service][] -#### Observability +#### Scalability -##### Reduced the maximum size of Service Fabric Logs +##### Enabled Service Fabric BackUpRestore service -The maximum size of Service Fabric Logs has been reduced from `65GB` to `10GB`. +The BackUpRestore service has been enabled to allow for future disaster recovery features to be implemented. Affected Components: * {{% ctx %}} App Server Install Scripts +* {{% ctx %}} Upgrade Scripts #### Performance -##### Improved the performance of the Execution Management Service +##### Improvements to Service Fabric services performance -The performance of the Execution Management Service has been improved to handle high volumes of executions more efficiently. +The performance of the [{{% ctx %}} Execution Service][] and the [{{% ctx %}} Monitoring Service][] has been improved to handle high volumes of executions more efficiently. Affected Components: * [{{% ctx %}} Innovation Core Application][] + * [{{% ctx %}} API Gateway Service][] * [{{% ctx %}} Execution Management Service][] + * [{{% ctx %}} Monitoring Service][] + * [{{% ctx %}} Provisioning Service][] + * [{{% ctx %}} Scheduling Service][] + * [{{% ctx %}} Triggers Service][] +* [{{% ctx %}} Innovation Execution Application][] + * [{{% ctx %}} Execution Service][] -##### Improved session update reliability on slow systems +#### Security + +##### Introduced security headers for {{% ctx %}} Interaction Portal + +The following security headers have been introduced to the [{{% ctx %}} Interaction Portal][Interaction Portal]: -The [{{% ctx %}} Interaction Portal][Interaction Portal] now handles session updates more reliably on slower systems. +* Content-Security-Policy +* Permissions-Policy +* Referrer-Policy +* Strict-Transport-Security +* X-Content-Type-Options +* X-Frame-Options Affected Components: * [{{% ctx %}} Interaction Portal][Interaction Portal] -#### Scalability +##### Removed sensitive information from {{% ctx %}} Interaction Portal HTTP responses -##### Increased the header size limit for Service Fabric API Gateway +The following sensitive information has been removed from [{{% ctx %}} Interaction Portal][Interaction Portal]'s HTTP responses: -The header size limit for the Service Fabric API Gateway has been increased from `32765 bytes` to `65536 bytes` to allow for larger headers to be processed. +* Server Information +* X-Powered-By information Affected Components: -* [{{% ctx %}} Innovation Core Application][] - * [{{% ctx %}} API Gateway Service][] - -#### Security - -##### Reviewed the Content-Security-Policy directives on {{% ctx %}} Gateway - -The Content-Security-Policy directives on {{% ctx %}} Gateway have been reviewed and updated to ensure that they are secure. +* [{{% ctx %}} Interaction Portal][Interaction Portal] -Affected Components: +#### Usability -* [{{% ctx %}} Gateway][Gateway] +##### Improved user experience on Operations Overview -##### Introduced the Permissions-Policy header on {{% ctx %}} Gateway +The [{{% ctx %}} Gateway][Gateway]'s Operations Overview page now includes the following improvements to the user experience: -The Permissions-Policy header on {{% ctx %}} Gateway has been introduced to improve security. +* Graph data is now loaded for default filters on page load +* Child filter selection is now maintained when parent filter is changed (e.g. selected `Flows` are maintained when changing the selected `Package versions` if they are still available on that version) +* Time period can now be refreshed, which will refresh the filters and graph data +* Items that have been filtered using the search in the filter dropdown can be selected and deselected +* Tooltips on page elements including graphs have been improved Affected Components: * [{{% ctx %}} Gateway][Gateway] -##### Removed the X-XSS-PROTECTION header on {{% ctx %}} Gateway +##### Added {{% ctx %}} Version to Gateway Logo Tooltip -The X-XSS-PROTECTION header on {{% ctx %}} Gateway has been removed as it is deprecated. +The {{% ctx %}} version is now available on the [{{% ctx %}} Gateway][Gateway] logo tooltip. Affected Components: * [{{% ctx %}} Gateway][Gateway] -#### Third-party Support +##### Redesigned Semaphore API -##### Added Health Check API to Service Fabric API Gateway +The [{{% ctx %}} API Gateway Service][]'s API has been redesigned allowing easier management of Semaphores for the following actions: -A Health Check API has been added to the Service Fabric API Gateway to allow third-party load balancers to check the health of the platform. +* Delete all executions for semaphore on a specified scope +* Delete an execution for semaphore on a specified scope +* Get all semaphores for given scope/all scopes Affected Components: * [{{% ctx %}} Innovation Core Application][] * [{{% ctx %}} API Gateway Service][] -* {{% ctx %}} App Server Install Scripts -* {{% ctx %}} Upgrade scripts + * [{{% ctx %}} Concurrency Management Service][] + * [{{% ctx %}} Data Storage Service][] +* [{{% ctx %}} Innovation Execution Application][] + * [{{% ctx %}} Execution Service][] -##### Updated 3rd Party Libraries +#### Third-Party Support -The following 3rd party libraries have been updated on {{% ctx %}} Gateway: +##### Updated third-party libraries -* Fuse -* jQuery -* jQuery UI -* Moment.js -* Stacktrace.js +Third-party libraries have been updated on the {{% ctx %}} platform. Affected Components: * [{{% ctx %}} Gateway][Gateway] +* [{{% ctx %}} Innovation Core Application][] + * [{{% ctx %}} API Gateway Service][] + * [{{% ctx %}} Authorisation Service][] + * [{{% ctx %}} Concurrency Management Service][] + * [{{% ctx %}} Configuration Management Service][] + * [{{% ctx %}} Data Storage Service][] + * [{{% ctx %}} Execution Management Service][] + * [{{% ctx %}} Licence Management Service][] + * [{{% ctx %}} Monitoring Service][] + * [{{% ctx %}} Package Management Service][] + * [{{% ctx %}} Provisioning Service][] + * [{{% ctx %}} Scheduling Service][] + * [{{% ctx %}} Triggers Service][] +* [{{% ctx %}} Innovation Execution Application][] + * [{{% ctx %}} Execution Service][] #### Installation -##### Added check for certificate friendly name - -The installation script now checks for the presence of a certificate friendly name and throws an error if it is not present. - -Affected Components: - -* {{% ctx %}} Web App Server Install Scripts - -##### Changed the installation script to use PSDrive to improve compatibility +##### Added unblock script to the installation -The installation script now uses PSDrive to improve compatibility with different environments. +An unblock script has been added to the installation to allow for the unblocking of files. This also includes an update to the documentation to reflect that. Affected Components: * {{% ctx %}} App Server Install Scripts -* {{% ctx %}} Upgrade Scripts - -##### Added support for RabbitMQ log file rotation - -The installation script now sets up log file rotation for RabbitMQ. -The default is now a maximum of 20 files, each with a maximum size of 20MB. - -Affected Components: - -* {{% ctx %}} App Server Install Scripts -* {{% ctx %}} Upgrade Scripts - -##### Opened ports for RabbitMQ Stream - -RabbitMQ Stream ports (6000 to 6500) are now open to reduce noise in RabbitMQ logs. - -Affected Components: - -* {{% ctx %}} App Server Install Scripts -* {{% ctx %}} Upgrade Scripts - -#### Upgrade - -##### Improved the load balancer upgrade process - -The upgrade process now restores the files to their pre-upgrade state if the load balancer upgrade fails. - -Affected Components: - -* {{% ctx %}} Upgrade Scripts - -##### Aligned the timeout of the Register-ServiceFabricApplicationType command with other commands - -The timeout of the Register-ServiceFabricApplicationType command has been set to `1800 seconds`, like other commands. - -Affected Components: - -* {{% ctx %}} Upgrade Scripts - -##### Changed the extension of the studio package created by the upgrade script - -The studio package created by the upgrade script now has the file extension `.studiopkg` in lower-case to be consistent with the documentation. - -Affected Components: - -* {{% ctx %}} Flows Upgrader - -##### Added support for RabbitMQ log file rotation - -The upgrade script now sets up log file rotation for RabbitMQ. -The default is now a maximum of 20 files, each with a maximum size of 20MB. - -Affected Components: - -* {{% ctx %}} App Server Install Scripts -* {{% ctx %}} Upgrade Scripts - -##### Opened ports for RabbitMQ Stream - -RabbitMQ Stream ports (6000 to 6500) are now open to reduce noise in RabbitMQ logs. - -Affected Components: - -* {{% ctx %}} App Server Install Scripts -* {{% ctx %}} Upgrade Scripts - -#### Documentation - -##### Added how to add the encryption key to the built-in Load Balancer server - -The documentation now includes instructions on how to add the encryption key to the built-in Load Balancer server during both installation and upgrade. - -##### Added Observability Compatibility table to release notes - -The [Observability Compatibility][] table has been added to the release notes. - -##### Updated ports used by the platform - -The documentation has been updated to include the new ports used by the {{% ctx %}} platform for the [{{% ctx %}} Listeners Service][] including the Flow API Proxy. ### Bug Fixes #### Capability -##### Send Email Using Microsoft365 block crashes the Execution Service +##### Schedules not stopped when node switches to secondary -A bug has been fixed where the Send Email Using Microsoft365 block would crash the Execution Service. +A bug has been fixed where schedules were not being stopped when a Service Fabric node switched to secondary, causing them to continue running on the secondary node. Affected Components: -* [{{% ctx %}} Innovation Execution Application][] - * [{{% ctx %}} Execution Service][] -* [{{% ctx %}} Block Packages][Blocks] - -##### Published packages with nested flows fail to execute - -A bug has been fixed where published packages containing nested flows at least three layers deep would throw a KeyNotFoundException when attempting to execute the third layer. - -Affected Components: +* [{{% ctx %}} Innovation Core Application][] + * [{{% ctx %}} Scheduling Service][] -* [{{% ctx %}} Innovation Execution Application][] - * [{{% ctx %}} Execution Service][] +#### Observability -##### C# LINQ expression does not work +##### Duration not logged correctly in log files for the Log Event Block -A bug has been fixed where C# LINQ expressions defined in the Expression editor did not work. +A bug has been fixed where the duration was not being logged correctly in log files generated by the [Log Event Block][]. Affected Components: +* [{{% ctx %}} Innovation Core Application][] + * [{{% ctx %}} API Gateway Service][] + * [{{% ctx %}} Authorisation Service][] + * [{{% ctx %}} Concurrency Management Service][] + * [{{% ctx %}} Configuration Management Service][] + * [{{% ctx %}} Data Storage Service][] + * [{{% ctx %}} Execution Management Service][] + * [{{% ctx %}} Licence Management Service][] + * [{{% ctx %}} Monitoring Service][] + * [{{% ctx %}} Package Management Service][] + * [{{% ctx %}} Provisioning Service][] + * [{{% ctx %}} Scheduling Service][] + * [{{% ctx %}} Triggers Service][] * [{{% ctx %}} Innovation Execution Application][] * [{{% ctx %}} Execution Service][] -##### Expression containing using the Split() method of a String data type causes an exception +##### Errored flow executions not being logged -A bug has been fixed where an expression using the `Split()` method of a String data type would sometimes throw a runtime exception. +A bug has been fixed where errored flow executions were not being logged. Affected Components: +* [{{% ctx %}} Innovation Core Application][] + * [{{% ctx %}} Package Management Service][] * [{{% ctx %}} Innovation Execution Application][] * [{{% ctx %}} Execution Service][] -#### Usability - -##### LiveView datetime picker styling issues - -A bug has been fixed where the LiveView datetime picker would not display correctly. - -Affected Components: +### Deprecated Features -* [{{% ctx %}} Gateway][Gateway] +There are no features deprecated as part of the 2025.1 release of the {{% ctx %}} Platform. -#### Installation +### Removed Features -##### Fixed error on the installation what-if command +There are no features removed in the 2025.1 release of the {{% ctx %}} Platform. -The installation script no longer imports the ServiceFabric PowerShell module when running the what-if command. +### Potential Breaking Changes -Affected Components: +The following may potentially break interactions with the {{% ctx %}} Platform: -* {{% ctx %}} App Server Install Scripts +##### Redesigned Semaphore API -##### Update certificate doesn't update load balancer health check subject name - -A bug has been fixed where updating the certificate would not update the load balancer health check subject name. +The [Semaphore API has been redesigned][Redesigning the Semaphore API] allowing easier management of Semaphores. This has caused changes to API routes. +This is only an issue if the Semaphore API was directly being used. For further assistance, please raise a case in the [{{% ctx %}} Service Portal][]. ### Breaking Changes -The following features have introduced breaking changes in the 2024.11 release of the {{% ctx %}} Platform: - -#### Added support for multiple instances of the {{% ctx %}} Interaction Portal running on the same machine - -The following feature has changed both the {{% ctx %}} Interaction Portal flows and the AppGyver Solution package. -If using the {{% ctx %}} Interaction Portal, it will need to be re-installed. -For further assistance, please raise a case in the [{{% ctx %}} Service Portal][]. +There are no known breaking changes as part of the 2025.1 release of the {{% ctx %}} Platform. ### Known Limitations -There are no known limitations added as part of the 2024.11 release of the {{% ctx %}} Platform. +Known limitations have been added within the 2025.1 release of the {{% ctx %}} Platform: + +* The generation of processes from `BPMN XML` template is currently limited and does not support all `BPMN XML 2.0` features. ## Version Support @@ -467,6 +402,7 @@ There are no known limitations added as part of the 2024.11 release of the {{% c | Release | Compatibility Version | |---------|-----------------------| +| 2025.1 | 31.24311 | | 2024.11 | 31.24311 | | 2024.9 | 31.24311 | | 2024.7 | 31.24311 | @@ -477,6 +413,7 @@ There are no known limitations added as part of the 2024.11 release of the {{% c | Release | Grafana Version | Grafana Loki Version | {{% ctx %}} Observability Version | |---------|--------------------------|----------------------|-----------------------------------| +| 2025.1 | [10.4.1][Grafana 10.4.1] | [3.0.0][Loki 3.0.0] | [3.0.0][Observability 3.0.0] | | 2024.11 | [10.4.1][Grafana 10.4.1] | [3.0.0][Loki 3.0.0] | [3.0.0][Observability 3.0.0] | | 2024.9 | [10.4.1][Grafana 10.4.1] | [3.0.0][Loki 3.0.0] | [3.0.0][Observability 3.0.0] | | 2024.7 | [10.4.1][Grafana 10.4.1] | [3.0.0][Loki 3.0.0] | [3.0.0][Observability 3.0.0] | @@ -485,7 +422,7 @@ There are no known limitations added as part of the 2024.11 release of the {{% c ## Install Instructions -If you are installing a new 2024.11 platform or adding it to an existing 7.2 Installation see the guidance below; otherwise, if you are upgrading from an existing 2024.9 platform refer to the [Upgrade Instructions][]. +If you are installing a new 2025.1 platform or adding it to an existing 7.2 Installation see the guidance below; otherwise, if you are upgrading from an existing 2024.11 platform refer to the [Upgrade Instructions][]. Installing {{% ctx %}} Only: @@ -499,7 +436,7 @@ Adding {{% ctx %}} to a 7.2 Installation: ## Upgrade Instructions -If you are upgrading from an existing 2024.9 platform see the guidance below: +If you are upgrading from an existing 2024.11 platform see the guidance below: Upgrading {{% ctx %}}: @@ -512,90 +449,72 @@ Releases are currently forecast to be made available on: | Release | Release Type | Forecast Release Date | |---------|----------------|-------------------------------------| -| 2025.1 | [Fast Track][] | Week commencing 10th February 2025 | | 2025.3 | [Release][] | Week commencing 7th April 2025 | | 2025.5 | [Fast Track][] | Week commencing 2nd June 2025 | | 2025.7 | [Fast Track][] | Week commencing 11th August 2025 | | 2025.9 | [Release][] | Week commencing 6th October 2025 | -[{{% ctx %}} Innovation Core Application]: {{< url path="Cortex.Guides.CortexInnovation.CoreApplication.MainDoc" version="2024.11" >}} -[{{% ctx %}} API Gateway Service]: {{< url path="Cortex.Guides.CortexInnovation.CoreApplication.Services.ApiGatewayService.MainDoc" version="2024.11" >}} -[{{% ctx %}} Authorisation Service]: {{< url path="Cortex.Guides.CortexInnovation.CoreApplication.Services.AuthorisationService.MainDoc" version="2024.11" >}} -[{{% ctx %}} Concurrency Management Service]: {{< url path="Cortex.Guides.CortexInnovation.CoreApplication.Services.ConcurrencyManagementService.MainDoc" version="2024.11" >}} -[{{% ctx %}} Configuration Management Service]: {{< url path="Cortex.Guides.CortexInnovation.CoreApplication.Services.ConfigurationManagementService.MainDoc" version="2024.11" >}} -[{{% ctx %}} Data Storage Service]: {{< url path="Cortex.Guides.CortexInnovation.CoreApplication.Services.DataStorageService.MainDoc" version="2024.11" >}} -[{{% ctx %}} Execution Management Service]: {{< url path="Cortex.Guides.CortexInnovation.CoreApplication.Services.ExecutionManagementService.MainDoc" version="2024.11" >}} -[{{% ctx %}} Licence Management Service]: {{< url path="Cortex.Guides.CortexInnovation.CoreApplication.Services.LicenceManagementService.MainDoc" version="2024.11" >}} -[{{% ctx %}} Listeners Service]: {{< url path="Cortex.Guides.CortexInnovation.CoreApplication.Services.ListenersService.MainDoc" version="2024.11" >}} -[{{% ctx %}} Monitoring Service]: {{< url path="Cortex.Guides.CortexInnovation.CoreApplication.Services.MonitoringService.MainDoc" version="2024.11" >}} -[{{% ctx %}} Package Management Service]: {{< url path="Cortex.Guides.CortexInnovation.CoreApplication.Services.PackageManagementService.MainDoc" version="2024.11" >}} -[{{% ctx %}} Provisioning Service]: {{< url path="Cortex.Guides.CortexInnovation.CoreApplication.Services.ProvisioningService.MainDoc" version="2024.11" >}} -[{{% ctx %}} Scheduling Service]: {{< url path="Cortex.Guides.CortexInnovation.CoreApplication.Services.SchedulingService.MainDoc" version="2024.11" >}} -[{{% ctx %}} Triggers Service]: {{< url path="Cortex.Guides.CortexInnovation.CoreApplication.Services.TriggersService.MainDoc" version="2024.11" >}} -[{{% ctx %}} Innovation Execution Application]: {{< url path="Cortex.Guides.CortexInnovation.ExecutionApplication.MainDoc" version="2024.11" >}} -[{{% ctx %}} Execution Service]: {{< url path="Cortex.Guides.CortexInnovation.ExecutionApplication.Services.ExecutionService.MainDoc" version="2024.11" >}} -[Interaction Portal]: {{< url path="Cortex.Guides.CortexInteractionPortal.MainDoc" version="2024.11" >}} - -[Monitoring Service has been introduced]: {{< ref "#introduced-the-monitoring-service" >}} -[Operations Overview page]: {{< ref "#introduced-the-operations-overview-page" >}} -[configuration for maximum query string length]: {{< ref "#added-configuration-for-maximum-query-string-length" >}} -[Cortex Interaction Portal can now be installed multiple times on the same machine]: {{< ref "#added-support-for-multiple-instances-of-the-cortex-interaction-portal-running-on-the-same-machine" >}} -[session updates more reliably on slower systems]: {{< ref "#improved-session-update-reliability-on-slow-systems" >}} +[{{% ctx %}} Innovation Core Application]: {{< url path="Cortex.Guides.CortexInnovation.CoreApplication.MainDoc" version="2025.1" >}} +[{{% ctx %}} API Gateway Service]: {{< url path="Cortex.Guides.CortexInnovation.CoreApplication.Services.ApiGatewayService.MainDoc" version="2025.1" >}} +[{{% ctx %}} Authorisation Service]: {{< url path="Cortex.Guides.CortexInnovation.CoreApplication.Services.AuthorisationService.MainDoc" version="2025.1" >}} +[{{% ctx %}} Concurrency Management Service]: {{< url path="Cortex.Guides.CortexInnovation.CoreApplication.Services.ConcurrencyManagementService.MainDoc" version="2025.1" >}} +[{{% ctx %}} Configuration Management Service]: {{< url path="Cortex.Guides.CortexInnovation.CoreApplication.Services.ConfigurationManagementService.MainDoc" version="2025.1" >}} +[{{% ctx %}} Data Storage Service]: {{< url path="Cortex.Guides.CortexInnovation.CoreApplication.Services.DataStorageService.MainDoc" version="2025.1" >}} +[{{% ctx %}} Execution Management Service]: {{< url path="Cortex.Guides.CortexInnovation.CoreApplication.Services.ExecutionManagementService.MainDoc" version="2025.1" >}} +[{{% ctx %}} Licence Management Service]: {{< url path="Cortex.Guides.CortexInnovation.CoreApplication.Services.LicenceManagementService.MainDoc" version="2025.1" >}} +[{{% ctx %}} Listeners Service]: {{< url path="Cortex.Guides.CortexInnovation.CoreApplication.Services.ListenersService.MainDoc" version="2025.1" >}} +[{{% ctx %}} Monitoring Service]: {{< url path="Cortex.Guides.CortexInnovation.CoreApplication.Services.MonitoringService.MainDoc" version="2025.1" >}} +[{{% ctx %}} Package Management Service]: {{< url path="Cortex.Guides.CortexInnovation.CoreApplication.Services.PackageManagementService.MainDoc" version="2025.1" >}} +[{{% ctx %}} Provisioning Service]: {{< url path="Cortex.Guides.CortexInnovation.CoreApplication.Services.ProvisioningService.MainDoc" version="2025.1" >}} +[{{% ctx %}} Scheduling Service]: {{< url path="Cortex.Guides.CortexInnovation.CoreApplication.Services.SchedulingService.MainDoc" version="2025.1" >}} +[{{% ctx %}} Triggers Service]: {{< url path="Cortex.Guides.CortexInnovation.CoreApplication.Services.TriggersService.MainDoc" version="2025.1" >}} +[{{% ctx %}} Innovation Execution Application]: {{< url path="Cortex.Guides.CortexInnovation.ExecutionApplication.MainDoc" version="2025.1" >}} +[{{% ctx %}} Execution Service]: {{< url path="Cortex.Guides.CortexInnovation.ExecutionApplication.Services.ExecutionService.MainDoc" version="2025.1" >}} +[Interaction Portal]: {{< url path="Cortex.Guides.CortexInteractionPortal.MainDoc" version="2025.1" >}} + +[create a new process from BPMN XML]: {{< ref "#support-for-creating-new-process-from-templates" >}} +[Average Duration graph has been added]: {{< ref "#added-average-duration-graph-to-operations-overview" >}} [Observability]: {{< ref "#observability" >}} -[reducing the maximum size of Service Fabric Trace Logs]: {{< ref "#reduced-the-maximum-size-of-service-fabric-logs" >}} -[Performance]: {{< ref "#performance" >}} -[handling high volumes of executions more efficiently]: {{< ref "#improved-the-performance-of-the-execution-management-service" >}} +[default size of logs]: {{< ref "#reduced-service-default-log-sizes" >}} [Scalability]: {{< ref "#scalability" >}} -[increasing the header size limit for Service Fabric API Gateway]: {{< ref "#increased-the-header-size-limit-for-service-fabric-api-gateway" >}} +[Service Fabric BackUpRestore service has been enabled]: {{< ref "#enabled-service-fabric-backuprestore-service" >}} +[improve the performance]: {{< ref "#improvements-to-service-fabric-services-performance" >}} [Security]: {{< ref "#security" >}} +[Introducing security headers]: {{< ref "#introduced-security-headers-for-cortex-interaction-portal" >}} +[Removing sensitive information from HTTP responses]: {{< ref "#removed-sensitive-information-from-cortex-interaction-portal-http-responses" >}} [Usability]: {{< ref "#usability" >}} -[Content-security-policy directives]: {{< ref "#reviewed-the-content-security-policy-directives-on-cortex-gateway" >}} -[Permissions-Policy header]: {{< ref "#introduced-the-permissions-policy-header-on-cortex-gateway" >}} -[X-XSS-PROTECTION header]: {{< ref "#removed-the-x-xss-protection-header-on-cortex-gateway" >}} -[fixing the LiveView datetime picker styling issues]: {{< ref "#liveview-datetime-picker-styling-issues" >}} -[Third-party Support]: {{< ref "#third-party-support" >}} -[Health Check API to Service Fabric API Gateway]: {{< ref "#added-health-check-api-to-service-fabric-api-gateway" >}} +[Improving the user experience on the Operations Overview page]: {{< ref "#improved-user-experience-on-operations-overview" >}} +[Adding the {{% ctx %}} Version to the Gateway logo tooltip]: {{< ref "#added-cortex-version-to-gateway-logo-tooltip" >}} +[Redesigning the Semaphore API]: {{< ref "#redesigned-semaphore-api" >}} +[Third-party libraries has been updated]: {{< ref "#updated-third-party-libraries" >}} [Installation]: {{< ref "#installation" >}} -[check for certificate friendly name]: {{< ref "#added-check-for-certificate-friendly-name" >}} -[use PSDrive to improve compatibility]: {{< ref "#changed-the-installation-script-to-use-psdrive-to-improve-compatibility" >}} -[allow log file rotation for RabbitMQ logs]: {{< ref "#added-support-for-rabbitmq-log-file-rotation" >}} -[open ports for RabbitMQ Stream]: {{< ref "#opened-ports-for-rabbitmq-stream" >}} -[Upgrade]: {{< ref "#upgrade" >}} -[restoring files to pre-upgrade if the load balancer upgrade fails]: {{< ref "#improved-the-load-balancer-upgrade-process" >}} -[aligning the timeout of the Register-ServiceFabricApplicationType command with other commands]: {{< ref "#aligned-the-timeout-of-the-register-servicefabricapplicationtype-command-with-other-commands" >}} -[changing the extension of the studio package created by the upgrade script]: {{< ref "#changed-the-extension-of-the-studio-package-created-by-the-upgrade-script" >}} -[Upgrade - allow log file rotation for RabbitMQ logs]: {{< ref "#added-support-for-rabbitmq-log-file-rotation-1" >}} -[Upgrade - opening ports for RabbitMQ Stream]: {{< ref "#opened-ports-for-rabbitmq-stream-1" >}} -[Documentation]: {{< ref "#documentation" >}} -[adding the encryption key to the built-in Load Balancer server]: {{< ref "#added-how-to-add-the-encryption-key-to-the-built-in-load-balancer-server" >}} -[adding the Observability Compatibility table to release notes]: {{< ref "#added-observability-compatibility-table-to-release-notes" >}} -[updating the ports used by the platform]: {{< ref "#updated-ports-used-by-the-platform" >}} +[adding an unblock script]: {{< ref "#added-unblock-script-to-the-installation" >}} [Upgrade Instructions]: {{< ref "#upgrade-instructions" >}} -[Observability Compatibility]: {{< ref "#observability-compatibility" >}} -[Blocks]: {{< url path="Cortex.Reference.Blocks.MainDoc" version="2024.11" >}} +[Blocks]: {{< url path="Cortex.Reference.Blocks.MainDoc" version="2025.1" >}} +[Log Event Block]: {{< url path="Cortex.Reference.Blocks.Logs.LogEvent.LogEvent.MainDoc" version="2025.1" >}} -[Gateway]: {{< url path="Cortex.Guides.Gateway.MainDoc" version="2024.11" >}} +[Gateway]: {{< url path="Cortex.Guides.Gateway.MainDoc" version="2025.1" >}} -[Innovation Only - Single Server - Without HA]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.MainDoc" version="2024.11" >}} -[Innovation Only - Multiple Server - With HA]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.MainDoc" version="2024.11" >}} +[Innovation Only - Single Server - Without HA]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.MainDoc" version="2025.1" >}} +[Innovation Only - Multiple Server - With HA]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.MainDoc" version="2025.1" >}} -[Adding Innovation to a 7.2 Installation - Single Server - Without HA]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.SingleServerWithoutHA.MainDoc" version="2024.11" >}} -[Adding Innovation to a 7.2 Installation - Multiple Server - With HA]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.MainDoc" version="2024.11" >}} +[Adding Innovation to a 7.2 Installation - Single Server - Without HA]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.SingleServerWithoutHA.MainDoc" version="2025.1" >}} +[Adding Innovation to a 7.2 Installation - Multiple Server - With HA]: {{< url path="Cortex.GettingStarted.OnPremise.AddInnovationTo72.MultipleServerWithHA.MainDoc" version="2025.1" >}} -[Upgrade - Single Server - Without HA]: {{< url path="Cortex.Guides.UpgradeCortex.2024.9to2024.11.SingleServerWithoutHA.MainDoc" version="2024.11" >}} -[Upgrade - Multiple Server - With HA]: {{< url path="Cortex.Guides.UpgradeCortex.2024.9to2024.11.MultipleServerWithHA.MainDoc" version="2024.11" >}} -[Breaking - Added support for multiple instances of CORTEX Interaction Portal running on the same machine]: {{< ref "#added-support-for-multiple-instances-of-the-cortex-interaction-portal-running-on-the-same-machine-1" >}} +[Upgrade - Single Server - Without HA]: {{< url path="Cortex.Guides.UpgradeCortex.2024.11to2025.1.SingleServerWithoutHA.MainDoc" version="2025.1" >}} +[Upgrade - Multiple Server - With HA]: {{< url path="Cortex.Guides.UpgradeCortex.2024.11to2025.1.MultipleServerWithHA.MainDoc" version="2025.1" >}} +[Potential Breaking - Redesigned Semaphore API]: {{< ref "#redesigned-semaphore-api-1" >}} -[{{% ctx %}} Studio]: {{< url path="Cortex.Guides.Studio.MainDoc" version="2024.11" >}} +[{{% ctx %}} Studio]: {{< url path="Cortex.Guides.Studio.MainDoc" version="2025.1" >}} -[{{% ctx %}} Service Portal]: {{< url path="Cortex.ServicePortal.MainDoc" version="2024.11" >}} +[{{% ctx %}} Service Portal]: {{< url path="Cortex.ServicePortal.MainDoc" version="2025.1" >}} -[Fast Track]: {{< url path="Cortex.Reference.Glossary.F-J.FastTrack" version="2024.11" >}} -[Release]: {{< url path="Cortex.Reference.Glossary.P-T.Release" version="2024.11" >}} +[Fast Track]: {{< url path="Cortex.Reference.Glossary.F-J.FastTrack" version="2025.1" >}} +[Release]: {{< url path="Cortex.Reference.Glossary.P-T.Release" version="2025.1" >}} -[2024.9]: {{< url path="Cortex.Blogs.Releases.2024.9.MainDoc" version="2024.11" >}} +[2024.11]: {{< url path="Cortex.Blogs.Releases.2024.11.MainDoc" version="2025.1" >}} [Grafana 8.5.4]: {{< url path="Grafana.SelfManaged.Downloads.GrafanaWebApp.Windows" >}} [Grafana 10.4.1]: {{< url path="Grafana.SelfManaged.Downloads.GrafanaWebApp.10.4.1.Windows" >}} diff --git a/content/en/docs/2024.11/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/prerequisites.md b/content/en/docs/2024.11/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/prerequisites.md index 27525eb10..dda2c9c56 100644 --- a/content/en/docs/2024.11/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/prerequisites.md +++ b/content/en/docs/2024.11/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/install-web-application-server/prerequisites.md @@ -102,3 +102,4 @@ To import the certificate manually follow the below steps: [Import Certificate Manually]: {{< ref "#import-certificate-manually" >}} [Install Application Servers and Load Balancer]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.InstallApplicationAndLoadBalancerServers" >}} [Install Flow Debugger]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.DebuggerInstallation" >}} +[gobetween]: {{< url path="GoBetween.MainDoc" >}} diff --git a/content/en/docs/2025.1/Whats New/_index.md b/content/en/docs/2025.1/Whats New/_index.md index 905a560e7..e9b6d6a89 100644 --- a/content/en/docs/2025.1/Whats New/_index.md +++ b/content/en/docs/2025.1/Whats New/_index.md @@ -7,7 +7,7 @@ weight: 1 ## Summary -2024.11 is the next [Fast Track][] release of {{% ctx %}} and improves on the [2024.9][] release in the following areas: +2025.1 is the next [Fast Track][] release of {{% ctx %}} and improves on the [2024.11][] release in the following areas: * [Capability][] * [Observability][] @@ -17,91 +17,57 @@ weight: 1 * [Usability][] * [Third-Party Support][] * [Installation][] -* [Upgrade][] -* [Documentation][] ## Improved Capability -This release introduces multiple new features to the {{% ctx %}} platform: +This release introduces the following new features to the {{% ctx %}} platform: -* The [Monitoring Service has been introduced][] that provides aggregated historical data about the platform. -* The [Operations Overview page][] has been added to {{% ctx %}} Gateway to provide a high-level view of the system's operations, which includes: - * Current Status - * Filters - * Flow graphs -* The [configuration for maximum query string length][] has been added to the {{% ctx %}} Gateway `web.config`. -* The [Cortex Interaction Portal can now be installed multiple times on the same machine][]. +* The user can now [create a new process from BPMN XML][] within [{{% ctx %}} Gateway][Gateway] +* An [Average Duration graph has been added][] to the Operations Overview page on [{{% ctx %}} Gateway][Gateway] ## Improved Observability -Observability has been improved by [reducing the maximum size of Service Fabric Trace Logs][]. +All services have had the [default size of logs][] used for Observability reduced to optimise disk usage. ## Improved Performance -The Performance of the {{% ctx %}} has been improved by: - -* optimising [handling high volumes of executions more efficiently][] -* handling [session updates more reliably on slower systems][] +Work has been undertaken to [improve the performance][] of the [{{% ctx %}} Execution][{{% ctx %}} Execution Service] and [{{% ctx %}} Monitoring][{{% ctx %}} Monitoring Service] services. ## Improved Scalability -Scalability has been enhanced by [increasing the header size limit for Service Fabric API Gateway][]. +The [Service Fabric BackUpRestore service has been enabled][] to allow future Scalability improvements such as disaster recovery features. ## Improved Security -Security has been tightened on {{% ctx %}} Gateway by: +Security has been tightened on the [{{% ctx %}} Interaction Portal][Interaction Portal] by: -* updating the [Content-security-policy directives][] -* introducing the [Permissions-Policy header][] -* removing the [X-XSS-PROTECTION header][] +* [Introducing security headers][] +* [Removing sensitive information from HTTP responses][] ## Improved Usability -Usability has been improved by [fixing the LiveView datetime picker styling issues][]. +Usability has been enhanced by: -## Improved Third-Party Support +* [Improving the user experience on the Operations Overview page][] +* [Adding the {{% ctx %}} Version to the Gateway logo tooltip][] +* [Redesigning the Semaphore API][Redesigning the Semaphore API] allowing easier management of Semaphores -Third-party Support has been improved by: +## Improved Third-Party Support -* adding a [Health Check API to Service Fabric API Gateway][] -* updating the following 3rd party libraries on {{% ctx %}} Gateway: - * Fuse - * jQuery - * jQuery UI - * Moment.js - * Stacktrace.js +[Third-party libraries has been updated][] on the {{% ctx %}} platform. ## Improved Installation -Installation has been modified to: - -* [check for certificate friendly name][] -* [use PSDrive to improve compatibility][] -* [allow log file rotation for RabbitMQ logs][] -* [open ports for RabbitMQ Stream][] - -## Improved Upgrade - -Upgrade has been improved by: +The Installation has been improved by [adding an unblock script][] to the installation process. -* [restoring files to pre-upgrade if the load balancer upgrade fails][] -* [aligning the timeout of the Register-ServiceFabricApplicationType command with other commands][] -* [changing the extension of the studio package created by the upgrade script][] -* [allow log file rotation for RabbitMQ logs][Upgrade - allow log file rotation for RabbitMQ logs] -* [opening ports for RabbitMQ Stream][Upgrade - opening ports for RabbitMQ Stream] +For a full list of what has been introduced in this release, please see the [2025.1 Release Notes][] -## Improved Documentation - -The documentation includes updates related to: - -* [adding the encryption key to the built-in Load Balancer server][] -* [adding the Observability Compatibility table to release notes][] -* [updating the ports used by the platform][] - -For a full list of what has been introduced in this release, please see the [2024.11 Release Notes][] - -[Fast Track]: {{< url path="Cortex.Reference.Glossary.F-J.FastTrack" version="2024.11" >}} -[2024.9]: {{< url path="Cortex.Blogs.Releases.2024.9.MainDoc" version="2024.11" >}} +[Fast Track]: {{< url path="Cortex.Reference.Glossary.F-J.FastTrack" version="2025.1" >}} +[2024.11]: {{< url path="Cortex.Blogs.Releases.2024.11.MainDoc" version="2025.1" >}} +[Gateway]: {{< url path="Cortex.Guides.Gateway.MainDoc" version="2025.1" >}} +[{{% ctx %}} Execution Service]: {{< url path="Cortex.Guides.CortexInnovation.ExecutionApplication.Services.ExecutionService.MainDoc" version="2025.1" >}} +[{{% ctx %}} Monitoring Service]: {{< url path="Cortex.Guides.CortexInnovation.CoreApplication.Services.MonitoringService.MainDoc" version="2025.1" >}} +[Interaction Portal]: {{< url path="Cortex.Guides.CortexInteractionPortal.MainDoc" version="2025.1" >}} [Capability]: {{< ref "#improved-capability" >}} [Observability]: {{< ref "#improved-observability" >}} @@ -111,33 +77,18 @@ For a full list of what has been introduced in this release, please see the [202 [Usability]: {{< ref "#improved-usability" >}} [Third-Party Support]: {{< ref "#improved-third-party-support" >}} [Installation]: {{< ref "#improved-installation" >}} -[Upgrade]: {{< ref "#improved-upgrade" >}} -[Documentation]: {{< ref "#improved-documentation" >}} - -[Monitoring Service has been introduced]: {{< url path="Cortex.Blogs.Releases.2024.11.MonitoringServiceHasBeenIntroduced" version="2024.11" >}} -[Operations Overview page]: {{< url path="Cortex.Blogs.Releases.2024.11.OperationsOverviewPage" version="2024.11" >}} -[configuration for maximum query string length]: {{< url path="Cortex.Blogs.Releases.2024.11.ConfigurationForMaximumQueryStringLength" version="2024.11" >}} -[Cortex Interaction Portal can now be installed multiple times on the same machine]: {{< url path="Cortex.Blogs.Releases.2024.11.CortexInteractionPortalCanNowBeInstalledMultipleTimesOnTheSameMachine" version="2024.11" >}} -[session updates more reliably on slower systems]: {{< url path="Cortex.Blogs.Releases.2024.11.SessionUpdatesMoreReliablyOnSlowerSystems" version="2024.11" >}} -[reducing the maximum size of Service Fabric Trace Logs]: {{< url path="Cortex.Blogs.Releases.2024.11.ReducingTheMaximumSizeOfServiceFabricTraceLogs" version="2024.11" >}} -[handling high volumes of executions more efficiently]: {{< url path="Cortex.Blogs.Releases.2024.11.HandlingHighVolumesOfExecutionsMoreEfficiently" version="2024.11" >}} -[increasing the header size limit for Service Fabric API Gateway]: {{< url path="Cortex.Blogs.Releases.2024.11.IncreasingTheHeaderSizeLimitForServiceFabricAPIGateway" version="2024.11" >}} -[Content-security-policy directives]: {{< url path="Cortex.Blogs.Releases.2024.11.ContentSecurityPolicyDirectives" version="2024.11" >}} -[Permissions-Policy header]: {{< url path="Cortex.Blogs.Releases.2024.11.PermissionsPolicyHeader" version="2024.11" >}} -[X-XSS-PROTECTION header]: {{< url path="Cortex.Blogs.Releases.2024.11.XXSSPROTECTIONHeader" version="2024.11" >}} -[fixing the LiveView datetime picker styling issues]: {{< url path="Cortex.Blogs.Releases.2024.11.FixingTheLiveViewDatetimePickerStylingIssues" version="2024.11" >}} -[Health Check API to Service Fabric API Gateway]: {{< url path="Cortex.Blogs.Releases.2024.11.HealthCheckAPIToServiceFabricAPIGateway" version="2024.11" >}} -[check for certificate friendly name]: {{< url path="Cortex.Blogs.Releases.2024.11.CheckForCertificateFriendlyName" version="2024.11" >}} -[use PSDrive to improve compatibility]: {{< url path="Cortex.Blogs.Releases.2024.11.UsePSDriveToImproveCompatibility" version="2024.11" >}} -[allow log file rotation for RabbitMQ logs]: {{< url path="Cortex.Blogs.Releases.2024.11.AllowLogFileRotationForRabbitMQLogs" version="2024.11" >}} -[open ports for RabbitMQ Stream]: {{< url path="Cortex.Blogs.Releases.2024.11.OpenPortsForRabbitMQStream" version="2024.11" >}} -[restoring files to pre-upgrade if the load balancer upgrade fails]: {{< url path="Cortex.Blogs.Releases.2024.11.RestoringFilesToPreUpgradeIfTheLoadBalancerUpgradeFails" version="2024.11" >}} -[aligning the timeout of the Register-ServiceFabricApplicationType command with other commands]: {{< url path="Cortex.Blogs.Releases.2024.11.AligningTheTimeoutOfTheRegisterServiceFabricApplicationTypeCommandWithOtherCommands" version="2024.11" >}} -[changing the extension of the studio package created by the upgrade script]: {{< url path="Cortex.Blogs.Releases.2024.11.ChangingTheExtensionOfTheStudioPackageCreatedByTheUpgradeScript" version="2024.11" >}} -[Upgrade - allow log file rotation for RabbitMQ logs]: {{< url path="Cortex.Blogs.Releases.2024.11.UpgradeAllowLogFileRotationForRabbitMQLogs" version="2024.11" >}} -[Upgrade - opening ports for RabbitMQ Stream]: {{< url path="Cortex.Blogs.Releases.2024.11.UpgradeOpeningPortsForRabbitMQStream" version="2024.11" >}} -[adding the encryption key to the built-in Load Balancer server]: {{< url path="Cortex.Blogs.Releases.2024.11.AddingTheEncryptionKeyToTheBuiltInLoadBalancerServer" version="2024.11" >}} -[adding the Observability Compatibility table to release notes]: {{< url path="Cortex.Blogs.Releases.2024.11.AddingTheObservabilityCompatibilityTableToReleaseNotes" version="2024.11" >}} -[updating the ports used by the platform]: {{< url path="Cortex.Blogs.Releases.2024.11.UpdatingThePortsUsedByThePlatform" version="2024.11" >}} - -[2024.11 Release Notes]: {{< url path="Cortex.Blogs.Releases.2024.11.MainDoc" version="2024.11" >}} + +[2025.1 Release Notes]: {{< url path="Cortex.Blogs.Releases.2025.1.MainDoc" version="2025.1" >}} + +[create a new process from BPMN XML]: {{< url path="Cortex.Blogs.Releases.2025.1.CreateANewProcessFromBpmnXml" version="2025.1" >}} +[Average Duration graph has been added]: {{< url path="Cortex.Blogs.Releases.2025.1.AverageDurationGraphHasBeenAdded" version="2025.1" >}} +[default size of logs]: {{< url path="Cortex.Blogs.Releases.2025.1.DefaultSizeOfLogs" version="2025.1" >}} +[improve the performance]: {{< url path="Cortex.Blogs.Releases.2025.1.ImproveThePerformance" version="2025.1" >}} +[Service Fabric BackUpRestore service has been enabled]: {{< url path="Cortex.Blogs.Releases.2025.1.ServiceFabricBackUpRestoreServiceHasBeenEnabled" version="2025.1" >}} +[Introducing security headers]: {{< url path="Cortex.Blogs.Releases.2025.1.IntroducingSecurityHeaders" version="2025.1" >}} +[Removing sensitive information from HTTP responses]: {{< url path="Cortex.Blogs.Releases.2025.1.RemovingSensitiveInformationFromHttpResponses" version="2025.1" >}} +[Improving the user experience on the Operations Overview page]: {{< url path="Cortex.Blogs.Releases.2025.1.ImprovingTheUserExperienceOnTheOperationsOverviewPage" version="2025.1" >}} +[Adding the {{% ctx %}} Version to the Gateway logo tooltip]: {{< url path="Cortex.Blogs.Releases.2025.1.AddingTheCortexVersionToTheGatewayLogoTooltip" version="2025.1" >}} +[Redesigning the Semaphore API]: {{< url path="Cortex.Blogs.Releases.2025.1.RedesigningTheSemaphoreApi" version="2025.1" >}} +[Third-party libraries has been updated]: {{< url path="Cortex.Blogs.Releases.2025.1.ThirdPartyLibrariesHasBeenUpdated" version="2025.1" >}} +[adding an unblock script]: {{< url path="Cortex.Blogs.Releases.2025.1.AddingAnUnblockScript" version="2025.1" >}} diff --git a/data/urls.toml b/data/urls.toml index 3fc7ef2ed..01e699d3b 100644 --- a/data/urls.toml +++ b/data/urls.toml @@ -6,6 +6,22 @@ MainDoc = "/blog/news" [Cortex.Blogs.Releases] MainDoc = "/blog/releases" + [Cortex.Blogs.Releases.2025.X] + MainDoc = "/blog/releases/2025.x" + [Cortex.Blogs.Releases.2025.1] + MainDoc = "/blog/2025/02/10/2025.1/" + CreateANewProcessFromBpmnXml = "/blog/2025/02/10/2025.1/#support-for-creating-new-process-from-templates" + AverageDurationGraphHasBeenAdded = "/blog/2025/02/10/2025.1/#added-average-duration-graph-to-operations-overview" + DefaultSizeOfLogs = "/blog/2025/02/10/2025.1/#reduced-service-default-log-sizes" + ImproveThePerformance = "/blog/2025/02/10/2025.1/#improvements-to-service-fabric-services-performance" + ServiceFabricBackUpRestoreServiceHasBeenEnabled = "/blog/2025/02/10/2025.1/#enabled-service-fabric-backuprestore-service" + IntroducingSecurityHeaders = "/blog/2025/02/10/2025.1/#introduced-security-headers-for-cortex-interaction-portal" + RemovingSensitiveInformationFromHttpResponses = "/blog/2025/02/10/2025.1/#removed-sensitive-information-from-cortex-interaction-portal-http-responses" + ImprovingTheUserExperienceOnTheOperationsOverviewPage = "/blog/2025/02/10/2025.1/#improved-user-experience-on-operations-overview" + AddingTheCortexVersionToTheGatewayLogoTooltip = "/blog/2025/02/10/2025.1/#added-cortex-version-to-gateway-logo-tooltip" + RedesigningTheSemaphoreApi = "/blog/2025/02/10/2025.1/#redesigned-semaphore-api" + ThirdPartyLibrariesHasBeenUpdated = "/blog/2025/02/10/2025.1/#updated-third-party-libraries" + AddingAnUnblockScript = "/blog/2025/02/10/2025.1/#added-unblock-script-to-the-installation" [Cortex.Blogs.Releases.2024.X] MainDoc = "/blog/releases/2024.x" [Cortex.Blogs.Releases.2024.11] diff --git a/layouts/shortcodes/cr.html b/layouts/shortcodes/cr.html new file mode 100644 index 000000000..b7d5379f9 --- /dev/null +++ b/layouts/shortcodes/cr.html @@ -0,0 +1 @@ +\ \ No newline at end of file