Commit Graph

52 Commits

Author SHA1 Message Date
Daniel P. Berrange 4837c42127 Add formal doc recording hypervisor feature capability matrix
Add document to replace / obsolete the giant table on

  https://wiki.openstack.org/wiki/HypervisorSupportMatrix

This initial draft is a fairly straightforward conversion of
that table. Over time, it needs much work to improve the coverage
of API operations and and coverage of important configuration
information that users will care about.

It is using the .ini file syntax in order to record the data in
an easily machine parsable format, while remaining human friendly
by avoiding the syntax heavy approach of XML / JSON / YAML

An extension is registered with sphinx that can convert the
.ini file content into docutils content that then gets rendered
into the developer docs, linked from the index page

Change-Id: I4d3db4bce5737dba30a026a11083a9ea64459cd4
2015-02-03 15:15:49 +00:00
Andreas Jaeger f5c3f6a953 Stop using intersphinx
Remove intersphinx from the docs build as it triggers network calls that
occasionally fail, and we don't really use intersphinx (links other
sphinx documents out on the internet)

This also removes the requirement for internet access during docs build.

This causes docs jobs to fail because we error out on warnings.

Change-Id: I71e941e2a639641a662a163c682eb86d51de42fb
Related-Bug: #1368910
2014-09-12 22:41:42 +02:00
Sahid Orentino Ferdjaoui ea8323eca4 cmd: add nova-serialproxy service
Adds a websocket proxy that is compatible with Nova
serial ports.

Co-Authored-By: Vladan Popovic <vpopovic@redhat.com>
Co-Authored-By: Ian Wells <iawells@cisco.com>
Co-Authored-By: Sushma Korati <sushma_korati@persistent.co.in>

Partial-Implements: blueprint serial-ports
Change-Id: Ia944cb93945140e6341588063329a981f7e778f1
2014-08-30 14:27:54 +00:00
Davanum Srinivas a507d42cf5 docs - Set pbr 'warnerrors' option for doc build
By setting this pbr option in setup.cfg, the doc build will fail in case
of any warnings or errors occur during the build process.

Closes-Bug: #1351350

Change-Id: Id4858062d2aaa4c2fe5b597e40e4e8947f544a4d
2014-08-11 12:53:37 +00:00
Sascha Peilicke 90a61d71cd Drop nova-rpc-zmq-receiver man-page
Doesn't make sense to install and build docs after it was removed.

Change-Id: Ia6193808cca625e83cb3497b5033db5c08dcdd1e
2014-04-01 11:06:33 +02:00
Ben Nemec c926216a9b Replace oslo.sphinx with oslosphinx
oslosphinx is now available as a replacement for oslo.sphinx that
won't conflict with oslo.config in virtual envs.

Change-Id: I7c116f816af895261e76af385ee3e9288e6fa70f
Closes-Bug: #1277168
2014-02-12 16:45:49 +00:00
Doug Hellmann 47500553d9 Use oslo.sphinx and remove local copy of doc theme
Use the new oslo.sphinx version of the OpenStack doc
theme instead of copying it into this repo.

blueprint oslo.sphinx

Signed-off-by: Doug Hellmann <doug.hellmann@dreamhost.com>
Change-Id: I0bd91f7bb43f97b99051fed65b75fc05d5149cc8
2013-07-06 13:18:04 -04:00
Monty Taylor e4decf693a Fixed two minor docs niggles.
The doc todo list didn't actually work, so remove it. Also, the
documentation is not written by Anso Labs quite so much anymore.

Change-Id: I746a26505d331ab55565e952a1a46425458b1412
2013-05-31 08:30:13 -04:00
Kurt Taylor d17f9ab13d Update OpenStack LLC to Foundation
Update all references of "LLC" to "Foundation".

Change-Id: I009e86784ef4dcf38882d64b0eff484576e04efe
2013-02-26 19:15:29 -05:00
Monty Taylor 4336152768 Update to simplified common oslo version code.
Based on https://review.openstack.org/#/c/19957/

Change-Id: Ieefee2af8812d0217e95eeffb3cf53d8e55c8fe6
2013-02-10 04:05:15 -06:00
Daniel P. Berrange eab051ec68 Add nova-spicehtml5proxy helper
Add nova-spicehtml5proxy which provides a websockets proxy,
equivalent to nova-novncproxy

