Jump to: navigation, search

Difference between revisions of "Documentation"

(Adding links to glance.openstack.org and docs.openstack.org)
(Pointers to docs.openstack.org where appropriate)
Line 11: Line 11:
 
== Administration and Deployment ==
 
== Administration and Deployment ==
  
We write draft documentation on the wiki or in Etherpad. These manuals are drafts on the wiki, ready for writing:
+
* [[OpenStack]] Compute Administration Manual [http://docs.openstack.org/openstack-compute/admin/content/  html] [http://docs.openstack.org/openstack-compute/admin/os-compute-admin-book.pdf  pdf]
* [[[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:
 
These guides are available and sourced in .rst files in /doc/source/ if you want to work on them:
Line 25: Line 22:
 
How to evaluate [[OpenStack]] and the technology behind it.
 
How to evaluate [[OpenStack]] and the technology behind it.
  
* [[ReleaseNotes/Austin | Release Notes for the Austin release]]
+
* [[ http://docs.openstack.org/openstack-compute/admin/content/ch01.html| Getting Started with OpenStack]]
* [[Swift|About OpenStack Object Storage (Swift)]]
 
* [http://openstack.org/projects/compute/ What is OpenStack Compute (Nova)]?
 
* [[[GettingImages|| Guidelines for Images for OpenStack] Compute (Nova)]]
 
* Quickstart Guide
 
* Case studies
 
  
 
== Release Notes ==
 
== Release Notes ==
Line 42: Line 34:
 
* [[[SwiftInstall|| Object Storage (Swift) Installation ]]]
 
* [[[SwiftInstall|| Object Storage (Swift) Installation ]]]
 
* [[[NovaInstall|| Compute (Nova) Installation, single machine ]]]
 
* [[[NovaInstall|| Compute (Nova) Installation, single machine ]]]
* [[NovaInstall/MultipleServer | Compute (Nova) Installation, multiple machine]]
 
  
 
== Configuration ==
 
== Configuration ==
 
How to configure Swift for object storage and Nova for managing cloud software.
 
How to configure Swift for object storage and Nova for managing cloud software.
  
* [[ConfigureSwift|Configuring Object Storage (Swift)]]
+
* [http://docs.openstack.org/openstack-object-storage/admin/content/ch04s03.html Configuring Object Storage (Swift)]
* Flag Files for Nova    
+
* [http://docs.openstack.org/openstack-compute/admin/content/ch05s07.html Flag Files for Nova]
** [[NovaApiFlags|nova-api]]
+
* [http://docs.openstack.org/openstack-compute/admin/content/ch04.html  Networking]
** [[NovaComputeFlags|nova-compute]]
 
* [[Networking]]
 
* [[Nova/UML|User Mode Linux]]
 
  
 
== Security ==
 
== Security ==
Line 60: Line 48:
 
How to apply a process to troubleshooting when you see errors or problems.
 
How to apply a process to troubleshooting when you see errors or problems.
  
* [[TroubleshootingSwift|Troubleshooting Swift ]]
+
* [http://docs.openstack.org/openstack-object-storage/admin/content/ch06s02.html Troubleshooting Object Storage (Swift) ]
 +
** [http://docs.openstack.org/openstack-object-storage/admin/content/ch06s03.html Troubleshooting Compute (Nova) ]
  
 
== Support ==
 
== Support ==

Revision as of 21:58, 11 February 2011

<<TableOfContents(2)>>

OpenStack software documentation

Documentation is community-oriented and available for different audiences on several websites - this wiki is for fast, changing documentation, the developer documentation for the projects is on nova.openstack.org, swift.openstack.org, and glance.openstack.org. For official documentation, see docs.openstack.org.

<<Columns(2, start)>>

OpenStack draft manuals

Administration and Deployment

These guides are available and sourced in .rst files in /doc/source/ if you want to work on them:

Getting Started with OpenStack

How to evaluate OpenStack and the technology behind it.

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 ]]]

Configuration

How to configure Swift for object storage and Nova for managing cloud software.

Security

Describes security, authorization, authentication, and trust management.

Troubleshooting

How to apply a process to troubleshooting when you see errors or problems.

Support

How to find or ask for support.

Glossary

  • Glossary - Contains terms that are our definitions for OpenStack, cloud computing, and open source.

<<Columns(2)>>

Project documentation

Development

How to contribute code to OpenStack or develop using the OpenStack projects.

Launchpad reference

How we use Launchpad to track features, bugs and releases.

<<Columns(2, end)>>