Jump to: navigation, search

Architecture Design Guide work items

Revision as of 04:38, 18 December 2015 by Darren Chan (talk | contribs) (Chapter 3 Functional Requirements)

Architecture Design Guide Reorganization

  • Do not modify the current guide in openstack-manuals/docs/arch-design. Commit your work to the draft directory openstack-manuals/docs/arch-design-draft.
  • Please ensure your commit messages references the blueprint: Implements: blueprint arch-guide-mitaka-reorg
  • If you need diagrams, ping darrenc.




Global task

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.

  • Rewrite abstract
  • markup glossary terms
  • How about we condense the use case information as a chapter at the start of the book, and mention hybrid as the main focus in the guide?
  • Mention http://docs.openstack.org/openstack-ops/content/cloud_controller_design.html
  • Would including a generic architecture design planning template in an appendix be useful or relevant?
  • Considerations when designing an OpenStack cloud in a development, staged or production environment

Chapter/Section tasks

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
    • 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
    • Include section?

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

  • Information from SMEs

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

  • 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