Running an OpenCRVS deployment

Preparation steps

Before you can deploy, you need to make sure that your country configuration Docker image has compiled and has been pushed to your container registry (E.G. Dockerhub). This was explained previously in Building, pushing & releasing your countryconfig code

Copy the tag associated with your countryconfig Docker container image because you will use it in the next step.

Run OpenCRVS Deployment

You can deploy to your server using the automated "Deploy OpenCRVS" Github Action for any environment created at Create a GitHub Environment step.

1. Navigate to GitHub Actions within infrastructure repository

2. Select "Deploy OpenCRVS" workflow

3. Enter the Tag of the core image. This usually corresponds to the OpenCRVS release tag, e.g. v2.0.0.

4. Enter the Tag of the country config image. Use the tag of the image built from your fork of the country config repository.

5. For the initial deployment, enable the “Data seeding during deployment” option. Note: You can also seed the environment later.

6. Select "Target environment" from dropdown menu.

7. Click "Run workflow" button, and monitor the run logs to ensure that the deployment completes successfully.

Deploy OpenCRVS GitHub Actions Workflow options

Verification steps

• Verify workflow was completed successfully

• Verify resources are up and running after deployment: kubectl get pods -n opencrvs-<env>

• Make sure all helm pre-/post-deploy hooks completed successfully:

  kubectl get jobs

• Access opencrvs in browser: https://<your domain> , see Login to an OpenCRVS server