πŸ₯ž backlog

Module-Cloud πŸ”—

[TECH ED] Write a case study πŸ”— Clone

https://curriculum.codeyourfuture.io/cloud

Why are we doing this?

  1. Write a case study of a Cloud related problem or task you have been set and the way you handled it. Follow this basic format:

Description

Problem

Solution

Tools used

  1. Publish your case study on your Portfolio

Maximum time in hours

3

How to get help

Share your blockers in Slack

How to submit

Publish your case study on your portfolio website. Share the link in Slack. Best case study, voted by the group, wins the coveted Best Case Study Award πŸ†

How to review

Ask your colleagues for a review on Slack. Make sure to review someone elses’ work. What can you learn from them?

Anything else?

https://www.youtube.com/watch?v=OXiaEXfkAec https://www.joshwcomeau.com/effective-portfolio/

Here’s an example of a case study: https://coderiders.am/case-studies/lifestyle-management-software-for-Dwel-Online

See how it follows the familiar structure of Description > Problem > Solution > Tools ? All business case studies do this:

https://blog.hubspot.com/blog/tabid/6307/bid/33282/the-ultimate-guide-to-creating-compelling-case-studies.aspx

  • 🎯 Topic Communication
  • 🎯 Topic Problem-Solving
  • 🎯 Topic Requirements
  • πŸ• Priority Mandatory
  • πŸ‚ Size Medium
  • πŸ“… Sprint 2
  • 🎁 Module Product
  • Cloud
[TECH ED] Write a run book πŸ”— Clone

https://www.transposit.com/devops-blog/sre/2020.01.30-writing-runbook-documentation-when-youre-an-sre/

Why are we doing this?

Write a runbook for a project you have deployed using the Cloud technologies in this module.

Publish this runbook on your portfolio, along with the project.

Runbook nameApplication X Deployment to Production
Runbook descriptionThis runbook provides instructions for deploying Application X to the production environment.
Owner@DevOpsEngineer
Version2.3
Version date//2024-03-21

On this page

πŸ› Architecture

[Include a high-level architectural diagram of the relevant hosts and services]

πŸ’¬ Support contacts

Expertise levelTeamTeam leadContact info
Level 1@ops-team-members@ops-team-lead[Include contact information for Level 1 support]
Level 2[Include details for Level 2 support, if applicable]
Level 3[Include details for Level 3 support, if applicable]

🎽 Runs

NameStateStart timeCompleted timeDuration
Application X Deployment[To be updated during deployment][To be updated during deployment][To be updated after deployment][To be calculated after deployment]

🎒 Process

Step instructions

  1. Ensure all prerequisites are met (e.g., successful testing in lower environments, approvals obtained)
  2. Take a backup of the current production environment
  3. [Detailed deployment steps]
  4. [Validation and testing steps]
  5. [Monitoring and alerting setup]
  6. [Communication to stakeholders]
EnabledExecution locationRun environmentsRun conditionsDocumentation
Yes[Specify the location or environment where the deployment will be executed]Production[Specify any conditions or prerequisites required for the deployment][Include links to relevant documentation, such as application guides, deployment scripts, or configuration files]

Maximum time in hours

8

How to get help

Share your blockers in Slack.

How to submit

Publish your runbook on your portfolio and as a document in your project repo. Link to your runbook on your project readme. Link your portfolio runbook in Slack. The best runbook, voted by the group, wins the coveted 🎽 πŸ“˜ Best Runbook Award

  • 🎯 Topic Communication
  • 🎯 Topic Requirements
  • πŸ• Priority Mandatory
  • πŸ¦‘ Size Large
  • πŸ“… Sprint 4
  • 🎁 Module Product
  • Cloud
[TECH ED] Write an incident report πŸ”— Clone

https://www.atlassian.com/incident-management/postmortem/templates#incident-summary

Why are we doing this?

Write up a problem or outage you have handled during this module, using the template provided:

Summary

This section should provide a high-level overview of the incident, including a brief description of what happened, the severity level, the affected services or components, and the impact on customers or users.

Timeline

This section should chronologically document the key events and actions taken during the incident, from the initial detection to the final resolution. It should include timestamps for each event and the person or team responsible for each action.

Root cause

This section should analyze and identify the underlying cause(s) of the incident. It should provide a detailed explanation of what went wrong, including any contributing factors or related issues.

Resolution and recovery

This section should describe the steps taken to resolve the incident and restore normal operations. It should include details about any workarounds or temporary solutions implemented, as well as the final fix or permanent resolution.

Corrective and preventive measures

This section should outline the actions that will be taken to prevent similar incidents from occurring in the future. It should include both short-term corrective measures and long-term preventive measures, such as process improvements, system upgrades, or training initiatives.

Maximum time in hours

3

How to get help

Use GenAI to evaluate and improve your incident report. Use this prompt to help you:

Act as a straightforward senior DevOps engineer with lots of experience in technical communication. Evaluate my incident report and tell me how I can improve it. Don’t rewrite my report, but give me examples and corrections piece by piece. Please be honest and kind.

How to submit

  1. Write up your incident report as a feature on your portfolio website
  2. Share the link in Slack.

It must be on your portfolio website and not in a message or doc, because the purpose of this exercise is to demonstrate this valuable skill to employers.

How to review

Share your links in Slack and ask a colleague to review. Make sure to review someone else’s report too. What can you learn from theirs?

  • 🎯 Topic Communication
  • πŸ• Priority Mandatory
  • πŸ‚ Size Medium
  • πŸ“… Sprint 3
  • 🎁 Module Product
  • Cloud