Skip to content

Changelog

Release 5.9

October 2024

Whats New In Our Products ?

Kelvin UI

  • Kelvin Core UI
    • New Left Sidebar menu layout option
    • New User Managment feature in Administration
      • Attributes Based Access Control
      • Groups Management
    • New Roles and Permissions Management feature in Administration
      • Attributes Based Access Control
    • Workload download image improvements
    • CSV Publisher new validation on timestamps
    • Data Explorer improvements on handling missing data in time streams for smooth rendering of line graphs
  • General Minor UI improvements
  • Bug fixes

Kelvin API

  • Bug Fixes:
    • Search by display name not working for asset types
    • Losing connection to K8S API causes edge-updater to try to update all services
  • New Features:
    • Allow setting custom kubelet arguments when provisioning a new cluster
    • Improve appregistry events and ingestion
    • Add option to download workload image directly from S3
    • Implement Authorization API (manage roles and groups).
    • Apply ABAC validation in multiple services (assets, datastreams, parameters, etc.)
  • Improvements:
    • Refactor API to new structure of code (API User)
  • Fixes:
    • Fix deploy with multiple app version workloads on reuse_workloads (App Manager)
    • Fix undeploy resource (App Manager)
    • Create context for writable input datastreams (App Manager)
    • Duplicate datastream validation added (App Manager)
  • Other:
    • Improve planner rules cluster_sel_method: none on empty instance planner rules
    • Add new rejected state to control change API (API Control Change)

Kelvin SDK

  • Kelvin App
    • Added Support for Dynamic (Runtime) Configuration reload
    • Added support to receive Control Changes
  • App Test (Publisher)
    • Added support for custom (Data) Generators
  • Small Bug Fixes

Whats New in our Documentation ?

  • Restructuring of the documentation layout and content
    • New Overview section replacing Kelvin
      • Concepts now moved here in Overview section
      • Security and Certification now moved here in Overview section
      • Versions now moved here in Overview section
    • Developer Tools updated and refocused in content
      • Quick Start Guides updated and refreshed
      • How To Guides streamlined and reorganized into less menus
      • Use Cases updated and old use cases removed
    • Developer Tools updated and refocused in content
      • Use Cases updated and old use cases removed
    • Platform Administration updated and refocused in content
      • Quick Start Guides updated and refreshed
      • Use Cases moved to separate menu item
      • Use Cases updates and removed unrelated cases
      • User Management reorganized for clarity between RBAC and ABAC
  • Other notable changes in the documentation;
    • Many changes and tests on the current SDK examples in the documentation in Developer Tools
    • New User Management ⟹ Access Control section for Attributes Based Access Control (ABAC)
    • New Documentation ⟹ User Management ⟹ Access Rights page for ABAC
    • New Spotlight tips sections in Developer Tools and Platform Administration sections
    • New full documentation in How to Guides ⟹ Deployment ⟹ Guardrails section (feature coming in v5.9.1)
    • Improved Documentation ⟹ User Management authentication workflow
    • Updated Comparison and descriptions of the Enterprise and Professional editions of Kelvin
    • Updated Planner Rules new keys available
  • New Video Tutorial on importing assets/data streams and use csv publisher to test in less than 6 minutes
  • New Video Tutorial on provisioning a new edge device in less than 3 minutes
  • New Video Tutorial on creating and testing new Kelvin SmartApp™ in less than 8 minutes
  • New Video Tutorial on deploying Kelvin SmartApp™ to new assets in less than 2 minutes
  • New documentation and video tutorial on the event callback feature of the Python SDK
  • New documentation and video tutorial on the test generator tool for Kelvin SmartApps™
  • Updated abbreviations for popup tooltips
  • Updated API Swagger file to latest version
  • All screenshots updated with latest look and feel for v5.9
  • Updated version references
  • General improvements

Release 5.8

July 2024

Whats New In Our Products ?

