Skip to content

Latest commit

 

History

History
120 lines (80 loc) · 5.74 KB

README.md

File metadata and controls

120 lines (80 loc) · 5.74 KB

Ministry Name Tracking App

This co-op project app was made as a minimum viable product (MVP) to track ministry name and acronym changes. It can also track ministry name history going forward.

Components

  • Postgres database
  • Node JS w/ express JS (using ejs and Javascript)

Getting Started

To run locally, you need docker desktop installed and running.

Create a .env file with the following variables:

  • PORT (default to 8080)
  • DB_PORT (default to 5432)
  • POSTGRES_HOST
  • POSTGRES_USER
  • POSTGRES_PASSWORD
  • POSTGRES_DB

run docker compose up --build

File Structure

The entry point is found in the server.js file in root while general app configuration is found in the app.js file. Also contains dockerfile for main app and docker-compose files for running locally.

Config

Contains yaml configuration files useful for Openshift deployment. Specifically for creating and populating a postgres database in openshift using init-db-1.yaml for the job and db-config... files for config maps.

Controllers

Contains the bulk of the logic. The api folder contains the logic for the api section while the frontEnd folder contains the logic for rendering the front end display including success and error pages.

DB

Contains database connection configuration file and database population sql scripts. The queries.js file contains all of the SQL queries used by the controller files. There is also a dockerfile for a postgres image including the population scripts if needed.

Kompose

Contains yml files converted from the docker-compose file. These were not used in the original openshift deployment but are stored here for alternate deployment options.

Public

CSS, images, and frontend JS script files for frontend functionality.

Routes

Contains routes for api and web app. All routes are then exported to indexRouter.js which mounts the routes to app.js.

eg. Route for Acronym api call based on acronym id:

Domain/route from index.js/route from apiAcronymRouter.js

http://localhost:8080/api/acronym/byAcronymID/:id

Utils

Helper functions for repeat logic.

Views

All ejs files for front end rendering.

Deployment to Openshift

These deployment steps are for a CI pipeline using a github actions workflow and the github container registry (ghcr.io). Specifically, it uses the openshit.yml workflow.

Prerequisites

These instructions assume you have oc installed.

Workflow Set-up

In openshift.yml, check that all the env. variables are correct eg. APP_NAME. In github, add the following repository secrets. See here for how to retrieve these values.

  • OPENSHIFT_SERVER: after oc login, run oc whoami --show-server to get this value

  • OPENSHIFT_TOKEN: after oc login, run oc whoami --show-token to get this value

  • OPENSHIFT_NAMESPACE: the desired namespace

  • TOKEN: github access token used to access ghcr. See registry docs for more information.

e.g.

This workflow is set to run on a push/merge to master branch. Update this if a different trigger is needed.

e.g.

The CRDA scan section is not configured. If you want to run this vulnerability check, see the github crda action for info on updating this section of the worklow.

e.g.

The workflow is now ready to run. It can be triggered manually in github > actions or run by merging a PR to master. Once run successfully, navigate to the openshift namespace for further steps to complete the deployment.

Openshift

In Openshift, navigate to the ministry-name-app Route and edit it so the Security > Secure Route checkbox is selected.

e.g.

If you have a database already implemented and the correct variables/secretes added to the deployment, you are good to go.

If this is the first deployment, continue on to the 'adding the database section'

Openshift - Adding the Database

This app is configured to use a postgres database. Add a postgres database either through the GUI or CLI with:

oc new-app --template=postgresql-persistent --param=DATABASE_SERVICE_NAME=<database serice name> --param=POSTGRESQL_USER=<POSTGRES_USER> --param=VOLUME_CAPACITY=<in Mi> --param=MEMORY_LIMIT=<in Mi> --param=POSTGRESQL_PASSWORD=<POSTGRES_PASSWORD> --param=POSTGRESQL_DATABASE=<POSTGRES_DB>--param=NAMESPACE=<your namespace>

and make sure you expose the postgres app:

oc expose service/<DATABASE_SERVICE_NAME>

In the postgres pod terminal, you can run the creatDbTables.sql & populateDbTables.sql scripts from the ./db folder manually using psql or convert the scripts into configMaps and create an Openshift job to run them automatically.

Openshift - Adding Environmental Variables

Finally, environmental variables/secretes need to be added to the app deployment so the app can connect to the database. Navigate to the ministry-name-app deployment and add the following variables/secrets to the Environment tab:

  • DB_PORT
  • PORT
  • POSTGRES_DB
  • POSTGRES_HOST **
  • POSTGRES_PASSWORD
  • POSTGRES_USER

All of the variables except POSTGRES_HOST should be the same as from the getting started section.

** For the openshift deployment, the POSTGRES_HOST value is found in the postgres Services > Details tab > Service Routing > Hostname

Recommendations for Further Development & Refactoring

Rebuild front-end with a proper JS framework (w/ Reach or Vue). Add unit tests & further error handling. For Openshift deployment, add database backup.