Table of contents

This is for internal use by the PaaS team. Public-facing documentation is located at docs.cloud.service.gov.uk.

Notifying tenants

Every now and then, we need to let our tenants know that something has happened or will happen on the platform. For example, letting teams know about security fixes, CF/stemcell/buildpack upgrades, new features and incidents.

Depending on what it is we want to tell users, we have two different channels for sending these notifications:

Sending incident alerts and updates

Follow the guidance in this section of the team manual if you’re managing incident comms and you need to send alerts and updates to tenants.

Sending platform change and new feature announcements

Changes, upgrades and fixes

Write a draft email and share it here.

Get a Product Manager to proof-read and add any ‘product-y’ elements - we want to make sure our notifications are consistent and meet the GDS style guidelines. If the email is time-sensitive and there are no Product Managers around, get another member of the team to proof-read the email before it’s sent.

Announcing new features

These announcements are our chance to showcase how we’re developing GOV.UK PaaS and will be written and sent by the product managers. Product Managers may ask the team member who worked on the story to provide some technical details that can be inclued in the email.

Sending notification emails to tenants

Use the google group interface to send the email.

  • Click on New topic
  • In By select: Post on behalf of GOV.UK PaaS announce
  • The Subject should help identify immediately the purpose of the email. Ex: “Incident with…”
  • In Type of post select: “Make an announcement” to emphasize this is one way communication
  • Body: paste the content of the reviewed draft. You may have to adjust formatting.

CF upgrade email template

Subject (ex): GOV.UK PaaS - Cloud Foundry changes - 17th March 2017

The body should contain:

  • Changes and bugfixes to highlight and new features enabled.
  • Downtime or service impact if any
  • Summary of buildpack changes.

 CF buildpack emails

Use the latest “GOV.UK PaaS - Upcoming buildpack upgrades” email in the gov-uk-paas-announce google group interface as an example.

You’ll need to produce a summary of changes between the old and new buildpacks, which is a bit of a tedious manual process. See operations.d/240-cf-set-buildpack-release.yml for the pinned versions and the GitHub releases pages for the buildpacks (e.g. cloudfoundry/binary-buildpack/releases/v1.0.21) to read about the changes.

NB Incident comms email templates are saved in Statuspage.