Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/defra/ffc-grants-desirability-notification
ffc-grants-desirability-notification
https://github.com/defra/ffc-grants-desirability-notification
Last synced: 6 days ago
JSON representation
ffc-grants-desirability-notification
- Host: GitHub
- URL: https://github.com/defra/ffc-grants-desirability-notification
- Owner: DEFRA
- License: other
- Created: 2021-03-01T10:30:50.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-10-21T13:35:17.000Z (29 days ago)
- Last Synced: 2024-10-21T21:48:34.672Z (28 days ago)
- Language: JavaScript
- Size: 208 KB
- Stars: 1
- Watchers: 13
- Forks: 2
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# FFC Grants Desirability Notification
Notification microservice for applications.
This service will pickup message and call gov notify api to send email to applicant as well as RPA.
## Prerequisites
- Access to an instance of an
[Azure Service Bus](https://docs.microsoft.com/en-us/azure/service-bus-messaging/)(ASB).
- Docker
- Docker Compose
Optional:
- Kubernetes
- Helm
### Azure Service Bus
This service depends on a valid Azure Service Bus connection string for
asynchronous communication. The following environment variables need to be set
in any non-production (`!config.isProd`) environment before the Docker
container is started. When deployed into an appropriately configured AKS
cluster (where [AAD Pod Identity](https://github.com/Azure/aad-pod-identity) is
configured) the micro-service will use AAD Pod Identity through the manifests
for
[azure-identity](./helm/ffc-grants-claim-service/templates/azure-identity.yaml)
and
[azure-identity-binding](./helm/ffc-grants-claim-service/templates/azure-identity-binding.yaml).
| Name | Description |
| ---- | ----------- |
| SERVICE_BUS_HOST | Azure Service Bus hostname, e.g. `myservicebus.servicebus.windows.net` |
| SERVICE_BUS_PASSWORD | Azure Service Bus SAS policy key |
| SERVICE_BUS_USER | Azure Service Bus SAS policy name, e.g. `RootManageSharedAccessKey` |
## Environment variables
The following environment variables are required by the application container.
Values for development are set in the Docker Compose configuration. Default
values for production-like deployments are set in the Helm chart and may be
overridden by build and release pipelines.
| Name | Description | Required | Default | Valid | Notes |
| ---- | ----------- | :-------: | ------- | ----- | ----- |
| APPINSIGHTS_CLOUDROLE | Role used for filtering metrics | no | | | Set to `ffc-grants-desirability-notification` in docker compose files |
| APPINSIGHTS_INSTRUMENTATIONKEY | Key for application insight | no | | | App insights only enabled if key is present. Note: Silently fails for invalid key |
| NODE_ENV | Node environment | no | development | development,test,production | |
| PORT | Port number | no | 3000 | | |
| PROTECTIVE_MONITORING_URL | protective monitoring url | no | url | | |
| NOTIFY_API_KEY | gov notify key | no | | | |
| DESIRABILITY_SUBMITTED_SUBSCRIPTION_ADDRESS| queue topic address | no | | | |
| DESIRABILITY_SUBMITTED_TOPIC_ADDRESS | queue topic address | no | | | |
Running the integration tests locally requires access to ASB, this can be
achieved by setting the following environment variables:
`SERVICE_BUS_HOST`, `SERVICE_BUS_USER`, `SERVICE_BUS_PASSWORD`.
`DESIRABILITY_SUBMITTED_SUBSCRIPTION_ADDRESS`, `DESIRABILITY_SUBMITTED_TOPIC_ADDRESS` must be set to a valid, developer specific queue that is
available on ASB e.g. `ffc-grants-desirability-notification-` where `` are the
initials of the developer.
## Test structure
The tests have been structured into subfolders of ./test as per the
[Microservice test approach and repository structure](https://eaflood.atlassian.net/wiki/spaces/FPS/pages/1845396477/Microservice+test+approach+and+repository+structure)
## How to run tests
A convenience script is provided to run automated tests in a containerised
environment. This will rebuild images before running tests via docker-compose,
using a combination of `docker-compose.yaml` and `docker-compose.test.yaml`.
The command given to `docker-compose run` may be customised by passing
arguments to the test script.
Examples:
```shell
# Run all tests
scripts/test
# Run tests with file watch
scripts/test -w
```
## Running the application
The application is designed to run in containerised environments, using Docker
Compose in development and Kubernetes in production.
- A Helm chart is provided for production deployments to Kubernetes.
### Build container image
Container images are built using Docker Compose, with the same images used to
run the service with either Docker Compose or Kubernetes.
When using the Docker Compose files in development the local `app` folder will
be mounted on top of the `app` folder within the Docker container, hiding the
CSS files that were generated during the Docker build. For the site to render
correctly locally `npm run build` must be run on the host system.
By default, the start script will build (or rebuild) images so there will
rarely be a need to build images manually. However, this can be achieved
through the Docker Compose
[build](https://docs.docker.com/compose/reference/build/) command:
```shell
# Build container images
docker-compose build
```
### Start and stop the service
Use Docker Compose to run service locally.
`docker-compose up`
Additional Docker Compose files are provided for scenarios such as linking to
other running services.
Link to other services:
```shell
docker-compose -f docker-compose.yaml -f docker-compose.override.yaml -f docker-compose.link.yaml up
```
#### Accessing the pod
The service is exposed via a Kubernetes ingress, which requires an ingress
controller to be running on the cluster. For example, the NGINX Ingress
Controller may be installed via Helm.
Alternatively, a local port may be forwarded to the pod:
```shell
# Forward local port to the Kubernetes deployment
kubectl port-forward --namespace=ffc-grants deployment/ffc-grants-desirability-notification 3000:3000
```
Once the port is forwarded or an ingress controller is installed, the service
can be accessed and tested in the same way as described in the
[Test the service](#test-the-service) section above.
#### Probes
The service has both an Http readiness probe and an Http liveness probe
configured to receive at the below end points.
Readiness: `/healthy`
Liveness: `/healthz`
## CI pipeline
This service uses the [FFC CI pipeline](https://github.com/DEFRA/ffc-jenkins-pipeline-library)
## Licence
THIS INFORMATION IS LICENSED UNDER THE CONDITIONS OF THE OPEN GOVERNMENT LICENCE found at:
The following attribution statement MUST be cited in your products and applications when using this information.
> Contains public sector information licensed under the Open Government license v3
### About the licence
The Open Government Licence (OGL) was developed by the Controller of Her Majesty's Stationery Office (HMSO) to enable information providers in the public sector to license the use and re-use of their information under a common open licence.
It is designed to encourage use and re-use of information freely and flexibly, with only a few conditions.