Entities Sprint 19.4a Release (includes Digital Business Card)

[severinbeauvais]

This release contains Entity + Digital Business Card changes.

Prior to moving into production, the following steps should be completed or confirmed:

• Add release # to this ticket

• Update version numbers in the code being released and list them here:

  • Business Create UI v5.5.8
  • Business Edit UI v4.7.4 unchanged in this release
  • Business Filings UI v7.0.5
  • Legal API v2.94.0 (last commit on release-2.94.0 branch: 8994805)
  • Entity Emailer v2.94.0
  • Entity Filer v2.94.0
  • Entity BN v2.94.0
  • Update Colin Filings Job
  • Update Legal Filings Job

• Ensure deployment steps are filled in - remove/replace placeholders

• Create a draft release in GitHub and confirm the correct commits are present

1. • Confirm the correct commits are present
2. • Select appropriate target is selected which represents the build in Test - either a commit from recent commits or a reference to a branch
3. • Autogenerate release notes using last release tag as a point of reference. Update change list manually if required.

• Dev to ensure that the commit list is represented on the release report
• QA to schedule the release with staff/clients (daytime's best or when staff are available for rollback)
• All dev/test pipeline test suites green
• Dev/QA chat to plan prod verification testing (unless already automated)
• Post message that projects are being deployed to Prod in Entities Product Team channel
• Release the code to production and complete smoke test (STEPS BELOW)
• Post message that projects have been deployed to Prod in Entities Product Team channel and OPS Team channel
• Finalise/publish the release in GitHub, tagging it
• Merge release branch back to master (if applicable)
• Change openshift builds/pipelines back to master (if applicable)

Deployment Steps

Dev:

• Create UI v5.5.8 - auto deployed by CD script
• Edit UI v4.7.4 - deployed by SB to replace Legal Name branch build with main branch build
• Filings UI v7.0.5 - auto deployed by CD script
• Legal API v2.94.0 auto deployed by CD script
• Entity Emailer v2.94.0 auto deployed by CD script
• Entity Filer v2.94.0 auto deployed by CD script
• Entity BN v2.94.0 auto deployed by CD script
• Update Colin Filings Job auto deployed by CD script
• Update Legal Filings Job auto deployed by CD script

.

• get Tenant ID + API key for BCROS for Dev, then update 1Password
• config map changes
  • in entity vault, change GUNICORN_PROCESSES to 1
  • in bbdc vault, add TRACTION_API_URL
  • in bbdc vault, add TRACTION_PUBLIC_SCHEMA_DID
  • in bbdc vault, add TRACTION_PUBLIC_ISSUER_DID
  • in bbdc vault, add TRACTION_TENANT_ID
  • in bbdc vault, add TRACTION_API_KEY
  • in bbdc vault, add BUSINESS_SCHEMA_ID
  • in bbdc vault, add BUSINESS_CRED_DEF_ID
  • in entity vault, update COLIN_URL under filings-job application
  • in entity vault, update COLIN_API under entity-filer application
• are there any dependencies, such as an auth/pay deployment or keycloak changes? no
• are there any one-time scripts to be run, such as for data migration?
• database updates which should be run automatically as part of GH CD via the legal-api pre-hook
  • Update credential_id field from length 100 to length 10 in dc_issued_credentials table
  • Add credential_revocation_id field to dc_issued_credentials table
  • Add revocation_registry_id field to dc_issued_credentials table
  • Add new dc_issued_business_user_credentials table
  • Verify version_num field in alembic_version table has value of 6e28f267db2a

Test:

• Create UI v5.5.8 - done by SB on Nov 8, 2023
• Edit UI v4.7.4 - done by SB on Nov 8, 2023 (see note in Dev above)
• Filings UI v7.0.5 - done by SB on Nov 8, 2023
• Legal API v2.94.0 - done by AC on Nov 15, 2023
• Entity Emailer v2.94.0 - done by AC on Nov 8, 2023
• Entity Filer v2.94.0 - done by AC on Nov 8, 2023
• Entity BN v2.94.0 - done by AC on Nov 8, 2023
• Update Colin Filings Job - done by AC on Nov 8, 2023
• Update Legal Filings Job - done by AC on Nov 8, 2023
  .
• get Tenant ID + API key for BCROS for Test
• config map changes
  • in bbdc vault, add TRACTION_API_URL
  • in bbdc vault, add TRACTION_PUBLIC_SCHEMA_DID
  • in bbdc vault, add TRACTION_PUBLIC_ISSUER_DID
  • in bbdc vault, add TRACTION_TENANT_ID
  • in bbdc vault, add TRACTION_API_KEY
  • in bbdc vault, add BUSINESS_SCHEMA_ID
  • in bbdc vault, add BUSINESS_CRED_DEF_ID
  • in entity vault, update COLIN_URL under filings-job application
  • in entity vault, update COLIN_API under entity-filer application
• database updates which should be run automatically as part of GH CD via the legal-api pre-hook
  • Update credential_id field from length 100 to length 10 in dc_issued_credentials table
  • Add credential_revocation_id field to dc_issued_credentials table
  • Add revocation_registry_id field to dc_issued_credentials table
  • Add new dc_issued_business_user_credentials table
  • Verify version_num field in alembic_version table has value of 6e28f267db2a

Prod:

• Create UI v5.5.8 - done by SB on Nov 16, 2023
• Edit UI v4.7.4 not needed; is already in Prod
• Filings UI v7.0.5 - done by SB on Nov 16, 2023
• Legal API v2.94.0 - done by AC on Nov 16, 2023
• Entity Emailer v2.94.0 - done by AC on Nov 16, 2023
• Entity Filer v2.94.0 - done by AC on Nov 16, 2023
• Entity BN v2.94.0 - done by AC on Nov 16, 2023
• Update Colin Filings Job - done by AC on Nov 16, 2023
• Update Legal Filings Job - done by AC on Nov 16, 2023
  .
• get Tenant ID + API key for BCROS for Prod
• config map changes
  • in bbdc vault, add TRACTION_API_URL
  • in bbdc vault, add TRACTION_PUBLIC_SCHEMA_DID
  • in bbdc vault, add TRACTION_PUBLIC_ISSUER_DID
  • in bbdc vault, add TRACTION_TENANT_ID
  • in bbdc vault, add TRACTION_API_KEY
  • in bbdc vault, add BUSINESS_SCHEMA_ID
  • in bbdc vault, add BUSINESS_CRED_DEF_ID
  • in entity vault, update COLIN_URL under filings-job application
  • in entity vault, update COLIN_API under entity-filer application
• database updates which should be run automatically as part of GH CD via the legal-api pre-hook
  • Update credential_id field from length 100 to length 10 in dc_issued_credentials table
  • Add credential_revocation_id field to dc_issued_credentials table
  • Add revocation_registry_id field to dc_issued_credentials table
  • Add new dc_issued_business_user_credentials table
  • Verify version_num field in alembic_version table has value of 6e28f267db2a
• notify the team via the OPS Team channel
• delete old ACA keys from 1Password for Dev/Test/Prod

Smoke Test Script

• load Filings UI for a sole prop, as a regular user, and test basic DBC feature (to verify interop)
• click "Get your Business Card Credential" button to verify basic functionality
• watch Sentry logs for 60 minutes
• watch Kibana logs for 60 minutes

[severinbeauvais]

@amanji Do you have some simple way to smoke test Digital Credentials in Prod to verify that things are working properly (especially config/communication between modules/systems)?

Update: Mihai verified that DBC is not visible in Prod for reg user and a sole prop, which is as expected because a FF still disables this feature.