LR-122: Lern repo and pod name correction to match the component name
- Anil Gupta
Introduction
Currently all the component names, repo names, pod names, and service names are not in sync with respect to naming.
LR-122: Lern repo and pod name correction to match the component name - DevelopmentDone
Background & Problem Statement
Adopters are confused because the names are not in sync. e.g., currently sunbird-lms-service is the repo name for the UserOrg component, but lms-service is the service name for the Batch service component.
Key Design Problems
Names are not is sync for component, repo, pods and service.
Design
Aligning or suggesting the names based on the features they have, the table below has details about existing names and suggested names for the required ones.
Component Name | Repo Name | Telemetry Data | JAR Name | K8s Deploy Name | Service Name | Features |
|---|---|---|---|---|---|---|
UserOrg Suggested: User Management Service UserOrg | sunbird-lms-service Suggested: user-management-service userorg-service | pdata.id=<env>.sunbird.learning.service pdata.pid=learner-service Suggested: pdata.id=<env>.sunbird.user.management.service pdata.pid=user-management-service pdata.id=<env>.sunbird.user.org.service pdata.pid=userorg-service | learning-service-1.0-SNAPSHOT.jar Suggested: user-management-service-1.0-SNAPSHOT.jar userorg-service-1.0-SNAPSHOT.jar | learner Suggested: user-management userorg | learner-service Suggested: user-management-service userorg-service |
|
Batch Service Suggested: LMS Service | sunbird-course-service Suggested: lms-service | pdata.id=<env>.sunbird.learning.service pdata.pid=lms-service Suggested: pdata.id=<env>.sunbird.lms.service | lms-service-1.0-SNAPSHOT.jar | lms | lms-service |
|
Group Service | groups-service | telemetry_pdata_id=dev.sunbird.groups.service | group-service-1.0.0.jar | groups | groups-service |
|
Notification Service | sunbird-notification-service Suggested: notification-service | telemetry_pdata_id=dev.sunbird.notifications.service | notification-service-1.0.0.jar | notification | notification-service |
|
Notes:
After renaming the service name, if any service is calling directly using the service url (e.g., http://learner-service:9000 needs to be updated with http://userorg-service:9000), then that service needs to change in its config/code.
There will be no change in kong-api endpoints.