Jump to: navigation, search

Difference between revisions of "Architecture Design Guide work items"

m (Chapter 9. Legal requirements)
m (Chapter 3 Functional Requirements)
 
(12 intermediate revisions by 2 users not shown)
Line 10: Line 10:
  
 
[https://review.openstack.org/#/q/topic:bp/arch-guide-mitaka-reorg reviews] and for those of us with dyslexia [https://review.openstack.org/#/q/topic:bp/archguide-mitaka-reorg archguide-reviews]
 
[https://review.openstack.org/#/q/topic:bp/arch-guide-mitaka-reorg reviews] and for those of us with dyslexia [https://review.openstack.org/#/q/topic:bp/archguide-mitaka-reorg archguide-reviews]
 +
[http://superuser.openstack.org/articles/why-the-discovery-process-is-the-openstack-cloud-architect-s-best-friend Cloud architect article]
  
 
== Global tasks==
 
== Global tasks==
Line 36: Line 37:
  
 
===Chapter 2 Identifying stakeholders===
 
===Chapter 2 Identifying stakeholders===
* Describe who the internal and external stakeholders are, and the impact they may have on business requirements and architecture design.  
+
* Describe who the internal and external stakeholders are, and the impact they may have on business requirements and architecture design. (Alexandra Settle)
  
 
See [https://bugs.launchpad.net/openstack-manuals/+bug/1548148 Launchpad bug 1548148]
 
See [https://bugs.launchpad.net/openstack-manuals/+bug/1548148 Launchpad bug 1548148]
  
 
===Chapter 3 Functional Requirements===
 
===Chapter 3 Functional Requirements===
* Information from SMEs
+
* Information from SMEs - Alexandra Settle (contacted potential SME's) https://review.openstack.org/#/c/304973/
 
* Mention deployment methods will affect cost, and reference to http://docs.openstack.org/openstack-ops/content/section_arch_provision.html the ops-guide
 
* Mention deployment methods will affect cost, and reference to http://docs.openstack.org/openstack-ops/content/section_arch_provision.html the ops-guide
 
* Do we need to expand http://docs.openstack.org/openstack-ops/content/section_arch_provision.html to include other deployment methods? If so, what are they?
 
* Do we need to expand http://docs.openstack.org/openstack-ops/content/section_arch_provision.html to include other deployment methods? If so, what are they?
Line 47: Line 48:
 
See [https://bugs.launchpad.net/openstack-manuals/+bug/1548154 Launchpad bug 1548154]
 
See [https://bugs.launchpad.net/openstack-manuals/+bug/1548154 Launchpad bug 1548154]
  
===Chapter 4 User requirements===
+
===Chapter 4 User requirements===  
* Information from SMEs
+
* Information from SMEs (Brian Moss - https://review.openstack.org/#/c/290261/)
 
* Business and technical requirements, consolidate http://docs.openstack.org/arch-design/generalpurpose-user-requirements.html, http://docs.openstack.org/arch-design/storage-focus-technical-considerations.html, http://docs.openstack.org/arch-design/network-focus-user-requirements.html#, http://docs.openstack.org/arch-design/multi-site-user-requirements.html, http://docs.openstack.org/arch-design/hybrid-user-requirements.html, http://docs.openstack.org/arch-design/hybrid-technical-considerations.html, http://docs.openstack.org/arch-design/massively-scalable-user-requirements.html .   
 
* Business and technical requirements, consolidate http://docs.openstack.org/arch-design/generalpurpose-user-requirements.html, http://docs.openstack.org/arch-design/storage-focus-technical-considerations.html, http://docs.openstack.org/arch-design/network-focus-user-requirements.html#, http://docs.openstack.org/arch-design/multi-site-user-requirements.html, http://docs.openstack.org/arch-design/hybrid-user-requirements.html, http://docs.openstack.org/arch-design/hybrid-technical-considerations.html, http://docs.openstack.org/arch-design/massively-scalable-user-requirements.html .   
  
Line 65: Line 66:
 
=== Chapter 6 Capacity planning and scaling ===
 
=== Chapter 6 Capacity planning and scaling ===
 
* Consolidate http://docs.openstack.org/arch-design/hybrid-technical-considerations.html#capacity-planning, http://docs.openstack.org/arch-design/compute-focus-operational-considerations.html#capacity-planning, http://docs.openstack.org/arch-design/massively-scalable-operational-considerations.html#growth-and-capacity-planning, http://docs.openstack.org/arch-design/multi-site-technical-considerations.html, http://docs.openstack.org/arch-design/hybrid-technical-considerations.html#capacity-planning
 
* Consolidate http://docs.openstack.org/arch-design/hybrid-technical-considerations.html#capacity-planning, http://docs.openstack.org/arch-design/compute-focus-operational-considerations.html#capacity-planning, http://docs.openstack.org/arch-design/massively-scalable-operational-considerations.html#growth-and-capacity-planning, http://docs.openstack.org/arch-design/multi-site-technical-considerations.html, http://docs.openstack.org/arch-design/hybrid-technical-considerations.html#capacity-planning
 +
See [https://bugs.launchpad.net/openstack-manuals/+bug/1548179 Launchpag bug 1548179]
  
 
* 6.1 Storage [mjrichardson, review TBA]
 
* 6.1 Storage [mjrichardson, review TBA]
Line 76: Line 78:
 
http://docs.openstack.org/arch-design/generalpurpose-technical-considerations.html#designing-network-resources, http://docs.openstack.org/arch-design/network-focus-technical-considerations.html,  
 
http://docs.openstack.org/arch-design/generalpurpose-technical-considerations.html#designing-network-resources, http://docs.openstack.org/arch-design/network-focus-technical-considerations.html,  
 
http://docs.openstack.org/arch-design/network-focus-architecture.html#tunable-networking-components, http://docs.openstack.org/arch-design/multi-site-architecture.html#networking, http://docs.openstack.org/arch-design/hybrid-user-requirements.html#network-considerations, http://docs.openstack.org/arch-design/hybrid-architecture.html,  
 
http://docs.openstack.org/arch-design/network-focus-architecture.html#tunable-networking-components, http://docs.openstack.org/arch-design/multi-site-architecture.html#networking, http://docs.openstack.org/arch-design/hybrid-user-requirements.html#network-considerations, http://docs.openstack.org/arch-design/hybrid-architecture.html,  
 +
 +
See [https://bugs.launchpad.net/openstack-manuals/+bug/1548182 Launchpad bug 1548182]
 +
 
* 6.3 Compute
 
* 6.3 Compute
 
**See http://docs.openstack.org/arch-design/generalpurpose-technical-considerations.html#compute-resource-design
 
**See http://docs.openstack.org/arch-design/generalpurpose-technical-considerations.html#compute-resource-design
 
* 6.4 Control plane API services & Horizon
 
* 6.4 Control plane API services & Horizon
 +
 +
See [https://bugs.launchpad.net/openstack-manuals/+bug/1548184 Launchpad bug 1548184]
  
 
===Chapter 7. High Availability===
 
===Chapter 7. High Availability===
Line 106: Line 113:
 
* 10.3 Scaling with multiple cells
 
* 10.3 Scaling with multiple cells
 
* Real world examples: http://docs.openstack.org/arch-design/compute-focus-prescriptive-examples.html (Njira Perci, In Progress)
 
* Real world examples: http://docs.openstack.org/arch-design/compute-focus-prescriptive-examples.html (Njira Perci, In Progress)
 +
 +
See [https://bugs.launchpad.net/openstack-manuals/+bug/1548176 Launchpad bug 1548176]

Latest revision as of 05:58, 18 April 2016

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 archguide-mitaka-reorg
  • We are currently converting work items to Launchpad bugs and adding the bug number next to the work item.

Resources

etherpad

spec

reviews and for those of us with dyslexia archguide-reviews Cloud architect article

Global tasks

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 - Shilla Saebi
  • 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.2 How this book is organized (Njira Perci, https://review.openstack.org/260045/, Merged)
    • 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 - Shilla Saebi
    • 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. (Alexandra Settle)

See Launchpad bug 1548148

Chapter 3 Functional Requirements

See Launchpad bug 1548154

Chapter 4 User requirements

See Launchpad bug 1548149

Chapter 5 Operator requirements

Chapter 6 Capacity planning and scaling

See Launchpag bug 1548179

http://docs.openstack.org/arch-design/generalpurpose-technical-considerations.html#designing-network-resources, http://docs.openstack.org/arch-design/network-focus-technical-considerations.html, http://docs.openstack.org/arch-design/network-focus-architecture.html#tunable-networking-components, http://docs.openstack.org/arch-design/multi-site-architecture.html#networking, http://docs.openstack.org/arch-design/hybrid-user-requirements.html#network-considerations, http://docs.openstack.org/arch-design/hybrid-architecture.html,

See Launchpad bug 1548182

See Launchpad bug 1548184

Chapter 7. High Availability

(Xav Paice, review https://review.openstack.org/260856 Merged)

Chapter 8. Security requirements

Chapter 9. Legal requirements

See Launchpad bug 1548175

Chapter 10 Cloud architecture examples

(reflecting concepts and terminology described in previous chapters)

See Launchpad bug 1548176