Jump to: navigation, search

Difference between revisions of "Architecture Design Guide restructure work items"

m (Chapter 5 Design)
(Tasks)
 
(44 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 
= Architecture Design Guide Restructure=
 
= Architecture Design Guide Restructure=
 
  '''''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 arch-guide-restructure''
+
* Please ensure your commit messages references the blueprint: '''Implements: blueprint arch-guide-restructure'''
 
   
 
   
  
 
==Resources==
 
==Resources==
 
[http://specs.openstack.org/openstack/docs-specs/specs/newton/arch-guide-restructure.html Newton specification]
 
[http://specs.openstack.org/openstack/docs-specs/specs/newton/arch-guide-restructure.html Newton specification]
 +
 +
[https://review.openstack.org/#/c/392372/7 Ocata specification]
  
 
[https://review.openstack.org/#/q/topic:bp/arch-guide-restructure Arch Guide-reviews]
 
[https://review.openstack.org/#/q/topic:bp/arch-guide-restructure Arch Guide-reviews]
Line 11: Line 13:
 
[http://superuser.openstack.org/articles/why-the-discovery-process-is-the-openstack-cloud-architect-s-best-friend Cloud architect article]
 
[http://superuser.openstack.org/articles/why-the-discovery-process-is-the-openstack-cloud-architect-s-best-friend Cloud architect article]
  
== Global tasks==
+
==Pike release goals==
 
+
* Focus on writing the Design chapter
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.
+
** Highest priority is completing the storage and networking sections
* Write abstract
+
** Complete other sections in the Design chapter
* Markup glossary terms
+
* Develop a use case template
<br />
+
* Remove arch content from the ops guide since it has been migrated to the arch guide
 +
* Archive the current arch guide
  
== Chapter/Section tasks==
+
===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.
+
* Rearchitect the storage chapter
  
===Chapter 1 Overview ===
+
==Ocata release goals==
 +
* Complete compute section in Design chapter
 +
* Publish draft guide to openstack-manuals (TBC)
  
  
 +
===Tasks===
 +
To assign yourself a task, put your name next to the section or task and reference the review URL. Change the status to DONE when the task is completed.
  
===Chapter 2 Use cases===
 
  
1.1. Development Cloud
+
{| class="wikitable"
Stakeholder
+
|-
User Stories
+
! Chapter !! Section !! Sub-section !! Assignee !! Bug number !! Progress
Design Model
+
|-
Component Block Diagram
+
| Overview  ||  || ||  || ||
 +
|-
 +
| Use cases || Development cloud ||  || Ben Silverman || || WIP
 +
|-
 +
| Use cases || General compute cloud || || Ben Silverman  || || WIP
 +
|-
 +
| Use cases || Web scale cloud || || Ben Silverman || || WIP
 +
|-
 +
| Use cases || Public cloud || || Ben Silverman || || WIP
 +
|-
 +
| Use cases || Network Function Virtualization (NFV) cloud || Design model || Ben Silverman  || || WIP
 +
|-
 +
| High Availability  ||  || ||  || || Ben to review migrated content
 +
|-
 +
| Capacity planning and scaling || The Starting Point || ||  || ||
 +
|-
 +
| Capacity planning and scaling || Adding Cloud Controller Nodes  || ||  || ||
 +
|-
 +
| Capacity planning and scaling || Segregating Your Cloud || ||  || ||
 +
|-
 +
| Capacity planning and scaling || Scalable Hardware || ||  || ||
 +
|-
 +
| Design || Compute service || Introduction || Ben Silverman  || || MERGED https://review.openstack.org/#/c/400525/4
 +
|-
 +
| Design || Compute service || Compute node technical detail  || Ben Silverman  || || MERGED  Change-Id: Ie269eb91a6cf3ea07a45bc2a86bf5080dd9e4989
 +
|-
 +
| Design || Compute service || Overview || Ben Silverman  || || MERGED Change-Id: Ie269eb91a6cf3ea07a45bc2a86bf5080dd9e4989
 +
|-
 +
| Design || Compute service || Choosing a CPU || Ben Silverman  || || MERGED Change-Id: Ib9c86d62a985976679de1d5e8fdd7e2aea5282a1
 +
|-
 +
| Design || Compute service || Choosing a hypervisor || Ben Silverman  || || MERGED Change-Id: I641cfee2d62bffb74d48fac0e7b580ef743dd757
 +
|-
 +
| Design || Compute service || Choosing server hardware || Ben Silverman  || || MERGED Change-Id: I5a52a3d7e9024126e02bb695e359a61320f4147a
 +
|-
 +
| Design || Compute service || Other hardware considerations || Ben Silverman  || || MERGED Change-Id: I5a52a3d7e9024126e02bb695e359a61320f4147a
 +
|-
 +
| Design || Compute service ||Instance Storage Solutions || Ben Silverman  || || Done
 +
|-
 +
| Design || Compute service || Overcommitting || Ben Silverman  || || Done
 +
|-
 +
| Design || Compute service || Logging || Ben Silverman  || || Done - Change-Id: I94b3065d605576ca48faff06a86865dc4b283bda
 +
|-
 +
| Design || Compute service || Networking || Ben Silverman  || || Done - Change-Id: I2054d3c59cfb8edb50ce3ebe903c3a7aaa62ddbf
 +
|-
 +
| Design || Compute service || Compute (server) hardware selection || Ben Silverman  || || BEN: I think this is redundant to 6.1.5
 +
|-
 +
| Design || Storage || Storage hardware selection || Ben Silverman || https://review.openstack.org/#/c/491274/ || MERGED
 +
|-
 +
| Design || Networking || || Shaun O'Meara ||https://review.openstack.org/#/c/391465/ || MERGED
 +
|-
 +
| Design || Networking || || Ben Silverman || || WIP - NICs etc.  
 +
|-
 +
| Design || Identity service || ||  || ||
 +
|-
 +
| Design || Image service || ||  || ||
 +
|-
 +
| Design || Control plane || ||  || ||
 +
|-
 +
| Design || Cloud Management Platform tools || ||  || ||
 +
|-
 +
|  ||  || ||  || ||
 +
|}
  
1.2 General Compute Cloud
+
==Newton goals==
Stakeholders
+
* Migrate http://docs.openstack.org/ops-guide/architecture.htm content to the Arch Guide under the relevant sections:
User Stories
+
**architecture.rst (Darren) https://review.openstack.org/#/c/324179/ Merged
Design Model
+
**arch_storage.rst (Darren) https://review.openstack.org/#/c/324179/ Merged
Component Block Diagram
+
**arch_scaling.rst (Darren) https://review.openstack.org/#/c/324179/ Merged
 +
** arch_provision.rst  <- Change title to planning and move to the Arch Guide (Darren)
 +
** arch_network_design.rst <- Move to network Section in Arch Guide. (Shaun)
 +
** arch_example_thoughts.rst <- Decide what to do with this content
 +
** arch_example_network.rst <- Move to network Section in Arch Guide (Shaun)
 +
** arch_example_neutron.rst <- Move to network Section in Arch Guide (Shaun)
 +
** arch_compute_nodes.rst (Darren) https://review.openstack.org/#/c/324179/ Merged
 +
** arch_cloud_controller.rst <- Move to control plane section DONE (Darren)
  
1.3 Web Scale Cloud
+
<br />
Stakeholders
 
User Stories
 
Design Model
 
Component Block Diagram
 
 
 
1.4 Public Cloud
 
Stakeholders
 
User Stories
 
Design Model
 
Component Block Diagram
 
 
 
===Chapter 3 High Availability===
 
 
 
 
 
===Chapter 4 Capacity and scale===
 
 
 
 
 
=== Chapter 5 Design===
 
5.1 Compute
 
 
 
5.2 Storage
 
 
 
5.3 Networking
 
 
 
5.4 Identity
 
 
 
5.5 Image
 
 
 
5.6 Control Plane
 
 
 
5.7 Dashboard and APIs
 

Latest revision as of 05:12, 7 August 2017

Architecture Design Guide Restructure

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-restructure


Resources

Newton specification

Ocata specification

Arch Guide-reviews

Cloud architect article

Pike release goals

  • Focus on writing the Design chapter
    • Highest priority is completing the storage and networking sections
    • Complete other sections in the Design chapter
  • Develop a use case template
  • Remove arch content from the ops guide since it has been migrated to the arch guide
  • Archive the current arch guide

Tasks

  • Rearchitect the storage chapter

Ocata release goals

  • Complete compute section in Design chapter
  • Publish draft guide to openstack-manuals (TBC)


Tasks

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


Chapter Section Sub-section Assignee Bug number Progress
Overview
Use cases Development cloud Ben Silverman WIP
Use cases General compute cloud Ben Silverman WIP
Use cases Web scale cloud Ben Silverman WIP
Use cases Public cloud Ben Silverman WIP
Use cases Network Function Virtualization (NFV) cloud Design model Ben Silverman WIP
High Availability Ben to review migrated content
Capacity planning and scaling The Starting Point
Capacity planning and scaling Adding Cloud Controller Nodes
Capacity planning and scaling Segregating Your Cloud
Capacity planning and scaling Scalable Hardware
Design Compute service Introduction Ben Silverman MERGED https://review.openstack.org/#/c/400525/4
Design Compute service Compute node technical detail Ben Silverman MERGED Change-Id: Ie269eb91a6cf3ea07a45bc2a86bf5080dd9e4989
Design Compute service Overview Ben Silverman MERGED Change-Id: Ie269eb91a6cf3ea07a45bc2a86bf5080dd9e4989
Design Compute service Choosing a CPU Ben Silverman MERGED Change-Id: Ib9c86d62a985976679de1d5e8fdd7e2aea5282a1
Design Compute service Choosing a hypervisor Ben Silverman MERGED Change-Id: I641cfee2d62bffb74d48fac0e7b580ef743dd757
Design Compute service Choosing server hardware Ben Silverman MERGED Change-Id: I5a52a3d7e9024126e02bb695e359a61320f4147a
Design Compute service Other hardware considerations Ben Silverman MERGED Change-Id: I5a52a3d7e9024126e02bb695e359a61320f4147a
Design Compute service Instance Storage Solutions Ben Silverman Done
Design Compute service Overcommitting Ben Silverman Done
Design Compute service Logging Ben Silverman Done - Change-Id: I94b3065d605576ca48faff06a86865dc4b283bda
Design Compute service Networking Ben Silverman Done - Change-Id: I2054d3c59cfb8edb50ce3ebe903c3a7aaa62ddbf
Design Compute service Compute (server) hardware selection Ben Silverman BEN: I think this is redundant to 6.1.5
Design Storage Storage hardware selection Ben Silverman https://review.openstack.org/#/c/491274/ MERGED
Design Networking Shaun O'Meara https://review.openstack.org/#/c/391465/ MERGED
Design Networking Ben Silverman WIP - NICs etc.
Design Identity service
Design Image service
Design Control plane
Design Cloud Management Platform tools

Newton goals