Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update docs #5309

Merged
merged 2 commits into from
Feb 23, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions runbooks/source/aws-leaked-credentials.html.md.erb
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
title: AWS Compromised Credentials
weight: 110
last_reviewed_on: 2023-11-20
review_in: 3 months
last_reviewed_on: 2024-02-23
review_in: 6 months
---

# AWS Compromised Credentials
Expand Down Expand Up @@ -30,4 +30,4 @@ Most of the users and keys are created through terraform, the process to recreat
## Audit the compromised credentials

Check CloudTrail for any activity of the credentials after it got exposed. This can be done by logging into AWS Management Console
Go to **Services -> CloudTrail -> Event history and filter by `AWS access key`
Go to Services -> CloudTrail -> Event history and filter by `AWS access key`
12 changes: 6 additions & 6 deletions runbooks/source/cloud-platform-communications-plan.html.md.erb
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
title: Cloud Platform Communications Plan
weight: 9190
last_reviewed_on: 2023-11-20
review_in: 3 months
last_reviewed_on: 2024-02-23
review_in: 6 months
---

# Cloud Platform Communications Plan
Expand All @@ -21,7 +21,7 @@ The table below sets out the typical types of communications the Cloud Platform
| Things we have learned | Justice Digital & Technology | Regularly when we have key things to show or promote | Show the Thing |
| Service impacting incidents | Service Teams | When an incident has been declared, key updates during resolution, and at incident closure | #cloud-platform-update |
| Sharing postmortems for service impacting incidents | Service Teams | When postmortem has been documented | #cloud-platform-update |
| Service impacting upgrades/Maintence | Service Teams | As required | #cloud-platform-update |
| Service impacting upgrades/Maintenance | Service Teams | As required | #cloud-platform-update |
| Sharing successes | Chief Technology Officer | Weekly | One to ones and team meetings |
| Sharing successes | SMT | Fortnightly | Architecture & Platforms weeknotes |
| Sharing successes | Justice Digital & Technology | Regularly when we have key things to show or promote | Post about them in #chat or #announcements on Slack/Consider for a Show the Thing |
Expand All @@ -42,9 +42,9 @@ The #cloud-platform-update channel is used for a number of different types of co

- service impact/what users might be reporting
- action being taken (this might just be that we are investigating the issue)
- when users can expact a progress update (and make sure that the update actually happens when you say it will)
- when users can expect a progress update (and make sure that the update actually happens when you say it will)
- details of any actions users need to take (if applicable)
- apoligise for the inconvenience (it might not be an issue in our control but this can build trust and let users know that you are taking resolution seriously)
- apologise for the inconvenience (it might not be an issue in our control but this can build trust and let users know that you are taking resolution seriously)

### Example

Expand All @@ -60,7 +60,7 @@ The #cloud-platform-update channel is used for a number of different types of co
- What you are upgrading
- When the upgrade will take place (including times)
- Why you are upgrading (in might be useful to include a link to some change notes or something that users can refer to if they want more information rather than adding it all in the comms.)
- Details of any service impact or anthing users might need to take action on as a result of changes (including if we are pausing pipelines)
- Details of any service impact or anything users might need to take action on as a result of changes (including if we are pausing pipelines)
- Details of any risks posed to services as a result of not taking requested actions
- Include examples of code if it helps users understand the changes
- Provide a high level overview of the process we will be taking to implement changes
Expand Down
12 changes: 3 additions & 9 deletions runbooks/source/custom-domain.html.md.erb
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
title: Add a custom domain
weight: 80
last_reviewed_on: 2023-11-20
review_in: 3 months
last_reviewed_on: 2024-02-23
review_in: 6 months
---

# <%= current_page.data.title %>
Expand All @@ -13,13 +13,7 @@ If this is a new sub-domain of `service.justice.gov.uk`, these steps are require

* Wait for the new hosted zone to be created by the pipeline, once the user's PR to define it has been merged
* Find the hosted zone record in the Route53 section of the AWS console of the cloud-platform account, and copy the nameserver details from the `NS` record. Create a temporary copy of these values (on the clipboard or a text file)
* Switch to the mojdsd AWS account console, and find the [hosted zone for service.justice.gov.uk] in the Route53 section
* Use the "Create Record Set" button:
* Name: The new sub-domain
* Type: NS - Name server
* TTL: 300
* Value: The nameserver details you copied from the cloud-platform AWS account hosted zone
* Routing Policy: Simple
* Contact Operations Engineering to request the new records be added

[user guide article]: https://user-guide.cloud-platform.service.justice.gov.uk/documentation/other-topics/custom-domain-cert.html
[hosted zone for service.justice.gov.uk]: https://console.aws.amazon.com/route53/home?region=eu-west-1#resource-record-sets:Z1QLRMQEXOI5G4
4 changes: 2 additions & 2 deletions runbooks/source/incident-process.html.md.erb
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
title: Incident Process
weight: 40
last_reviewed_on: 2023-11-20
review_in: 3 months
last_reviewed_on: 2024-02-23
review_in: 6 months
---

# Incident Process
Expand Down
4 changes: 2 additions & 2 deletions runbooks/source/manually-apply-namespace.html.md.erb
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
title: Manually Plan/Apply Namespace Resources
weight: 180
last_reviewed_on: 2023-11-20
review_in: 3 months
last_reviewed_on: 2024-02-23
review_in: 6 months
---

# Manually Plan/Apply Namespace Resources in live cluster
Expand Down
6 changes: 3 additions & 3 deletions runbooks/source/on-call.html.md.erb
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
title: Going on call
weight: 9150
last_reviewed_on: 2023-11-20
review_in: 3 months
last_reviewed_on: 2024-02-23
review_in: 6 months
---

# Going on call
Expand All @@ -17,7 +17,7 @@ Cloud Platform team members provide support out of hours, as detailed in [Cloud
* Understand how to carry out those actions, and what they do.
* Verify access ahead of time to various systems and interfaces required to carry out these actions.

> Getting set up to access production is quite involved if you dont work on the service youre supporting, so its worth making sure youve done so ahead of time.
> Getting set up to access production is quite involved if you don't work on the service you're supporting, so it's worth making sure you've done so ahead of time.

### Not expected:

Expand Down
4 changes: 2 additions & 2 deletions runbooks/source/rotate-git-crypt-key.html.md.erb
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
title: Git-crypt
weight: 75
last_reviewed_on: 2023-11-20
review_in: 3 months
last_reviewed_on: 2024-02-23
review_in: 6 months
---

# Git-crypt
Expand Down
4 changes: 2 additions & 2 deletions runbooks/source/velero.html.md.erb
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
title: Velero - Cluster backups and disaster recovery
weight: 601
last_reviewed_on: 2023-11-20
review_in: 3 months
last_reviewed_on: 2024-02-23
review_in: 6 months
---

# Velero - Cluster backups and disaster recovery
Expand Down
Loading