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

Revision as of 04:25, 29 August 2013

• Launchpad Entry: Design for OpenStack Cloud Administration Guide
• Created: Nicholas Chase
• Updated: Nermina Miller
• Advisor: Anne Gentle

Summary

This blueprint describes a plan to create documentation for OpenStack cloud administrators. 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 Cloud Administration Guide

Audience: Administrators and operators who maintain OpenStack clouds

Product info: Havana, 2013.1

Include common glossary? Yes

Purpose:

• Provide information about managing and troubleshooting various parts of a cloud system
• Consolidate the material left over from appropriation to config, install, and user guides
• Consolidate the formatting and style
• Match up the chapter titles to the order of OpenStack components in the Getting Started... chapter
• Link to appropriate parts in other guides for additional information
• Update the material against Havana (last task)

Source material:

• OpenStack Compute Administration Guide
• OpenStack Networking Administration Guide
• OpenStack Object Storage Administration Guide
• OpenStack Block Storage Service Administration Guide

Proposed contents

1. Getting Started with OpenStack (move up from Compute)
   1. OpenStack architecture
   2. OpenStack services
   3. Feedback
2. Compute
   1. Introduction to Compute (revise the order so it fits the upcoming sequence)
      1. Hypervisors
      2. Users and Tenants (Projects)
      3. Images and Instances
      4. System Architecture
      5. Block Storage and OpenStack Compute
   2. Identity Management
      1. Identity Service Concepts
      2. Memcached and System Time
      3. User CRUD
      4. Monitoring
      5. Certificates for PKI
      6. Run the Identity Service
      7. Troubleshoot the Identity Service
   3. Image Management
      1. Adding images with glance image-create
      2. Getting virtual machine images
      3. Booting a test image
      4. Tearing down (deleting) Instances
      5. Pausing and Suspending Instances
      6. Select a specific host to boot instances on (move to booting)
      7. Creating images from running instances with KVM and Xen
      8. Replicating images across multiple data centers
   4. Instance Management
      1. Interfaces to managing instances
      2. Instance building blocks
      3. Customizing Flavors
      4. Creating instances
      5. Control where instances run
      6. Instance specific data
      7. Managing instance networking
      8. Manage Volumes
      9. Access running instances
      10. Manage running instances
   5. Hypervisors
      1. Hypervisor Configuration Basics
      2. KVM
      3. Xen, XenAPI, XenServer, and XCP
      4. LXC (Linux containers)
      5. VMware vSphere
      6. PowerVM
      7. Hyper-V Virtualization Platform
      8. Bare Metal Driver
   6. Networking with nova-network
      1. Networking Options
      2. DHCP server: dnsmasq
      3. Metadata service
      4. Enabling Ping and SSH on VMs
      5. Removing a Network from a Project
      6. Using multiple interfaces for your instances (multinic)
      7. Existing High Availability Options for Networking
      8. Troubleshooting Networking
   7. (Block Storage) Volumes [install info needs to be moved]
      1. Scheduling
      2. Filter Scheduler
      3. Filters
      4. Weights
      5. Chance Scheduler
      6. Host aggregates
   8. Cells [all config, needs to be moved]
   9. System Administration
      1. Understanding the Compute Service Architecture [move up]
      2. Managing Compute Users
      3. Managing the Cloud
      4. Show usage statistics for hosts and instances
      5. Managing logs
      6. Reference Information for Securing with Root Wrappers
      7. Using Migration
      8. Recovering from a failed compute node
      9. Recovering from a UID/GID mismatch
      10. Nova Disaster Recovery Process
   10. OpenStack Interfaces [make a separate chapter]
       1. The OpenStack dashboard
       2. Using VNC Console
   11. Security Hardening
       1. Trusted Compute Pools
   12. OpenStack Compute Automated Installations (move to install doc?)
   13. OpenStack Compute Tutorials
       1. Running Your First Elastic Web Application on the Cloud
   14. Support [move to the end]
       1. Community Support
   15. Troubleshooting OpenStack Compute
       1. Log files for OpenStack Compute
       2. Common Errors and Fixes for OpenStack Compute
       3. Manually reset the state of an instance
       4. Problems with Injection
3. OpenStack Networking
   1. Using OpenStack Networking
      1. Core OpenStack Networking API features
      2. Using OpenStack Compute with OpenStack Networking
   2. Under the Hood [Proposing a new title: Networking scenarios]
      1. Open vSwitch
      2. Linux bridge
   3. Advanced Features through API Extensions
      1. Provider Networks
      2. L3 Routing and NAT
      3. Security Groups
      4. Load-Balancer-as-a-Service
      5. Plugin Specific Extensions
   4. Authentication and Authorization
   5. Advanced Operational Features (remove Quota info and merge with other Advanced Feautures)
      1. Logging Settings
      2. Notifications
   6. High Availability
   7. Limitations
   8. Demos Setup [Poll for placement]
      1. Single Flat Network
      2. Provider Router with Private Networks
      3. Per-tenant Routers with Private Networks
      4. Scalable and Highly Available DHCP Agents
   9. Plugin pagination and sorting support
4. Object Storage
   1. Introduction to OpenStack Object Storage
      1. Accounts and Account Servers
      2. Authentication and Access Permissions
      3. Containers and Objects
      4. Operations
      5. Language-Specific API Bindings
   2. System Administration for OpenStack Object Storage
      1. Understanding How Object Storage Works
      2. Object Layout on Storage
      3. Preparing the Ring
      4. Considerations and Tuning
      5. Replication
      6. Managing Large Objects (Greater than 5 GB)
      7. Throttling Resources by Setting Rate Limits
      8. Additional Features
      9. Bulk Delete
      10. Managing OpenStack Object Storage with CLI Swift
   3. OpenStack Object Storage Tutorials
      1. Storing Large Photos or Videos on the Cloud
   4. OpenStack Object Storage Monitoring
      1. Swift Recon
      2. Swift-Informant
      3. Statsdlog
      4. Swift StatsD Logging
   5. Support [generic, can be moved to the end]
   6. Troubleshooting OpenStack Object Storage
      1. Handling Drive Failure
      2. Handling Server Failure
      3. Detecting Failed Drives
      4. Emergency Recovery of Ring Builder Files
5. Block Storage
   1. Introduction to the OpenStack Block Storage Service
   2. Managing Volumes
      1. Troubleshoot your cinder installation
      2. Adding Block Storage Nodes
      3. Boot From Volume
6. Support
7. A list of other docs with links
8. Glossary (if and when possible)
9. Index (if and when possible)