Difference between revisions of "Documentation"
| Line 2: | Line 2: | ||
= [[OpenStack]] Manuals = | = [[OpenStack]] Manuals = | ||
| − | These manuals are drafts, ready for writing: | + | We write draft documentation on the wiki or in Etherpad. These manuals are drafts on the wiki, ready for writing: |
* [[[NovaAdminManual||OpenStack] Compute Administration Manual ]] | * [[[NovaAdminManual||OpenStack] Compute Administration Manual ]] | ||
* [[[NovaDeploymentManual|| OpenStack] Compute Deployment Manual ]] | * [[[NovaDeploymentManual|| OpenStack] Compute Deployment Manual ]] | ||
* [[[NovaUserManual|| OpenStack] Compute End User Manual ]] | * [[[NovaUserManual|| OpenStack] Compute End User Manual ]] | ||
| − | These guides are available and sourced in .rst files in /doc/source/ if you want to | + | These guides are available and sourced in .rst files in /doc/source/ if you want to work on them: |
* [http://swift.openstack.org/admin_guide.html OpenStack Object Storage (Swift) Administrator's Guide] | * [http://swift.openstack.org/admin_guide.html OpenStack Object Storage (Swift) Administrator's Guide] | ||
* [http://swift.openstack.org/deployment_guide.html OpenStack Object Storage (Swift) Deployment Guide] | * [http://swift.openstack.org/deployment_guide.html OpenStack Object Storage (Swift) Deployment Guide] | ||
| + | * [http://nova.openstack.org/adminguide/index.html OpenStack Compute (Nova) Administration Guide ] | ||
| + | * [http://nova.openstack.org/devref/index.html OpenStack Compute (Nova) Developer Guide ] | ||
== Getting Started with [[OpenStack]] == | == Getting Started with [[OpenStack]] == | ||
Revision as of 14:40, 23 November 2010
OpenStack Manuals
We write draft documentation on the wiki or in Etherpad. These manuals are drafts on the wiki, ready for writing:
- [[[NovaAdminManual||OpenStack] Compute Administration Manual ]]
- [[[NovaDeploymentManual|| OpenStack] Compute Deployment Manual ]]
- [[[NovaUserManual|| OpenStack] Compute End User Manual ]]
These guides are available and sourced in .rst files in /doc/source/ if you want to work on them:
- OpenStack Object Storage (Swift) Administrator's Guide
- OpenStack Object Storage (Swift) Deployment Guide
- OpenStack Compute (Nova) Administration Guide
- OpenStack Compute (Nova) Developer Guide
Getting Started with OpenStack
How to evaluate OpenStack and the technology behind it.
- Release Notes for the Austin release
- About OpenStack Object Storage (Swift)
- What is OpenStack Compute (Nova)?
- Quickstart Guide
- Case studies
Release Notes
Lists what's new and what's changed in each release as well as known issues and potential workarounds.
- [[[ReleaseNotes|| Release Notes]]]
Installation
How to install either Swift or Nova.
- [[[SwiftInstall|| Object Storage (Swift) Installation ]]]
- [[[NovaInstall|| Compute (Nova) Installation, single machine ]]] Compute (Nova) Installation, multiple machine
Configuration
How to configure Swift for object storage and Nova for managing cloud software.
- Configuring Object Storage (Swift)
- Flag Files for Nova
- Networking
- User Mode Linux
Security
Describes security, authorization, authentication, and trust management.
Development
How to contribute code to OpenStack or develop using the OpenStack projects.
- Coding Standards
- Design Tenets
- [[[LifeWithBzrAndLaunchpad|| Learning bzr and Launchpad ]]]
- Getting the Code (using Launchpad and bzr)
Troubleshooting
How to apply a process to troubleshooting when you see errors or problems.
Support
How to find or ask for support.
