diff options
Diffstat (limited to 'doc/source')
| -rw-r--r-- | doc/source/conf.py | 4 | ||||
| -rw-r--r-- | doc/source/getting.started.rst | 63 | ||||
| -rw-r--r-- | doc/source/index.rst | 22 |
3 files changed, 33 insertions, 56 deletions
diff --git a/doc/source/conf.py b/doc/source/conf.py index 349d23af2..505771ff8 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -47,9 +47,9 @@ copyright = u'2010, United States Government as represented by the Administrator # built documents. # # The short X.Y version. -version = '0.9' +version = '2010.1' # The full version, including alpha/beta/rc tags. -release = '0.9.1' +release = '2010.1' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. diff --git a/doc/source/getting.started.rst b/doc/source/getting.started.rst index f683bb256..2df4a45ea 100644 --- a/doc/source/getting.started.rst +++ b/doc/source/getting.started.rst @@ -18,34 +18,30 @@ Getting Started with Nova ========================= +This code base is continually changing so dependencies also change. -GOTTA HAVE A nova.pth file added or it WONT WORK (will write setup.py file soon) - -Create a file named nova.pth in your python libraries directory -(usually /usr/local/lib/python2.6/dist-packages) with a single line that points -to the directory where you checked out the source (that contains the nova/ -directory). - -DEPENDENCIES +Dependencies ------------ Related servers we rely on * RabbitMQ: messaging queue, used for all communication between components -* OpenLDAP: users, groups (maybe cut) -* ReDIS: Remote Dictionary Store (for fast, shared state data) -* nginx: HTTP server to handle serving large files (because Tornado can't) + +Optional servers + +* OpenLDAP: By default, the auth server uses the RDBMS-backed datastore by setting FLAGS.auth_driver to 'nova.auth.dbdriver.DbDriver'. But OpenLDAP (or LDAP) could be configured. +* ReDIS: By default, this is not enabled as the auth driver. Python libraries we don't vendor * M2Crypto: python library interface for openssl * curl -* XenAPI: Needed only for Xen Cloud Platform or XenServer support. Available from http://wiki.xensource.com/xenwiki/XCP_SDK or http://community.citrix.com/cdn/xs/sdks. +* XenAPI: Needed only for Xen Cloud Platform or XenServer support. Available from http://wiki.xensource.com/xenwiki/XCP_SDK or http://community.citrix.com/cdn/xs/sdks. Vendored python libaries (don't require any installation) -* Tornado: scalable non blocking web server for api requests * Twisted: just for the twisted.internet.defer package +* Tornado: scalable non blocking web server for api requests * boto: python api for aws api * IPy: library for managing ip addresses @@ -58,40 +54,19 @@ Recommended Installation -------------- -:: - # system libraries and tools - apt-get install -y aoetools vlan curl - modprobe aoe - - # python libraries - apt-get install -y python-setuptools python-dev python-pycurl python-m2crypto - - # ON THE CLOUD CONTROLLER - apt-get install -y rabbitmq-server dnsmasq nginx - # build redis from 2.0.0-rc1 source - # setup ldap (slap.sh as root will remove ldap and reinstall it) - NOVA_PATH/nova/auth/slap.sh - /etc/init.d/rabbitmq-server start - - # ON VOLUME NODE: - apt-get install -y vblade-persist - - # ON THE COMPUTE NODE: - apt-get install -y python-libvirt - apt-get install -y kpartx kvm libvirt-bin - modprobe kvm - - # optional packages - apt-get install -y euca2ools + Due to many changes it's best to rely on the `OpenStack wiki <http://wiki.openstack.org>`_ for installation instructions. Configuration --------------- -ON CLOUD CONTROLLER +These instructions are incomplete, but we are actively updating the `OpenStack wiki <http://wiki.openstack.org>`_ with more configuration information. + +On the cloud controller * Add yourself to the libvirtd group, log out, and log back in -* fix hardcoded ec2 metadata/userdata uri ($IP is the IP of the cloud), and masqurade all traffic from launched instances +* Fix hardcoded ec2 metadata/userdata uri ($IP is the IP of the cloud), and masqurade all traffic from launched instances + :: iptables -t nat -A PREROUTING -s 0.0.0.0/0 -d 169.254.169.254/32 -p tcp -m tcp --dport 80 -j DNAT --to-destination $IP:8773 @@ -119,9 +94,9 @@ ON CLOUD CONTROLLER } } -ON VOLUME NODE +On the volume node -* create a filesystem (you can use an actual disk if you have one spare, default is /dev/sdb) +* Create a filesystem (you can use an actual disk if you have one spare, default is /dev/sdb) :: @@ -137,9 +112,7 @@ Running Launch servers * rabbitmq -* redis -* slapd -* nginx +* redis (optional) Launch nova components diff --git a/doc/source/index.rst b/doc/source/index.rst index 6627fe066..1109e9011 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -15,18 +15,22 @@ License for the specific language governing permissions and limitations under the License. -Welcome to nova's documentation! +Welcome to Nova's documentation! ================================ -Nova is a cloud computing fabric controller (the main part of an IaaS system) built to match the popular AWS EC2 and S3 APIs. -It is written in Python, using the Tornado and Twisted frameworks, and relies on the standard AMQP messaging protocol, -and the Redis distributed KVS. -Nova is intended to be easy to extend, and adapt. For example, it currently uses -an LDAP server for users and groups, but also includes a fake LDAP server, -that stores data in Redis. It has extensive test coverage, and uses the -Sphinx toolkit (the same as Python itself) for code and user 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 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 - there are bugs! +is very much under active development - please test it and log bugs! Contents: |