Blueprint: libvirt-spice
Change-Id: I48be78c97bb7dd6635fd4bba476ef22701418ba1
Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
2013-01-16 10:19:37 +00:00
Dan Smith 4ea757b880 Add the beginnings of the nova-conductor service
This adds a new service called "nova-conductor" which will provide
services for nova-compute, such as completing database updates and
handling long-running tasks.

Right now, this just adds a fraction of the database-related work
so that we can proceed with incremental changes to nova-compute.

For compatibility/flexibility, both LocalAPI and (RPC)API classes
are provided. Users concerned with performance or compatibility
who wish to maintain compute-node-local database accesses can
set the [conductor] use_local=True, which will mimic the legacy
behavior.

DocImpact

Change-Id: Ib81d879f40b7daceeffad5af0631c7db68168661
2012-11-19 11:41:34 -08:00
Vishvananda Ishaya 7e2b93acc5 removes the nova-volume code from nova
This removes the majority of the nova-volume code from the codebase.
It updates relevent config options to default to cinder. It updates a
number of existing tests that were depending on code that was removed.

A few things still need to be removed:

 * volume/driver.py & volume/iscsi.py
   These files are used by the libvirt volume driver tests. These
   tests should be updated to mock the relevant calls.

 * scheduler/simple.py & scheduler/multi.py
   These files should no longer be necessary so they can be removed
   in a subsequent patch

 * exception.py cleanup
   Once the above files are removed there are a number of unused
   exceptions which can be removed

 * database calls and database tables
   The database calls have not been removed and the tables have not
   been dropped. This can be done in a separate migration

 * additional config options and nova.conf.sample
   There may be a few extra config options that can be removed and the
   conf sample can be regenerated

Implements bp delete-nova-volume

Change-Id: I0b540e54dbabd26901a7530035a38583bb521fda
2012-10-28 11:34:05 -07:00
Joe Gordon c8b15fc78c Add man pages
Add partially written manpages for:
* nova-all
* nova-api-ec2
* nova-api-metadata
* nova-api-os-compute
* nova-api-os-volume
* nova-api
* nova-cert
* nova-compute
* nova-console
* nova-consoleauth
* nova-dhcpbridge
* nova-network
* nova-novncproxy
* nova-objectstore
* nova-rootwrap
* nova-rpc-zmq-receiver
* nova-scheduler
* nova-volume-usage-audit
* nova-volume
* nova-xvpvncproxy

Change-Id: I3734831ce2f6b5d765e98b3f50fe8c1ad7965685
2012-09-17 12:00:08 -07:00
Ray Chen d41aa7aed7 Code clean up
Some code clean up in the file doc/source/conf.py
to make the code more pretty.

Change-Id: Icb25428739725c530977a011bf28f17fda1c29fb
2012-08-21 21:49:50 +08:00
Ray Chen 9424514e6f Fix PEP8 issues
Fix some PEP8 issues in doc/ext/nova_todo.py and doc/source/conf.py
and make the code look more clearly.

Change-Id: I2b0ce1b09a4a707cffaa565747aabd5346eb9f41
2012-08-17 11:35:57 +08:00
Monty Taylor eb2de037a3 Update common setup code to latest.
This gets us up to date with common/setup.py and replaces custom nova
autodoc generation with the port of that code found in common.

Change-Id: I2a1c5d2c0fdcf40dbea50cc123b537adb068cdc2
2012-07-07 16:32:19 -05:00
Adam Gandelman 440a85f141 doc/source/conf.py: Fix man page building
Commit 29df6cd70 renamed novamanage to nova-manage but did
not update doc/source/conf.py accordingly causing build_sphinx
failures.

Also removes a stale conf.py backup created some time ago

Change-Id: Ia00b6d88eab90e0e77992375d7ccc7036c9d5f34
2012-03-12 14:20:22 -07:00
Hengqing Hu 9a042d3c50 Remove trailing whitespaces in regular file
Fixes bug #945346

Change-Id: I07a303c2e503e50d7138585c683e0d1310339276
2012-03-07 13:43:37 +08:00
Jenkins 11ba52fb20 Merge "fix restructuredtext formatting in docstrings that show up in the developer guide" 2012-03-07 01:34:42 +00:00
Derek Higgins f9c0f1e7ab No longer ignoring man/novamanage
Fixes Bug #948165
man/novamanage is a manpage and should be included

