Release - 5.5.0
Hot-fix 5.5.1 (08-08-2023)
Enhancement:
KN-902: CSP changes
As part of this hotfix, we have integrated a JavaScript file upload library. This library is designed to function with presignedURLs, file objects, and provider names. Depending on the provided values, the library will initiate interactions with the specified cloud provider and proceed to upload the file to the designated presignedURL.
Release Tags:
File Upload library:
Tag: v1.0.3
Install: npm i @project-sunbird/sunbird-file-upload-library@1.0.3
URL: https://www.npmjs.com/package/@project-sunbird/sunbird-file-upload-library/v/1.0.3
Please click here to find more details about how to install and use of this library.
How to extend the File upload library code to other Cloud Service Providers (CSPs):
The current iteration of this library has been developed with a primary focus on facilitating operations within the Azure cloud environment. Should you have the intention of expanding its capabilities to encompass additional Cloud Service Providers (CSPs) such as AWS, GCP, or Oracle, I highly recommend referring to the accompanying documentation. This document offers a comprehensive and detailed guide, providing step-by-step instructions and valuable insights on how to successfully extend the library's functionality to these other CSPs, ensuring seamless integration and compatibility.
Content Plugins:
Please build and deploy using blow content-plugin tags for new CSP changes.
Tag: release-5.2.1_RC4
Collection Editor:
Tag: v5.4.10
Install: npm i @project-sunbird/sunbird-collection-editor@5.4.10
URL: https://www.npmjs.com/package/@project-sunbird/sunbird-collection-editor/v/5.4.10
NOTE:
Editor is expecting
providername inside config. for more details, clike herePlease add File Upload library in
package.json. Collection editor has a dependency on File Upload library.
Sunbird Content Editor:
Please build and deploy using blow content-editor and content-plugin tags for new CSP changes.
Content Editor:
Tag: release-5.2.1_RC3
Content Plugins:
Tag: release-5.2.1_RC3
NOTE: Editor is expecting provider name inside config. For more details, click here
Sunbird Generic Editor:
Please build and deploy using blow genric-editor and content-plugin tags for new CSP changes.
Generic Editor:
Tag: release-5.2.1_RC2
Content Plugins:
Tag: release-5.2.1_RC2
NOTE: Editor is expecting provider name inside config. For more details, click here
Crucial Note Regarding CSP Changes:
At present, all editors are utilizing the default file upload library, which is designed to support the Azure CSP provider. However, if an adopter wishes to extend this library to incorporate new CSPs such as AWS or GCP, the following modifications need to be made in both Editors and Plugins to ensure their functionality:
The editor anticipates the inclusion of the
providername within the configuration. Please ensure that the provider name is added to the configuration as specified in the readme.md file.Update the package.json file with the new version of the File Upload library. It's important to note that the Collection editor relies on the File Upload library, so this update is crucial.
In order to incorporate the new version of the File Upload library, make the following changes to the specified plugins, and subsequently perform the build and deployment for both the Content editor and Generic editor. It's essential to replace the mentioned file at the following location:
editor/libs/sunbird-file-upload-library.js, ensuring that the filename remains unchanged.org.ekstep.assetbrowser-1.4
org.ekstep.uploadlargecontent-1.0
org.ekstep.uploadcontent-1.5
API Services:
| Component | Service to be Build | Tag | Deploy Job | Deployment Tag | Comment |
|---|---|---|---|---|---|
Knowledge-platform | Build/Core/Content | Deploy/Kubernetes/Content | |||
Knowledge-platform-jobs | Build/KnowledgePlatform/FlinkJobs | Deploy/KnowledgePlatform/FlinkJobs | Jobs to be deployed: 1. asset-enrichment 2.content-publish 3. post-publish-processor 4. qrcode-image-generator 5. video-stream-generator | ||
Sunbird-learning-service | Build/KnowledgePlatform/Learning | Deploy/KnowledgePlatform/Learning | |||
Knowledge-mw-service | Build/Core/KnowledgeMW | Deploy/Kubernetes/KnowledgeMW |
Jenkins Configurations for CSP support:
Set the variables CLOUD_STORE_GROUP_ID, CLOUD_STORE_ARTIFACT_ID and CLOUD_STORE_VERSION with appropriate values in Jenkins, either at the global level or for each individual service in the build job's configuration. For above-mentioned build jobs, configure like as we mentioned below.
Configure the following values:
| Name | ||
|---|---|---|
CLOUD_STORE_GROUP_ID | org.sunbird | Set the cloud storage SDK group_id ex: org.sunbird |
CLOUD_STORE_ARTIFACT_ID | cloud-store-sdk | Set the cloud storage artefact id ex: cloud-store-sdk |
CLOUD_STORE_VERSION | 1.4.6 | Set the cloud storage version ex: 1.4.6 NOTE: For OCI changes, we crated new version 1.4.7. |
5.5.0 (15-05-2023)
Discussion thread: https://github.com/orgs/Sunbird-Knowlg/discussions/106
Release timeline:
| Start date | End date | |
|---|---|---|
Planning phase | 27-Feb, 2023 | 14-Mar, 2023 |
Sprint 1 | 15-Mar, 2023 | 5-Apr, 2023 |
Sprint 2 | 6-Apr, 2023 | 27-Apr, 2023 |
PPV | 28-Apr, 2023 | 12-May, 2023 |
Prod | 15-May, 2023 |
5.5 total scope: Link
Document Release Version
| Project | Release Version | Date |
|---|---|---|
Sunbird Knowlg | R5.5.0 | 15 May 2023 |
1. Summary of the changes
This document contains information about the new features and enhancements planned to the Knowlg building block as part of release 5.5.0:
Enhancements: Click here to view the list.
Bug Fixes - click here to see the list of bugs fixed in this release.
Test Scenarios: NA
Documentation issue, release 5.4.0: KN-866
Release Tags:
In this release, we have published NPM package for the below editor and players web components. These NPM web components can help simplify web development by providing a standardized way to use editors and players in any UI framework, and which can save time and effort eventually.
And also we have introduced a oneclick-installation feature using Terraform,allowing easy provisioning of all services,databases and jobs .The installation process has been optimized to reduce manual configuration steps and simplify setup for new users.
Collection Editor as Web component:
Tag: 1.0.2
Install: npm i @project-sunbird/sunbird-collection-editor-web-component
URL: https://www.npmjs.com/package/@project-sunbird/sunbird-collection-editor-web-component/v/1.0.2
Sunbird-pdf-player as Web component:
Tag: 1.0.1
Install: npm i @project-sunbird/sunbird-pdf-player-web-component
URL: https://www.npmjs.com/package/@project-sunbird/sunbird-pdf-player-web-component/v/1.0.1
Sunbird-video-player as Web component:
Tag: 1.0.1
Install: npm i @project-sunbird/sunbird-video-player-web-component
URL: https://www.npmjs.com/package/@project-sunbird/sunbird-video-player-web-component/v/1.0.1
Sunbird-epub-player as Web component:
Tag: 1.0.1
Install: npm i @project-sunbird/sunbird-epub-player-web-component
URL: https://www.npmjs.com/package/@project-sunbird/sunbird-epub-player-web-component/v/1.0.1
Note: All the player angular libraries are updated with angular version 14 and published to npm with version 5.5.0. From the next release, the web component will be the primary export that is recommended way to use the players.
Oneclick-installation:
Features:
Terraform scripts have been implemented to automate the provisioning process, ensuring consistent and reliable deployments.
Terraform variables and templates have been added, providing users with the ability to customize the deployment according to their specific requirements.
Installation and Upgrade Instructions:
Follow the README.md file from the below link for any specific configuration steps or considerations. https://github.com/aimansharief/knowledge-platform/blob/knowlg-oneclick/knowlg-automation/README.md
Last updated