Kelvin UI

  • Kelvin Core UI
    • Core UI now has Enterprise and Professional editions offering a set of user functionality each to the end-user;
    • Applications can now create evidences for recommendations, at the moment Dynacards are supported and shown inside each recommendation;
    • User session now refreshes properly which removes the need for constant authentication;
    • Users can now access the API Specification from the support menu;
    • Significant improvements to Data Explorer;
    • Overall improvements and bug fixing.
  • Kelvin Edge UI
    • Web application running on each cluster allowing the user to access and fully manage the cluster's workloads.

Kelvin API

  • A new API, designed for every edge cluster, has been introduced. This API is protected by custom authentication and offers a range of features, including:
    • Workload management:
      • Features;
        • Start.
        • Stop.
        • Delete.
        • Import.
        • View/Download logs.
        • Update workload configuration.
        • Update workload system.
        • View workload telemetry.
    • Apply staged workload.
    • Cluster information.
    • Node listing.
    • Service listing.
  • A new API specification has been added to each edge cluster, ensuring seamless integration with the existing services.
  • For the Professional edition, all APIs (server and edge) and cluster services have been adapted to:
    • Restrict certain actions.
    • Implement custom logic.
    • Automatically initiate workload image generation upon deploying a new workload.
  • The Kelvin-provision tool has been updated to accommodate the changes in cluster services, featuring commands for:
    • Listing workloads
    • Deleting workloads (new command)
    • Importing workloads
  • The workload-worker was refactored to generate workload images using a more efficient method, offering improved performance and reliability. This update also includes support for multi-architecture images.
  • Additionally, the time-series API has seen a significant 60% performance boost.
  • Overall, this update brings numerous improvements and bug fixes.

Kelvin SDK

  • Edge:
    • Added DataTag Object to the SDK
      • Asynchronous Creation (basically works the same way as Parameters)

Whats New in our Documentation ?

  • Created full API Reference site for Edge API
  • Added new Gathering System Optimization video example in Use Cases
  • Added new section on the new Edge API including;
    • Overview
    • Authentication
    • Pagination
    • Reference
  • Added new Edge UI section including;
    • Overview
    • Installing Edge Services
    • Managing User Credentials
    • Login to Edge Services
    • Edge UI Dashboard
    • Deploy Workload
    • Start / Stop Workload
    • Delete Workload
  • Added new Main Menu item Kelvin including;
    • Version Comparison
    • Enterprise Overview
    • Professional Overview
  • Added new Recommendation View and Actions page in Operations - Assets Menu
  • Added new Recommendation View and Actions page in Operations - SmartApps™ Menu
  • Added new Recommendation View and Actions page in Operations - Data Explorer Menu
  • Added new View Recommendations for Assets section in Operations Tools
  • Added new Action a Recommendation for Assets section in Operations Tools
  • Added new Video Tutorial on the Overview of the Edge UI and API
  • Updated page on Deploying Kelvin SmartApps™ in Developer Tools
  • Updated page on Update a Workload in Developer Tools
  • Updated page on Deploy Workload Offline in Developer Tools
  • Updated page on Start/Stop a Workload in Developer Tools
  • Updated page on Delete Workload in Developer Tools
  • Updated page on Last Recommendations in Operation Tools
  • Updated page Kelvin SmartApp™ -
  • Updated page Produce Recommendations with Dynacards for Kelvin SmartApps™ in developer Tools
  • Updated page Produce Recommendations with Dynacards for Docker App in developer Tools
  • Updated Kelvin API Overview page in Developer Tools
  • Updated Kelvin API Overview with the new menu item available
  • Updated new favicon
  • Updated abbreviations for popup tooltips
  • All screenshots updated with latest look and feel.
  • Replace v5.7 with v5.8 Kelvin API reference file
  • General improvements

Release 5.7

June 2024

Whats New In Our Products ?

Kelvin UI

  • Deploy Workloads option to install standard or staged deployment
  • Support to Apply staged workloads remotely
  • New Data Streams filter for Assets Table
  • Create & Apply schedule parameter change options available in Assets page
  • New custom column option to see upcoming schedules in Asset table
  • Bug fixes

