New structure for documentation.
This commit is contained in:
Todd Willey
@@ -0,0 +1,31 @@
|
||||
..
|
||||
Copyright 2010 United States Government as represented by the
|
||||
Administrator of the National Aeronautics and Space Administration.
|
||||
All Rights Reserved.
|
||||
|
||||
Licensed under the Apache License, Version 2.0 (the "License"); you may
|
||||
not use this file except in compliance with the License. You may obtain
|
||||
a copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
||||
WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
||||
License for the specific language governing permissions and limitations
|
||||
under the License.
|
||||
|
||||
Administration Guide
|
||||
====================
|
||||
|
||||
How to deploy, monitor, and debug Nova.
|
||||
|
||||
|
||||
Contents
|
||||
--------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
getting.started
|
||||
|
||||
@@ -0,0 +1,123 @@
|
||||
..
|
||||
Copyright 2010 United States Government as represented by the
|
||||
Administrator of the National Aeronautics and Space Administration.
|
||||
All Rights Reserved.
|
||||
|
||||
Licensed under the Apache License, Version 2.0 (the "License"); you may
|
||||
not use this file except in compliance with the License. You may obtain
|
||||
a copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
||||
WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
||||
License for the specific language governing permissions and limitations
|
||||
under the License.
|
||||
|
||||
Concepts and Introduction
|
||||
=========================
|
||||
|
||||
|
||||
Introduction
|
||||
------------
|
||||
|
||||
Nova is the software that controls your Infrastructure as as Service (IaaS)
|
||||
cloud computing platform. It is similar in scope to Amazon EC2 and Rackspace
|
||||
CloudServers. Nova does not include any virtualization software, rather it
|
||||
defines drivers that interact with underlying virtualization mechanisms that
|
||||
run on your host operating system, and exposes functionality over a web API.
|
||||
|
||||
This document does not attempt to explain fundamental concepts of cloud
|
||||
computing, IaaS, virtualization, or other related technologies. Instead, it
|
||||
focues on describing how Nova's implementation of those concepts is achieved.
|
||||
|
||||
|
||||
Concept: Projects
|
||||
-----------------
|
||||
|
||||
Projects
|
||||
|
||||
|
||||
Concept: Virtualization
|
||||
-----------------------
|
||||
|
||||
* KVM
|
||||
* UML
|
||||
* XEN
|
||||
* HyperV
|
||||
|
||||
|
||||
Concept: Volumes
|
||||
----------------
|
||||
|
||||
Volumes
|
||||
|
||||
|
||||
Concept: Quotas
|
||||
---------------
|
||||
|
||||
* Defaults
|
||||
* Override for project
|
||||
|
||||
|
||||
Concept: API
|
||||
------------
|
||||
|
||||
* EC2
|
||||
* OpenStack / Rackspace
|
||||
|
||||
|
||||
Concept: Networking
|
||||
-------------------
|
||||
|
||||
* Simple networking
|
||||
* NASA-Style Networking
|
||||
|
||||
|
||||
Concept: Services
|
||||
-----------------
|
||||
|
||||
Services
|
||||
|
||||
|
||||
Concept: Flags
|
||||
--------------
|
||||
|
||||
python-gflags
|
||||
|
||||
|
||||
Concept: Plugins
|
||||
----------------
|
||||
|
||||
LazyPluggable
|
||||
|
||||
|
||||
Concept: IPC
|
||||
------------
|
||||
|
||||
Rabbit!
|
||||
|
||||
|
||||
Concept: Fakes
|
||||
--------------
|
||||
|
||||
Fakes
|
||||
|
||||
|
||||
Concept: Scheduler
|
||||
------------------
|
||||
|
||||
Scheduler
|
||||
|
||||
|
||||
Concept: ORM
|
||||
------------
|
||||
|
||||
ORM
|
||||
|
||||
|
||||
Concept: Manager Pattern
|
||||
------------------------
|
||||
|
||||
Managers
|
||||
@@ -0,0 +1,49 @@
|
||||
..
|
||||
Copyright 2010 United States Government as represented by the
|
||||
Administrator of the National Aeronautics and Space Administration.
|
||||
All Rights Reserved.
|
||||
|
||||
Licensed under the Apache License, Version 2.0 (the "License"); you may
|
||||
not use this file except in compliance with the License. You may obtain
|
||||
a copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
||||
WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
||||
License for the specific language governing permissions and limitations
|
||||
under the License.
|
||||
|
||||
Nova Development Guide
|
||||
======================
|
||||
|
||||
Nova is written in python
|
||||
|
||||
|
||||
Contents
|
||||
--------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
architecture
|
||||
network
|
||||
storage
|
||||
auth
|
||||
compute
|
||||
endpoint
|
||||
nova
|
||||
fakes
|
||||
binaries
|
||||
modules
|
||||
packages
|
||||
|
||||
|
||||
Indices and tables
|
||||
------------------
|
||||
|
||||
* :ref:`genindex`
|
||||
* :ref:`modindex`
|
||||
* :ref:`search`
|
||||
|
||||
+21
-27
@@ -18,37 +18,31 @@
|
||||
Welcome to Nova's documentation!
|
||||
================================
|
||||
|
||||
Nova is a cloud computing fabric controller (the main part of an IaaS system).
|
||||
It is written in Python and relies on the standard AMQP messaging protocol, uses the Twisted framework,
|
||||
and optionally uses the Redis distributed key value store for authorization.
|
||||
Nova is a cloud computing fabric controller, the main part of an IaaS system.
|
||||
|
||||
Nova is intended to be easy to extend and adapt. For example, authentication and authorization
|
||||
requests by default use an RDBMS-backed datastore driver. However, there is already support
|
||||
for using LDAP backing authentication (slapd) and if you wish to "fake" LDAP, there is a module
|
||||
available that uses ReDIS to store authentication information in an LDAP-like backing datastore.
|
||||
It has extensive test coverage, and uses the Sphinx toolkit (the same as Python itself) for code
|
||||
and developer documentation. Additional documentation is available on the
|
||||
'OpenStack wiki <http://wiki.openstack.org>'_.
|
||||
While Nova is currently in Beta use within several organizations, the codebase
|
||||
is very much under active development - please test it and log bugs!
|
||||
Nova is written with the following design guidelines in mind:
|
||||
|
||||
Contents:
|
||||
* Component based architecture: Quickly add new behaviors
|
||||
* Highly available: Scale to very serious workloads
|
||||
* Fault-Tollerant: Isloated processes avoid cascading failures
|
||||
* Recoverable: Failures should be easy to diagnose, debug, and rectify
|
||||
* Open Standards: Be a reference implementation for a community-driven api
|
||||
|
||||
This documentation is generated by the Sphinx toolkit and lives in the source
|
||||
tree. Additional documentation on Nova and other components of OpenStack can
|
||||
be found on the 'OpenStack wiki <http://wiki.openstack.org>'.
|
||||
|
||||
|
||||
Contents
|
||||
--------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
getting.started
|
||||
architecture
|
||||
network
|
||||
storage
|
||||
auth
|
||||
compute
|
||||
endpoint
|
||||
nova
|
||||
fakes
|
||||
binaries
|
||||
modules
|
||||
packages
|
||||
:maxdepth: 1
|
||||
|
||||
concepts.and.introduction
|
||||
administration.guide
|
||||
development.guide
|
||||
|
||||
|
||||
Indices and tables
|
||||
==================
|
||||
|
||||
Reference in New Issue
Block a user