Deploy case notifications

This section sets out the detailed steps to installing NBS 7 Case Notification, end to end.

On this page

  1. Overview
  2. Considerations
  3. Dependencies
  4. Keycloak configuration

Overview

Case notification services should be deployed in the following order:

  1. Debezium
  2. XML HL7 parser service
  3. Data extraction service
  4. Notification service

All services except Debezium require you to first set up Keycloak configuration. After you deploy all required services for case notifications, validate with API testing.

Considerations

Case notifications are optional. Your jurisdiction can use either the NBS 7 case notification services or continue to route case notifications through Rhapsody.

  • If you are continuing with Rhapsody, skip this section. Do not deploy any of the four services listed above, and do not enable them in Kubernetes.
  • If you are moving to NBS 7 case notifications, complete all four services in the order listed.

Dependencies

Case notifications require NND Sync for the full pipeline to function. Set up NND Sync before deploying case notification services. NND Sync is the only dependency. RDB Data Sync is not required.

Keycloak configuration

The XML HL7 parser, data extraction, and notification services require Keycloak. Complete this configuration before deploying them.

  1. In each service’s values.yaml, confirm the Keycloak auth URI. In the default configuration this value should not need to change unless the name or namespace of the Keycloak pod is modified.

    authUri: "http://keycloak.default.svc.cluster.local/auth/realms/NBS"

  2. For each of the three services, import the corresponding Keycloak profile from NEDSS-Helm/charts/keycloak/extra.

The Notification service also requires the Keycloak client ID and secret for the XML HL7 Parser service. These are configured with the api.clientId and api.secret fields in its values.yaml. See Notification service for more information.

Table of contents