Upgrade Sunbird release document

Overview

Release note:

This page details out the jobs required to be run as part of the upgrade from Sunbird Ed and CoKreat release 5.1.0 to release 5.2.0. Use the following table to understand the jobs that need to be executed in order to successfully complete the upgrade. Any jenkins job configuration or pre-requisites mentioned under manual configuration section needs to be done first before running any of the mentioned jobs. The order of the jobs should also be run as shown below. They can be run in parallel to speed up the execution.

Build and Deploy for Sunbird

Sunbird_ED:

Service

Build job

Build tag

Deploy Job

Deploy tag

Comments

Mobile App

Mobile/job/Sunbird-IONIC-Mobile-App/

Portal

Build/Core/Player

Deploy/Kubernetes/Player

ML Services

Build/managed-learn/ml-projects-service

Deploy/managed-learn/ml-projects-service

Build/managed-learn/ml-core-service

Deploy/managed-learn/ml-core-service

Build/managed-learn/ml-reports-service

Deploy/managed-learn/ml-reports-service

ML-Analytics

Deploy/managed-learn/ml-analytics-service

Other

Deploy/Kubernetes/OnboardAPI

Deploy/Kubernetes/OnboardConsumers

Deploy/Kubernetes/nginx-public-ingress

Deploy/DataPipeline/InternalKong

Sunbird-Knowlg

Service/Compon

Build job

Build tag

Deploy Job

Deploy tag

Comments

Sync tool

Build/KnowledgePlatform/SyncTool

Content service

Build/Core/Content

Deploy/Kubernetes/Content

Taxonomy service

Build/Core/Taxonomy

Deploy/Kubernetes/Taxonomy

DIAL service

Build/Core/Dial

Deploy/Kubernetes/Dial

Learning service

Build/KnowledgePlatform/Learning

Deploy/KnowledgePlatform/Learning

Knowlg middleware

Build/Core/KnowledgeMW

Deploy/Kubernetes/KnowledgeMW

Knowlg platform jobs

Build/KnowledgePlatform/FlinkJobs

Deploy/KnowledgePlatform/FlinkJobs

Interactive editor

Build/Plugins/ContentEditor

Deploy/Plugins/ContentEditor

Content plugins

Build/Plugins/ContentPlugins

Deploy/Plugins/ContentPlugins

File upload editor

Build/Plugins/GenericEditor

Deploy/Plugins/GenericEditor

Sunbird Lern

Service/Component	Build job	Deploy Job
User & Org service	Build/Core/Learner	Deploy/Kubernetes/Learner
LMS	Build/Core/Lms	Deploy/Kubernetes/Lms
Certificate	Build/Core/Cert	Deploy/Kubernetes/Cert
Lern data products	Build/Lern/LernDataProducts	Deploy/Lern/LernDataProducts
Lern jobs	Build/Lern/LernFlinkJobs	Deploy/Lern/LernFlinkJobs

Service/Component

Build job

Build tag

Deploy Job

Deploy tag

Comments

User & Org service

Build/Core/Learner

Deploy/Kubernetes/Learner

LMS

Build/Core/Lms

Deploy/Kubernetes/Lms

Certificate

Build/Core/Cert

Deploy/Kubernetes/Cert

Lern data products

Build/Lern/LernDataProducts

Deploy/Lern/LernDataProducts

Lern jobs

Build/Lern/LernFlinkJobs

Deploy/Lern/LernFlinkJobs

Sunbird Inquiry

Service to be Build

Build Tag

Service to Deploy

Deploy Tag

Comments

Deploy/Kubernetes/InquiryUploadSchema

Build/Core/Assessment

Deploy/Kubenetes/Assessment

Build/job/KnowledgePlatform/InquiryFlinkJob

Deploy/KnowledgePlatform/InquiryFlinkJob

Build/Core/Analytics

Deploy/Kubernetes/Analytics

Sunbird Obsrv

Service to be Build	Build Tag	Service to Deploy	Deploy Tag	Comments
Build/Core/Analytics		Deploy/Kubernetes/Analytics

Service to be Build

Build Tag

Service to Deploy

Deploy Tag

Comments

Build/Core/Analytics

Deploy/Kubernetes/Analytics

Variables to update for Ed and vdn

variable name	description	Value
		'true'

variable name

description

Value

'true'

Add below Api's in Internal Kong configuration

Check if below api's exists or not before adding, if exists replace the existing one if not add it.

Add below variables in Core,KnowledgePlatform and Datapipeline inventory for ED and vdn

Refer to variables and comment section from here link to update below variables.

