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