Skip to content

Commit

Permalink
[ESWE-1161] Customise README.md and banner.txt (#5)
Browse files Browse the repository at this point in the history
  • Loading branch information
@rickchoijd
rickchoijd authored Dec 11, 2024
1 parent 48405ba commit b488b67
Show file tree
Hide file tree
Showing 2 changed files with 42 additions and 120 deletions.
123 changes: 16 additions & 107 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,121 +4,30 @@
[![Docker Repository on ghcr](https://img.shields.io/badge/ghcr.io-repository-2496ED.svg?logo=docker)](https://ghcr.io/ministryofjustice/hmpps-jobs-board-integration-api)
[![API docs](https://img.shields.io/badge/API_docs_-view-85EA2D.svg?logo=swagger)](https://hmpps-jobs-board-integration-api-dev.hmpps.service.justice.gov.uk/webjars/swagger-ui/index.html?configUrl=/v3/api-docs)

Template github repo used for new Kotlin based projects.
# About
The **Match Jobs and Manage Applications** - Jobs Board Integration service is conceived as an independent service providing asynchronous communication with other services. For now, the only service it will be integrated with will be the Meganexus Jobs Board.

# Instructions

If this is a HMPPS project then the project will be created as part of bootstrapping -
see [dps-project-bootstrap](https://github.com/ministryofjustice/dps-project-bootstrap). You are able to specify a
template application using the `github_template_repo` attribute to clone without the need to manually do this yourself
within GitHub.

This project is community managed by the mojdt `#kotlin-dev` slack channel.
Please raise any questions or queries there. Contributions welcome!

Our security policy is located [here](https://github.com/ministryofjustice/hmpps-jobs-board-integration-api/security/policy).

Documentation to create new service is located [here](https://tech-docs.hmpps.service.justice.gov.uk/applicationplatform/newservice-GHA/).

## Creating a Cloud Platform namespace

When deploying to a new namespace, you may wish to use the
[templates project namespace](https://github.com/ministryofjustice/cloud-platform-environments/tree/main/namespaces/live.cloud-platform.service.justice.gov.uk/hmpps-templates-dev)
as the basis for your new namespace. This namespace contains both the kotlin and typescript template projects,
which is the usual way that projects are setup.

Copy this folder and update all the existing namespace references to correspond to the environment to which you're deploying.

If you only need the kotlin configuration then remove all typescript references and remove the elasticache configuration.

To ensure the correct github teams can approve releases, you will need to make changes to the configuration in `resources/service-account-github` where the appropriate team names will need to be added (based on [lines 98-100](https://github.com/ministryofjustice/cloud-platform-environments/blob/main/namespaces/live.cloud-platform.service.justice.gov.uk/hmpps-templates-dev/resources/serviceaccount-github.tf#L98) and the reference appended to the teams list below [line 112](https://github.com/ministryofjustice/cloud-platform-environments/blob/main/namespaces/live.cloud-platform.service.justice.gov.uk/hmpps-templates-dev/resources/serviceaccount-github.tf#L112)). Note: hmpps-sre is in this list to assist with deployment issues.

Submit a PR to the Cloud Platform team in
#ask-cloud-platform. Further instructions from the Cloud Platform team can be found in
the [Cloud Platform User Guide](https://user-guide.cloud-platform.service.justice.gov.uk/#cloud-platform-user-guide)

## Renaming from HMPPS Jobs Board Integration Api - github Actions

Once the new repository is deployed. Navigate to the repository in github, and select the `Actions` tab.
Click the link to `Enable Actions on this repository`.

Find the Action workflow named: `rename-project-create-pr` and click `Run workflow`. This workflow will
execute the `rename-project.bash` and create Pull Request for you to review. Review the PR and merge.

Note: ideally this workflow would run automatically however due to a recent change github Actions are not
enabled by default on newly created repos. There is no way to enable Actions other then to click the button in the UI.
If this situation changes we will update this project so that the workflow is triggered during the bootstrap project.
Further reading: <https://github.community/t/workflow-isnt-enabled-in-repos-generated-from-template/136421>

The script takes six arguments:
* The product page on Developer Portal: [Match Jobs and Manage Applications](https://developer-portal.hmpps.service.justice.gov.uk/products/candidate-matching-1)
* The high level design on Confluence: [Match Jobs & Manage Applications - HLD](https://dsdmoj.atlassian.net/wiki/x/34NiJgE)

### New project name
## Team
This integration service is developed and supported by `Education Skills & Work` team. They can be contacted via `#education-skills-work-employment-dev` on Slack.

This should start with `hmpps-` e.g. `hmpps-prison-visits` so that it can be easily distinguished in github from
other departments projects. Try to avoid using abbreviations so that others can understand easily what your project is.
## Healthiness
The integration service has a `/health` endpoint which indicates the service is up and running.

### Slack channel for release notifications

By default, release notifications are only enabled for production. The circleci configuration can be amended to send
release notifications for deployments to other environments if required. Note that if the configuration is amended,
the slack channel should then be amended to your own team's channel as `dps-releases` is strictly for production release
notifications. If the slack channel is set to something other than `dps-releases`, production release notifications
will still automatically go to `dps-releases` as well. This is configured by `releases-slack-channel` in
`.circleci/config.yml`.

### Slack channel for pipeline security notifications

Ths channel should be specific to your team and is for daily / weekly security scanning job results. It is your team's
responsibility to keep up-to-date with security issues and update your application so that these jobs pass. You will
only be notified if the jobs fail. The scan results can always be found in circleci for your project. This is
configured by `alerts-slack-channel` in `.circleci/config.yml`.

### Non production kubernetes alerts

By default Prometheus alerts are created in the application namespaces to monitor your application e.g. if your
application is crash looping, there are a significant number of errors from the ingress. Since Prometheus runs in
cloud platform AlertManager needs to be setup first with your channel. Please see
[Create your own custom alerts](https://user-guide.cloud-platform.service.justice.gov.uk/documentation/monitoring-an-app/how-to-create-alarms.html)
in the Cloud Platform user guide. Once that is setup then the `custom severity label` can be used for
`alertSeverity` in the `helm_deploy/values-*.yaml` configuration.

Normally it is worth setting up two separate labels and therefore two separate slack channels - one for your production
alerts and one for your non-production alerts. Using the same channel can mean that production alerts are sometimes
lost within non-production issues.

### Production kubernetes alerts

This is the severity label for production, determined by the `custom severity label`. See the above
#non-production-kubernetes-alerts for more information. This is configured in `helm_deploy/values-prod.yaml`.

### Product ID

This is so that we can link a component to a product and thus provide team and product information in the Developer
Portal. Refer to the developer portal at https://developer-portal.hmpps.service.justice.gov.uk/products to find your
product id. This is configured in `helm_deploy/<project_name>/values.yaml`.

## Manually branding from template app

Run the `rename-project.bash` without any arguments. This will prompt for the six required parameters and create a PR.
The script requires a recent version of `bash` to be installed, as well as GNU `sed` in the path.

## TODOs and Examples

We have tried to provide some examples of best practice in the application - so there are lots of TODOs in the code
where changes are required to meet your requirements. There is an `ExampleResource` that includes best practice and also
serve as spring security examples. The template typescript project has a demonstration that calls this endpoint as well.

For the demonstration, rather than introducing a dependency on a different service, this application calls out to
itself. This is only to show a service calling out to another service and is certainly not recommended!
# Instructions

## Running the application locally

The application comes with a `dev` spring profile that includes default settings for running locally. This is not
necessary when deploying to kubernetes as these values are included in the helm configuration templates -
e.g. `values-dev.yaml`.
* Run with the Spring profile `dev` on local
* Set active profile via this environmental variable `spring.profiles.active=dev`
* API Spec:
* Goto `http://localhost:8080/swagger-ui/index.html` to explore the OpenAPI specifications
* Checking endpoints
* Goto `http://localhost:8080/health` to check the service is up and running

There is also a `docker-compose.yml` that can be used to run a local instance of the template in docker and also an
instance of HMPPS Auth (required if your service calls out to other services using a token).
### Running with Docker

```bash
docker compose pull && docker compose up
Expand Down
39 changes: 26 additions & 13 deletions src/main/resources/banner.txt
View file
Original file line number Diff line number Diff line change
@@ -1,13 +1,26 @@
_ _ _ _ ___ ___ ____
|__| |\/| |__] |__] [__
| | | | | | ___]

___ ____ _ _ ___ _ ____ ___ ____
| |___ |\/| |__] | |__| | |___
| |___ | | | |___ | | | |___

_ _ ____ ___ _ _ _ _
|_/ | | | | | |\ |
| \_ |__| | |___ | | \|

TODO: Please change me by generating your own ASCII art and placing in banner.txt
**********************************************************************
* ___ ___ _____ ____________________ _________ *
* / | \ / \\______ \______ \/ _____/ *
*/ ~ \/ \ / \| ___/| ___/\_____ \ *
*\ Y / Y \ | | | / \ *
* \___|_ /\____|__ /____| |____| /_______ / *
* \/ \/ \/ *
* ____. ___. __________ .___*
* | | ____\_ |__ ______ \______ \ _________ _______ __| _/*
* | |/ _ \| __ \ / ___/ | | _// _ \__ \\_ __ \/ __ | *
*/\__| ( <_> ) \_\ \\___ \ | | ( <_> ) __ \| | \/ /_/ | *
*\________|\____/|___ /____ > |______ /\____(____ /__| \____ | *
* \/ \/ \/ \/ \/ *
*.___ __ __ .__ *
*| | _____/ |_ ____ ________________ _/ |_|__| ____ ____ *
*| |/ \ __\/ __ \ / ___\_ __ \__ \\ __\ |/ _ \ / \ *
*| | | \ | \ ___// /_/ > | \// __ \| | | ( <_> ) | \ *
*|___|___| /__| \___ >___ /|__| (____ /__| |__|\____/|___| / *
* \/ \/_____/ \/ \/ *
* _____ __________.___ *
* / _ \\______ \ | *
* / /_\ \| ___/ | *
*/ | \ | | | *
*\____|__ /____| |___| *
* \/ *
**********************************************************************

0 comments on commit b488b67

Please sign in to comment.