Difference between revisions of "Blueprint-os-admin-docs"
(10 intermediate revisions by the same user not shown) | |||
Line 8: | Line 8: | ||
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 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 | + | This blueprint takes the information left over after the extraction of install and config reference from component guides and establishes a new guide that will contain links and references to other guides and serve as a standalone system maintenance guide.<br /> |
This blueprint is related to [[Blueprint-restructure-documentation|Blueprint Restructure Documentation]]. | This blueprint is related to [[Blueprint-restructure-documentation|Blueprint Restructure Documentation]]. | ||
− | == Blueprint | + | == Blueprint—OpenStack Cloud Administration Guide == |
− | '''Audience''': Administrators and operators who maintain OpenStack clouds | + | |
+ | '''Audience''': Administrators and operators who maintain OpenStack clouds<br /> | ||
'''Product info:''' Havana, 2013.1<br /> | '''Product info:''' Havana, 2013.1<br /> | ||
Line 23: | Line 24: | ||
* Provide information about managing and troubleshooting various parts of a cloud system | * 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 | * Link to appropriate parts in other guides for additional information | ||
− | * | + | * Update the material against Havana (last task) |
Line 34: | Line 38: | ||
* OpenStack Block Storage Service Administration Guide | * OpenStack Block Storage Service Administration Guide | ||
+ | == Proposed contents == | ||
− | + | # Getting Started with OpenStack [move up from Compute] | |
− | + | ## OpenStack architecture | |
− | + | ## OpenStack services | |
− | + | ## Feedback | |
− | + | # Compute | |
− | + | ## Introduction to Compute [revise the order so it fits the upcoming sequence] | |
− | + | ### Hypervisors | |
− | + | ### Users and Tenants (Projects) | |
− | + | ### Images and Instances | |
− | + | ### System Architecture | |
− | + | ### Block Storage and OpenStack Compute | |
− | + | ## Identity Management | |
− | + | ### Identity Service Concepts | |
− | + | ### Memcached and System Time | |
− | Identity Service Concepts | + | ### User CRUD |
− | Memcached and System Time | + | ### Monitoring |
− | User CRUD | + | ### Certificates for PKI |
− | Monitoring | + | ### Run the Identity Service |
− | Certificates for PKI | + | ### Troubleshoot the Identity Service |
− | Run the Identity Service | + | ## Image Management |
− | Troubleshoot the Identity Service | + | ### Adding images with glance image-create |
− | Image Management | + | ### Getting virtual machine images |
− | Adding images with glance image-create | + | ### Booting a test image |
− | Getting virtual machine images | + | ### Tearing down (deleting) Instances |
− | Booting a test image | + | ### Pausing and Suspending Instances |
− | Tearing down (deleting) Instances | + | ### Select a specific host to boot instances on [move to booting] |
− | Pausing and Suspending Instances | + | ### Creating images from running instances with KVM and Xen |
− | Select a specific host to boot instances on | + | ### Replicating images across multiple data centers |
− | Creating images from running instances with KVM and Xen | + | ## Instance Management |
− | Replicating images across multiple data centers | + | ### Interfaces to managing instances |
− | Instance Management | + | ### Instance building blocks |
− | Interfaces to managing instances | + | ### Customizing Flavors |
− | Instance building blocks | + | ### Creating instances |
− | Customizing Flavors | + | ### Control where instances run |
− | Creating instances | + | ### Instance specific data |
− | Control where instances run | + | ### Managing instance networking |
− | Instance specific data | + | ### Manage Volumes |
− | Managing instance networking | + | ### Access running instances |
− | Manage Volumes | + | ### Manage running instances |
− | Access running instances | + | ## Hypervisors |
− | Manage running instances | + | ### Hypervisor Configuration Basics |
− | Hypervisors | + | ### KVM |
− | Hypervisor Configuration Basics | + | ### Xen, XenAPI, XenServer, and XCP |
− | KVM | + | ### LXC (Linux containers) |
− | Xen, XenAPI, XenServer, and XCP | + | ### VMware vSphere |
− | LXC (Linux containers) | + | ### PowerVM |
− | VMware vSphere | + | ### Hyper-V Virtualization Platform |
− | PowerVM | + | ### Bare Metal Driver |
− | Hyper-V Virtualization Platform | + | ## Networking with nova-network |
− | Bare Metal Driver | + | ### Networking Options |
− | Networking with nova-network | + | ### DHCP server: dnsmasq |
− | Networking Options | + | ### Metadata service |
− | DHCP server: dnsmasq | + | ### Enabling Ping and SSH on VMs |
− | Metadata service | + | ### Removing a Network from a Project |
− | Enabling Ping and SSH on VMs | + | ### Using multiple interfaces for your instances (multinic) |
− | Removing a Network from a Project | + | ### Existing High Availability Options for Networking |
− | Using multiple interfaces for your instances (multinic) | + | ### Troubleshooting Networking |
− | Existing High Availability Options for Networking | + | ## (Block Storage) Volumes [install info needs to be moved] |
− | Troubleshooting Networking | + | ### Scheduling |
− | (Block Storage) Volumes | + | ### Filter Scheduler |
− | Scheduling | + | ### Filters |
− | Filter Scheduler | + | ### Weights |
− | Filters | + | ### Chance Scheduler |
− | Weights | + | ### Host aggregates |
− | Chance Scheduler | + | ## Cells [all config, needs to be moved] |
− | Host aggregates | + | ## System Administration |
− | Cells | + | ### Understanding the Compute Service Architecture [move up] |
− | System Administration | + | ### Managing Compute Users |
− | Understanding the Compute Service Architecture | + | ### Managing the Cloud |
− | Managing Compute Users | + | ### Show usage statistics for hosts and instances |
− | Managing the Cloud | + | ### Managing logs |
− | Show usage statistics for hosts and instances | + | ### Reference Information for Securing with Root Wrappers |
− | Managing logs | + | ### Using Migration |
− | Reference Information for Securing with Root Wrappers | + | ### Recovering from a failed compute node |
− | Using Migration | + | ### Recovering from a UID/GID mismatch |
− | Recovering from a failed compute node | + | ### Nova Disaster Recovery Process |
− | Recovering from a UID/GID mismatch | + | ## OpenStack Interfaces [make a separate chapter] |
− | Nova Disaster Recovery Process | + | ### The OpenStack dashboard |
− | OpenStack Interfaces | + | ### Using VNC Console |
− | The OpenStack dashboard | + | ## Security Hardening |
− | Using VNC Console | + | ### Trusted Compute Pools |
− | Security Hardening | + | ## OpenStack Compute Automated Installations [move to install doc?] |
− | Trusted Compute Pools | + | ## OpenStack Compute Tutorials |
− | OpenStack Compute Automated Installations | + | ### Running Your First Elastic Web Application on the Cloud |
− | OpenStack Compute Tutorials | + | ## Support [move to the end] |
− | Running Your First Elastic Web Application on the Cloud | + | ### Community Support |
− | Support | + | ## Troubleshooting OpenStack Compute |
− | Community Support | + | ### Log files for OpenStack Compute |
− | Troubleshooting OpenStack Compute | + | ### Common Errors and Fixes for OpenStack Compute |
− | Log files for OpenStack Compute | + | ### Manually reset the state of an instance |
− | Common Errors and Fixes for OpenStack Compute | + | ### Problems with Injection |
− | Manually reset the state of an instance | + | # OpenStack Networking |
− | Problems with Injection | + | ## Using OpenStack Networking |
− | + | ### Core OpenStack Networking API features | |
− | Using OpenStack Networking | + | ### Using OpenStack Compute with OpenStack Networking |
− | Core OpenStack Networking API features | + | ## Under the Hood [Proposing a new title: Networking scenarios] |
− | Using OpenStack Compute with OpenStack Networking | + | ### Open vSwitch |
− | Under the Hood | + | ### Linux bridge |
− | Open vSwitch | + | ## Advanced Features through API Extensions |
− | Linux bridge | + | ### Provider Networks |
− | Advanced Features through API Extensions | + | ### L3 Routing and NAT |
− | Provider Networks | + | ### Security Groups |
− | L3 Routing and NAT | + | ### Load-Balancer-as-a-Service |
− | Security Groups | + | ### Plugin Specific Extensions |
− | Load-Balancer-as-a-Service | + | ## Authentication and Authorization |
− | Plugin Specific Extensions | + | ## Advanced Operational Features [remove Quota info and merge with other Advanced Features] |
− | Authentication and Authorization | + | ### Logging Settings |
− | Advanced Operational Features | + | ### Notifications |
− | Logging Settings | + | ## High Availability |
− | Notifications | + | ## Limitations |
− | High Availability | + | ## Demos Setup [Poll for placement] |
− | Limitations | + | ### Single Flat Network |
− | Demos Setup | + | ### Provider Router with Private Networks |
− | Single Flat Network | + | ### Per-tenant Routers with Private Networks |
− | Provider Router with Private Networks | + | ### Scalable and Highly Available DHCP Agents |
− | Per-tenant Routers with Private Networks | + | ## Plugin pagination and sorting support |
− | Scalable and Highly Available DHCP Agents | + | # Object Storage |
− | + | ## Introduction to OpenStack Object Storage | |
− | Plugin pagination and sorting support | + | ### Accounts and Account Servers |
− | + | ### Authentication and Access Permissions | |
− | Introduction to OpenStack Object Storage | + | ### Containers and Objects |
− | Accounts and Account Servers | + | ### Operations |
− | Authentication and Access Permissions | + | ### Language-Specific API Bindings |
− | Containers and Objects | + | ## System Administration for OpenStack Object Storage |
− | Operations | + | ### Understanding How Object Storage Works |
− | Language-Specific API Bindings | + | ### Object Layout on Storage |
− | System Administration for OpenStack Object Storage | + | ### Preparing the Ring |
− | Understanding How Object Storage Works | + | ### Considerations and Tuning |
− | Object Layout on Storage | + | ### Replication |
− | Preparing the Ring | + | ### Managing Large Objects (Greater than 5 GB) |
− | Considerations and Tuning | + | ### Throttling Resources by Setting Rate Limits |
− | Replication | + | ### Additional Features |
− | Managing Large Objects (Greater than 5 GB) | + | ### Bulk Delete |
− | Throttling Resources by Setting Rate Limits | + | ### Managing OpenStack Object Storage with CLI Swift |
− | Additional Features | + | ## OpenStack Object Storage Tutorials |
− | Bulk Delete | + | ### Storing Large Photos or Videos on the Cloud |
− | Managing OpenStack Object Storage with CLI Swift | + | ## OpenStack Object Storage Monitoring |
− | OpenStack Object Storage Tutorials | + | ### Swift Recon |
− | Storing Large Photos or Videos on the Cloud | + | ### Swift-Informant |
− | OpenStack Object Storage Monitoring | + | ### Statsdlog |
− | Swift Recon | + | ### Swift StatsD Logging |
− | Swift-Informant | + | ## Support [generic, can be moved to the end] |
− | Statsdlog | + | ## Troubleshooting OpenStack Object Storage |
− | Swift StatsD Logging | + | ### Handling Drive Failure |
− | Support | + | ### Handling Server Failure |
− | Troubleshooting OpenStack Object Storage | + | ### Detecting Failed Drives |
− | Handling Drive Failure | + | ### Emergency Recovery of Ring Builder Files |
− | Handling Server Failure | + | # Block Storage |
− | Detecting Failed Drives | + | ## Introduction to the OpenStack Block Storage Service |
− | Emergency Recovery of Ring Builder Files | + | ## Managing Volumes |
− | + | ### Troubleshoot your cinder installation | |
− | Introduction to the OpenStack Block Storage Service | + | ### Adding Block Storage Nodes |
− | Managing Volumes | + | ### Boot From Volume |
− | Troubleshoot your cinder installation | + | # Support |
− | Adding Block Storage Nodes | + | # A list of other docs with links |
− | Boot From Volume | + | # Glossary (if and when possible) |
− | + | # Index (if and when possible) | |
− | |||
− | |||
+ | '''Next steps''': | ||
− | + | * Now that we have narrowed down the purpose of this guide to cloud system administrations, ask SMEs whether any other content should be moved to other guides | |
+ | * Match up the structure of each chapter, moving the content around and updating the headings as appropriate | ||
+ | * Clean up the content for style and grammar | ||
+ | * Update the material for Havana |
Latest revision as of 15:31, 30 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 blueprint takes the information left over after the extraction of install and config reference from component guides and establishes a new guide that will contain links and references to other guides and serve as a standalone system maintenance guide.
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
- Getting Started with OpenStack [move up from Compute]
- OpenStack architecture
- OpenStack services
- Feedback
- Compute
- Introduction to Compute [revise the order so it fits the upcoming sequence]
- Hypervisors
- Users and Tenants (Projects)
- Images and Instances
- System Architecture
- Block Storage and OpenStack Compute
- Identity Management
- Identity Service Concepts
- Memcached and System Time
- User CRUD
- Monitoring
- Certificates for PKI
- Run the Identity Service
- Troubleshoot the Identity Service
- Image Management
- Adding images with glance image-create
- Getting virtual machine images
- Booting a test image
- Tearing down (deleting) Instances
- Pausing and Suspending Instances
- Select a specific host to boot instances on [move to booting]
- Creating images from running instances with KVM and Xen
- Replicating images across multiple data centers
- Instance Management
- Interfaces to managing instances
- Instance building blocks
- Customizing Flavors
- Creating instances
- Control where instances run
- Instance specific data
- Managing instance networking
- Manage Volumes
- Access running instances
- Manage running instances
- Hypervisors
- Hypervisor Configuration Basics
- KVM
- Xen, XenAPI, XenServer, and XCP
- LXC (Linux containers)
- VMware vSphere
- PowerVM
- Hyper-V Virtualization Platform
- Bare Metal Driver
- Networking with nova-network
- Networking Options
- DHCP server: dnsmasq
- Metadata service
- Enabling Ping and SSH on VMs
- Removing a Network from a Project
- Using multiple interfaces for your instances (multinic)
- Existing High Availability Options for Networking
- Troubleshooting Networking
- (Block Storage) Volumes [install info needs to be moved]
- Scheduling
- Filter Scheduler
- Filters
- Weights
- Chance Scheduler
- Host aggregates
- Cells [all config, needs to be moved]
- System Administration
- Understanding the Compute Service Architecture [move up]
- Managing Compute Users
- Managing the Cloud
- Show usage statistics for hosts and instances
- Managing logs
- Reference Information for Securing with Root Wrappers
- Using Migration
- Recovering from a failed compute node
- Recovering from a UID/GID mismatch
- Nova Disaster Recovery Process
- OpenStack Interfaces [make a separate chapter]
- The OpenStack dashboard
- Using VNC Console
- Security Hardening
- Trusted Compute Pools
- OpenStack Compute Automated Installations [move to install doc?]
- OpenStack Compute Tutorials
- Running Your First Elastic Web Application on the Cloud
- Support [move to the end]
- Community Support
- Troubleshooting OpenStack Compute
- Log files for OpenStack Compute
- Common Errors and Fixes for OpenStack Compute
- Manually reset the state of an instance
- Problems with Injection
- Introduction to Compute [revise the order so it fits the upcoming sequence]
- OpenStack Networking
- Using OpenStack Networking
- Core OpenStack Networking API features
- Using OpenStack Compute with OpenStack Networking
- Under the Hood [Proposing a new title: Networking scenarios]
- Open vSwitch
- Linux bridge
- Advanced Features through API Extensions
- Provider Networks
- L3 Routing and NAT
- Security Groups
- Load-Balancer-as-a-Service
- Plugin Specific Extensions
- Authentication and Authorization
- Advanced Operational Features [remove Quota info and merge with other Advanced Features]
- Logging Settings
- Notifications
- High Availability
- Limitations
- Demos Setup [Poll for placement]
- Single Flat Network
- Provider Router with Private Networks
- Per-tenant Routers with Private Networks
- Scalable and Highly Available DHCP Agents
- Plugin pagination and sorting support
- Using OpenStack Networking
- Object Storage
- Introduction to OpenStack Object Storage
- Accounts and Account Servers
- Authentication and Access Permissions
- Containers and Objects
- Operations
- Language-Specific API Bindings
- System Administration for OpenStack Object Storage
- Understanding How Object Storage Works
- Object Layout on Storage
- Preparing the Ring
- Considerations and Tuning
- Replication
- Managing Large Objects (Greater than 5 GB)
- Throttling Resources by Setting Rate Limits
- Additional Features
- Bulk Delete
- Managing OpenStack Object Storage with CLI Swift
- OpenStack Object Storage Tutorials
- Storing Large Photos or Videos on the Cloud
- OpenStack Object Storage Monitoring
- Swift Recon
- Swift-Informant
- Statsdlog
- Swift StatsD Logging
- Support [generic, can be moved to the end]
- Troubleshooting OpenStack Object Storage
- Handling Drive Failure
- Handling Server Failure
- Detecting Failed Drives
- Emergency Recovery of Ring Builder Files
- Introduction to OpenStack Object Storage
- Block Storage
- Introduction to the OpenStack Block Storage Service
- Managing Volumes
- Troubleshoot your cinder installation
- Adding Block Storage Nodes
- Boot From Volume
- Support
- A list of other docs with links
- Glossary (if and when possible)
- Index (if and when possible)
Next steps:
- Now that we have narrowed down the purpose of this guide to cloud system administrations, ask SMEs whether any other content should be moved to other guides
- Match up the structure of each chapter, moving the content around and updating the headings as appropriate
- Clean up the content for style and grammar
- Update the material for Havana