workload-ref-archs/workload-template.rst

OpenStack Workload Reference Architecture: <workload-name>

Introduction

This section provides detailed information on what the workload is.

Please include a high-level overview diagram whenever possible.

OpenStack for <workload>

This section provides detailed information on which OpenStack services are required to support this workload.

Please include all core and optional services.

Please provide a brief description of each services used in this document. For example:

Core services

Compute (Nova)	Manages the life cycle of compute instances, including spawning, scheduling, and decommissioning of virtual machines (VMs) on demand.
Object Storage (Swift)	Stores and retrieves arbitrary unstructured data objects via a RESTful HTTP-based API. Highly fault-tolerant with data replication and scale-out architecture.

Please include a logical representation diagram and a functional interaction diagram of the OpenStack services whenever possible.

Structuring a <workload> with OpenStack

This section provides detailed information on the workload requirements and specify how each of the OpenStack services (mentioned in previous section) are used to satisfy the workload requirements.

Please include a diagram of the deployment architecture whenever possible.

Demonstration and Sample Code

Every workload must be accompanied by at least one sample code that can be used to provision such workload environment. This can be either Heat template, Murano packages, or other code (e.g. ansible)

This section provides a brief summary of the sample code. You do not need to explain every single step in the sample code. However, please provide sufficient information to explain what the sample code is trying to achieve.

Scope and Assumptions

This section describes the specific scope, limitation or assumption made for this workload reference architecture.

For example: The Heat template provided for this reference architecture assumes that the web application workload is deployed in a single-region, single-zone OpenStack environment. The deployment in a multi-zone/multi-region environment is outside the scope of this document.

Summary

This section concludes the document.