Fix rst formatting and cross-references
blueprint sphinx-doc-cleanup bug 944385 - Fix formatting and markup issues that produce error messages - Update TOC lists for missing/new files - Fix a few links - Update instructions with dependencies for building the documentation - Updated base on review comments from oubiwann to fix trailing whitespace in modified files Change-Id: I589152bfab9c543d2b11fa8bed2344259aa90675
This commit is contained in:
Doug Hellmann
Lorin Hochstein
parent
b70994bc11
commit
1b520963ba
1
.mailmap
1
.mailmap
@ -21,6 +21,7 @@
|
||||
<Dave.Walker@canonical.com> <DaveWalker@ubuntu.com>
|
||||
<derekh@redhat.com> <higginsd@gmail.com>
|
||||
<devin.carlen@gmail.com> <devcamcar@illian.local>
|
||||
<doug.hellmann@dreamhost.com> <doug.hellmann@gmail.com>
|
||||
<dprince@redhat.com> <dan.prince@rackspace.com>
|
||||
<edouard1.thuleau@orange.com> <thuleau@gmail.com>
|
||||
<ewan.mellor@citrix.com> <emellor@silver>
|
||||
|
||||
@ -2,7 +2,29 @@
|
||||
Building the docs
|
||||
=================
|
||||
|
||||
It is really easy. You'll need sphinx (the python one) and if you are using the virtualenv you'll need to install it in the virtualenv specifically so that it can load the nova modules.
|
||||
Dependencies
|
||||
============
|
||||
|
||||
Sphinx_
|
||||
You'll need sphinx (the python one) and if you are
|
||||
using the virtualenv you'll need to install it in the virtualenv
|
||||
specifically so that it can load the nova modules.
|
||||
|
||||
::
|
||||
|
||||
pip install Sphinx
|
||||
|
||||
Graphviz_
|
||||
Some of the diagrams are generated using the ``dot`` language
|
||||
from Graphviz.
|
||||
|
||||
::
|
||||
|
||||
sudo apt-get install graphviz
|
||||
|
||||
.. _Sphinx: http://sphinx.pocoo.org
|
||||
|
||||
.. _Graphviz: http://www.graphviz.org/
|
||||
|
||||
|
||||
Use `make`
|
||||
|
||||
@ -15,7 +15,7 @@ do
|
||||
# and make sure to emit that many '=' under
|
||||
# it to avoid heading format errors
|
||||
# in Sphinx.
|
||||
let heading_len=$(echo "$heading" | wc -c)
|
||||
heading_len=$(echo "$heading" | wc -c)
|
||||
underline=$(head -c $heading_len < /dev/zero | tr '\0' '=')
|
||||
( cat <<EOF
|
||||
${heading}
|
||||
|
||||
@ -37,7 +37,8 @@ Doc Link (WADL)
|
||||
http://
|
||||
|
||||
Short Description
|
||||
This extension enables the assignment of config-drives to a compute guest on instance create running in an OpenStack cloud.
|
||||
This extension enables the assignment of config-drives to a
|
||||
compute guest on instance create running in an OpenStack cloud.
|
||||
|
||||
Sample Query Responses
|
||||
----------------------
|
||||
@ -46,9 +47,16 @@ As shown below, responses to an EXTENSION query in XML or JSON provide basic inf
|
||||
|
||||
Extension Query Response: XML::
|
||||
|
||||
TBD
|
||||
|
||||
.. todo:: Provide example of extension query XML response.
|
||||
|
||||
Extension Query Response: JSON::
|
||||
|
||||
TBD
|
||||
|
||||
.. todo:: Provide example of extension query JSON response.
|
||||
|
||||
|
||||
Document Change History
|
||||
-----------------------
|
||||
@ -94,7 +102,9 @@ Changes to the Cloud Servers Specification
|
||||
In section 4.1.2 (Create Servers) of the API Specification: Examples 4.3 and 4.4 should optionally add the config-drive attribute as in the below examples:
|
||||
|
||||
|
||||
Example XML with config_drive attribute = True::
|
||||
Example XML with config_drive attribute = True:
|
||||
|
||||
::
|
||||
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<server xmlns="http://docs.openstack.org/compute/api/v1.1"
|
||||
@ -121,7 +131,9 @@ Example XML with config_drive attribute = True::
|
||||
</personality>
|
||||
</server>
|
||||
|
||||
Example XML with config_drive attribute is an imageRef::
|
||||
Example XML with config_drive attribute is an imageRef:
|
||||
|
||||
::
|
||||
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<server xmlns="http://docs.openstack.org/compute/api/v1.1"
|
||||
@ -150,7 +162,9 @@ Example XML with config_drive attribute is an imageRef::
|
||||
</server>
|
||||
|
||||
|
||||
Example JSON with config_drive attribute is true::
|
||||
Example JSON with config_drive attribute is true:
|
||||
|
||||
::
|
||||
|
||||
{
|
||||
"server" : {
|
||||
@ -178,7 +192,9 @@ Example JSON with config_drive attribute is true::
|
||||
}
|
||||
}
|
||||
|
||||
Example JSON with config_drive attribute is an imageRef::
|
||||
Example JSON with config_drive attribute is an imageRef:
|
||||
|
||||
::
|
||||
|
||||
{
|
||||
"server" : {
|
||||
|
||||
@ -1,5 +1,6 @@
|
||||
About The Floating IP DNS Extension
|
||||
================================
|
||||
===================================
|
||||
|
||||
The Floating IP DNS extension provides an interface for managing DNS records associated with IP addresses
|
||||
allocated by the Floating Ips extension. Requests are dispatched to a DNS driver selected at startup.
|
||||
|
||||
@ -85,7 +86,8 @@ None
|
||||
|
||||
New Resources
|
||||
-------------
|
||||
Get a list of registered DNS Domains published by the DNS drivers:
|
||||
|
||||
Get a list of registered DNS Domains published by the DNS drivers::
|
||||
|
||||
GET /v1.1/<tenant_id>/os-floating-ip-dns/
|
||||
|
||||
@ -97,7 +99,7 @@ Get a list of registered DNS Domains published by the DNS drivers:
|
||||
{'domain': 'example.internal', 'scope': 'private', 'availability_zone': 'zone1'}]}
|
||||
|
||||
|
||||
Create or modify a DNS domain:
|
||||
Create or modify a DNS domain::
|
||||
|
||||
PUT /v1.1/<tenant_id>/os-floating-ip-dns/<domain>
|
||||
|
||||
@ -130,7 +132,7 @@ Create or modify a DNS domain:
|
||||
Failure Response Code: 403 (Insufficient permissions.)
|
||||
|
||||
|
||||
Delete a DNS domain and all associated host entries:
|
||||
Delete a DNS domain and all associated host entries::
|
||||
|
||||
DELETE /v1.1/<tenant_id>/os-floating-ip-dns/<domain>
|
||||
|
||||
@ -139,7 +141,7 @@ DELETE /v1.1/<tenant_id>/os-floating-ip-dns/<domain>
|
||||
Failure Response Code: 403 (Insufficient permissions to delete.)
|
||||
|
||||
|
||||
Create or modify a DNS entry:
|
||||
Create or modify a DNS entry::
|
||||
|
||||
PUT /v1.1/<tenant_id>/os-floating-ip-dns/<domain>/entries/<name>
|
||||
|
||||
@ -154,7 +156,7 @@ Create or modify a DNS entry:
|
||||
'name' : 'instance1' }}
|
||||
|
||||
|
||||
Find unique DNS entry for a given domain and name:
|
||||
Find unique DNS entry for a given domain and name::
|
||||
|
||||
GET /v1.1/<tenant_id>/os-floating-ip-dns/<domain>/entries/<name>
|
||||
|
||||
@ -166,7 +168,7 @@ Find unique DNS entry for a given domain and name:
|
||||
'name' : <name> }}
|
||||
|
||||
|
||||
Find DNS entries for a given domain and ip:
|
||||
Find DNS entries for a given domain and ip::
|
||||
|
||||
GET /v1.1/<tenant_id>/os-floating-ip-dns/<domain>/entries?ip=<ip>
|
||||
|
||||
@ -182,7 +184,7 @@ Find DNS entries for a given domain and ip:
|
||||
'name' : 'example2' }]}
|
||||
|
||||
|
||||
Delete a DNS entry:
|
||||
Delete a DNS entry::
|
||||
|
||||
DELETE /v1.1/<tenant_id>/os-floating-ip-dns/<domain>/entries/<name>
|
||||
|
||||
|
||||
@ -44,6 +44,9 @@ As shown below, responses to an EXTENSION query in XML or JSON provide basic inf
|
||||
|
||||
Extension Query Response: XML::
|
||||
|
||||
TBD
|
||||
|
||||
.. todo:: Provide example of extension query XML response.
|
||||
|
||||
Extension Query Response: JSON::
|
||||
|
||||
|
||||
@ -47,6 +47,9 @@ As shown below, responses to an EXTENSION query in XML or JSON provide basic inf
|
||||
|
||||
Extension Query Response: XML::
|
||||
|
||||
TBD
|
||||
|
||||
.. todo:: Provide example of extension query XML response.
|
||||
|
||||
Extension Query Response: JSON::
|
||||
|
||||
|
||||
@ -1,5 +1,6 @@
|
||||
About The Rescue Extension
|
||||
==========================
|
||||
|
||||
The rescue extension lets you put a server into a "rescue" status when the virtual instance will be replaced with a "rescue" image and have its existing drive attached as a second disk so that a root user can log in and troubleshoot problems with the virtual server.
|
||||
|
||||
To put a server into "rescue" state, you do not have to be an administrator. The only requirement is that the base image used to build your instance must still be available.
|
||||
@ -67,7 +68,7 @@ This extension to the OpenStack Compute API enables rescue of running instances.
|
||||
To support these new actions, the extension also issues new states.
|
||||
|
||||
New Actions
|
||||
----------
|
||||
-----------
|
||||
rescue
|
||||
unrescue
|
||||
|
||||
|
||||
@ -69,7 +69,7 @@ Summary of Changes
|
||||
This extension to the OpenStack Compute API enables listing of Virtual Interfaces of running instances.
|
||||
|
||||
New Actions
|
||||
----------
|
||||
-----------
|
||||
virtual_interfaces
|
||||
|
||||
New Faults
|
||||
|
||||
@ -48,6 +48,9 @@ As shown below, responses to an EXTENSION query in XML or JSON provide basic inf
|
||||
|
||||
Extension Query Response: XML::
|
||||
|
||||
TBD
|
||||
|
||||
.. todo:: Provide example of XML query and response for volumes extension.
|
||||
|
||||
Extension Query Response: JSON::
|
||||
|
||||
|
||||
@ -54,6 +54,7 @@ Extension Query Response: XML::
|
||||
|
||||
Extension Query Response: JSON::
|
||||
|
||||
N/A
|
||||
|
||||
Document Change History
|
||||
-----------------------
|
||||
|
||||
@ -1,92 +0,0 @@
|
||||
Generating source/api/nova..adminclient.rst
|
||||
Generating source/api/nova..api.cloud.rst
|
||||
Generating source/api/nova..api.ec2.admin.rst
|
||||
Generating source/api/nova..api.ec2.apirequest.rst
|
||||
Generating source/api/nova..api.ec2.cloud.rst
|
||||
Generating source/api/nova..api.ec2.images.rst
|
||||
Generating source/api/nova..api.ec2.metadatarequesthandler.rst
|
||||
Generating source/api/nova..api.openstack.auth.rst
|
||||
Generating source/api/nova..api.openstack.backup_schedules.rst
|
||||
Generating source/api/nova..api.openstack.faults.rst
|
||||
Generating source/api/nova..api.openstack.flavors.rst
|
||||
Generating source/api/nova..api.openstack.images.rst
|
||||
Generating source/api/nova..api.openstack.servers.rst
|
||||
Generating source/api/nova..api.openstack.sharedipgroups.rst
|
||||
Generating source/api/nova..auth.dbdriver.rst
|
||||
Generating source/api/nova..auth.fakeldap.rst
|
||||
Generating source/api/nova..auth.ldapdriver.rst
|
||||
Generating source/api/nova..auth.manager.rst
|
||||
Generating source/api/nova..auth.signer.rst
|
||||
Generating source/api/nova..cloudpipe.pipelib.rst
|
||||
Generating source/api/nova..compute.disk.rst
|
||||
Generating source/api/nova..compute.instance_types.rst
|
||||
Generating source/api/nova..compute.manager.rst
|
||||
Generating source/api/nova..compute.power_state.rst
|
||||
Generating source/api/nova..context.rst
|
||||
Generating source/api/nova..crypto.rst
|
||||
Generating source/api/nova..db.api.rst
|
||||
Generating source/api/nova..db.sqlalchemy.api.rst
|
||||
Generating source/api/nova..db.sqlalchemy.models.rst
|
||||
Generating source/api/nova..db.sqlalchemy.session.rst
|
||||
Generating source/api/nova..exception.rst
|
||||
Generating source/api/nova..fake.rabbit.rst
|
||||
Generating source/api/nova..flags.rst
|
||||
Generating source/api/nova..image.service.rst
|
||||
Generating source/api/nova..manager.rst
|
||||
Generating source/api/nova..network.linux_net.rst
|
||||
Generating source/api/nova..network.manager.rst
|
||||
Generating source/api/nova..objectstore.bucket.rst
|
||||
Generating source/api/nova..objectstore.handler.rst
|
||||
Generating source/api/nova..objectstore.image.rst
|
||||
Generating source/api/nova..objectstore.stored.rst
|
||||
Generating source/api/nova..process.rst
|
||||
Generating source/api/nova..quota.rst
|
||||
Generating source/api/nova..rpc.rst
|
||||
Generating source/api/nova..scheduler.chance.rst
|
||||
Generating source/api/nova..scheduler.driver.rst
|
||||
Generating source/api/nova..scheduler.manager.rst
|
||||
Generating source/api/nova..scheduler.simple.rst
|
||||
Generating source/api/nova..server.rst
|
||||
Generating source/api/nova..service.rst
|
||||
Generating source/api/nova..test.rst
|
||||
Generating source/api/nova..tests.access_unittest.rst
|
||||
Generating source/api/nova..tests.api.fakes.rst
|
||||
Generating source/api/nova..tests.api.openstack.fakes.rst
|
||||
Generating source/api/nova..tests.api.openstack.test_api.rst
|
||||
Generating source/api/nova..tests.api.openstack.test_auth.rst
|
||||
Generating source/api/nova..tests.api.openstack.test_faults.rst
|
||||
Generating source/api/nova..tests.api.openstack.test_flavors.rst
|
||||
Generating source/api/nova..tests.api.openstack.test_images.rst
|
||||
Generating source/api/nova..tests.api.openstack.test_servers.rst
|
||||
Generating source/api/nova..tests.api.openstack.test_sharedipgroups.rst
|
||||
Generating source/api/nova..tests.api.test_wsgi.rst
|
||||
Generating source/api/nova..tests.api_integration.rst
|
||||
Generating source/api/nova..tests.api_unittest.rst
|
||||
Generating source/api/nova..tests.auth_unittest.rst
|
||||
Generating source/api/nova..tests.cloud_unittest.rst
|
||||
Generating source/api/nova..tests.compute_unittest.rst
|
||||
Generating source/api/nova..tests.declare_flags.rst
|
||||
Generating source/api/nova..tests.fake_flags.rst
|
||||
Generating source/api/nova..tests.flags_unittest.rst
|
||||
Generating source/api/nova..tests.network_unittest.rst
|
||||
Generating source/api/nova..tests.objectstore_unittest.rst
|
||||
Generating source/api/nova..tests.process_unittest.rst
|
||||
Generating source/api/nova..tests.quota_unittest.rst
|
||||
Generating source/api/nova..tests.real_flags.rst
|
||||
Generating source/api/nova..tests.rpc_unittest.rst
|
||||
Generating source/api/nova..tests.runtime_flags.rst
|
||||
Generating source/api/nova..tests.scheduler_unittest.rst
|
||||
Generating source/api/nova..tests.service_unittest.rst
|
||||
Generating source/api/nova..tests.validator_unittest.rst
|
||||
Generating source/api/nova..tests.virt_unittest.rst
|
||||
Generating source/api/nova..tests.volume_unittest.rst
|
||||
Generating source/api/nova..utils.rst
|
||||
Generating source/api/nova..validate.rst
|
||||
Generating source/api/nova..virt.connection.rst
|
||||
Generating source/api/nova..virt.fake.rst
|
||||
Generating source/api/nova..virt.images.rst
|
||||
Generating source/api/nova..virt.libvirt_conn.rst
|
||||
Generating source/api/nova..virt.xenapi.rst
|
||||
Generating source/api/nova..volume.driver.rst
|
||||
Generating source/api/nova..volume.manager.rst
|
||||
Generating source/api/nova..wsgi.rst
|
||||
@ -34,7 +34,7 @@ Contributing Code
|
||||
-----------------
|
||||
|
||||
To contribute code, sign up for a Launchpad account and sign a contributor license agreement,
|
||||
available on the `OpenStack Wiki <http://wiki.openstack.org/CLA>`_. Once the CLA is signed you
|
||||
available on the `OpenStack Wiki`_. Once the CLA is signed you
|
||||
can contribute code through the Bazaar version control system which is related to your Launchpad
|
||||
account. See the :doc:`devref/development.environment` page to get started.
|
||||
|
||||
@ -54,7 +54,9 @@ The wiki is a living source of knowledge. It is edited by the community, and
|
||||
has collections of links and other sources of information. Typically the pages are a good place
|
||||
to write drafts for specs or documentation, describe a blueprint, or collaborate with others.
|
||||
|
||||
* `OpenStack Wiki <http://wiki.openstack.org/>`_
|
||||
* `OpenStack Wiki`_
|
||||
|
||||
.. _OpenStack Wiki: http://wiki.openstack.org/
|
||||
|
||||
|
||||
Nova on Github
|
||||
|
||||
@ -78,7 +78,12 @@ version = nova_version.canonical_version_string()
|
||||
#today_fmt = '%B %d, %Y'
|
||||
|
||||
# List of documents that shouldn't be included in the build.
|
||||
#unused_docs = []
|
||||
unused_docs = [
|
||||
'api_ext/rst_extension_template',
|
||||
'man/novamanage',
|
||||
'vmwareapi_readme',
|
||||
'installer',
|
||||
]
|
||||
|
||||
# List of directories, relative to source directory, that shouldn't be searched
|
||||
# for source files.
|
||||
|
||||
@ -22,9 +22,9 @@ The interface is a mostly RESTful API. REST stands for Representational State Tr
|
||||
Routing
|
||||
-------
|
||||
|
||||
To map URLs to controllers+actions, OpenStack uses the Routes package, a clone of Rails routes for Python implementations. See http://routes.groovie.org/ fore more information.
|
||||
To map URLs to controllers+actions, OpenStack uses the Routes package, a clone of Rails routes for Python implementations. See http://routes.groovie.org/ for more information.
|
||||
|
||||
URLs are mapped to "action" methods on "controller" classes in `nova/api/openstack/__init__/ApiRouter.__init__` .
|
||||
URLs are mapped to "action" methods on "controller" classes in ``nova/api/openstack/__init__/ApiRouter.__init__`` .
|
||||
|
||||
See http://routes.groovie.org/manual.html for all syntax, but you'll probably just need these two:
|
||||
- mapper.connect() lets you map a single URL to a single action on a controller.
|
||||
@ -33,9 +33,9 @@ See http://routes.groovie.org/manual.html for all syntax, but you'll probably ju
|
||||
Controllers and actions
|
||||
-----------------------
|
||||
|
||||
Controllers live in `nova/api/openstack`, and inherit from nova.wsgi.Controller.
|
||||
Controllers live in ``nova/api/openstack``, and inherit from nova.wsgi.Controller.
|
||||
|
||||
See `nova/api/openstack/servers.py` for an example.
|
||||
See ``nova/api/openstack/servers.py`` for an example.
|
||||
|
||||
Action methods take parameters that are sucked out of the URL by mapper.connect() or .resource(). The first two parameters are self and the WebOb request, from which you can get the req.environ, req.body, req.headers, etc.
|
||||
|
||||
@ -44,7 +44,7 @@ Serialization
|
||||
|
||||
Actions return a dictionary, and wsgi.Controller serializes that to JSON or XML based on the request's content-type.
|
||||
|
||||
If you define a new controller, you'll need to define a _serialization_metadata attribute on the class, to tell wsgi.Controller how to convert your dictionary to XML. It needs to know the singular form of any list tag (e.g. <servers> list contains <server> tags) and which dictionary keys are to be XML attributes as opposed to subtags (e.g. <server id="4"/> instead of <server><id>4</id></server>).
|
||||
If you define a new controller, you'll need to define a ``_serialization_metadata`` attribute on the class, to tell wsgi.Controller how to convert your dictionary to XML. It needs to know the singular form of any list tag (e.g. ``<servers>`` list contains ``<server>`` tags) and which dictionary keys are to be XML attributes as opposed to subtags (e.g. ``<server id="4"/>`` instead of ``<server><id>4</id></server>``).
|
||||
|
||||
See `nova/api/openstack/servers.py` for an example.
|
||||
|
||||
|
||||
@ -18,37 +18,45 @@
|
||||
Setting Up a Development Environment
|
||||
====================================
|
||||
|
||||
This page describes how to setup a working Python development environment that
|
||||
can be used in developing nova on Ubuntu, Fedora or Mac OS X. These
|
||||
instructions assume you're already familiar with git. Refer to
|
||||
http://wiki.openstack.org/GettingTheCode for additional information.
|
||||
This page describes how to setup a working Python development
|
||||
environment that can be used in developing nova on Ubuntu, Fedora or
|
||||
Mac OS X. These instructions assume you're already familiar with
|
||||
git. Refer to GettingTheCode_ for additional information.
|
||||
|
||||
Following these instructions will allow you to run the nova unit tests. If you
|
||||
want to be able to run nova (i.e., launch VM instances), you will also need to
|
||||
install libvirt and at least one of the `supported
|
||||
hypervisors`<http://wiki.openstack.org/HypervisorSupportMatrix>_. Running
|
||||
nova is currently only supported on Linux, although you can run
|
||||
the unit tests on Mac OS X. See :doc:`quickstart` for how to get a working
|
||||
version of OpenStack Compute running as quickly as possible.
|
||||
.. _GettingTheCode: http://wiki.openstack.org/GettingTheCode
|
||||
|
||||
Following these instructions will allow you to run the nova unit
|
||||
tests. If you want to be able to run nova (i.e., launch VM instances),
|
||||
you will also need to install libvirt and at least one of the
|
||||
`supported hypervisors`_. Running nova is currently only supported on
|
||||
Linux, although you can run the unit tests on Mac OS X. See
|
||||
:doc:`../quickstart` for how to get a working version of OpenStack
|
||||
Compute running as quickly as possible.
|
||||
|
||||
.. _supported hypervisors: http://wiki.openstack.org/HypervisorSupportMatrix
|
||||
|
||||
Virtual environments
|
||||
--------------------
|
||||
|
||||
Nova development uses `virtualenv <http://pypi.python.org/pypi/virtualenv>`_
|
||||
to track and manage Python dependencies while in development and testing. This
|
||||
allows you to install all of the Python package dependencies in a virtual
|
||||
environment or `virtualenv` (a special subdirectory of your nova directory),
|
||||
instead of installing the packages at the system level.
|
||||
Nova development uses `virtualenv <http://pypi.python.org/pypi/virtualenv>`__ to track and manage Python
|
||||
dependencies while in development and testing. This allows you to
|
||||
install all of the Python package dependencies in a virtual
|
||||
environment or "virtualenv" (a special subdirectory of your nova
|
||||
directory), instead of installing the packages at the system level.
|
||||
|
||||
Virtualenv is useful for running the unit tests, but is not typically used
|
||||
for full integration testing or production usage.
|
||||
.. note::
|
||||
|
||||
Virtualenv is useful for running the unit tests, but is not
|
||||
typically used for full integration testing or production usage.
|
||||
|
||||
Linux Systems
|
||||
-------------
|
||||
|
||||
Note: This section is tested for Nova on Ubuntu (10.10-64) and
|
||||
Fedora-based (RHEL 6.1) distributions. Feel free to add notes and change
|
||||
according to your experiences or operating system.
|
||||
.. note::
|
||||
|
||||
This section is tested for Nova on Ubuntu (10.10-64) and
|
||||
Fedora-based (RHEL 6.1) distributions. Feel free to add notes and
|
||||
change according to your experiences or operating system.
|
||||
|
||||
Install the prerequisite packages.
|
||||
|
||||
@ -135,8 +143,10 @@ Contributing Your Work
|
||||
----------------------
|
||||
|
||||
Once your work is complete you may wish to contribute it to the project. Add
|
||||
your name and email address to the `Authors` file, and also to the `.mailmap`
|
||||
your name and email address to the ``Authors`` file, and also to the ``.mailmap``
|
||||
file if you use multiple email addresses. Your contributions can not be merged
|
||||
into trunk unless you are listed in the Authors file. Nova uses the Gerrit
|
||||
code review system. For information on how to submit your branch to Gerrit,
|
||||
see http://wiki.openstack.org/GerritWorkflow
|
||||
see GerritWorkflow_.
|
||||
|
||||
.. _GerritWorkflow: http://wiki.openstack.org/GerritWorkflow
|
||||
|
||||
@ -45,7 +45,7 @@ The :mod:`nova.auth.fakeldap` Module
|
||||
|
||||
|
||||
The :mod:`nova.testing.fake.rabbit` Module
|
||||
---------------------------------
|
||||
------------------------------------------
|
||||
|
||||
.. automodule:: nova.testing.fake.rabbit
|
||||
:noindex:
|
||||
|
||||
@ -36,11 +36,11 @@ Background Concepts for Nova
|
||||
.. toctree::
|
||||
:maxdepth: 3
|
||||
|
||||
architecture
|
||||
threading
|
||||
il8n
|
||||
distributed_scheduler
|
||||
multinic
|
||||
zone
|
||||
rabbit
|
||||
|
||||
Other Resources
|
||||
|
||||
@ -1,19 +0,0 @@
|
||||
Module Reference
|
||||
================
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
services
|
||||
database
|
||||
volume
|
||||
compute
|
||||
network
|
||||
auth
|
||||
api
|
||||
scheduler
|
||||
fakes
|
||||
nova
|
||||
cloudpipe
|
||||
objectstore
|
||||
glance
|
||||
@ -48,12 +48,13 @@ Key Concepts
|
||||
|
||||
cloud101
|
||||
nova.concepts
|
||||
swift.concepts
|
||||
service.architecture
|
||||
nova.object.model
|
||||
swift.object.model
|
||||
object.model
|
||||
runnova/index
|
||||
|
||||
.. swift.concepts
|
||||
.. swift.object.model
|
||||
|
||||
Developer Docs
|
||||
==============
|
||||
|
||||
|
||||
@ -35,9 +35,11 @@ focuses on describing how Nova's implementation of those concepts is achieved.
|
||||
|
||||
This page outlines concepts that you will need to understand as a user or
|
||||
administrator of an OpenStack installation. Each section links to more more
|
||||
detailed information in the :doc:`adminguide/index`,
|
||||
detailed information in the `OpenStack Compute Administration Guide`_
|
||||
but you'll probably want to read this section straight-through before tackling
|
||||
the specifics presented in the administration guide.
|
||||
the specifics presented there.
|
||||
|
||||
.. _OpenStack Compute Administration Guide: http://docs.openstack.org/diablo/openstack-compute/admin/content/
|
||||
|
||||
|
||||
Concept: Users and Projects
|
||||
@ -163,7 +165,8 @@ The nova-manage command is used to perform many essential functions for
|
||||
administration and ongoing maintenance of Nova, such as user creation,
|
||||
vpn management, and much more.
|
||||
|
||||
See :doc:`nova.manage` in the Administration Guide for more details.
|
||||
See :doc:`runnova/nova.manage` in the Administration Guide for more
|
||||
details.
|
||||
|
||||
Concept: Flags
|
||||
--------------
|
||||
|
||||
@ -18,8 +18,19 @@
|
||||
Flags and Flagfiles
|
||||
===================
|
||||
|
||||
Nova uses a configuration file containing flags located in /etc/nova/nova.conf. You can get the most recent listing of avaialble flags by running nova-(servicename) --help, for example, nova-api --help.
|
||||
Nova uses a configuration file containing flags located in
|
||||
``/etc/nova/nova.conf``. You can get the most recent listing of avaialble
|
||||
flags by running ``nova-(servicename) --help``, for example:
|
||||
|
||||
A script for generating a sample nova.conf file is located in *<nova_root>/tools/conf/run.sh*. This script traverses through the source code and retrieves information of every option that is defined. A file named *nova.conf.sample* will be placed in the same directory.
|
||||
::
|
||||
|
||||
The OpenStack wiki has a page with the flags listed by their purpose and use at http://wiki.openstack.org/FlagsGrouping.
|
||||
nova-api --help
|
||||
|
||||
A script for generating a sample ``nova.conf`` file is located in
|
||||
``<nova_root>/tools/conf/run.sh``. This script traverses through the
|
||||
source code and retrieves information of every option that is
|
||||
defined. A file named ``nova.conf.sample`` will be placed in the same
|
||||
directory.
|
||||
|
||||
The OpenStack wiki has a page with the flags listed by their purpose
|
||||
and use at http://wiki.openstack.org/FlagsGrouping.
|
||||
|
||||
@ -53,9 +53,12 @@ For background on the core objects referenced in this section, see :doc:`../obje
|
||||
managing.users
|
||||
managing.projects
|
||||
managing.instances
|
||||
managing.instance.types
|
||||
managing.images
|
||||
managing.volumes
|
||||
managing.networks
|
||||
managingsecurity
|
||||
|
||||
.. managing.volumes
|
||||
|
||||
Deployment
|
||||
----------
|
||||
@ -66,7 +69,9 @@ For a starting multi-node architecture, you would start with two nodes - a cloud
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
dbsync
|
||||
binaries
|
||||
|
||||
.. dbsync
|
||||
|
||||
|
||||
Networking
|
||||
|
||||
@ -37,6 +37,11 @@ Read more about Nova network strategies here:
|
||||
Network Management Commands
|
||||
---------------------------
|
||||
|
||||
.. todo::
|
||||
|
||||
Reformat command line app instructions for ``nova-manage`` using
|
||||
``:command:``, ``:option:``, and ``.. program::``. (bug-947261)
|
||||
|
||||
Admins and Network Administrators can use the 'nova-manage' command to manage network resources:
|
||||
|
||||
VPN Management
|
||||
|
||||
@ -25,15 +25,22 @@ Although the original ec2 api only supports users, nova adds the concept of proj
|
||||
The api will return NotAuthorized if a normal user attempts to make requests for a project that he or she is not a member of. Note that admins or users with special admin roles skip this check and can make requests for any project.
|
||||
|
||||
To create a project, use the `project create` command of nova-manage. The syntax is nova-manage project create projectname manager_id [description] You must specify a projectname and a manager_id. For example::
|
||||
|
||||
nova-manage project create john_project john "This is a sample project"
|
||||
|
||||
You can add and remove users from projects with `project add` and `project remove`::
|
||||
|
||||
nova-manage project add john_project john
|
||||
nova-manage project remove john_project john
|
||||
|
||||
Project Commands
|
||||
----------------
|
||||
|
||||
.. todo::
|
||||
|
||||
Reformat command line app instructions for ``nova-manage`` using
|
||||
``:command:``, ``:option:``, and ``.. program::``. (bug-947261)
|
||||
|
||||
Admins and Project Managers can use the 'nova-manage project' command to manage project resources:
|
||||
|
||||
* project add: Adds user to project
|
||||
@ -64,5 +71,7 @@ Nova utilizes a quota system at the project level to control resource consumptio
|
||||
* Publicly accessible IP addresses
|
||||
|
||||
Use the following command to set quotas for a project
|
||||
|
||||
* project quota: Set or display quotas for project
|
||||
|
||||
* arguments: project_id [key] [value]
|
||||
|
||||
@ -48,7 +48,7 @@ RBAC management is exposed through the dashboard for simplified user management.
|
||||
|
||||
|
||||
User Commands
|
||||
~~~~~~~~~~~~
|
||||
~~~~~~~~~~~~~
|
||||
|
||||
Users, including admins, are created through the ``user`` commands.
|
||||
|
||||
|
||||
@ -252,7 +252,7 @@ Security groups
|
||||
Concept: Certificate Authority
|
||||
------------------------------
|
||||
|
||||
Nova does a small amount of certificate management. These certificates are used for :ref:`project vpns <../cloudpipe>` and decrypting bundled images.
|
||||
Nova does a small amount of certificate management. These certificates are used for :ref:`project vpns <cloudpipe>` and decrypting bundled images.
|
||||
|
||||
|
||||
Concept: Images
|
||||
|
||||
@ -33,6 +33,7 @@ In general, a VNC console Connection works like so:
|
||||
the session ends
|
||||
|
||||
Note that in general, the vnc proxy performs multiple functions:
|
||||
|
||||
* Bridges between public network (where clients live) and private network
|
||||
(where vncservers live)
|
||||
* Mediates token authentication
|
||||
@ -52,6 +53,8 @@ Getting an Access Url
|
||||
Nova provides the ability to create access_urls through the os-consoles extension.
|
||||
Support for accessing this url is provided by novaclient:
|
||||
|
||||
::
|
||||
|
||||
nova get-vnc-console [server_id] [xvpvnc|novnc]
|
||||
|
||||
|
||||
@ -67,14 +70,18 @@ nova-xvpvncproxy service, which you should run to enable this feature.
|
||||
* :option:`--xvpvncproxy_host=[host]` - host to bind (defaults to 0.0.0.0)
|
||||
|
||||
As a client, you will need a special Java client, which is
|
||||
a version of TightVNC slightly modified to support our token auth::
|
||||
a version of TightVNC slightly modified to support our token auth:
|
||||
|
||||
::
|
||||
|
||||
git clone https://github.com/cloudbuilders/nova-xvpvncviewer
|
||||
cd nova-xvpvncviewer
|
||||
make
|
||||
|
||||
Then, to create a session, first request an access url using python-novaclient
|
||||
and then run the client like so::
|
||||
and then run the client like so:
|
||||
|
||||
::
|
||||
|
||||
# Retrieve access url
|
||||
nova get-vnc-console [server_id] xvpvnc
|
||||
@ -90,6 +97,9 @@ http://github.com/cloudbuilders/noVNC.git (in a branch called vnc_redux while
|
||||
this patch is in review).
|
||||
|
||||
To use this nova-novncproxy:
|
||||
|
||||
::
|
||||
|
||||
git clone http://github.com/cloudbuilders/noVNC.git
|
||||
git checkout vnc_redux
|
||||
utils/nova-novncproxy --flagfile=[path to flagfile]
|
||||
@ -111,6 +121,8 @@ Accessing a vnc console through a web browser
|
||||
Retrieving an access_url for a web browser is similar to the flow for
|
||||
the java client:
|
||||
|
||||
::
|
||||
|
||||
# Retrieve access url
|
||||
nova get-vnc-console [server_id] novnc
|
||||
# Then, paste the url into your web browser
|
||||
@ -135,3 +147,9 @@ Important Options
|
||||
management ip on the same network as the proxies.
|
||||
For multi-host libvirt deployments this can be set to a host
|
||||
management ip on the same network as the proxies.
|
||||
|
||||
|
||||
.. todo::
|
||||
|
||||
Reformat command line app instructions for commands using
|
||||
``:command:``, ``:option:``, and ``.. program::``. (bug-947261)
|
||||
|
||||
@ -105,7 +105,8 @@ Note:- Due to a faulty wsdl being shipped with ESX vSphere 4.1 we need a working
|
||||
|
||||
Debug flag
|
||||
----------
|
||||
::
|
||||
|
||||
.. note::
|
||||
|
||||
suds logging is very verbose and turned off by default. If you need to
|
||||
debug the VMware API calls, change the default_log_levels flag appropriately.
|
||||
|
||||
Loading…
Reference in New Issue
Block a user