README.md

Developer manual

A guide for developers working on TDR. This is a space to share how to do things like deploying code or debugging complex parts of the stack.

Guides

Accounts and permissions

• Add a new AWS SSO group (internal manual)
• GOV.UK notify access (internal manual)
• Leavers checklist (internal manual)
• Update AWS SSO group permissions (internal manual)

Admin Tasks

• Deploy the service unavailable page
• How to add a new series

Alerts

• ECR scans
• Missed Jenkins backups
• Rotate AWS keys
• Rotate Client Secrets

CI/CD

• Clear Jenkins disk space
• Jenkins style guide
• Reset Jenkins Builds
• Update Jenkins

Code repositories

• Create a repo

Database permissions

• Fix permission denied errors for new tables

Database restore

• Restore either the Keycloak or Consignment API database

Debugging

• Creating or creating a bastion host for database access
• Debug failing file checks
• Find S3 upload folder
• Security log queries (internal manual)

Development processes

• Close a card
• Deploy code to production
• Plan a user story
• Test accessibility of a feature
• Add a user as an outside collaborator

Development setup

• Access TDR accounts as a developer (internal manual)
• Install git secrets
• New starters guide
• Set up signed commits

Environment setup

• Creating a new environment
• Securing the Keycloak root user (internal manual)
• Setup TDR AWS Infrastructure

Keycloak

• Retrieve Authorisation Token From Keycloak

Reporting

• Running TDR reports using GitHub actions