This document is provided for informational purposes only. It represents the current product offerings and practices from Amazon Web Services (AWS) as of the date of issue of this document, which are subject to change without notice. Customers are responsible for making their own independent assessment of the information in this document and any use of AWS products or services, each of which is provided “as is” without warranty of any kind, whether express or implied. This document does not create any warranties, representations, contractual commitments, conditions, or assurances from AWS, its affiliates, suppliers, or licensors. The responsibilities and liabilities of AWS to its customers are controlled by AWS agreements, and this document is not part of, nor does it modify, any agreement between AWS and its customers.
© 2024 Amazon Web Services, Inc. or its affiliates. All Rights Reserved. This work is licensed under a Creative Commons Attribution 4.0 International License.
This AWS Content is provided subject to the terms of the AWS Customer Agreement available at http://aws.amazon.com/agreement or other written agreement between the Customer and either Amazon Web Services, Inc. or Amazon Web Services EMEA SARL or both.
Author: Author Name
Approver: Approver Name
Last Date Approved: 3/25/2024
Preparation
This playbook outlines the process to create a new playbook/runbook, transition the document from DRAFT to APPROVED, and re-validation requirements using GitLab.
For more advanced playbook creation, please reference the AWS Incident Response Playbooks Workshop
It is important to maintain our runbooks to dive deep and deliver results quickly to customers. Per Matthew Helmke “Runbooks help us as a part of a wider set of practices, all designed to build reliability. Keeping runbooks up-to-date is a vital part of site reliability engineering.” (https://www.gremlin.com/blog/ensuring-runbooks-are-up-to-date/)
Our team uses Github to manage documentation. Look at References to see some abbreviated steps for our process flow.
# Playbook: Playbook/Runbook# Tooling: ToolNameAssociate Issue: (./issues/1)customer correspondence mmethod and request review/comment.In order for a Playbook to be approved at least two (2) team members must have reviewed and added their names and a comment in the associated issue
Update and implement any recommendations or corrections to the document
Once your document has been reviewed and all corrections made, submit your document for the approval process to be finalized.
approverapprover letting him know the document is ready for final review[Playbook Creation Process](./docs/Playbook_Creation_Process.md)Note: Remember that all steps prior to the merge request MUST be completed within your working branch
user A, user B, user C.TBD
customer correspondence mechanism and request review/comment.In order for a Playbook to be approved at least two (2) team members must have reviewed and added their names and a comment in the associated issue
Update and implement any recommendations or corrections to the document
Once your document has been reviewed and all corrections made, submit your document for the approval process to be finalized.
approverapprover letting them know the document is ready for final review[Playbook Creation Process](./docs/Playbook_Creation_Process.md)Note: Remember that all steps prior to the merge request MUST be completed within your working branch
user A, user B, user CTBD
Team Owners
Review the document and associated issue in GitHub
Delete REVIEW from the title of the document
Delete the statement THIS IS A DRAFT PLAYBOOK from the document
Last Date Approved as YYYY/MM/DD for when you approve the documentWe use issues to track ongoing and completed work. Additionally, this assists the team with transitioning through our review and approval process. This also permits comments from reviewers to address anything withing repository objects as part of our documentation bar raiser process.
customer milestone hereWe work in individual branches so in progress work does not interfere with what others may be doing in real-time.
Graphical User Interface: the GUI allows you to interact with GitHub from a web browser to interact with this repository
Command Line Interface: the CLI allows you to interact with GitHub form the command-line
Merge Request(s) allow a secondary bar raiser review prior to merging with the parent repository.
Command Line Interface: the CLI allows you to interact with GitHub form the command-line