Skip to content

Azure: Onboarding Reservoir DDMS

Service name: Reservoir DDMS

The following steps must be completed for a service to onboard with OSDU on Azure.

Onboarding Steps:

Service design review and planning

Infrastructure and Initial Requirements

  • Create helm charts for service. The charts for each service are located in the devops/azure directory. You can look at charts from other services as a model. The charts will be nearly identical except for the different environment variables, values, etc each service needs to run.
  • Service is deployed into its own namespace (ddms-reservoir).
  • Service has its own ingress.
  • If there are new entitlements for this DDMS, add them to the list of groups used to bootstrap a data partition that can be found here.
  • If there are new entitlements for this DDMS, add them to the list of groups used to bootstrap the opendes data partition found here.
  • Create an Istio auth policy in the devops/azure/chart/templates directory for the service. Here is an example of an Istio auth policy that is generic and can be used by other services. Link.
  • Add any test data that is required for the service integration tests. Link.
  • Update upload-data.py to upload any new test data files you created. Link.

Developer Experience

  • Verify that the README for the Azure provider correctly and clearly describes how to run and test the service.
  • Community PR requirements are enforced for the repo by default.

Development and Demo Azure Devops Pipelines

  • Create development ADO pipeline at devops/azure/development-pipeline.yml in the service repo.
  • Verify development pipeline passes in ADO.
  • Create documentation on how to add this service to an existing ADO project.

Functional Validations

  • Service Swagger is reachable.
  • Service passes all integration tests.
  • Service is able to pass any end-to-end workflows that have been defined.

Release

  • Relase helm charts created.
  • Release helm charts validated.
  • Release helm charts uploaded to Azure ACR.
  • Release documentation for helm-charts-azure written and verified.

Required Documentation

  • What entity types do this service manage:

    TODO: Provide link or info here

  • Functional Swagger Link:

    TODO: Provide link or info here

  • Instructions on how to run and test the service locally:

    TODO: Provide link or info here

  • Instructions for creating ADO pipeline for the service:

    TODO: Provide link or info here

  • What are the entitlements required to call the different endpoints for this service:

    TODO: Provide link or info here

  • What Compute RG level infrastructure is required to run this service:

    TODO: Provide link or info here

  • What Data Partition RG level infrastructure is required to run this service:

    TODO: Provide link or info here

  • How is the infrastructure for this service deployed:

    TODO: Provide link or info here

  • What is the default tier/scaling for the service-specific infrastructure:

    TODO: Provide link or info here

  • Are the schemas included in WKS [YES/NO]. If not, how will customers load the schemas:

    TODO: Provide link or info here

  • Link to a postman collection where a customer can find an end-to-end workflow for the service:

    TODO: Provide link or info here

Edited by Yunhua Koglin