Architecture Design Guide Restructure

Architecture Design Guide Restructure

Problem description

The current Architecture Design Guide is primarily organized by use case resulting in duplication of cloud architecture concepts.

The proposal is to revise the content structure to refine use cases to the most common OpenStack deployments, and create an abstraction between cloud architecture concepts and various OpenStack projects. This will make it easier to maintain the guide.

Proposed change

The proposed structure of the guide is to first describe common cloud use cases, then general architectural concepts, followed by cloud architecture design with a detailed breakdown of the major cloud components.

Proposed table of contents

The proposed structure for the updated Architecture Design Guide is as follows:

  1. Overview

  2. Use cases

    1. Development cloud
    2. General compute cloud
    3. Web scale cloud
    4. Storage cloud
    5. Network Function Virtualization (NFV) cloud
  3. High Availability

    Business requirements for implementing HA, what components in the control plane need to be HA and why.

  4. Capacity planning and scaling

    1. Adding cloud controller nodes
    2. Segregating your cloud
    3. Scalable hardware
  5. Design

    1. Compute

      Implementation of the compute platform including hypervisors, nova, and ironic.

    2. Storage

      Storage choices and the implementation of projects such as cinder and manila.

    3. Networking

      Networking design choices such as SDN, LBaaS, and neutron.

    4. Identity

      Authentication, authorization, and assignment at all levels for keystone and related projects.

    5. Image

      Management, creation, distribution, and deployment of images for glance and related projects.

    6. Control Plane

      General implementation of the OpenStack control components and the decision making that goes into the choices that need to be made.

    7. Dashboard and APIs

      Interaction with cloud services using a graphical interface or the OpenStack APIs. This would include horizon and other Cloud Management Platform (CMP) tools.

The Use cases chapter will document the five most common OpenStack use cases. It will describe the scope and requirements, which will be a precursor for reference architecture information.

Alternatives

Leave the guide as is.

Implementation

Assignee(s)

Primary assignee:
  • dazzachan
Other contributors:
  • tersian
  • alexandra-settle

Work items

  • Remove the current Architecture Design Guide from docs.openstack.org, and publish the draft Architecture Design Guide in its current state to to increase visibility.
  • Temporarily archive the current Architecture Design Guide in a directory until the docs archiving process <https://specs.openstack.org/openstack/docs-specs/specs/pike/archiving.html> is implemented.
  • Remove the Architecture chapter from the Operations Guide since the content has been migrated to the draft Architecture Design Guide.
  • Update .htaccess with redirects for removed/changed URLs.
  • Complete writing the storage and networking sections in the Design chapter, followed by the remaining sections.
  • For each task, submit a bug report.
  • Develop a use case content template to be applied to the Use Cases chapter.

Dependencies

Contributions and input from SMEs.

Testing

Testing will follow the standard documentation review process.

References

Creative Commons Attribution 3.0 License

Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.

docs-specs 0.0.1.dev182