openstack/nova
Code Issues Proposed changes

Doc skeleton from collaborative etherpad hack session.

Browse Source
This commit is contained in:
Todd Willey
2010-10-27 15:52:06 -04:00
parent 32a75c0181
commit 55a0cfc96b
10 changed files with 204 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
doc/source/administration.guide.rst
View File

@@ -30,4 +30,6 @@ Contents
quickstart
getting.started
multi.node.install
services
flags
monitoring

15
doc/source/auth.rst
View File

@@ -18,6 +18,21 @@
Auth Documentation
==================
from etherpad todo
------------------
::
* FIX RST IMPORT ERRORS
* Manager
* Driver
* ldap
* fakeldap
* redisectomy
legacy docs
-----------
Nova provides RBAC (Role-based access control) of the AWS-type APIs. We define the following roles:
Roles-Based Access Control of AWS-style APIs using SAML Assertions

21
doc/source/compute.rst
View File

@@ -18,6 +18,27 @@
Compute Documentation
=====================
from etherpad todo
------------------
::
* FIX RST IMPORT ERRORS
* Compute Manager
* public methods
* responsibilities
* Compute Driver
* public methods
* libvirt implementation
- kvm/qemu
- uml
* xen implementation
* hyperv implementation
legacy docs
-----------
This page contains the Compute Package documentation.

76
doc/source/concepts.and.introduction.rst
View File

@@ -45,7 +45,10 @@ in the administration guide.
Concept: Users and Projects
---------------------------
Projects
* access to images is limited by project
* access/secret are per user
* keypairs are per user
* quotas are per project
Concept: Virtualization
@@ -55,6 +58,7 @@ Concept: Virtualization
* UML
* XEN
* HyperV
* qemu
Concept: Volumes
@@ -70,6 +74,13 @@ Concept: Quotas
* Override for project
Concept: RBAC
-------------
* Intersecting Roles
* cloudadmin vs. user admin flag
Concept: API
------------
@@ -80,14 +91,30 @@ Concept: API
Concept: Networking
-------------------
* Simple networking
* VLAN Networking
* VLAN
* Cloudpipe
* Certificates (See also: CA)
* Flat Networking
* Flat with DHCP
* How to generate addresses
* Floating Addresses
Concept: Services
-----------------
Services
* nova-api
* nova-scheduler
* nova-compute
* nova-volume
* nova-network
* nova-instancemonitor
Concept: nova-manage
--------------------
nova manage
Concept: Flags
@@ -99,7 +126,13 @@ python-gflags
Concept: Plugins
----------------
LazyPluggable
* Managers/Drivers: utils.import_object from string flag
* virt/connections: conditional loading from string flag
* db: LazyPluggable via string flag
* auth_manager: utils.import_class based on string flag
* Volumes: moving to pluggable driver instead of manager
* Network: pluggable managers
* Compute: same driver used, but pluggable at connection
Concept: IPC/RPC
@@ -111,28 +144,33 @@ Rabbit!
Concept: Fakes
--------------
Fakes
* auth
* ldap
Concept: Scheduler
------------------
Scheduler
Concept: ORM
------------
ORM
Concept: Manager Pattern
------------------------
Managers
* simple
* random
Concept: Security Groups
------------------------
Security groups
Concept: Certificate Authority
------------------------------
Per-project CA
* Images
* VPNs
Concept: Images
---------------
* launching
* bundling

15
doc/source/development.guide.rst
View File

@@ -27,11 +27,20 @@ Contents
.. toctree::
:maxdepth: 1
architecture
network
database
storage
auth
compute
network
auth
Older Contents
--------------
.. toctree::
:maxdepth: 1
architecture
endpoint
nova
fakes

27
doc/source/monitoring.rst Normal file
View File

@@ -0,0 +1,27 @@
..
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.
Monitoring
==========
* components
* throughput
* exceptions
* hardware
* ganglia
* syslog

4
doc/source/multi.node.install.rst
View File

@@ -19,3 +19,7 @@ Multi-Node Nova
===============
http://etherpad.openstack.org/NovaMultinodeInstall
* Puppet
* Chef
* PXE

19
doc/source/network.rst
View File

@@ -18,6 +18,25 @@
nova Networking
================
from etherpad todo
------------------
::
* Network Manager
* overview (use vish email)
* public methods
* responsibilities
* Vlan + DHCP implementation
* Flat + DHCP implementation
* Flat impleplementation
* Network Driver
* public methods
* hardware specific commands
legacy docs
-----------
The nova networking components manage private networks, public IP addressing, VPN connectivity, and firewall rules.
Components

31
doc/source/services.rst Normal file
View File

@@ -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.
Services
========
Admin guide should go beyoned concepts & introduction by talking about how
each service interacts with each other, what requirements for deployment are,
monotoring, logging, etc
* nova-api
* nova-scheduler
* nova-compute
* nova-volume
* nova-network
* nova-instancemonitor

16
doc/source/storage.rst
View File

@@ -18,6 +18,22 @@
Storage in the Nova Cloud
=========================
from etherpad todo
-------------------
::
* Volume Manager
* public methods
* responsibilities
* Volume Driver
* public methods
* AoE implementation
* ISCSI implementation
legacy docs
-----------
There are three primary classes of storage in a nova cloud environment:
* Ephemeral Storage (local disk within an instance)