Jump to: navigation, search

Difference between revisions of "Blueprint-os-admin-docs"

Line 1: Line 1:
* '''Launchpad Entry''':  [https://blueprints.launchpad.net/openstack-manuals/+spec/blueprint-os-admin-docs/ Design for OpenStack Administration Guide]
* '''Launchpad Entry''':  [https://blueprints.launchpad.net/openstack-manuals/+spec/blueprint-os-admin-docs/ Design for OpenStack Administration Guide]
* '''Created''': Nicholas Chase
* '''Created''': Nicholas Chase
* '''Updated''': Nermina Miller
* '''Contributors''':  
* '''Contributors''':  

Revision as of 03:13, 29 August 2013



This blueprint describes a plan to create documentation for OpenStack administrators and operators. These are tasks that go beyond the everyday actions an OpenStack user would take, but don't get into the depths of the OpenStack Operations Manual.

This documentation organizes the existing administration documentation into conceptional categories rather than chronological activities. It is meant to be comprehensive, but to be built out of content that has been drawn from other manuals. The reason for this is that while this guide is meant to be comprehensive, users should still be able to create documentation in smaller chunks to avoid being overwhelmed. (This process is covered by a separate blueprint.)

This blueprint is related to Blueprint Restructure Documentation.

Blueprint - OpenStack Administration Guide

Audience: Administrators and operators of OpenStack clouds who maintain OpenStack clusters.

Product info: Havana, 2013.1

Include common glossary? Yes


  • Explain OpenStack cloud concepts and describe how to use an OpenStack cloud.
  • Include Cloud application architecture diagram.
  • TBD

Source material:

CHAPTER 1: Overview

One-to-two paragraph description of the OpenStack cloud. Descriptions of the OpenStack projects. Architecture diagram with few sentences of explanation. State the goals of the book - concepts, set-up, and tutorials.

SECTION 1: OpenStack Cloud Concepts

Describe the main concepts that a user needs to understand to use the cloud.

SECTION 2: How to Interact with an OpenStack Cloud

Describe ways you can interact with a cloud:

Horizon Dashboard


OpenStack Command-line Clients

Provide x-ref to OpenStack Command Reference. Base off of: http://docs.rackspace.com/servers/api/v2/cn-gettingstarted/content/novaclient.html

cURL Commands with Embedded API Calls

Base off of: http://docs.rackspace.com/servers/api/v2/cn-gettingstarted/content/curl.html

OpenStack APIs

Talk about ways to use the APIs – cURL? SDKs? Language bindings?

CHAPTER 2: Architecture

A more in-depth discussion of how all of the pieces and projects fit together.

CHAPTER 3: Compute

SECTION 1: Introduction


SECTION 2: Installation

This section includes both basic and automated installation. It will likely pull heavily from the installation guide.

SECTION 3: Configuration

This section discusses nova.conf. but any actual configuration parameters will be sourced from the configuration guide.

SECTION 4: Identity, Image, and Instance Management

SECTION 5: Scheduling

SECTION 6: System Administration

SECTION 7: Interfaces

SECTION 8: Security

SECTION 9: Troubleshooting

SECTION 10: Community Support

SECTION 11: Tutorials

CHAPTER 3. OpenStack Networking

SECTION 1: Introduction

This section gives an overview of the architecture and touches on what things look like under the hood, including giving a "teaser" of advanced features.

SECTION 2: Installation

SECTION 3: Configuration for OpenStack Identity and Compute

This section includes both basic and advanced configuration and core configuration options.

SECTION 4 Deployment and Usage Cases

This section includes both basic and advanced use cases, such as high availability, demos and plugin pagination and sorting support.

SECTION 5 Authentication and Authorization

CHAPTER 4 OpenStack Storage

This chapter is a combination of the Object and Block storage books, and might be better broken out into two chapters, if we can find a way to include the introduction just once. Perhaps we need to create parts. The only thing stopping me is that the other parts would have just one chapter each, which is just wrong.

SECTION 1 Introduction

This section includes the storage concepts table.

SECTION 2 Object Storage

Source material

System Administration
Community Support

SECTION 3 Block Storage

Source material

Introduction (link to OpenStack Compute in the text)
  • Managing
  • Drivers
System Monitoring
Community Support

CHAPTER 5. Summary

CHAPTER 6. Glossary

This is the common glossary

CHAPTER 7. Index

I think this would be pretty useful, but probably difficult to maintain.