Change-Id: I497b3d2a348dc74f8ebcd08e628a6b9324dd3a8f
2012-03-06 16:41:04 +00:00
Doug Hellmann c16cd04cf6 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
2012-03-06 08:08:25 -05:00
Doug Hellmann b1de27f68a fix restructuredtext formatting in docstrings that show up in the developer guide
blueprint sphinx-doc-cleanup
bug 945160

- Correct parameter declarations, list formatting, cross-references, etc.
- We don't need "let" in generate_autodoc_index.sh since we aren't doing math.
- Change conf.py to not prefix class and function names with full namespace
  in generated output to save width on the screen.

Change-Id: I9adc8681951913fd291d03e7142146e9d46841df
2012-03-05 16:18:53 -05:00
Jesse Andrews a9694595a6 update copyright, add version information to footer
Change-Id: Ic957de1d986f7df6193228aa0051bd93f75945ba
2012-03-01 21:41:46 -08:00
Ken Pepple 5424690912 added myself to authors and fixed typo to follow standard 2011-01-09 09:25:27 -08:00
Ken Pepple 346bd0e7c9 typo correction 2011-01-08 17:46:22 -08:00
Ken Pepple 16eeac7105 fixed doc make process for new nova version (rev530) machanism 2011-01-08 17:40:06 -08:00
Soren Hansen a29bba7e9f s/canonical_version/canonical_version_string/g 2011-01-08 00:02:24 +01:00
Soren Hansen 8b3925e4d4 Less code generation. 2011-01-07 15:17:03 +01:00
Todd Willey 8cdfdd14a0 Let documentation get version from nova/version.py as well. 2011-01-06 15:29:38 -05:00
Anne Gentle acf8800d73 Adds images (only links one in), start for a nova-manage man file, and also documents all nova-manage commands. Can we merge it in even though the man page build isn't working? 2010-11-19 22:04:37 +00:00
Anne Gentle a777513b7c Testing man page build through conf.py 2010-11-17 14:28:09 -06:00
Soren Hansen fb5f32be1c Update version to 2011.1 as that is the version we expect to release next. 2010-11-17 12:34:15 +01:00
root b9867670af unify env syntax 2010-11-12 11:09:07 -08:00
root 7915fd554e create SPHINX_DEBUG env var. Setting this will disable aggressive autodoc generation. Also provide some sample for P syntax 2010-11-12 10:02:03 -08:00
root eecb36c85f fix conf file from earlier merge 2010-11-12 09:29:40 -08:00
root 2b93efeda3 anne's changes to the networking documentation 2010-11-12 08:05:45 -08:00
Anne Gentle dc957d99b2 Updated Networking doc 2010-11-12 09:52:56 -06:00
root b78364281d merge in trunk 2010-11-08 20:38:21 -08:00
root 2a81e25f89 working on novadoc structure 2010-11-08 18:40:21 -08:00
Todd Willey a3b6e0f358 Use the autodoc tools in the setup.py build_sphinx toolchain. 2010-11-07 17:53:39 -05:00
Todd Willey 75841f22d3 Fix include paths so setup.py build_sphinx works again. 2010-11-07 17:18:41 -05:00
root dd505245c2 add in custom todo, and custom css 2010-11-05 12:49:42 -07:00
Vishvananda Ishaya 80a6dd72ef prettier theme 2010-11-03 14:04:36 -07:00
Todd Willey b76286c5ef Merge trunk and apply some sphinx love. 2010-11-01 14:13:58 -04:00
Anne Gentle 75a0182e9a Changes to conf.py 2010-10-29 12:27:30 -05:00
Vishvananda Ishaya 21d4fce6dd merged and fixed conflicts 2010-10-27 16:37:40 -07:00
Vishvananda Ishaya 0211ec7d61 updates to auth, concepts, and network, fix of docstring 2010-10-27 16:33:25 -07:00
Todd Willey a1287cf4e1 cleanup rrd doc generation. 2010-10-27 17:31:46 -04:00
Soren Hansen a199f1ba53 Also update version in docs. 2010-10-19 23:41:25 -04:00