Release - 5.7.0

Hot-fix 5.7.0 (06-05-2024)

1. Not able to download QR-codes from published collection. KN-1057

Component	Service to be Build	Tag	Deploy Job	Deployment Tag	Comment
Knowledge-platform	Build/Core/Content	release-5.7.0_RC11	Deploy/Kubernetes/Content	release-5.6.0-knowlg_RC1
Knowledge-platform-jobs	Build/KnowledgePlatform/FlinkJobs	release-5.7.0_RC3	Deploy/KnowledgePlatform/FlinkJobs	release-5.7.0_RC4	Jobs to be deployed: 1. post-publish-processor

Hot-fix 5.7.0 (17-04-2024)

1. Removing inQuiry schemas from Knowlg repo (IQ-750)

Release Tags:

Component	Service to be Build	Tag	Deploy Job	Deployment Tag	Comment
Schema upload	NA	NA	Deploy/Kubernetes/UploadSchema	release-5.7.0_RC9

Hot-fix 5.7.0 (20-03-2024)

Bug:

1. cloud storage SDK values pass in build time in search-service: KN-1033

2. Question & Question Set objects image nodes issue

Release Tags:

API Services:

Component	Service to be Build	Tag	Deploy Job	Deployment Tag	Comment
Search-service	Build/Core/search	release-5.7.0_RC8	Deploy/Kubernetes/Search	release-5.6.0-knowlg_RC1	Deploy Tag is given for reference only. Please do not use directly for deployment.

Hot-fix 5.7.0 (07-03-2024)

Bugs:

1. CLONE - Imported Questionset is not playing in staging - IQ-682

Release Tags:

API Services:

Component	Service to be Build	Tag	Deploy Job	Deployment Tag	Comment
Knowledge-platform-jobs	Build/KnowledgePlatform/FlinkJobs	release-5.7.0_RC2	Deploy/KnowledgePlatform/FlinkJobs	release-5.5.0_RC1	Jobs to be deployed: 1. auto-creator-v2

Hot-fix 5.7.0 (27-02-2024)

Bugs:

1. CLONE - New framework category values are not getting saved while creating resource content - KN-972

Release Tags:

API Services:

Component	Service to be Build	Tag	Deploy Job	Deployment Tag	Comment
Knowledge-platform-jobs	Build/KnowledgePlatform/FlinkJobs	release-5.7.0_RC1	Deploy/KnowledgePlatform/FlinkJobs	release-5.5.0_RC1	Jobs to be deployed: 1. content-publish

Sunbird Content Editor:

Please build and deploy using blow content-editor and content-plugin tags for above bug fix.

Content Editor:

Tag: release-5.2.1_RC4

Content Plugins:

Tag: release-5.2.1_RC4

Hot-fix 5.7.0 (14-02-2024)

Bugs:

1. Portal: When content creator TN tried to save course, its throwing error "Something went wrong" -KN-973

2. [Mobile][SSO]: After accepting the Global Consent pop up, the user navigates to the 'Edit Profile' screen, where the user is unable to select the fields. - KN-974

Component	Service to be Build	Tag	Deploy Job	Deployment Tag	Comment
Knowledge-platform	Build/Core/Content	release-5.7.0_RC7	Deploy/Kubernetes/Content	release-5.6.0-knowlg_RC1
	Build/Core/Taxonomy	release-5.7.0_RC7	Deploy/Kubernetes/Taxonomy	release-5.6.0-knowlg_RC1

Configurations:

As part of this release, we moved retire API to content service. So, please update/add below kafka topic as a configuration.

kafka.topics.graph.event = "<ENV>.learning.graph.events"

Example: dev.knowlg.learning.graph.events

Hot-fix 5.7.0 (12-02-2024)

Bugs:

1. Configured Category values are not coming for the Draft and Published Text Book - KN-966

2. [SHALLOW COPY]: User is able to delete the Shallow copy created book where user should not be able to delete the Book. - KN-970

Component	Service to be Build	Tag	Deploy Job	Deployment Tag	Comment
Knowledge-platform	Build/Core/Content	release-5.7.0_RC6	Deploy/Kubernetes/Content	release-5.6.0-knowlg_RC1

5.7.0 (13-09-2023)

Discussion thread: https://github.com/orgs/Sunbird-Knowlg/discussions/146

Release timeline:

	Start date	End date
Planning phase	3-Jul, 2023	14-Jul, 2023
Sprint 1	17-Jul, 2023	4-Aug, 2023
Sprint 2	7-Aug, 2023	25-Aug, 2023
PPV	28-Aug, 2023	8-Sept, 2023
Prod	13-Sept, 2023 (delayed 2 days)

5.7.0 total scope: Link

