For the complete documentation index, see llms.txt. This page is also available as Markdown.

Running validation checks

Run validation checks

"Deploy OpenCRVS" workflow runs validation checks before and after deployment to confirm that the environment is ready and that the deployed services are reachable. Use following stepts to run validation checks manually

  1. Navigate to GitHub Actions within infrastructure repository

  2. Select "10. Validate pre/post deploy" action

  3. Select "Target environment" from dropdown menu, all environments created at Create a GitHub Environment step should be listed here.

  4. Select "Target stage":

    1. predeploy

    2. postdeploy

  5. Enter the Tag of the core image currently deployed (or about to be deployed), e.g. v2.1.0

  6. Click "Run workflow" button

Deployment validation checks

Stage
When to run
What it checks

Pre-deployment validation

Before running the deployment

Required datastores are reachable from the deployment environment, and SMTP configuration is present when two-factor authentication is enabled.

Post-deployment validation

After deployment completes

Public service domains resolve in DNS, have valid HTTPS certificates, are covered by the certificate SANs, and respond over HTTPS. SMTP connectivity is also checked when SMTP is configured.

Following checks are running at pre-deployment:

  • Postgres connectivity

  • Redis connectivity

  • MinIO connectivity

  • Elasticsearch connectivity, if configured

  • SMTP configuration:

    • Server availability

    • Configuration

Following checks are running at post-deployment:

  1. For each public domain, validation runs the following checks in order:

    1. DNS resolution

    2. SSL certificate fetch

    3. SSL certificate SAN coverage

    4. HTTPS availability

    5. Public IP check: a warning (not a failure) is reported when an OpenCRVS domain resolves to a public IP address

  2. Events service readiness check

  3. Email integration check

Last updated