GOV.UK
Manual
Common tasks
How to...
- Deploy an application to GOV.UK
- Deploy emergency publishing banners
- Deploy non-emergency global banner
- Node classes without redundancy
- Post a message on the status page
- Publish changes to the business readiness finder
- Purge a page from cache
- Query Kibana (includes useful queries)
- Reboot a machine
- Run a rake task
- Update content for the business readiness finder
2nd line
Learn
- Before you start on 2nd line
- Change in-hours time period for daylight savings
- Out of hours support (on-call)
- Welcome to 2nd line
- What we do on 2nd line
How to...
A/B testing
Learn
How to...
Accounts
How to...
- Access apps on the shared Heroku account
- Create a GPG key
- Get access to Jenkins
- Get SSH access to integration
- Give a content designer access to GitHub
- Manage Signon accounts
- Remove a user from Puppet
- Set up your SSH configuration
Analytics
How to...
Applications
How to...
- Add authentication to an application
- Name a new application or gem
- Node classes without redundancy
- Retire an application
- Set up a new Rails application
Learn
Assets
Learn
How to...
- Remove an asset
- Replace an asset's file
- Upload a large asset to Whitehall
- Upload an asset to asset-manager
AWS accounts
How to...
- Access the AWS console
- Nagstamon
- Set up your AWS account
- SSH into AWS machines
- Use AWS on the command line
Backups
How to...
- Backup and restore databases in AWS RDS
- Backup and restore Elasticsearch indices
- Replay traffic to correct an out-of-sync search index
- Restore from offsite backups
- Rotate offsite backup GPG keys
Learn
Business readiness finder
How to...
CDN & Caching
Learn
How to...
Cookies
Learn
data.gov.uk
Learn
How to...
- Common 2nd line support requests for data.gov.uk
- Deployments for data.gov.uk
- Monitor data.gov.uk
- Operation of data.gov.uk
- Support tasks for CKAN
- Troubleshoot data.gov.uk
- WMS map previews on data.gov.uk
Databases
How to...
- Clone a MySQL instance from one slave to another (Carrenza only)
- Resync a MongoDB database
- Resync a PostgreSQL standby
- Upgrade MySQL in production and staging (Carrenza only)
- Use database GUI tools
Learn
Dependencies
How to...
Learn
Deployment
How to...
- 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 AWS CloudFront
- Fall back to the static mirrors
- Handle encrypted hieradata
- Monitor your app during deployment
- Publish special routes
- Restart an application
- Run a rake task
- Set up Heroku review apps for pull requests
- Switch an app off temporarily
Learn
Development VM
How to...
- Access the VM after using the VPN
- Can't connect to Mongo in VM
- Content store times out in VM
- Fix `Signature expired` errors
- Fix bundler errors when running `bowl`
- Fix issues with installing Ruby gems using Bundler
- Fix issues with vagrant-dns
- Fix low disk space in development
- Fix NFS errors in VM
- Get started on GOV.UK
- 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
DNS
Learn
Docker
How to...
Documentation
How to...
Emails
Learn
How to...
- Email callbacks from Notify fails
- Email notifications: how they work
- Manage email subscribers (change email, unsubscribe, move lists)
- Receive emails from Email Alert API in integration and staging
- Stop all email subscription sending
- Test email sending
Frontend
Learn
How to...
GitHub
How to...
Learn
Incidents
Learn
How to...
Infrastructure
How to...
- Add a disk to a vCloud machine (Carrenza only)
- Add a new Ruby version
- Add a secret to a Concourse pipeline
- Connect to vCloud Director (Carrenza only)
- Create a Concourse pipeline
- Generate a Certificate Signing Request (CSR) for GOV.UK
- Manage RabbitMQ
- Migrate Terraform resources between state files
- Move apps between servers
- Patch Jenkins
- Provision machines for data science research
- Reboot a machine
- Remove a machine
- Renew a TLS certificate for GOV.UK
- Reprovision a machine
Learn
- Concourse
- GOV.UK and Virtual Private Networks (VPNs)
- GOV.UK in AWS
- GOV.UK's environments (integration, staging, production)
- Stacks in AWS
- Upgrade Terraform
Learning GOV.UK
How to...
Learn
Logging
Learn
How to...
Monitoring
How to...
- Add a dashboard for an application
- Add an Icinga passive check to a Jenkins job
- Add sidekiq-monitoring to your application
- Error reporting with Sentry
- How to deal with errors
- How to debug underperforming search
- Nagios NRPE connection failures
- Platform Health Dashboard
- Screens that we have in the office
- Use AWS X-Ray to trace app requests
- Use Terraboard to monitor Terraform state
Learn
- Datasync with govuk_env_sync
- Graphite and deployment dashboards
- Metrics
- Pingdom Bouncer canary check
- Sidekiq
- Tools: Icinga, Grafana and Graphite, Kibana and Fabric
- Uptime Metrics
Packaging
How to...
- Manage Debian packages
- Packer Vagrant Dev VM / Image Creation
- Publish a Ruby gem
- Publish to Puppet Forge
Patterns & Style Guides
How to...
Publishing
How to...
- Add a new document type
- Add support for a new translation in Whitehall
- Change a government following a general election
- Change a slug and create redirect in Whitehall
- Change a specialist document base path
- Content that doesn't show up correctly in search or list pages
- Deploy emergency publishing banners
- Deploy non-emergency global banner
- Documents are published, but the links aren't up to date
- Find hardcoded markup in GovSpeak
- Help with publishing content
- If documents aren't live after being published
- Make a new document type available to search
- Manually setting the search popularity of content
- Redirect an HTML attachment's URL in Whitehall
- Reindex an Elasticsearch index
- Remove a change note in Whitehall
- Rename a country
- Republish content
- Upload HMRC PAYE files
Learn
- How the draft stack works
- How the topic taxonomy works
- How to publish a facet group
- How to tag content with facet values
- What data we expose as schema.org structured data
Related links
Learn
Routing
How to...
- Change an organisation's slug
- Check for a 'gone' route
- Edit an existing route in the Router
- Redirect a route
Security
How to...
Team tools
Learn
Testing
How to...
- Brakeman
- End to end testing publishing apps
- Test & build a project on Jenkins CI
- Test Ruby projects
- Troubleshoot CI Jenkins Performance
Learn
Transition
How to...
- Remove redirected URLs from Transition
- Transition a site to GOV.UK
- Use the side-by-side browser
- Whitelist site to allow redirection away from GOV.UK