Difference between revisions of "Architecture Design Guide work items"
(→Chapter 1. Introduction) |
m (→Chapter 3 Functional Requirements) |
||
(57 intermediate revisions by 6 users not shown) | |||
Line 1: | Line 1: | ||
= Architecture Design Guide Reorganization= | = 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.''''' | '''''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 | + | * 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== | ==Resources== | ||
[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. | + | [http://specs.openstack.org/openstack/docs-specs/specs/mitaka/archguide-mitaka-reorg.html spec] |
+ | |||
+ | [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== | ||
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. | 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 | + | * Rewrite abstract - Shilla Saebi |
* Markup glossary terms | * 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? | * 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? | ||
Line 24: | Line 27: | ||
===Chapter 1. Introduction=== | ===Chapter 1. Introduction=== | ||
− | *1.1 Intended audience (Njira Perci, https://review.openstack.org/259998/, | + | *1.1 Intended audience (Njira Perci, https://review.openstack.org/259998/, Merged) |
− | ** include content from the original guide | + | ** include content from the original guide |
− | *1.2 How this book is organized (Njira Perci, | + | *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 | **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 | + | *1.3 Why and How we wrote this book - Shilla Saebi |
** Include section? | ** Include section? | ||
===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] | ||
===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? | ||
− | ===Chapter 4 User requirements=== | + | See [https://bugs.launchpad.net/openstack-manuals/+bug/1548154 Launchpad bug 1548154] |
− | * Information from SMEs | + | |
− | * 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 | + | ===Chapter 4 User requirements=== |
+ | * 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 . | ||
+ | |||
+ | See [https://bugs.launchpad.net/openstack-manuals/+bug/1548149 Launchpad bug 1548149] | ||
=== Chapter 5 Operator requirements=== | === Chapter 5 Operator requirements=== | ||
− | * Consolidate http://docs.openstack.org/arch-design/hybrid-operational-considerations.html, http://docs.openstack.org/arch-design/storage-focus-operational-considerations.html, http://docs.openstack.org/arch-design/network-focus-operational-considerations.html, http://docs.openstack.org/arch-design/multi-site-operational-considerations.html, http://docs.openstack.org/arch-design/hybrid-operational-considerations.html, http://docs.openstack.org/arch-design/massively-scalable-user-requirements.html#operator-requirements (Xav, review | + | * <strike>Consolidate http://docs.openstack.org/arch-design/hybrid-operational-considerations.html, http://docs.openstack.org/arch-design/storage-focus-operational-considerations.html, http://docs.openstack.org/arch-design/network-focus-operational-considerations.html, http://docs.openstack.org/arch-design/multi-site-operational-considerations.html, http://docs.openstack.org/arch-design/hybrid-operational-considerations.html, http://docs.openstack.org/arch-design/massively-scalable-user-requirements.html#operator-requirements (Xav, review https://review.openstack.org/#/c/260238)</strike> |
− | * 5.1 SLA considerations (Xav Paice, https://review.openstack.org/259823) | + | * <strike>5.1 SLA considerations (Xav Paice, https://review.openstack.org/259823, Merged)</strike> |
− | * 5.2 Monitoring - - consolidate http://docs.openstack.org/arch-design/compute-focus-operational-considerations.html#monitoring, | + | * <strike>5.2 Monitoring - - consolidate http://docs.openstack.org/arch-design/compute-focus-operational-considerations.html#monitoring, (also in https://review.openstack.org/#/c/260238)</strike> |
− | * 5.3 Selecting hardware | + | * <strike>5.3 Selecting hardware |
**Selecting the right hardware - servers, switches, and how they integrate | **Selecting the right hardware - servers, switches, and how they integrate | ||
− | ** Consolidate http://docs.openstack.org/arch-design/generalpurpose-architecture.html, http://docs.openstack.org/arch-design/compute-focus-architecture.html, http://docs.openstack.org/arch-design/storage-focus-architecture.html | + | ** Consolidate http://docs.openstack.org/arch-design/generalpurpose-architecture.html, http://docs.openstack.org/arch-design/compute-focus-architecture.html, http://docs.openstack.org/arch-design/storage-focus-architecture.html (Darren Chan, reivew TBA), http://docs.openstack.org/arch-design/specialized-hardware.html</strike> |
* 5.4 integration with external IDP | * 5.4 integration with external IDP | ||
− | * 5.5 Upgrades?http://docs.openstack.org/arch-design/multi-site-operational-considerations.html#upgrades | + | * <strike>5.5 Upgrades?http://docs.openstack.org/arch-design/multi-site-operational-considerations.html#upgrades (see https://review.openstack.org/#/c/260238)</strike> |
=== 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 | + | * 6.1 Storage [mjrichardson, review TBA] |
− | ** Consolidate http://docs.openstack.org/arch-design/hybrid-architecture.html#data, http://docs.openstack.org/arch-design/multi-site-architecture.html#storage, http://docs.openstack.org/arch-design/hybrid-architecture.html#data | + | ** <strike>Consolidate http://docs.openstack.org/arch-design/hybrid-architecture.html#data, http://docs.openstack.org/arch-design/multi-site-architecture.html#storage, http://docs.openstack.org/arch-design/hybrid-architecture.html#data</strike> |
** Shared storage, implications for live migration | ** Shared storage, implications for live migration | ||
** Protecting data-at-rest | ** Protecting data-at-rest | ||
Line 68: | 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=== | ||
+ | <strike>(Xav Paice, review https://review.openstack.org/260856 Merged) | ||
+ | |||
* Consolidate http://docs.openstack.org/arch-design/hybrid-architecture.html#network-services, http://docs.openstack.org/arch-design/generalpurpose-technical-considerations.html, http://docs.openstack.org/arch-design/network-focus-user-requirements.html#high-availability-issues, http://docs.openstack.org/arch-design/multi-site-user-requirements.html#high-availability | * Consolidate http://docs.openstack.org/arch-design/hybrid-architecture.html#network-services, http://docs.openstack.org/arch-design/generalpurpose-technical-considerations.html, http://docs.openstack.org/arch-design/network-focus-user-requirements.html#high-availability-issues, http://docs.openstack.org/arch-design/multi-site-user-requirements.html#high-availability | ||
* Separation of data plane and control plane | * Separation of data plane and control plane | ||
* Eliminating single points of failure | * Eliminating single points of failure | ||
− | * The services that must remain up 100%, and those that can be restarted without affecting users | + | * The services that must remain up 100%, and those that can be restarted without affecting users</strike> |
===Chapter 8. Security requirements=== | ===Chapter 8. Security requirements=== | ||
− | * Include original content. Perhaps reference to the relevant sections in the Security Guide? | + | *<strike> Include original content. Perhaps reference to the relevant sections in the Security Guide? |
− | * See also http://docs.openstack.org/arch-design/generalpurpose-technical-considerations.html#security | + | ** See also http://docs.openstack.org/arch-design/generalpurpose-technical-considerations.html#security (Darren Chan, https://review.openstack.org/#/c/259844/, merged)</strike> |
+ | * REDIRECT [[Target page name]] | ||
===Chapter 9. Legal requirements=== | ===Chapter 9. Legal requirements=== | ||
− | * Include original content. | + | * <strike>Include original content (Darren Chan, https://review.openstack.org/#/c/260286/, merged)</strike> |
+ | * Include things to consider and how this impacts the cloud architecture design | ||
− | ===Chapter 10 | + | See [https://bugs.launchpad.net/openstack-manuals/+bug/1548175 Launchpad bug 1548175] |
+ | |||
+ | ===Chapter 10 Cloud architecture examples === | ||
(reflecting concepts and terminology described in previous chapters) | (reflecting concepts and terminology described in previous chapters) | ||
− | * Are any of | + | * Are any of these examples applicable: http://docs.openstack.org/arch-design/hybrid-prescriptive-examples.html, http://docs.openstack.org/arch-design/storage-focus-prescriptive-examples.html, http://docs.openstack.org/arch-design/network-focus-prescriptive-examples.html,http://docs.openstack.org/arch-design/hybrid-prescriptive-examples.html, http://docs.openstack.org/arch-design/specialized.html |
* 10.1 Small scale, single site with Neutron networking | * 10.1 Small scale, single site with Neutron networking | ||
* 10.2 Adding another region | * 10.2 Adding another region | ||
* 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 | + | * 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
Contents
- 1 Architecture Design Guide Reorganization
- 1.1 Resources
- 1.2 Global tasks
- 1.3 Chapter/Section tasks
- 1.3.1 Chapter 1. Introduction
- 1.3.2 Chapter 2 Identifying stakeholders
- 1.3.3 Chapter 3 Functional Requirements
- 1.3.4 Chapter 4 User requirements
- 1.3.5 Chapter 5 Operator requirements
- 1.3.6 Chapter 6 Capacity planning and scaling
- 1.3.7 Chapter 7. High Availability
- 1.3.8 Chapter 8. Security requirements
- 1.3.9 Chapter 9. Legal requirements
- 1.3.10 Chapter 10 Cloud architecture examples
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
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.1 Intended audience (Njira Perci, https://review.openstack.org/259998/, Merged)
- include content from the original guide
- 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)
Chapter 3 Functional Requirements
- 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
- 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?
Chapter 4 User requirements
- 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 .
Chapter 5 Operator requirements
-
Consolidate http://docs.openstack.org/arch-design/hybrid-operational-considerations.html, http://docs.openstack.org/arch-design/storage-focus-operational-considerations.html, http://docs.openstack.org/arch-design/network-focus-operational-considerations.html, http://docs.openstack.org/arch-design/multi-site-operational-considerations.html, http://docs.openstack.org/arch-design/hybrid-operational-considerations.html, http://docs.openstack.org/arch-design/massively-scalable-user-requirements.html#operator-requirements (Xav, review https://review.openstack.org/#/c/260238) -
5.1 SLA considerations (Xav Paice, https://review.openstack.org/259823, Merged) -
5.2 Monitoring - - consolidate http://docs.openstack.org/arch-design/compute-focus-operational-considerations.html#monitoring, (also in https://review.openstack.org/#/c/260238) -
5.3 Selecting hardware- Selecting the right hardware - servers, switches, and how they integrate
- Consolidate http://docs.openstack.org/arch-design/generalpurpose-architecture.html, http://docs.openstack.org/arch-design/compute-focus-architecture.html, http://docs.openstack.org/arch-design/storage-focus-architecture.html (Darren Chan, reivew TBA), http://docs.openstack.org/arch-design/specialized-hardware.html
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
- 6.1 Storage [mjrichardson, review TBA]
-
Consolidate http://docs.openstack.org/arch-design/hybrid-architecture.html#data, http://docs.openstack.org/arch-design/multi-site-architecture.html#storage, http://docs.openstack.org/arch-design/hybrid-architecture.html#data - Shared storage, implications for live migration
- Protecting data-at-rest
-
- 6.2 Networking
- Neutron considerations with router design - DVR or centralized
- Consolidate http://docs.openstack.org/arch-design/hybrid-architecture.html#network-services
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,
- 6.3 Compute
- 6.4 Control plane API services & Horizon
Chapter 7. High Availability
(Xav Paice, review https://review.openstack.org/260856 Merged)
- Consolidate http://docs.openstack.org/arch-design/hybrid-architecture.html#network-services, http://docs.openstack.org/arch-design/generalpurpose-technical-considerations.html, http://docs.openstack.org/arch-design/network-focus-user-requirements.html#high-availability-issues, http://docs.openstack.org/arch-design/multi-site-user-requirements.html#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?- See also http://docs.openstack.org/arch-design/generalpurpose-technical-considerations.html#security (Darren Chan, https://review.openstack.org/#/c/259844/, merged)
Chapter 9. Legal requirements
-
Include original content (Darren Chan, https://review.openstack.org/#/c/260286/, merged) - Include things to consider and how this impacts the cloud architecture design
Chapter 10 Cloud architecture examples
(reflecting concepts and terminology described in previous chapters)
- Are any of these examples applicable: http://docs.openstack.org/arch-design/hybrid-prescriptive-examples.html, http://docs.openstack.org/arch-design/storage-focus-prescriptive-examples.html, http://docs.openstack.org/arch-design/network-focus-prescriptive-examples.html,http://docs.openstack.org/arch-design/hybrid-prescriptive-examples.html, http://docs.openstack.org/arch-design/specialized.html
- 10.1 Small scale, single site with Neutron networking
- 10.2 Adding another region
- 10.3 Scaling with multiple cells
- Real world examples: http://docs.openstack.org/arch-design/compute-focus-prescriptive-examples.html (Njira Perci, In Progress)