Jump to: navigation, search

Difference between revisions of "Architecture Design Guide work items"

Line 6: Line 6:
[[ https://etherpad.openstack.org/p/arch-guide-reorg etherpad]]
[https://etherpad.openstack.org/p/arch-guide-reorg etherpad]
[[ http://specs.openstack.org/openstack/docs-specs/specs/mitaka/arch-guide-mitaka-reorg.html spec ]
[http://specs.openstack.org/openstack/docs-specs/specs/mitaka/arch-guide-mitaka-reorg.html spec]
== Global changes==
== Global changes==

Revision as of 00:35, 18 December 2015

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.
  • If you need diagrams, ping darrenc.


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.

  1. markup glossary terms


To assign yourself a task, put your name next to the section or task and reference the review URL. Change the status to complete when the task is completed.

Chapter 1. Introduction

1.1 Intended audience

  1. include content from the original guide

1.2 How this book is organized

  1. 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 6 Capacity planning and scaling

  • 6.1 Storage
    • Shared storage, implications for live migration
    • Protecting data-at-rest
  • 6.2 Networking
    • Neutron considerations with router design - DVR or centralized
  • 6.3 Compute
  • 6.4 Control plane API services & Horizon

Chapter 7. High Availability

  • Separation of data plane and control plane
  • Eliminating single points of failure
  • The services that must remain up 100%, and those that can be restarted without affecting users

Chapter 8. Security requirements

  1. include original content. Perhaps reference to the relevant sections in the Security Guide?

Chapter 9. Legal requirements

  1. 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