Document Release Version

Project	Release Version	Date
Sunbird Knowlg	R5.7.0	13-Sept, 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.7.0:

Enhancements: Click here to view the list. (CSP changes was Hotfix taken as part of previous release, ticket updated for this release)

Bug Fixes - click here to see the list of bugs fixed in this release.

Test Scenarios: NA

Following are the Planned Tickets of R 5.7.0

New Features:

None

Enhancements / Technical tasks::

S.no	JIRA ID	Description
1	KN-502	Learning service deprecation
2	KN-920	Knowlg: CSP changes
3	KN-906	Refresh Lock API refactoring
4	KN-907	Retire Lock API refactoring
5	KN-908	List Lock API refactoring
6	KN-880	Create Lock API refactoring

Release Tags:

Upgrade Knowlg From 5.6.0 to 5.7.0

API Services:

Component	Service to be Build	Tag	Deploy Job	Deployment Tag	Comment
Schema upload	NA	NA	Deploy/Kubernetes/UploadSchema	release-5.7.0_RC4
Knowledge-platform	Build/Core/Content	release-5.7.0_RC4	Deploy/Kubernetes/Content	release-5.6.0-knowlg_RC1
	Build/Core/Taxonomy	release-5.7.0_RC4	Deploy/Kubernetes/Taxonomy	release-5.6.0-knowlg_RC1

user-pii-data-updater:

We can utilize the Flink job created by the inquiry team to update user PII data in Knowlg, along with the necessary configuration changes. The details are provided below for your reference:

Component	Service to be Build	Tag	Deploy Job	Deployment Tag	Comment
Flink Job	Build/job/KnowledgePlatform/job/InquiryFlinkJob	release-7.0.0_RC3	Deploy/job/dev/job/KnowledgePlatform/job/InquiryFlinkJob/	release-7.0.0_RC3	A New Flink Job user-pii-data-updater is added. This job is used to cleanup Personal Identifiable Information (PII) of deleted user from Asset metadata. (e.g: Content/Collection metadata). This job need pii configuration in each target object type configured. Ref for PII Config Sample: https://github.com/Sunbird-inQuiry/inquiry-api-service/blob/1e57d014004f4c515c50fa8af6fb0d0de6c0cb2d/schemas/question/1.1/config.json#L74 Config File Reference For Above Job: https://github.com/Sunbird-inQuiry/data-pipeline/blob/2297fe1288654283f586d1802d458f4238c1e3f6/kubernetes/helm_charts/datapipeline_jobs/values.j2#L264

Variables Added For user-pii-data-updater Flink job:

Variable Name	Description	Default Value
user_pii_updater_kafka_topic_name	Input Kafka Topic Name	{{ env_name }}.delete.user
user_pii_updater_group	Group Name For The Flink Job	{{ env_name }}-user-pii-updater-group
user_pii_target_object_types	Target Object Type and Schema Version should be configured as value . e.g: If you want to process 5 different objects for deleted user, then all 5 object types should be part of this configuration along with corresponding schema versions.	'{ "Content": ["1.0"], "Collection": ["1.0"] }'
user_pii_replacement_value	The value which need to be inserted for target pii fields.	"Deleted User"
admin_email_notification_enable	This falg is used to enable/disable email notification for admin	true
user_org_service_base_url	Base Url of userorg service for sending notification	"http://{{private_ingressgateway_ip}}/userorg"
email_notification_subject	Subject Line for Email Notification	"User Account Deletion Notification"
email_notification_regards	Value For Regards in Email Notification	"Team"

NOTE: If any adopter is deploying Knowlg alone, they should extract this specific job from the inQuiry codebase and include the mentioned configurations. Alternatively, if they are using both Knowlg and inQuiry, they only need to update the configuration values for user_pii_target_object_types that encompass both Knowlg and inQuiry objects.

Configuration/Environment variable changes:

In this release, we have deprecated the Sunbird Learning service, including an API that was previously served by this service. We have relocated this API to the Sunbird content service. Consequently, we need to update the Kong file to ensure that the upstream URL for the license validation API (asset/v3/validate) points to the Content service instead of the Learning service.

Breaking changes (The existing features will break the if we don’t do the below actions):

During the upgrade to version 5.7.0, it is essential to ensure that the mentioned services and environments are properly updated. Previously, the APIs mentioned were part of the sunbird-learning-service, but now they have been moved to the content-service without altering the API contract. Additionally, changes have been made to ensure that these APIs are no longer served from the sunbird-learning-service.

Therefore, it is crucial to verify that the necessary updates are implemented correctly for a smooth transition to version 5.7.0.

List of APIs moved to Content Service:

S.No	API
1	/asset/v3/validate