diff --git a/docs/release-notes/img/data-catalog-architecture.png b/docs/release-notes/img/data-catalog-architecture.png deleted file mode 100644 index 2334699573..0000000000 Binary files a/docs/release-notes/img/data-catalog-architecture.png and /dev/null differ diff --git a/docs/release-notes/img/extension-manager.png b/docs/release-notes/img/extension-manager.png new file mode 100644 index 0000000000..77f8649ff8 Binary files /dev/null and b/docs/release-notes/img/extension-manager.png differ diff --git a/docs/release-notes/img/infrastructure-resources.png b/docs/release-notes/img/infrastructure-resources.png new file mode 100644 index 0000000000..8ca8dc59a3 Binary files /dev/null and b/docs/release-notes/img/infrastructure-resources.png differ diff --git a/docs/release-notes/img/marketplace-updates.png b/docs/release-notes/img/marketplace-updates.png new file mode 100644 index 0000000000..3785913e40 Binary files /dev/null and b/docs/release-notes/img/marketplace-updates.png differ diff --git a/docs/release-notes/img/runtime-custom-resources.png b/docs/release-notes/img/runtime-custom-resources.png new file mode 100644 index 0000000000..69cfc46da2 Binary files /dev/null and b/docs/release-notes/img/runtime-custom-resources.png differ diff --git a/docs/release-notes/img/software-catalog-overview.png b/docs/release-notes/img/software-catalog-overview.png new file mode 100644 index 0000000000..4e45fd3cdc Binary files /dev/null and b/docs/release-notes/img/software-catalog-overview.png differ diff --git a/docs/release-notes/img/software-catalog.png b/docs/release-notes/img/software-catalog.png new file mode 100644 index 0000000000..db9829ef36 Binary files /dev/null and b/docs/release-notes/img/software-catalog.png differ diff --git a/docs/release-notes/img/versioning-management.png b/docs/release-notes/img/versioning-management.png new file mode 100644 index 0000000000..ce061148b1 Binary files /dev/null and b/docs/release-notes/img/versioning-management.png differ diff --git a/docs/release-notes/mia-platform-v13.mdx b/docs/release-notes/mia-platform-v13.mdx index 22809e8c40..9153ebc854 100644 --- a/docs/release-notes/mia-platform-v13.mdx +++ b/docs/release-notes/mia-platform-v13.mdx @@ -5,6 +5,18 @@ sidebar_label: v13 Overview image: "img/release-note-link-preview.png" --- +export const Highlight = ({children, color}) => ( + + {children} + +); + **Welcome to Mia-Platform v13!** # Compose your Platform @@ -22,6 +34,16 @@ The main benefits for the user can be summarized by the following: Let's go in deep with the new Features: +### Extend Mia-Platform Console using... the Console! | v13 - Fall Release + +We have strengthened our Platforge Extensibility Kit by adding the possibility to add extensions from Console UI and enriching the type of supported extensions. You can now extend your Console by embedding iFrames, adding External Links & composing your pages with Microfrontend Composer within a dedicated "Extensions" section, accessible to Company Owners within the Platforge section at Company level. + +Customizing your Mia-Platform Console has never been so easy: simply select the type of extension, the desired Area and where to display it from the available options, then choose what you want to show your users! + +To discover more about how to manage your Extensions and the types of supported extensions, head to the [Extensions documentation](/console/company-configuration/extensions.md). + +![Extension Manager](img/extension-manager.png) + ### Extend Frontend of Mia-Platform Console with iFrames Extend the Console as you like. @@ -35,14 +57,6 @@ This function is now only accessible via Application Programming Interface (API) To learn more, please refer to the [documentation](/console/console-extensibility/overview.md). -### Managing Custom Resources through the Console - -You can now manage and configure custom objects that are not part of the standard Console supported resources using the classic user interface of the Console. This feature further expands the Console domain over user's entire workloads, enabling greater operability, governance, and control over systems. - -![Custom Resources](img/custom-resources.png) - -To discover more, please refer to the [documentation](/console/design-your-projects/custom-resources/custom-resources.md). - ### React to Console actions using Webhooks The variety of Console events suitable for webhook configuration constantly increases, allowing you to react and build custom flows and logic each time the event occurs. @@ -62,6 +76,28 @@ You can find the brand new plugin in the [Backstage Marketplace](https://backsta ![Backstage](img/backstage-banner.jpg) +## Infrastructure Management + +### Manage Infrastructure Resources through Console + +You can now manage and configure custom objects that are not part of the standard Console supported resources using the classic user interface of the Console. This feature further expands the Console domain over user's entire workloads, enabling greater operability, governance, and control over systems. + +![Custom Resources](img/infrastructure-resources.png) + +#### Support to all Infrastructure Resources | v13 - Fall Release + +With the Fall release updates we have officially introduced the possibility to manage the provisioning of your infrastructure, configuring - at the Design level - your Infrastructure Resources. +Within the Design of your Console you can then see a new "Infrastructure" section entirely dedicated to Infrastructure as Code! + +To discover more, please refer to the [documentation page](/console/design-your-projects/custom-resources/custom-resources.md) and check out some useful [use cases](/console/design-your-projects/custom-resources/use-cases.md). + +#### Support of Custom Kubernetes Resources in Runtime area | v13 - Fall Release + +We finalized the support for Kubernetes type Resources by introducing the possibility of monitoring such resources at Runtime once deployed. +For each resource you will be able to access its detail where you will see the respective Describe and Events that are generated, similarly to the other resources in the Runtime Area. + +To discover more, you can refer to the [documentation](/console/design-your-projects/custom-resources/custom-resources.md). + ## Simplify Composability Mia-Platform Suite empowers development teams to enhance software composability by facilitating streamlined reuse and embracing scalable approaches. With Mia-Platform v13, software composability is even more NoCode! @@ -74,30 +110,47 @@ The main benefits for the user can be summarized by the following: Let's go in deep with the new Features: -### Enrich Meta Data and list all your data assets: Data Catalog +### Data Catalog Application | v13 - Fall Release + +Mia-Platform product suite is finally enriched with a new core component, the **Data Catalog** application, an essential tool for performing Data Discovery and Data Governance on your Company data assets. + +![Data Catalog home](img/data_catalog_home.png) + +Mia-Platform Data Catalog serves as a centralized repository of metadata that provides a clear and detailed overview of the Company data assets, reducing time for Data Discovery and empowering Data Governance Teams with powerful metadata management features. + +Thanks to Data Catalog, you can reduce Data Discovery time with advanced search capabilities, maintain adherence to numerous data management regulations and laws, such as GDPR in Europe, provide a centralized space for your teams to share data information and knowledge, and improve data quality with powerful metadata enrichment features. In addition, thanks to Data Lineage capabilities, it is possible to understand how data move and transform within your data landscape. + +To find out how it works and all the benefits of Mia-Platform Data Catalog, please refer to the related [documentation](/data_catalog/overview.mdx). -Let's welcome our first release of **Data Catalog**, designed to provide the data governance teams and data analysts with a centralized location where all metadata concerning the data assets of an organization are collected. +### Software Catalog | v13 - Fall Release -Set up our Data Catalog Agent, to connect to different external sources, such as Oracle Database, Salesforce, Postgres Database, MySQL Database, Microsoft SQL Server Database, and to extract all metadata existing on your organization's System of Records. +We are excited to announce the launch of the first release of the **Software Catalog**, designed to help you track, manage, and document software across your ecosystem. +The Software Catalog provides a centralized and reliable way to access software ownership, metadata, lifecycle status, and versions, ensuring accountability throughout the company's software landscape. -Through Mia-Platform Console, it is possible to: +![software catalog overview](img/software-catalog-overview.png) -- Keep metadata up to date with the external System of Records -- Navigate data models in a centralized place -- Enrich metadata with descriptions and GDPR regulation properties for each table field -- Export your data models in .csv format -- Make metadata usable via Data Catalog API from third-party systems and custom frontends +With Mia-Platform Software Catalog, you can: +- Explore available software resources in a centralized location +- View detailed item information, including metadata, lifecycle status, versions, release notes, and availability (Global, Public, or Private) +- Seamlessly navigate between different versions of each item -![Data Catalog Architecture](img/data-catalog-architecture.png) +### Versioning management of Marketplace resources | v13 - Fall Release -To learn more, please refer to the [documentation](/runtime_suite_templates/data-catalog-agent/10_overview.md). +Version control for your Marketplace resources is now available in Mia-Platform Console. Users can manage and access different versions of Plugins and infrastructure Resources, selecting the one that best suits their needs and easily switching between versions. +If you want to discover more, head to the [dedicated section](/marketplace/add_to_marketplace/create_your_company_marketplace.md#set-controlled-versions-for-your-marketplace-resources-and-make-them-available-to-users) inside the [Company Marketplace](/marketplace/add_to_marketplace/create_your_company_marketplace.md) documentation page. + +![Versioning Management](img/versioning-management.png) ### Seamless Runtime Management with Fast Data Control Plane Mia-Platform Fast Data has been empowered with a Runtime Management solution, the **Fast Data Control Plane**. -This Fast Data suite component provides a general overview of the Fast Data pipelines released on the runtime environment, and allows to monitor and govern the execution of your Fast Data system. -From its user-friendly web interface, you can pause and resume the consumption of data streams along Fast Data pipelines with just a few clicks to strategically allocate resources consumption and efficiently utilize them during peak demand processes. +This Fast Data suite component acts as the single central access point for governing the Fast Data Runtime of your entire Company. +Fast Data Control Plane application provides a general overview of the Fast Data pipelines released on the runtime environment, and allows to monitor and govern the execution of your Fast Data system. +From its user-friendly web interface, you can pause and resume the consumption of data streams along Fast Data pipelines with just a few clicks to strategically allocate resources consumption and efficiently utilize them during peak demand processes. + +![Fast Data Control Plane](img/fd-control-plane.gif) + Many are the benefits of adopting the Fast Data control plane in your Fast Data Projects, for example: - **Optimize Resource Allocation**, by strategically pausing and resuming the consumption of data streams along the Fast Data pipelines @@ -105,9 +158,7 @@ Many are the benefits of adopting the Fast Data control plane in your Fast Data - **Performance Testing and Simulation**, to simulate different scenarios for performance testing by observing your system behavior under various conditions - **Enhanced System Reliability**, allowing you to gracefully handle unexpected situations and/or system maintenance periods while minimizing system downtime. -![Fast Data Control Plane](img/fd-control-plane.gif) - -To learn more, please refer to the [documentation](/fast_data/runtime_management/overview.mdx). +To learn more, please refer to the related [documentation](/fast_data/runtime_management/overview.mdx). ### Streamline how you build your Sagas, now No-Code @@ -151,9 +202,12 @@ The main benefits for the user can be summarized by the following: - Action Advisory - Simplify access to features -Let's go in deep with the new Features: +### AI RAG Chat application | v13 - Fall Release + +In this release, we have worked on an application to extend the use of AI assistance with the process of Retrieval-Augmented Generation (RAG) in a simple way. You can then configure a RAG Application chat within your project to easily set up your own chatbot. This application is featuring automatic embeddings generation from website pages. +For more information on how to configure your custom RAG Application, head to the [related tutorial](/marketplace/tutorials/create-a-rag-application.md). -### Mia-Assistant +### Let's welcome Mia-Assistant in Console! With this release we introduce a first version of our **Mia-Assistant**, an AI-based virtual chat that will make it easier for you to discover our Mia-Platform Console and access its documentation! Mia-Assistant will answer your questions and provide you the related Mia-Platform documentation reference, to help you retrieve all the information you need and improve your experience with our product! diff --git a/docs/release-notes/stable versions.md b/docs/release-notes/stable versions.md index 837d5734d2..78472d633a 100644 --- a/docs/release-notes/stable versions.md +++ b/docs/release-notes/stable versions.md @@ -32,5 +32,6 @@ As the transition period from one MTW to the next approaches, more precise dates |-----------|----------------|----------------------|----------------------| | Q1 - 2024 | v12.0.x | _January 18th, 2024_ | _April 15th, 2024_ | | Q2 - 2024 | v12.3.x | _April 15th, 2024_ | _July 18th, 2024_ | -| Q3 - 2024 | v13.0.x | _July 18th, 2024_ | _mid-October, 2024_ | -| Q4 - 2024 | _TBD_ | _mid-October, 2024_ | _mid-January, 2025_ | +| Q3 - 2024 | v13.0.x | _July 18th, 2024_ | _October 24th, 2024_ | +| Q4 - 2024 | v13.1.x | _October 24th, 2024_ | _January 16th, 2025_ | +| Q1 - 2025 | v13.3.x | _January 16th, 2025_ | _mid-April, 2025_ | diff --git a/docs/release-notes/v13.2.1.md b/docs/release-notes/v13.2.1.md index 2cb022e578..19e3281d12 100644 --- a/docs/release-notes/v13.2.1.md +++ b/docs/release-notes/v13.2.1.md @@ -5,15 +5,7 @@ sidebar_label: v13.2.1 image: "img/release-note-link-preview.png" --- -_October 10th, 2024_ - -:::info -Mia-Platform Console v13.2.1 is **now in Preview** and will be generally available on October 24th. - -Console SaaS users can try out v13.2.1 latest improvements in Preview! Open a Service Request to ask for the creation of a sandbox Company in case you do not have access to any Company. - -For self-hosted installations, please read the [following guidelines](#how-to-update-your-console). -::: +_October 24th, 2024_ ## Console @@ -78,4 +70,4 @@ The new version `7.2.1` of the CRUD Service is available! ## How to update your Console -For self-hosted installations, please head to the [self hosted upgrade guide](/infrastructure/self-hosted/installation-chart/100_how-to-upgrade.md) or contact your Mia-Platform referent and upgrade to _Console Helm Chart_ `v13.7.4-beta.0`. +For self-hosted installations, please head to the [self hosted upgrade guide](/infrastructure/self-hosted/installation-chart/100_how-to-upgrade.md) or contact your Mia-Platform referent and upgrade to _Console Helm Chart_ `v13.7.4`. diff --git a/docs/release-notes/v13.3.0.md b/docs/release-notes/v13.3.0.md new file mode 100644 index 0000000000..d20929193a --- /dev/null +++ b/docs/release-notes/v13.3.0.md @@ -0,0 +1,170 @@ +--- +id: v13.3.0 +title: Version 13.3.0 Release Notes +sidebar_label: v13.3.0 - Fall Release +image: "img/release-note-link-preview.png" +--- + +export const Highlight = ({children, color}) => ( + + {children} + +); + +_October 24th, 2024_ + +:::info +Mia-Platform Console v13.3.0 - Fall Release is **now in Preview** and will be generally available on November 21st. + +Console SaaS users can try out v13.3.0 - Fall Release latest improvements in Preview! Open a Service Request to ask for the creation of a sandbox Company in case you do not have access to any Company. + +For self-hosted installations, please read the [following guidelines](#how-to-update-your-console). +::: + +## Support to all Infrastructure Resources in Design + +With this release, we are excited to introduce the ability to manage infrastructure provisioning by configuring your Infrastructure Resources at the Design level. +A new "Infrastructure" section has been added within the Design of your Console, fully dedicated to Infrastructure as Code! + +For more information, please visit the [documentation page](/console/design-your-projects/custom-resources/custom-resources.md) and explore some helpful [use cases](/console/design-your-projects/custom-resources/use-cases.md). + +## Support to Infrastructure Kubernetes Resources in the Runtime area + +With the v13.3.0 it is now possible to monitor directly in the Runtime area all the Custom Resources deployed for your project, on each environment on it. + +For each resource you will be able to access its detail where you will see the respective Describe and Events that are generated, similarly to the other resources in the Runtime Area. + +To discover more, please refer to the [documentation](/console/design-your-projects/custom-resources/custom-resources.md). + +![runtime custom resources](img/runtime-custom-resources.png) + +## Introducing the Mia-Platform Software Catalog + +The Mia-Platform Software Catalog offers a centralized solution for tracking, managing, and documenting software resources across the company. It provides visibility into software ownership, metadata, lifecycle status, and versions, helping teams ensure accountability and avoid duplication of efforts. + +For more information and to see the currently supported resources, please refer to the [documentation](/software-catalog/overview.md) for detailed insights on the Software Catalog. + +![software catalog overview](img/software-catalog.png) + +## View version updates of Marketplace resources in your configuration + +From this release, you will be able to see, within your configuration, your Marketplace resources that have a new version update available. +This will allow you to be notified and keep your resources updated easily and frictionlessly! + +![Marketplace Updates](img/marketplace-updates.png) + +## Add External Links in Console with the Extensibility manager + +We have enhanced our Platforge extensibility kit by adding external links among the supported extensions. You can now add this type of link in the sidebar from the Extension Manager in Console. + +For more information about Console Extensions, please visit the related [documentation page](/console/company-configuration/extensions.md). + +## Extend Mia-Platform Console pages using Microfrontend Composer BETA + +With a view to further enhancing our Platforge toolkit dedicated to Console extensibility, we also introduced the possibility of composing Console pages using the Microfrontend Composer. +To do this, all you have to do is go to the Extensions manager at Company level, add an extension by selecting the ‘Create with Composer’ option and start customizing the new section you want to add! + +Please note that this feature has now been released in Beta. To discover more, refer to the [Extensions documentation](/console/company-configuration/extensions.md). + +## Support for Repository Creation in Infrastructure Resources + +For Infrastructure Resources that have an associated repository defined in their template, the Console now fully supports the repository creation step. + +## Console + +### Improvements + +#### New Flow Manager Configurator look + +We have refreshed the look of the Flow Manager Configurator with updated graphics, new colors, and several design improvements to enhance the overall user experience and visual appeal. + +#### Annotations & Labels Suggestions + +The Console now suggests previously used Annotations & Labels when adding them to a Microservice, speeding up the process and reducing the chance of errors. + +### Bug Fix + +This version addressed the following bugs: + +* We fixed a bug where the Design configuration wasn't displayed correctly if saved via shortcut before fully loading; +* The english translation of some validation error messages in Console has been revised + +## Fast Data + +### Fast Data Services + +#### Projection Storer + +The new version `1.3.2` of the Projection Storer service is available! + +##### Improvements + +* Introduced the support for connecting to the storage using TLS/SSL connection. For more information about how to configure it, visit the related SSL connection [documentation](/fast_data/configuration/projection_storer.md#ssl-connection) + +## Data Catalog + +### Data Catalog Application + +The services of [Data Catalog Application](/data_catalog/data_catalog_frontend.mdx) have been updated to improve _advanced search_ performances and the overall user experience across Data Catalog UI. +The latest services versions are reported [here](/data_catalog/compatibility_matrix.md#service-latest-versions). + +#### Introduction of Fabric Sync cronjob + +As reported in the [Migration Guides](/data_catalog/data_catalog_open_lineage.mdx#migration-guides) paragraph of [Data Catalog Open Lineage](/data_catalog/data_catalog_open_lineage.mdx) service, when upgrading from `v0.1.0` to `v0.1.1`, it is necessary to configure the Fabric Sync cronjob, which is responsible to keep synchronized the information displayed on Data Catalog application with the collection of datasets imported by Data Catalog Agent. + +For more information about how to configure and trigger the Fabric Sync, please follow the [related documentation](/data_catalog/data_catalog_agent_setup.mdx#sync-assets). + +## Microfrontend Composer + +### Back-Kit Library + +The new version `v1.5.9` of the back-kit library is available! + +Refer to back-kit [changelog](/microfrontend-composer/back-kit/changelog.md) for finer-grained details of new versions. + +#### Improvements + +##### New keyword to get the current time + +It is now possible to add new key `$dateNow` in handlebars to retrieve current date time in ISO format in http requests. + +## Marketplace + +### Marketplace Updates + +#### Teleconsultation Service + +A new major version of the Teleconsultation Service - both frontend and backend - is out! + +The Teleconsultation Service `v2.0.0` is officially available from October 1st, 2024 and supports the new version of the Kaleyra API (v2). + +The end of life for Kaleyra API v1 is October 31st, 2024, so after that date all `v1.x.x` versions will stop working. + +##### Breaking Changes + +- If no company theme or logo is specified in the service configuration, no default is set and therefore no update is performed when service starts +- Endpoint `POST /teleconsultation/:roomId/participants/data` has been deleted + +#### Appointment Manager + +The new version `2.5.0` of the Appointment Manager is available! + +In this minor version we have resolved an issue where an availability slot was incorrectly blocked if it started immediately after an exception period. Previously, if the start time of the next available slot matched the end time of the exception, the system would erroneously block that slot, even though it was intended to be available. This has now been fixed, and availability will be correctly displayed in such cases. + +The fix automatically truncates start and end date to the second, so, if you are encoutering this issue, please update the affected exceptions after upgrading to `v2.5.0`. + +#### Form Service BE + +The new version `2.1.0` of the Form Service Backend is available! + +In this minor version, we’ve added a new feature to the `FormModal` component. Now, the title can be passed as a prop, just like the message. This update offers greater flexibility for customizing modal titles based on specific needs. Moreover, we upgraded some dependencies, including Node.js to v20 and the `custom-plugin-lib` to v6. + +## How to update your Console + +For self-hosted installations, please head to the [self hosted upgrade guide](/infrastructure/self-hosted/installation-chart/100_how-to-upgrade.md) or contact your Mia-Platform referent and upgrade to _Console Helm Chart_ `v13.X.X`. diff --git a/docs/release-notes/versions.md b/docs/release-notes/versions.md index 4db4d6a841..2f231312a6 100644 --- a/docs/release-notes/versions.md +++ b/docs/release-notes/versions.md @@ -7,6 +7,7 @@ slug: "/release-notes/versions" --- | Release | Release notes | |---------|--------------------------------------------| +| v13.3.0 | [Read the release notes](/release-notes/v13.3.0.md) | | v13.2.1 | [Read the release notes](/release-notes/v13.2.1.md) | | v13.2.0 | [Read the release notes](/release-notes/v13.2.0.md) | | v13.1.1 | [Read the release notes](/release-notes/v13.1.1.md) | diff --git a/docs/software-catalog/img/item-versions.png b/docs/software-catalog/img/item-versions.png index b873601a58..b9148b32ef 100644 Binary files a/docs/software-catalog/img/item-versions.png and b/docs/software-catalog/img/item-versions.png differ diff --git a/docs/software-catalog/img/table-filters.png b/docs/software-catalog/img/table-filters.png index 85e15f4dd5..8125222e76 100644 Binary files a/docs/software-catalog/img/table-filters.png and b/docs/software-catalog/img/table-filters.png differ diff --git a/docs/software-catalog/img/table-overview.png b/docs/software-catalog/img/table-overview.png index d1e1f065a6..4e45fd3cdc 100644 Binary files a/docs/software-catalog/img/table-overview.png and b/docs/software-catalog/img/table-overview.png differ diff --git a/docs/software-catalog/img/versions-navigation.png b/docs/software-catalog/img/versions-navigation.png index be444d9926..94f42c5149 100644 Binary files a/docs/software-catalog/img/versions-navigation.png and b/docs/software-catalog/img/versions-navigation.png differ diff --git a/sidebars.json b/sidebars.json index 9071ff5951..2d45b06456 100644 --- a/sidebars.json +++ b/sidebars.json @@ -1893,6 +1893,7 @@ "id": "release-notes/versions" }, "items": [ + { "id": "release-notes/v13.3.0", "type": "doc" }, { "id": "release-notes/v13.2.1", "type": "doc" }, { "id": "release-notes/v13.2.0", "type": "doc" }, { "id": "release-notes/v13.1.1", "type": "doc" },