Architecture Design Guide work items
Contents
Architecture Design Guide Reorganization
- Do not modify the current guide in openstack-manuals/docs/arch-design. A draft directory has been set up in openstack-manuals/docs/arch-design-draft.
- Please ensure your commit messages references the blueprint: Implements: blueprint arch-guide-mitaka-reorg
- To avoid merge conflicts, work in a different section to someone else.
Resources
[ https://etherpad.openstack.org/p/arch-guide-reorg etherpad] [ spec ]
Global changes
To assign yourself a task, put your name next to the task and reference the review URL. Change the status to complete when the task is completed.
- markup glossary terms
Chapter/Section
To assign yourself a task, put your name next to the task and reference the review URL. Change the status to complete when the task is completed.
Chapter 1. Introduction
1.1 Intended audience
- include content from the original guide
1.2 How this book is organized
- Rewrite this section mentioning the book follows a structure that system architects would use in developing cloud architecture design documents
1.3 Why and How we wrote this book
Chapter 2 Identifying stakeholders
- Describe who the internal and external stakeholders are, and the impact they may have on business requirements and architecture design.
Chapter 3 Functional Requirements
Chapter 4 User requirements
Chapter 5 Operator requirements
5.1 SLA considerations 5.2 Monitoring 5.3 Selecting hardware Selecting the right hardware - servers, switches, and how they integrate
5.4 integration with external IDP
Chapter 8. Security requirements
- include original content. Perhaps reference to the relevant sections in the Security Guide?
Chapter 9. Legal requirements
- include original content. Is it possible to include examples or things to consider?
Chapter 10. Example architectures
(reflecting concepts and terminology described in previous chapters) 10.1 Small scale, single site with Neutron networking 10.2 Adding another region 10.3 Scaling with multiple cells