Skip to content

Latest commit

 

History

History
180 lines (127 loc) · 6.67 KB

first-line-support-developer-runbook.md

File metadata and controls

180 lines (127 loc) · 6.67 KB
Raw

First-line support developer runbook

The audience for this document is a developer working on first-line support, who may not have worked on this service before. It explains how to perform some tasks that you might get asked to do.

Non-standard things about this project

  • We usually use the word “development” to refer to the development environment in Azure — this is what other projects might call “staging”. To refer to the application running on a developer’s machine, we usually include the word “local”, for example “local development”.

Support tasks

If you want to do one of these tasks and you don’t have what you need, see the first-line support onboarding list.

I want to make a bug fix and deploy it

You will need

  • permissions to open a pull request in the repository

  • credentials for DfE’s Cloud Infrastructure platform and membership of an Active Directory group that allows you to perform a release — here’s how to check:

    1. Log in to https://portal.azure.com with your @digital.education.gov.uk email address.

    2. Search for s118-teacherpaymentsservice-production.

    3. Click “My permissions”.

    4. If you see something like

      You are a member of the group 's118-teacherpaymentservice-Delivery Team USR (null)' which has been assigned the role 'Reader' (type BuiltInRole) and has access to subscription s118-teacherpaymentsservice-production

      then you have what you need.

You may need

  • credentials for DfE Sign-in pre-production, if you’re investigating a bug in the /admin site — see dfe-sign-in.md

Steps

  1. Set up the app locally. See README.md#setting-up-the-app-locally.

    If you need to try out something in the /admin site locally, see how to set up DfE Sign-in locally.

  2. Fix the bug.

  3. Describe the fix in CHANGELOG.md.

  4. Open a pull request into master, and get it reviewed.

  5. Merge the pull request.

  6. If possible, verify that the fix works on the development environment.

  7. Do a release. See release-process.md.

I want to pull some data from the production database

You will need

  • credentials for the project’s Azure infrastructure

Steps

  1. Make a Privileged Identity Management (PIM) request, to gain the elevated permissions required to access production resources. See privileged-identity-management-requests.md.
  2. Ask another developer to approve the PIM request.
  3. Start a Rails console. See README.md#accessing-production-data-with-a-live-rails-console.

I want to investigate an error

You may need

  • access to the production Logit.io stack for the service, to view the web and worker logs
  • access to the dxw/dfe-claim project in Rollbar, to view details of exceptions

How to do it

I want to export data for the “school check email”

Someone from DfE will probably ask us to do this at least once a month whilst there is a claim window open, which is around September – March.

You will need

  • credentials for DfE’s G Suite - i.e. an @digital.education.gov.uk email address

  • credentials for DfE’s Cloud Infrastructure platform and membership of an Active Directory group that allows you to connect to a production container — here’s how to check:

    1. Log in to https://portal.azure.com with your @digital.education.gov.uk email address.

    2. Search for s118-teacherpaymentsservice-production.

    3. Click “My permissions”.

    4. If you see something like

      You are a member of the group 's118-teacherpaymentservice-Delivery Team USR (null)' which has been assigned the role 'Reader' (type BuiltInRole) and has access to subscription s118-teacherpaymentsservice-production`

      then you have what you need.

How to do it

Follow the steps in school-check-data.md. The “relevant service operator” which that document refers to is probably the person who raised the support ticket.

I want to rotate the Verify Service Provider (VSP) certificates

Someone from DfE will probably ask us to do this at least once every 6 months.

You will need

  • the same things needed to make a bug fix and deploy it:
    • permissions to open a pull request in the repository
    • credentials for DfE’s Cloud Infrastructure platform and membership of an Active Directory group that allows you to perform a release

How to do it

Follow the steps in govuk-verify-rotating-keys-and-certificates.md.

I want to remove the 'downloaded' state from a payroll run so it can be downloaded again

You will need

  • credentials for the project’s Azure infrastructure

Steps

  1. Make a Privileged Identity Management (PIM) request, to gain the elevated permissions required to access production resources. See privileged-identity-management-requests.md.
  2. Ask another developer to approve the PIM request.
  3. Start a Rails console. See README.md#accessing-production-data-with-a-live-rails-console.
  4. Identify the latest PayrollRun object (double check that the dates are as expected), set downloaded_at and downloaded_by_id to nil and save the object: 
    payroll = PayrollRun.last
payroll.downloaded_at = nil
payroll.downloaded_by_id = nil
payroll.save

I want to restart the worker container instance

You will need

  • credentials for the project’s Azure infrastructure

Steps

  1. Make a Privileged Identity Management (PIM) request, to gain the elevated permissions required to access production resources. See privileged-identity-management-requests.md.
  2. Ask another developer to approve the PIM request.
  3. Search for s118p01-app-worker-aci within the Azure portal.
  4. Click "Restart"

Alternatively, instead of doing it via the web interface, you can run az container restart --name s118p01-app-worker-aci --resource-group s118p01-app.