Team Guide to Software Operability
Team Guide to Software Operability
Proven techniques for making software work well
About the Book
Team Guide to Software Operability is the first guidebook in the new collection from Skelton Thatcher Publications.
Learn how a focus on software operability helps to increase system reliability, reduce problems in Production, and reduce total cost of ownership (TCO).
The ‘Team Guide’ collection is designed to help teams building and running software systems to be as effective as possible.
Guides are curated by experienced practitioners and emphasise the need for collaboration and learning, with the team at the centre.
About the Authors
Bundles that include this book
About the Contributors
Manuel Pais is an independent DevOps and Delivery Consultant, focused on teams and flow.
With a diverse experience including development, build management, testing and QA, Manuel has helped large organizations in finance, legal, and manufacturing adopt test automation and continuous delivery, as well as understand DevOps from both technical and human perspectives.
Manuel is co-author of the Team Guide to Software Releasability book and lead editor for the remaining books in the Team Guide series.
Table of Contents
- Team Guides for Software
- Foreword
-
Introduction
- What is software operability and why should we care?
- Where can operability techniques be used?
- How to use this book
- What is covered in this book
- Why we wrote this book
- Feedback and suggestions
-
1. What does good operability look like?
- 1.1 Use operability checklists to assess core operability
- 1.2 Assess operability with real people regularly
- 1.3 Provide a good User Experience for all agents and all users, external and internal
- 1.4 Treat operational aspects as product features: viable, configurable, deployable, diagnosable, reliable, well-performing, securable, observable, recoverable
- 1.5 Good operability does not necessarily mean good safety or ethics
- 1.6 Summary
-
2. Core practices for good software operability
- 2.1 Logging and metrics are the first features to implement
- 2.2 Enumerate all likely failure modes of the software
- 2.3 Use well-defined, meaningful event identifiers
- 2.4 Define and track at least one KPI or SLI per service
- 2.5 Include operational hooks as first-class features
- 2.6 ‘DONE’ means working correctly in Production
- 2.7 Treat Operations as a high-skill activity
- 2.8 The software development team writes a draft Run Book
- 2.9 Avoid a separate ‘Production-ization’ or ‘Hardening’ phase
- 2.10 Avoid Production-specific tools
- 2.11 Talk about ‘operational features’, not ‘non-functional requirements’
- 2.12 Developers and Product Owners should be on-call
- 2.13 Make operational problems visible
- 2.14 Test for operability in a deployment pipeline
- 2.15 Summary
-
3. Use Run Book collaboration to increase operability and prevent operational issues
- 3.1 Operational aspects are very similar across many software systems
- 3.2 Use a Run Book template as a common baseline for operational aspects
- 3.3 Use a Run Book Dialogue Sheet to facilitate discovery and avoid ‘documentation fallacy’
- 3.4 Assess operability on a regular basis: every sprint, iteration, or week
- 3.5 Summary
-
4. Use modern log aggregation and metrics for deep operational insights
- 4.1 Use logging to help design and understand distributed systems
- 4.2 Collect and aggregate logs and metrics centrally using standard tools & software
- 4.3 Focus on collaboration, design decisions, and team experience
- 4.4 Identify 2 or 3 key application metrics and test these early on
- 4.5 Run log aggregation and metrics locally on development workstations
- 4.6 Hide sensitive information at the point of logging
- 4.7 Use Structured Logging for greater meaning
- 4.8 Use Event IDs for visibility of application behaviour
- 4.9 Collaborate on Event IDs to enhance operability
- 4.10 Test your logging and metrics
- 4.11 Trace operations across system boundaries with correlation IDs
- 4.12 Adapt your logging and metrics techniques to the technology characteristics
- 4.13 Summary
-
5. Use well-defined readiness checks to increase operational confidence
- 5.1 Introduction
- 5.2 Define readiness checks so we know when a service is ‘ready’
- 5.3 Use Deployment Verification Tests (DVTs) to increase confidence in infrastructure
- 5.4 Expose Endpoint Healthchecks for persistent services to detect problems early
- 5.5 Provide custom diagnostic hooks to expose additional operational information
- 5.6 Run operational checks within a deployment pipeline to gain rapid feedback
- 5.7 Define a set of Service Readiness criteria to establish operational viability
- 5.8 Summary
-
6. Use information radiators and dashboards to drive effective behaviour and good psychological responses
- 6.1 Introduction
- 6.2 Invest time an effort in good dashboard design and information radiators
- 6.3 Avoid information overload - be selective about information on screen
- 6.4 Consider common psychological responses
- 6.5 Use dashboards to promote inter-team collaboration
- 6.6 Example: Using Dashboard visualisation in Formula 1
- 6.7 Be aware of typical mistakes with dashboard design
- 6.8 Summary
-
7. Make operability part of the software product
- 7.1 Overview: why we need a focus on operability
- 7.2 Use rich, time-series logging and metrics to drive product decisions
- 7.3 Go beyond the Agile “User Story” to address operability as a first-class concern
- 7.4 Use secondary User Personas to address operability aspects
- 7.5 Use a single backlog for visible features and operational features
- 7.6 Make operational aspects part of the team’s regular work
- 7.7 Address operational aspects from the very start and then throughout the delivery phase
- 7.8 Raise an alert if a team is spending less than ~30% of their time / effort / budget on operational aspects
- 7.9 Product Owners should be responsible for the operational success of the software
- 7.10 Developers, Testers, and Product Owners should be “on call” for operational problems
- 7.11 Understand the business case for operability
- 7.12 Encourage a culture of operability
- 7.13 Summary (?)
-
Appendix
- Adapt your logging techniques to the technology characteristics
- Understand how the complexity of modern distributed systems drives a need for a focus on operability
- Terminology
-
References and further reading
- Introduction
- Chapter 1 - What does good operability look like?
- Chapter 2 - Core Operability Practices
- Chapter 3 - Use Run Book collaboration to increase operability and prevent operational issues
- Chapter 4 - Use modern log aggregation for deep operational and insights
- Chapter 5 - Use Deployment Verification Tests and Endpoint Healthchecks for rapid feedback on environments
- Chapter 6 - Run operational checks within a deployment pipeline to gain rapid feedback and increased collaboration
- Chapter 7 - Use information radiators and dashboards to drive effective behaviour and good psychological responses
- Chapter 8 - Use operability as a differentiating aspect of your software
- Appendix
-
Run Book template
- Service or system overview
- System characteristics
- Required resources
- Security and access control
- System configuration
- System backup and restore
- Monitoring and alerting
- Operational tasks
- Maintenance tasks
- Failover and Recovery procedures
- Index
-
About the authors
- Matthew Skelton
- Alex Moore
- Rob Thatcher
- Conflux Books
- Notes
About the Publisher
This book is published on Leanpub by Conflux Digital Ltd
Authors have earned$10,266,166writing, publishing and selling on Leanpub, earning 80% royalties while saving up to 25 million pounds of CO2 and up to 46,000 trees.
Learn more about writing on Leanpub
The Leanpub 45-day 100% Happiness Guarantee
Within 45 days of purchase you can get a 100% refund on any Leanpub purchase, in two clicks.
See full terms
Free Updates. DRM Free.
If you buy a Leanpub book, you get free updates for as long as the author updates the book! Many authors use Leanpub to publish their books in-progress, while they are writing them. All readers get free updates, regardless of when they bought the book or how much they paid (including free).
Most Leanpub books are available in PDF (for computers), EPUB (for phones and tablets) and MOBI (for Kindle). The formats that a book includes are shown at the top right corner of this page.
Finally, Leanpub books don't have any DRM copy-protection nonsense, so you can easily read them on any supported device.
Learn more about Leanpub's ebook formats and where to read them
Top Books
- #1
C++20
Rainer GrimmC++20 is the next big C++ standard after C++11. As C++11 did it, C++20 changes the way we program modern C++. This change is, in particular, due to the big four of C++20: ranges, coroutines, concepts, and modules.
- #2
500 QUIZ MMG COMMENTATI
ALS Medicina Generale500 Quiz degli ULTIMI Concorsi di Medicina Generale (2014/2016/2017/2018/2019)
Riassunti e suddivisi per area con Griglia risposte vuota e Griglia risposte esatte Ministeriale
Commentati con link alla fonte per approfondimento e ausilio allo studio
- #3
R Programming for Data Science
Roger D. PengThis book brings the fundamentals of R programming to you, using the same material developed as part of the industry-leading Johns Hopkins Data Science Specialization. The skills taught in this book will lay the foundation for you to begin your journey learning data science. Printed copies of this book are available through Lulu.
- #4
Ansible for DevOps
Jeff GeerlingAnsible is a simple, but powerful, server and configuration management tool. Learn to use Ansible effectively, whether you manage one server—or thousands.
- #5
Atomic Kotlin
Bruce Eckel and Svetlana IsakovaFor both beginning and experienced programmers! From the author of the multi-award-winning Thinking in C++ and Thinking in Java together with a member of the Kotlin language team comes a book that breaks the concepts into small, easy-to-digest "atoms," along with exercises supported by hints and solutions directly inside IntelliJ IDEA!
- #6
Continuous Delivery Pipelines
Dave FarleyThis practical handbook provides a step-by-step guide for you to get the best continuous delivery pipeline for your software.
- #7
C++ Best Practices
Jason TurnerLevel up your C++, get the tools working for you, eliminate common problems, and move on to more exciting things!
- #8
Visualise, document and explore your software architecture
Simon BrownA short guide to visualising, documenting and exploring your software architecture.
- #9
Discrete Mathematics for Computer Science
Alexander Shen, Alexander S. Kulikov, Vladimir Podolskii, and Aleksandr GolovnevThis book supplements the DM for CS Specialization at Coursera and contains many interactive puzzles, autograded quizzes, and code snippets. They are intended to help you to discover important ideas in discrete mathematics on your own. By purchasing the book, you will get all updates of the book free of charge when they are released.
- #10
Functional Design and Architecture
Alexander GraninSoftware Design in Functional Programming, Design Patterns and Practices, Methodologies and Application Architectures. How to build real software in Haskell with less efforts and low risks. The first complete source of knowledge.
Top Bundles
- #1
Software Architecture for Developers: Volumes 1 & 2 - Technical leadership and communication
2 Books
"Software Architecture for Developers" is a practical and pragmatic guide to modern, lightweight software architecture, specifically aimed at developers. You'll learn:The essence of software architecture.Why the software architecture role should include coding, coaching and collaboration.The things that you really need to think about before... - #2
Software Architecture and Design Practice Reference
2 Books
Dive deeper in Software Architecture with the Design Practice Reference. Learn all about software architecture and design from the books in this bundle:Software Architecture covers topics from quality attributes to designing and modeling components, interfaces, connectors, and containers, all the way to services and microservices. The Design... - #6
Linux Administration Complet
4 Books
Ce lot comprend les quatre volumes du Guide Linux Administration :Linux Administration, Volume 1, Administration fondamentale : Guide pratique de préparation aux examens de certification LPIC 1, Linux Essentials, RHCSA et LFCS. Administration fondamentale. Introduction à Linux. Le Shell. Traitement du texte. Arborescence de fichiers. Sécurité... - #7
The Python Craftsman
3 Books
The Python Craftsman series comprises The Python Apprentice, The Python Journeyman, and The Python Master. The first book is primarily suitable for for programmers with some experience of programming in another language. If you don't have any experience with programming this book may be a bit daunting. You'll be learning not just a programming... - #8
All the Books of The Medical Futurist
6 Books
We put together the most popular books from The Medical Futurist to provide a clear picture about the major trends shaping the future of medicine and healthcare. Digital health technologies, artificial intelligence, the future of 20 medical specialties, big pharma, data privacy, digital health investments and how technology giants such as Amazon... - #10
Mastering Containers
2 Books
Docker and Kubernetes are taking the world by storm! These books will get you up-to-speed fast! Docker Deep Dive is over 400 pages long, and covers all objectives on the Docker Certified Associate exam.The Kubernetes Book includes everything you need to get up and running with Kubernetes!
