Architecture Design Guide restructure work items
Contents
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
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.
- Write abstract
- Markup glossary terms
- Migrate http://docs.openstack.org/ops-guide/architecture.htm content to the Arch Guide under the relevant sections:
- architecture.rst (Darren) https://review.openstack.org/#/c/324179/ Merged
- arch_storage.rst (Darren) https://review.openstack.org/#/c/324179/ Merged
- arch_scaling.rst (Darren) https://review.openstack.org/#/c/324179/ Merged
- arch_provision.rst <- This should stay in the Ops Guide but under a new section (Deployment?)
- arch_network_design.rst <- Stay in the Ops Guide?
- arch_example_thoughts.rst <- Decide what to do with this content
- arch_example_network.rst <- Decide what to do with this content
- arch_example_neutron.rst <- Decide what to do with this content
- arch_compute_nodes.rst (Darren) https://review.openstack.org/#/c/324179/ Merged
- arch_cloud_controller.rst <- Decide what to do with this content
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 Overview
Chapter 2 Use cases
1.1. Development Cloud
- Stakeholder
- User Stories
- Design Model
- Component Block Diagram
1.2 General Compute Cloud
- Stakeholders
- User Stories
- Design Model
- Component Block Diagram
1.3 Web Scale Cloud
- 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 planning and scaling
- The Starting Point
- Adding Cloud Controller Nodes
- Segregating Your Cloud
- Scalable Hardware
Chapter 5 Design
5.x Customer requirements
- Create a customer requirements section and add content from the mitaka guide (Darren)
5.1 Compute service
- Technical Detail
- Capacity and Scale
- High Availability
- Operator Requirements
- Deployment Considerations
- Maintenance Considerations
- Component Block Diagram
5.2 Storage
- Technical Detail
- Capacity and Scale
- High Availability
- Operator Requirements
- Deployment Considerations
- Maintenance Considerations
5.3 Networking
- Technical Detail
- Capacity and Scale
- High Availability
- Operator Requirements
- Deployment Considerations
- Maintenance Considerations
5.4 Identity service
- Technical Detail
- Capacity and Scale
- High Availability
- Operator Requirements
- Deployment Considerations
- Maintenance Considerations
5.5 Image service
- Technical Detail
- Capacity and Scale
- High Availability
- Operator Requirements
- Deployment Considerations
- Maintenance Considerations
5.6 Control Plane
Technical Detail Capacity and Scale High Availability Operator Requirements Deployment Considerations Maintenance Considerations
5.7 Dashboard and APIs
Technical Detail Capacity and Scale High Availability Operator Requirements Deployment Considerations Maintenance Considerations