v1.4.0 Release notes

In OpenCRVS v1.4.0 we have entirely refactored infrastructure provisioning in opencrvs-countryconfig. There are no changes to opencrvs-core.

Upgrading from v1.3.0 to v1.4.0 requires the upgrade Migration Notes to be followed precisely.

Documentation updates

The documentation section 3.3 Set-up a server hosted environment has been entirely re-written for the new infrastructure provisioning tasks. We recommend that you read it before continuing.

Note

In the next OpenCRVS release v1.5.0, there will be two significant changes:

  • The infrastructure directory and related pipelines will be moved to a new repository.

  • Both the new infrastructure repository and the OpenCRVS country resource package repositories will start following their own release cycles, mostly independent from the core's release cycle. From this release forward, both packages are released as "OpenCRVS minor compatible" releases, meaning that the OpenCRVS countryconfig 1.3.0- is compatible with OpenCRVS 1.3.0, 1.3.1, 1.3.2, etc. This allows for the release of new hotfix versions of the core without having to publish a new version of the infrastructure or countryconfig.

New features

šŸ”’ Entirely reconfigured infrastructure and provisioning scripts for new servers. Each server is now SSH secured with Google Authenticator.

šŸ”’ Backup server now automatically provisioned. Production environments automatically back up to backup server and they are automatically restored onto staging, thus reducing monitoring and maintenance tasks.

An example Wireguard VPN configuration is now supplied.

We now recommend creating a new Ubuntu user provision with passwordless sudo rights for all automated operations on the server, instead of using the root user. New users for different operations will be created in future releases.

All human users on all servers now have their own Linux users with mandatory 2-factor authentication.

OpenCRVS now has an interactive script environment:init for creating new Github environments and defining secrets. This script should also be run for existing environments to ensure all variables and secrets are defined, especially important when pulling the latest changes from the repository to your own country resource package.

The environment creator script also manages the known hosts file automatically.

šŸš° New pipeline for automatic provisioning of Ubuntu servers (all environments).

šŸš° New pipeline for resetting data from an environment (non-production environments).

šŸš° New pipeline for resetting SSH 2FA for all environments.

šŸš° Development deploy pipeline now includes a "debug" option for SSHing into the action runner (non-production environments).

A new "staging" environment has been introduced, acting as a production environment clone that resets its data nightly to match the production environment.

The deployment script can now verify if there are undefined environment variables referred to in your compose files. All secrets and variables defined in Github Environments are automatically passed down to the deployment script.

šŸ”’ Backup archives are now secured with a passphrase.

HTTPS setup now offers three options: HTTP challenge, DNS challenge, and using a pre-issued certificate file.

There's now a generic purpose POST /email endpoint only available from the internal network. Elastalert2 is configured to use this endpoint instead of directly using SMTP details or the Sendgrid API key.

šŸ”’ QA environment now hosts a Wireguard server and admin panel (wg-easy). After deploying, you can access the admin panel at vpn..

Allow configuring additional SSH parameters globally using SSH_ARGS Github variable.

Breaking changes

  • Added examples for configuring HTTP-01, DNS-01, and manual HTTPS certificates. By default, development and QA environments use HTTP-01, while others use DNS-01.

  • An automated script now generates all secrets & variables defined in Github Secrets and creates appropriate Github environments. They are now passed automatically to the deployment script.

  • The VPN_HOST_ADDRESS variable is now required for staging and production installations to ensure deployments are not publicly accessible.

  • Replica limits have been removed; any number can now be deployed.

  • Each environment now has a dedicated docker-compose--deploy.yml. Use environment:init to create a new environment and generate a corresponding file for customizable configurations.

  • šŸ”’ OpenHIM console is no longer exposed via HTTP.

  • Ansible playbooks are refactored into smaller task files.

  • Known hosts are now defined in the infrastructure/known-hosts file. You can clear the file and use bash infrastructure/environments/update-known-hosts.sh <domain> to add your own domains.

  • Ansible inventory files are now in .yml format. Please convert your old production.ini and similar files to this new format.

  • The authorized_keys file has been removed, and keys should now be defined in the inventory yaml files.

  • The DOCKER_PASSWORD secret has been replaced with DOCKER_TOKEN.

Last updated