Kelvin API

  • Staged workload implementation:
    • Deploy staged workloads.
    • Pre-download staged workload data.
    • Allow to apply multi-staged workloads at the same time.
    • Allow doing actions in a running workload without affecting a staged workload.
    • Allow doing actions in a staged workload without affecting a running workload.
    • Allow to cancel/delete a staged workload without affecting a running workload.
    • Implemented the staged workloads logic in the cluster/edge side (pre-download, apply action, status report, storage, etc.)
  • asset-insight API:
    • Allow to filter assets by datastream values.
    • Filter and sort improvements.
    • Internal queries to ArangoDB are more protected using "BindVars" avoiding "SQL" injection.
  • Improvements in the asset parameter schedules.
  • Bump control-change-manager to version 2.0.6
  • Bug fixes and overall improvements.

Kelvin SDK

  • Edge:
    • Added RollingWindow object implementation to the SDK
    • OPCUA Bridge ARM support
    • Bug fixes

Whats New in our Documentation ?

  • Added page on Asset Properties vs Parameters in Concepts
  • Added Create Scheduled Parameter change option in the configuration section of the Assets page in Kelvin UI
  • Added Apply / Revert Scheduled Parameter change option in Assets page in Kelvin UI
  • Added Delete Scheduled Parameter change option in Assets page in Kelvin UI
  • Added List Scheduled Parameter changes in Assets page in Kelvin UI
  • Added page on edge hardware requirements for Edge systems
  • Added page on Best Practices for developers when writing scalable programs
  • Added page on Staged Workload Monitoring
  • Added page in Developers section on Data Tag Names (create, update list and delete)
  • Added page in Developers section on Data Tags (create, update list and delete)
  • Added page on KRN fomrats in Concepts
  • Added page on Update Workload feature in the Orchstration section
  • Added Undeploy feature on Staged Workload Deploys
  • Added new feature Schedule custom column in Assets page in Kelvin UI
  • Added new Data Stream filter in the Assets page of the Kelvin UI
  • Added clarification message on load times when using the Asset filter feature
  • Updated page on Staged Workload Deploys, Activate and Undeploy for Kelvin API, Kelvin API Client (Python) and Kelvin UI
  • Updated Developer's schedule page to include all new Kelvin API Client (Python) script examples
  • Updated all connection pages with new features and structure
  • Updated and added Workload links to the Quick Start opening page in Developer Tools
  • Updated and added Scheduled Parameter Change links to the Quick Start opening page in Operations Tools
  • Tested and Updated all Kelvin APi and Kelvin API Client (Python) code in documentation
  • Removed all documentation on the Connection deploy option for Kelvin SDK.
  • All screenshots updated with latest look and feel.
  • Fix link issue with a single page shown in multiple locations
  • Fix missing left menu bug for some pages

Mini update for Documentation 26/06/2024

  • Updated the Metics Guardrail page
  • Replaced Application name with Kelvin SmartApps™
  • General improvements

Release 5.6

May 2024

Whats New In Our Products ?

Kelvin UI

  • New parameter scheduling system that allows for setting and revert parameters
  • Table configurations can now be reset and use the instance defaults
  • Improvements to Data Tagging feature
  • Overall improvements and bugfixing.

Kelvin API

  • Overall improvements in assets API.
  • New endpoints that allow to get and update a workload configuration section without restarting the applications.
  • Clean asset property definition that has no associations with other assets.
  • API recommendations:
    • Allow recommendations without expiration date.
    • The expiration date is not validated when a recommendation is created by a user.
  • Asset parameters schedule implementation:
    • Allow to schedule asset parameter changes
    • Allow to execute a schedule manually.
    • Allow to delete a schedule.
  • New endpoint that returns all resource application parameter values.
  • API control changes: Improve upload endpoint cluster validation
  • Removed swagger documentation from the code base.

Kelvin SDK

  • Removed kelvin bridge deploy cmd
  • Added Multi-Arch (arm) build capability with kelvin app build|upload --multiarch
  • Added MLFlow integration
    • kelvin app mlflow create/import/list

