CodeYourFuture / CodeYourFuture/Module-Cloud
[TECH ED] Write a run book
- Lingua principale
- Nessun dato sulla lingua
- Stelle
- 0
- Fork
- 6
- Metriche di merge delle PR
- Nessuna PR unita negli ultimi 30g
Descrizione
### Link to the coursework
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.
Example runbook template from Atlassian
**Runbook name** | Application X Deployment to Production
-------------------|----------------------------------------
**Runbook description** | This runbook provides instructions for deploying Application X to the production environment.
**Owner** | @DevOpsEngineer
**Version** | 2.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 level | Team | Team lead | Contact 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
Name | State | Start time | Completed time | Duration
-----|-------|------------|-----------------|----------
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]
Enabled | Execution location | Run environments | Run conditions | Documentation
--------|---------------------|-------------------|-----------------|---------------
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_
Guida per i contributori
Apri la guida per i contributori
Direzione di ricerca
Inizia con il materiale didattico collegato e il modello di runbook Atlassian presenti in questa issue, quindi documenta un progetto che hai distribuito utilizzando le tecnologie cloud del modulo. Pubblica il runbook come documento nel repository del progetto e nel tuo portfolio, collegalo dal README del progetto e condividi il link al portfolio in Slack; il completamento si considera raggiunto quando sono presenti questi link e le istruzioni per la distribuzione, la validazione, il supporto e il monitoraggio.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- cloud
- Ambito
- cloud, devops, documentation
- Tipo di issue
- Documentazione
- Difficoltà
- 3/5
- Tempo stimato
- 1-2 giorni
- Stato di attività
- Ferma
- Chiarezza
- Specificata chiaramente
- Idoneità per principianti
- 35/100