GOV.UK
Manual
Common tasks
- Deploy an application to GOV.UK
- Deploy emergency publishing banners
- Post a message on the status page
- Purge a page from cache
- Reboot a machine
- Run a rake task
- Useful Kibana queries
2nd line
- Before you start on 2nd line
- Manage product support tickets (Zendesk)
- Out of hours support (on-call)
- Raising issues with Reliability Engineering
- Welcome to 2nd line
- Working on 2nd line
A/B testing
Accounts
- Access apps on the shared Heroku account
- Create a GPG key
- Get access to Jenkins
- Give a content designer access to GitHub
- Manage Signon accounts
- Remove a user from Puppet
- SSH Configuration
Applications
Architecture
- Architectural overview of GOV.UK applications
- Dictionary
- GOV.UK in AWS
- GOV.UK's environments (integration, staging, production)
- Stacks in AWS
Assets
- Assets: how they work
- Remove an asset
- Replace an asset's file
- Upload an asset to asset-manager
- Upload an asset to whitehall
AWS accounts
Backups
- Backup and restore databases in AWS RDS
- Backup and restore Elasticsearch indices
- MongoDB backups
- MySQL backups
- PostgreSQL backups
- Replaying traffic to correct an out-of-sync search index
- Restore from offsite backups
- Rotate offsite backup GPG keys
Basics
CDN & Caching
- Cookies and sessions in GOV.UK frontend apps
- Our content delivery network (CDN)
- Purge a page from cache
- Query CDN Logs
data.gov.uk
- Architecture of data.gov.uk
- Backups for data.gov.uk
- Deployments for data.gov.uk
- Migrating data between CKAN instances
- Monitoring for data.gov.uk
- Operation of data.gov.uk
- Supporting CKAN
- Troubleshooting data.gov.uk
Databases
- Clone a MySQL instance from one slave to another (Carrenza only)
- PgBouncer
- PostgreSQL Advisory Locks
- Resync a MongoDB database
- Resync a PostgreSQL standby
- Upgrade MySQL in production and staging (Carrenza only)
- Use database GUI tools
Dependencies
- Manage Ruby dependencies with Dependabot
- Policy on keeping software current
- Upgrade Rails to a new version
Deployment
- Block apps from being deployed
- Deploy an application to GOV.UK
- Deploy AWS infrastructure with Terraform
- Deploy fixes for a security vulnerability
- Deploy Puppet
- Deploy when GitHub is unavailable
- Fall back to the static mirrors
- Handle encrypted hieradata
- Monitor your app during deployment
- Restart an application
- Run a rake task
- Set up Heroku review apps for pull requests
- Switch an app off temporarily
Development VM
- Can't connect to Mongo in VM
- Content store times out in VM
- Fix issues with installing Ruby gems using Bundler
- Fix issues with vagrant-dns
- Fix low disk space in development
- Fix NFS errors in VM
- Not enough RAM for the VM
- Problems provisioning and fetching packages in VM
- Replicate application data locally for development
- Run an application in the VM
- Send a test email via Notify
- SSH into GOV.UK servers from the VM
- SSH into your VM directly
- Unable to mount VirtualBox shared folders
- Using `bowl` fails with bundler error
DNS
Documentation
- Documentation style guide
- Monitor docs traffic
- Review a page in this manual
- Where to find what documentation
Emails
- Email Alert API analytics
- Email notifications: how they work
- Manage email subscribers (change email, unsubscribe, move lists)
- Receiving emails from Email Alert API in integration and staging
- Stop all email subscription sending
- Test email sending
Frontend
GitHub
Incidents
- Incident management guidance
- Post a message on the status page
- So, you're having an incident
- Write an incident report
Infrastructure tasks
- Add a disk to a vCloud machine (Carrenza only)
- Add a new Ruby version
- Generate a Certificate Signing Request (CSR) for GOV.UK
- Manage RabbitMQ
- Move apps between servers
- Patch Jenkins
- Reboot a machine
- Remove a machine
- Renew a TLS certificate for GOV.UK
- Reprovision a machine
- Update Pingdom IP ranges
Logging
- How logging works on GOV.UK
- How to use Logit for GOV.UK
- Set up request tracing
- Useful Kibana queries
Monitoring
- Add a deployment dashboard for an application
- Add an Icinga passive check to a Jenkins job
- Add sidekiq-monitoring to your application
- Error reporting with Sentry
- GOV.UK and Virtual Private Networks (VPNs)
- Graphite and deployment dashboards
- How to deal with errors
- Metrics
- Monitor Sidekiq queues for your application
- Monitoring screens
- Nagios NRPE connection failures
- Pingdom Bouncer canary check
- Sidekiq
- Tools: Icinga, Grafana and Graphite, Kibana and Fabric
- Uptime Metrics
- Use AWS X-Ray to trace app requests
- Use Terraboard to monitor Terraform state
Packaging
Patterns & Style Guides
Publishing
- Add a new document type
- Change a specialist document base path
- Content that doesn't show up correctly in search or list pages
- Deploy emergency publishing banners
- Documents are published, but the links aren't up to date
- Find hardcoded markup in GovSpeak
- Fix blank options in finder filters
- Help with publishing high priority content
- How the draft stack works
- Make a new document type available to search
- Manually setting the search popularity of content
- Reindex an Elasticsearch index
- Remove a change note in Whitehall
- Rename a country
- Schema.org structured data
- Topic Taxonomy
- Upload HMRC PAYE files
Routing
- Change an organisation's slug
- Check for a 'gone' route
- Edit an existing route in the Router
- Redirect a route
Team tools
Testing
- Brakeman
- End to end testing publishing apps
- Jenkins CI infrastructure
- Pact Broker
- Test & build a project on Jenkins CI
- Test Ruby projects
- Troubleshooting CI Jenkins Performance