Whats New in our Documentation ?

  • Range of new video tutorials for Platform Administrators
    • Create Asset Type video tutorial
    • Create Asset video tutorial
    • Bulk create assets video tutorial
    • Create Data Stream video tutorial
    • Create Cluster in Kelvin UI video tutorial
    • Create OPC UA Connection in Kelvin UI video tutorial
    • Introduction to Kelvin Infrastructure video tutorial
    • Introduction to Asset / Data Stream Pairs video tutorial
  • New written and detailed video tutorial for Paper Quality Optimization for Platform Administrators
  • Added new Kelvin Infrastructure page for the concepts section.
  • Added documentation pages for new feature Scheduled Parameter changes for Kelvin UI, Kelvin API, Kelvin API Client (Python)
    • Create Scheduled Parameter page
    • Apply Scheduled Parameters page
    • Delete Scheduled Parameters page
    • List Schedules page
  • Added documentation on the ability to reset column settings back to the factory default for Kelvin UI.
  • Added Timeseries to DataFrame instructions for Kelvin API Client (Python)
  • Added documentation on Pinned Applications for Kelvin UI
  • Updated documentation descriptions for On-Demand Workloads to Staged Workloads
  • Updated, testing and changed all Kelvin API Client (Python) program examples to the new kelvin.api.client library which replaces the old kelvin.sdk.client library.
  • Updated, testing and change all Kelvin API requests to the new format and body structures.
  • Removed MQTT Connection for now until it is updated and re-enabled in Kevin UI.
  • All screenshots updated with latest look and feel.
  • Clean up long menus into logical Cards in a page instead for easier reading and finding relevant topics.
  • Standardized tab structure across documentation pages to be Kelvin UI, Kelvin API, Kelvin API Client (Python), Kelvin SDK examples.
  • Added Kelvin SDK commands in many locations as examples (where applicable)
  • Updated Kelvin API reference documentation

Release 5.5

March 2024

Whats New In Our Products ?

Kelvin UI

  • Data Explorer UI Revamp
  • Data Explorer Data Tagging:
    • Create data tags for points in time or time ranges;
    • Add context to data tags: datastreams, applications, etc;
    • Filter and search data tags for specific tags;
    • Create new tags to categorize data tags.
  • New connection type: CSV Publisher, that allows users to publish offline data in two modes:
    • Publish according to the timestamp intervals;
    • Publish in constant interval.
  • Bulk datastream creation wizard.
  • Easily create units on datastream creation.
  • Revamped data stream creation flow.
  • New application developer onboarding UI that allows the dev to understand what next steps they should take to create and deploy their first application.
  • Recommendations, app management and control changes are now respecting keycloak granular permissions.
  • Overal improvements and bugfixes.

Kelvin API

Release notes for API version 8.7.0 Cloud/APIs

  • Adapt build pipeline to support arm64/aarch64 architectures both edge and cloud applications.
  • Added new API for tags and data tags.
  • Added new API for filestorage.
  • Added a middleware that converts old error structures into the new error structure.
  • Removed JSON spec plugin system. Embed in any applications that need them. It is not possible to cross-compile plugins for other architectures.
  • Removed protocol requirement definition when deploying bridge applications. Added support to deploy any bridge application.
  • Apply the new pagination to all API services (except secret API).
  • Automatically remove unused property definitions whenever there are no associations (for example assets).
  • Also search by the display name in the cluster list endpoint.
  • Added a retry mechanism to validate if an image exists in the private registry whenever an app is created (appregistry create endpoint).
  • Overall improvements and validations in the control-change and recommendations APIs.
  • Refactor datastreams endpoint to simplify the logic and validations.

Release notes for Edge

  • Improved error handling when upgrading a cluster.
  • Implemented a better way to report workloads, nodes, and services status by splitting into different routines.
  • Added NATs connection environment variables to the Gateway and control-change-manager.
  • DevOps improvements on how some Kelvin applications are deployed in the edge.
  • Added sharding to kube-state-metrics to improve performance in large clusters. (edited)

Kelvin SDK

  • Replaced Edge MQTT Broker with NATS
  • Overall improvements to the whole Control Change life cycle
  • Added connector (Bridge) interfaces to the SDK (Build)
  • New connector (Bridge): CSV Publisher
  • Updated SDK CSV Simulator tool according to the new CSV Publisher Connector

