Skip to main content

Prerequisites

You and your team

You must be a member of a team in the Ministry of Justice GitHub organisation. That team must belong to parent team HMPPS Developers.

The team will determine access to the github repo and cloud platform namespaces.

The team must have an MOJ Slack channel. You should have three slack channels dedicated to send alerts from Github Actions for failed jobs etc:

  • Non-prod alerts - a channel for alerts from non-production environments
  • Prod alerts - a channel for alerts in the production environment
  • security alerts - a channel for alerts triggered by security jobs

For example, the abc team may have:

  • #hmpps_abc_alerts for prod alerts
  • #hmpps_abc_alerts_nonprod for non prod alerts
  • #hmpps_abc_alerts_security for security alerts

The service

You should aim to understand the following about your service before starting :

  • What is the service name as it will appear in URLs? If you need to change the name later it will destroy and recreate the resources in Cloud Platform.

    • The new service needs a good name. Note that by convention we use the service name in the DNS domain used by the service. As this will have a size limit try not to make your service name too long - a maximum of 25 characters should be ok.

  • Which DNS domain will this service use?

    • .hmpps.service.justice.gov.uk - the service is relevant across HMPPS

    • .prison.service.justice.gov.uk - the service is prison-focussed

    • .probation.service.justice.gov.uk - the service is probation-focussed

    • Other - may require additional work to setup DNS for bespoke domains and the Cloud Platform team can assist with this.

  • Does the service require restricted access? Which IP/subnets will be allowed access? This can be managed after creation with a restricted IP address list in the values-.yaml files.

  • Does the service require other AWS resources - databases, caches, SQS queues, SNS topics or S3 buckets? These should be created using the terraform modules provided by Cloud Platform - see other services for examples.