storage_endpoint variables for public, private, management and artifact is not required in current release, give empty string as value (cloud_public_storage_endpoint, cloud_private_storage_endpoint, etc)

// ###### common.yml ###############

cloud_public_storage_accountname: ""
cloud_public_storage_endpoint: ""
cloud_public_storage_region: ""
cloud_public_storage_project: ""

cloud_private_storage_accountname: ""
cloud_private_storage_endpoint: ""
cloud_private_storage_region: ""
cloud_private_storage_project: ""

cloud_management_storage_accountname: ""
cloud_management_storage_endpoint: ""
cloud_management_storage_region: ""
cloud_management_storage_project: ""

cloud_artifact_storage_accountname: ""
cloud_artifact_storage_endpoint: ""
cloud_artifact_storage_region: ""
cloud_artifact_storage_project: ""

Refer to variables and comment section from here link to update below secrets variables

// ########## secrets.yml ###############
cloud_public_storage_secret: ""
cloud_private_storage_secret: ""
cloud_management_storage_secret: ""
cloud_artifact_storage_secret: ""

Refer to variables and comment section from here link to update below variables

// ############# common.yml ##############
cloud_storage_certqr_bucketname: "certqr"
cloud_storage_chatbot_bucketname: "chatbot"
cloud_storage_dial_bucketname: "dial"
cloud_storage_flink_bucketname: "flink-state-backend"
cloud_storage_playercdn_bucketname: "player"
cloud_storage_public_bucketname: "public"
cloud_storage_publicreports_bucketname: "public-reports"
cloud_storage_privatereports_bucketname: "reports"
cloud_storage_samiksha_bucketname: "samiksha"
cloud_storage_schema_bucketname: "schema"
cloud_storage_sourcing_bucketname: "sourcing"
cloud_storage_offlineinstaller_bucketname: "{{env}}-offlineinstaller"
cloud_storage_content_bucketname: "sunbird-content-{{env}}"
cloud_storage_telemetry_bucketname: "telemetry-data-store"
cloud_storage_termsandcondtions_bucketname: "termsandcondtions"
cloud_storage_user_bucketname: "user"
cloud_storage_desktopappcrashlogs_bucketname: "desktopappcrashlogs"
cloud_storage_label_bucketname: "label"
cloud_storage_certservice_bucketname: "{{env}}-e-credentials"
cloud_storage_uci_bucketname: "uci-staging"
cloud_storage_cassandrabackup_bucketname: "cassandra-backup"
cloud_storage_dpcassandrabackup_bucketname: "dp-cassandra-backup"
cloud_storage_dppostgresbackup_bucketname: "dp-postgresql-backup"
cloud_storage_dpredisbackup_bucketname: "dp-redis-backup"
cloud_storage_esbackup_bucketname: "elasticsearch-snapshots"
cloud_storage_influxdbbackup_bucketname: "influxdb-backup"
cloud_storage_jenkinsbackup_bucketname: "jenkins-backup"
cloud_storage_mongobackup_bucketname: "mongodb-backup"
cloud_storage_neo4jbackup_bucketname: "neo4j-backup"
cloud_storage_redisbackup_bucketname: "redis-backup"
cloud_storage_artifacts_bucketname: "{{ artifacts_container }}"

Variables to remove from inventory
delete below variables from core/common.yml if its defined.
upstream_url
plugin_upstream_url
discussion_upstream_url

Migrations

Please execute the migration instructions mentioned by the dependent building blocks

Building Block	Migration Instructions link
Knowlg	https://knowlg.sunbird.org/learn/product-and-developer-guide/other/data-migration
InQuiry	https://project-sunbird.atlassian.net/wiki/spaces/SBDES/pages/3259105331/inQuiry+CSP+migration+verification+steps
Lern	https://lern.sunbird.org/use/release-notes/release-v-5.0.1#data-migrations-run-these-scripts-after-service-deployment

Building Block

Migration Instructions link

Knowlg

https://knowlg.sunbird.org/learn/product-and-developer-guide/other/data-migration

InQuiry

https://project-sunbird.atlassian.net/wiki/spaces/SBDES/pages/3259105331/inQuiry+CSP+migration+verification+steps

Lern

https://lern.sunbird.org/use/release-notes/release-v-5.0.1#data-migrations-run-these-scripts-after-service-deployment

CoKreat Deployments and migration

Please follow the instructions mentioned in the below link by CoKreat building block to upgrade CoKreat from 5.0.0 to 5.1.0

Variables lists and build tag is same for Ed and vdn. Use release-5.1.0-vdn_RC1 for knowlg service deployments in VDN

cokreat- Release v5.1.0 (Upcoming release)Sunbird coKreat

Last updated 7 months ago