Skip to content

Entitlements V2 Service Onboarding

Service name: Entitlements

The following steps must be completed for a service to onboard with OSDU on Azure. Additionally, please add the Service Onboarding tag to this issue when it is created.

For more information, visit our service onboarding documentation here.

Steps:

Infrastructure and Initial Requirements

  • Add any additional Azure cloud infrastructure (Cosmos containers, Storage containers, fileshares, etc.) to the Terraform template. Link. Note that if the infrastructure is a part of the data-partition template, you may need to add secrets to the keyvault that are partition specific; if doing so, update the createPartition REST request to include the keys that you have added so they are accessible in service code. Link
  • Create an ingress point for the service. 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.
  • Update the integration tester with any entitlements required to test the service. Link
  • Add in any new secrets that the service needs to run. Link
  • Create environment variable script to generate .yaml files to be used with Intellij EnvFile plugin and .envrc files to be used with direnv. Link

Gitlab Code and Documentation

  • Complete the service code such that it passes all integration tests locally. There is some documentation on starting off implementing an Azure provider. Link
  • 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. Link
  • Implement Istio for the service if this has not already been done. Here is an example MR that shows what steps are required. Link
  • Create an Istio auth policy in the devops/azure/chart/templates directory. Here is an example of an Istio auth policy that is generic and can be used by other services. Link
  • Add any variables that are required for the service integration tests to the Azure CI-CD file. Link
  • Verify that the README for the Azure provider correctly and clearly describes how to run and test the service. There is a README template to help. Link
  • Push any changes and verify that the Gitlab pipeline is passing in master.

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 Demo ADO pipeline at devops/azure/pipeline.yml in the service repo.
  • Verify demo pipeline is passing in ADO.

User Documentation

  • Add the service to the mirror pipeline instructions. Link
  • Add the service to the manual deployment instructions. Link
  • Add any required variables to the already existing variable group instructions for automated deployment. You should know if any variables need to be added to existing variable groups from creating the development and demo pipelines. Link
  • Add a variable group Azure Service Release - $SERVICE_NAME to the documentation. You should know what values to set for this variable group from creating the development and demo pipelines. Link
  • Add a step for creating the service pipeline at the bottom of the service-automation page. Link
  • Create a rest script with sample calls to the service for users. Link

Setup:

  1. Create an empty repo entitlements
  2. Add a variable into Mirror Variables

ADO_ORGANIZATION and ADO_PROJECT should be your actual names.

Variable Value
ENTITLEMENTS_REPO https://dev.azure.com/${ADO_ORGANIZATION}/$ADO_PROJECT/_git/entitlements
  1. Edit the Mirror Pipeline and add the task
    - task: swellaby.mirror-git-repository.mirror-git-repository-vsts-task.mirror-git-repository-vsts-task@1
      displayName: 'entitlements'
      inputs:
        sourceGitRepositoryUri: 'https://community.opengroup.org/osdu/platform/security-and-compliance/entitlements.git'
        destinationGitRepositoryUri: '$(ENTITLEMENTS_REPO)'
        destinationGitRepositoryPersonalAccessToken: $(ACCESS_TOKEN)
  1. Run the Mirror Pipeline
  2. Create a Variable Group Azure Service Release - entitlements with the variables:
Variable Value
MAVEN_DEPLOY_POM_FILE_PATH drop/provider/entitlements-v2-azure
MAVEN_INTEGRATION_TEST_OPTIONS -DargLine=""
MAVEN_INTEGRATION_TEST_POM_FILE_PATH drop/deploy/testing/entitlements-v2-test-azure/pom.xml
SERVICE_RESOURCE_NAME $(ENTITLEMENTS_SERVICE_NAME)
  1. Create a Pipeline service-entitlements against the Repo entitlements-service for file /devops/azure/pipeline.yml
  2. Execute the Pipeline
Edited by Rostislav Vatolin