SMDS: RETINA Onboarding

Consumer Application Details | Pre-requisite | Creation of New Topics | Addition of a New Tenant

Consumer Application Details

• Application Name(s) Please provide the names of the application(s) involved.
• Data Topics Required Specify the necessary topics, such as Customer, Contact, Facility, and Concern.
• Primary and Secondary Points of Contact Identify the primary and secondary points of contact responsible for communication and coordination.
• Team Email Distribution List (DL) Share the team’s email distribution list for correspondence.
• Detailed Business/Benefit Case Outline the business case and the benefits of utilizing this data, including its intended applications.
• Application ID(s) for Consumer List Provide the application ID(s) that should be added to the consumer list.
• Tentative Testing Dates (SIT, PP, and Prod) Share the tentative dates for consumption in SIT, PP, and Production environments. Please send an email confirmation once consumption testing is successfully completed in each environment.
• Tentative Bulk Testing Date Provide a tentative date for bulk data testing in either SIT or PP to help mitigate unexpected issues related to high outbound loads in production.

Pre-requisite

• Access to the Retina Github Repository - Maersk-Global/empv3-tenant-intake: Tenant Intake Repo to handle RETinA Self-service requests for all environments.
• Access to the MIM Repository - Maersk-Global/API-JSON-Schema-Definitions: Maersk JSON schema specifications, OpenAPI definitions, GraphQL, Avro schema and sample data repository for all platforms and projects.
• Ensure that the Avro/Json Schemas are approved and present in the correct path.
• The email of the user who will be raising the PR should be included in the tenant.yml file under the dev team section.
• Please ensure your GitHub primary email ID is NOT private.
• Access to the Hashicorp Vault for viewing secrets - Retina::Vault

Creation of New Topics

• Clone the repo - EMPV3-Tenant-Intake
• Create a new branch from the main branch.
• Navigate to the correct folder based on the domain for which the topic is being created:
  • CMD PP: data/shared/smds-cmd/pp/topic
  • CMD Prod: data/shared/smds-cmd/prod/topic
  • OPS PP: data/shared/smds/pp/topic
  • OPS Prod: data/shared/smds/prod/topic
• Prepare a topic file named according to the following standards:
  • File name syntax: <environment>-<region>-shared-<productkey>-<unique-topic-identifier>-topic.json
  • Example: pp-west-2-shared-smds-cmd-MSK.commercial.customer.topic.internal.any.v3-topic.json
• Add the following mandatory parameters in the topic JSON file (for reference - MSK.commercial.customer.topic.internal.any.v3-topic.json):

{
  "k8sclustername": "<cluster_name>",
  "topicname": "<topic_name>",
  "region": "<region>",
  "partition": <partition>,
  "schema": {
    "schema_type": "<schema_type>",
    "key_schema_url": "<schema_url>",
    "value_schema_url": "<schema_url>"
  }
}

• Add additional parameters based on requirements, such as enabling log compaction, etc.
• Commit and push your changes to the new branch you created and raise a PR to the main branch.
• Once the PR is raised, an automatic GitHub action will be triggered to validate the user inputs.
• Upon successful validation, the pull request will be automatically approved and merged.
• Topic creation can be verified on the Retina Manager dashboard:
  • PP - Retina Manager - PP
  • Prod - Retina Manager - Prod

Addition of a New Tenant

• Ensure an email request has been sent by the requesting tenant and approved by Ajit Vijay Daware / User e8ff2 after the tenant provides the following information:

Application Name(s): Primary / Secondary Point of Contact: Team email list: Benefit case & how you plan to use this data: Application ID(s) to be added in consumer list: Tentative dates in SIT, PP and Prod consumption (please send out mail confirmation of successful consumption testing in each env): Tentative date for bulk testing in either SIT or PP (to prevent surprises in production due to high outbound loads):

• Once approved, clone the repo if not done already - EMPV3-Tenant-Intake
• Create a new branch from the main branch.
• Navigate to the correct folder based on the domain for which the tenant needs to be added:
  • CMD: data/shared/smds-cmd/tenant.yml
  • OPS: data/shared/smds/tenant.yml
• Add the tenant name under the appropriate section:
  • PP - consumer_auth > pp > auth_tenant (for the topic tenant needs to be added to) > Read
  • Prod - consumer_auth > prod > auth_tenant (for the topic tenant needs to be added to) > Read
• Commit and push your changes to the new branch you created and raise a PR to the main branch.
• Once the PR is raised, an automatic GitHub action will be triggered to validate the user inputs.
• Upon successful validation, the pull request will be automatically approved and merged.
• Reply in the same email thread confirming that the tenant has been successfully added and ask them to verify the same.

If the tenant is already approved as a consumer for EMP V2 topics, they can directly migrate across all three environments. However, if the request originates from a new tenant system, confirmation of successful consumption after being added to each environment is required.