CSB 004 - bcgov/common-service-showcase GitHub Wiki
March 26th 2021
What is happening?
Hi here teams! Support for the Common Hosted Email Service (CHES) on OCP3 will be partially extended to the end of April. After this date, the old OCP3 endpoint will be deprecated and shut down.
We are extending support for OCP3 because we are expecting a heavy load on the CHES service on April 6th and onwards, which may potentially have an impact on the timeliness of email dispatches. If your line of business has time sensitivity constraints with when emails are dispatched, you may continue using the old OCP3 instance for a bit until the initial anticipated heavy load stabilizes.
For your reference, here are the old and new Service name/endpoints to migrate to: The Common Hosted Email Service (CHES)
- ches-dev.pathfinder.gov.bc.ca -> ches-dev.apps.silver.devops.gov.bc.ca
- ches-test.pathfinder.gov.bc.ca -> ches-test.apps.silver.devops.gov.bc.ca
- ches.pathfinder.gov.bc.ca -> ches.nrs.gov.bc.ca
CHES DEV on OCP3 will be shut down on March 31. CHES TEST on OCP3 will be shut down on April 19. CHES PROD on OCP3 will be shut down on April 30.
We have also introduced a new /promote/:msgId endpoint to CHES, which will allow you to to immediately promote and dispatch the specified email message if it is still delayed. For more details on this new endpoint, visit our OpenAPI 3.0 documentation at https://ches.nrs.gov.bc.ca/api/v1/docs#operation/PostPromoteMessage. Note that this feature only exists on OCP4 - the older OCP3 instance does not have this feature.
When?
Since March 11, the new OCP4 endpoints are accessible and ready to serve your requests. Product teams leveraging CHES are strongly encouraged to start planning for their applications to use the new endpoints as soon as possible. We will be supporting the old OCP3 endpoints until the end of April. After this date, the old OCP3 pathfinder endpoints will no longer exist.
Do I need to do anything?
If you use CHES, you should migrate to using the new endpoints before the end of April to avoid service disruptions. Assuming your application has been properly configured, you will only need to change the API service endpoint domains in your application configuration to begin using the OCP4 hosted instance of CHES. OIDC token endpoints and client details remain unchanged.
We recommend updating your Dev environment first and validate your application functionality first before updating your higher environments. Depending on your application design, this may require an application service downtime. If you have any plans of leveraging the delayTS feature and have not yet migrated to OCP4, please strongly consider migrating first as it will ensure your emails will be dispatched at the right time.
Errata
With the migration to OCP4, we have performed a one-off DB migration snapshot of past email entries and records. All email requests performed on OCP3 before March 4 will exist in the OCP4 instance. However, any new message records on the OCP3 instance will not show up on the OCP4 instance as they are functionally different instances of CHES.
Please follow the #nr-common-services-showcase channel for any upcoming Common Service Bulletins. If you have any questions, please feel free to contact us in #nr-common-services-showcase .
Thanks!