Whats New in our Documentation ?

  • New PCP Optimization video tutorial added
  • New Tag feature in Data Explorer documented
  • Developer Tools to compile feedback from comments and Data Tags
  • Cluster docs has been significantly improved with new documentation on topics; overview, use case, upgrade and unreliable Internet.
  • New documentation on max assets per workload setting for Applications.
  • All Bridges have now been renamed Connections or Connectors. The legacy Bridges name is now only is found in Kelvin SDK and Kelvin API.
  • All references to Operators has now been renamed as Operations Engineer. Developer, Data Scientists, Platform Administrators remains the same.
  • Applications Overview page improved with new content.
  • Updated Quick starts in Developer Tools and Platform Administration to conform to latest version methodologies
  • Multi-Objective Optimization with Machine Learning is now renames Paper Quality Optimization
  • Added complete new section in Developer Tools How To on Developing Docker Apps
  • Primitive Type term is now replaced with Data Type and the old Data Type terminology is retired.
  • Units can now be created on-the-fly in Kelvin UI while creating a new Data Stream.
  • All infographics now follow the new design structure
  • Added mouseover glossary of all Kelvin terms
  • All screenshots updated to v5.5 version
  • Many other updates to the documentation pages and images
  • Special mention to significant new pages created;
    • Created page: Developer Tools → How To → Develop → Docker Apps → Create a Docker App : This gives a full information to create a Docker App
    • Created page: Developer Tools → How To → Develop → Docker Apps → Consume Data : This gives a full information to consume data in a Docker App
    • Created page: Developer Tools → How To → Develop → Docker Apps → Produce Data : This gives a full information to produce data from a Docker App
    • Created page: Developer Tools → How To → Develop → Docker Apps → Produce Control Changes : This gives a full information to create control changes from a Docker App
    • Created page: Developer Tools → How To → Develop → Docker Apps → Produce Recommendations : This gives a full information to create recommendation from a Docker App
    • Created page: Developer Tools → How To → Develop → Docker Apps → Test a Docker App : This gives information how to test a Docker App
    • Created page: Developer Tools → How To → Develop → Docker Apps → Upload to Register : This gives details how to upload Docker App to App Registry
    • Created page: Developer Tools → How To → Monitor → All Recommendation Comments : This shows how to retrieve all comments using Kelvin API and Kelvin SDK
    • Created page: Developer Tools → How To → Monitor → All Comments for One Recommendation : This shows how to retrieve all comments for one Recommendation using Kelvin UI, Kelvin API and Kelvin SDK
    • Created page: Developer Tools → How To → Monitor → All Comments for One Recommendation : This shows how to retrieve all comments for one Recommendation using Kelvin UI, Kelvin API and Kelvin SDK
    • Created page: Developer Tools → How To → Monitor → View Data Tags for an Asset : This shows how to retrieve Data Tags for one Asset and Tag Name using Kelvin UI, Kelvin API and Kelvin SDK
    • Created page: Operations Tools → Data Explorer → How To → Create/View Tags : This gives details how create and view the new Tags feature in Data Explorer
    • Created page : Platform Administration → How To → Data Streams → Bulk Create Data Streams : This page shows how to create the csv file from Google Sheets and import it into the Kelvin Platform
    • Created page : Platform Administration → How To → Cluster Management → Use Cases : This page provides an introduction to various setups and infrastructures that can utilize clusters effectively
    • Created Page : Platform Administration → How To → Cluster Management → Unreliable Internet : This page focuses on Kelvin cluster technology in locations that have unreliable or no Internet. Both for fault tolerance to avoid data/action loss as well as the ability for Clusters to operate offline (i.e. not connected to Internet or the Cloud) between Applications, Connections and other Workloads as long as they are all running and connected locally.
    • Created page : New tutorial, part 2 of the Paper Quality Optimization with focus specifically on the Developer's journey from Jupyter Notebook to local testing kelvin App.
    • Created page : Developer Tools → Concepts Overview → Clusters
    • Created page : Platform Administration → How to → Cluster Management → Use Cases
    • Created page : Platform Administration → How to → Cluster Management → Unreliable Internet
    • Created page : Concept Overviews → Applications
    • Created video tutorial : Quick Overview of Adding an Asset to an Application and Taking action on a Recommendation