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 Cloud Administration Guide] |
* '''Created''': Nicholas Chase | * '''Created''': Nicholas Chase | ||
* '''Updated''': Nermina Miller | * '''Updated''': Nermina Miller | ||
| − | * '''Contributors''': | + | * '''Contributors''': Anne Gentle |
== Summary == | == Summary == | ||
| − | This blueprint describes a plan to create documentation for OpenStack administrators | + | 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.)<br /> | 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.)<br /> | ||
| Line 12: | Line 12: | ||
This blueprint is related to [[Blueprint-restructure-documentation|Blueprint Restructure Documentation]]. | This blueprint is related to [[Blueprint-restructure-documentation|Blueprint Restructure Documentation]]. | ||
| − | == Blueprint - OpenStack Administration Guide == | + | == Blueprint - OpenStack Cloud Administration Guide == |
| − | '''Audience''': Administrators and operators | + | '''Audience''': Administrators and operators who maintain OpenStack clouds.<br /> |
'''Product info:''' Havana, 2013.1<br /> | '''Product info:''' Havana, 2013.1<br /> | ||
| Line 21: | Line 21: | ||
'''Purpose''': | '''Purpose''': | ||
| − | * | + | * Provide information about managing and troubleshooting various parts of a cloud system |
| − | * | + | * Link to appropriate parts in other guides for additional information |
| − | * | + | * Consolidate the material left over from appropriation to config, install, and user guides |
'''Source material''': | '''Source material''': | ||
| − | * | + | * OpenStack Compute Administration Guide |
| − | * | + | * OpenStack Networking Administration Guide |
| − | * | + | * OpenStack Object Storage Administration Guide |
| − | + | * OpenStack Block Storage Service Administration Guide | |
| − | |||
| − | |||
| − | * | ||
| − | |||
| − | |||
| − | === CHAPTER 1: | + | === CHAPTER 1: Getting Started with OpenStack (move up from Compute) === |
| − | + | OpenStack architecture | |
| − | + | OpenStack services | |
| − | + | Feedback | |
| − | + | === CHAPTER 2: 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 | ||
| + | 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 | ||
| + | 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 | ||
| + | CHAPTER 3. OpenStack Networking | ||
| + | Using OpenStack Networking | ||
| + | Core OpenStack Networking API features | ||
| + | Using OpenStack Compute with OpenStack Networking | ||
| + | Under the Hood (Proposed 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) | ||
| + | Logging Settings | ||
| + | Notifications | ||
| + | High Availability | ||
| + | Limitations | ||
| + | Demos Setup | ||
| + | Single Flat Network | ||
| + | Provider Router with Private Networks | ||
| + | Per-tenant Routers with Private Networks | ||
| + | Scalable and Highly Available DHCP Agents | ||
| + | Core Config File Options (move to config) | ||
| + | Plugin pagination and sorting support | ||
| + | CHAPTER 4 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 | ||
| + | CHAPTER 4 Block Storage | ||
| + | Introduction to the OpenStack Block Storage Service | ||
| + | Managing Volumes | ||
| + | Troubleshoot your cinder installation | ||
| + | Adding Block Storage Nodes | ||
| + | Boot From Volume | ||
| + | CHAPTER 5 A list of other docs with links | ||
| + | CHAPTER 6 Glossary (if and when possible) | ||
| + | CHAPTER 7 Index (if and when possible) | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
I think this would be pretty useful, but probably difficult to maintain. | I think this would be pretty useful, but probably difficult to maintain. | ||
Revision as of 03:29, 29 August 2013
- Launchpad Entry: Design for OpenStack Cloud Administration Guide
- Created: Nicholas Chase
- Updated: Nermina Miller
- Contributors: Anne Gentle
Contents
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
- Link to appropriate parts in other guides for additional information
- Consolidate the material left over from appropriation to config, install, and user guides
Source material:
- OpenStack Compute Administration Guide
- OpenStack Networking Administration Guide
- OpenStack Object Storage Administration Guide
- OpenStack Block Storage Service Administration Guide
CHAPTER 1: Getting Started with OpenStack (move up from Compute)
OpenStack architecture OpenStack services Feedback
CHAPTER 2: 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 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 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 CHAPTER 3. OpenStack Networking Using OpenStack Networking Core OpenStack Networking API features Using OpenStack Compute with OpenStack Networking Under the Hood (Proposed 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) Logging Settings Notifications High Availability Limitations Demos Setup Single Flat Network Provider Router with Private Networks Per-tenant Routers with Private Networks Scalable and Highly Available DHCP Agents Core Config File Options (move to config) Plugin pagination and sorting support CHAPTER 4 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 CHAPTER 4 Block Storage Introduction to the OpenStack Block Storage Service Managing Volumes Troubleshoot your cinder installation Adding Block Storage Nodes Boot From Volume CHAPTER 5 A list of other docs with links CHAPTER 6 Glossary (if and when possible) CHAPTER 7 Index (if and when possible)
I think this would be pretty useful, but probably difficult to maintain.
