https://github.com/ukhomeoffice/dq-raw-message-retrieval

https://github.com/ukhomeoffice/dq-raw-message-retrieval

hodq kubernetes nodejs

Last synced: 18 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/ukhomeoffice/dq-raw-message-retrieval
• Owner: UKHomeOffice
• License: mit
• Created: 2018-01-15T09:11:47.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2024-09-12T13:11:22.000Z (9 months ago)
• Last Synced: 2025-02-16T21:18:56.640Z (3 months ago)
• Topics: hodq, kubernetes, nodejs
• Language: JavaScript
• Size: 352 KB
• Stars: 0
• Watchers: 16
• Forks: 1
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# DQ Raw Message Retrieval

DQ Raw Message Retrieval retrieves the associated RAW zip file from an S3 bucket of a url, and displays its contents in stream.

Requires environment variables `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY` and `BUCKET_NAME` to be set.

## Components

- **./app**

  - *E:\RAW_ARCHIVE* used by the test suite

  - *test* test suite

  - *Dockerfile* builds a Docker container on Alpine and installs NodeJS for the application to used

  - *package-lock.json* list of packages used to build the container - depends on *package.json*.

     This file is auto-generated by NodeJS upon build. If the container need updating the current file needs to be deleted and the new one copied out from the container that gets built and added to the repository tree.

  - *package.json* lists dependencies to use to build NodeJS within the container

  - *zip_file_fixture.zip* used by the test suite

- **./existing**

  - This is the old application which is only kept here for reference - no longer in use.

- **./kube**

  - *deployment.yml* describe the various containers that will live in the K8S pod

  - *ingress.yml* describe the ACP ingress service

  - *network-policy.yml* describe the port the service is listening on

  - *secret.yml* describe all secrets passed into pod

  - *service.yml* maps the port to the HTTPS service

- **.drone.yml**

  - building the Docker container then deploys it along with all the other K8S Containers into NotProd and Prod

- **test.sh**

  - RMR container tester script

- **zip_file_fixture.zip**

  - example zip file

## Dependencies

- Docker

- Kubernetes

- Keycloak

- AWS

## Testing

- Testing is built into the Docker container build step using the *./app/test* suite by running the *index.test.js* NodeJS script.