698 Commits

Author SHA1 Message Date
Ihar Hrachyshka
53ed158cba devref: don't link to nonlocal images
External images generate warnings for build-sphinx, and are not
supported for output formats other than html.

Change-Id: I9310577473982884897915dd29e09a2e4aaf51c7
2015-02-23 18:48:11 +00:00
Ihar Hrachyshka
9f947dc5dd devref: fixed class name for test_migrations autodocumentation
The file name is different, so documentation was not properly generated
before.

Also fixed a docstring not to issue sphinx warning due to incorrect
indentation.

Change-Id: I48ab899077458d99eee6f643577d574106c1ca88
2015-02-23 18:48:01 +00:00
Ihar Hrachyshka
e2452857cc devref: updated documentation for oslo-incubator
The project now has another name (oslo-incubator, not openstack-common).

Include the page into devref index.

Change-Id: I779d7cf35e0ec3f80fa6a53f12ed3ee98dd8c5cb
2015-02-23 18:47:53 +00:00
Ihar Hrachyshka
9cbd590ee9 devref: updated documentation for advanced services
Now that we don't maintain the code for the services, we should not ship
documentation to it, but just refer to it.

Change-Id: Id0ced1196718204dda8d51b26715e2f845792ca1
2015-02-23 13:47:05 -05:00
Jenkins
0a2d3b7937 Merge "Adopt rpc_api devref to new oslo_messaging namespace" 2015-02-09 21:04:12 +00:00
Ihar Hrachyshka
1bed055efc Adopt rpc_api devref to new oslo_messaging namespace
Change-Id: Ib6f58cffae882652da52962c9e61298193b50d62
2015-02-07 10:56:34 +01:00
armando-migliaccio
eca0d1ff24 Fix minor nits with the devref's contribute section
Be more explicit on the adoption of Externally Hosted Plugins, which
are based on Extra.d Hooks.

Partially-implement: blueprint core-vendor-decomposition

Change-Id: I4510aaa74c8853278b1c17757d4f4fa67554093a
2015-02-06 23:45:19 -08:00
armando-migliaccio
4a28245623 Provide more details about testing strategies
With the decomp running at full steam, some questions have been
raised on Gerrit, IRC or the mailing list. This patch adds more
details on how to go about unit testing and some current limitations
of 3rd party systems.

Partial-implements: blueprint core-vendor-decomposition

Change-Id: I3920bb394d57de126fd0de8a238f7b710baa1075
2015-02-05 19:02:37 +00:00
armando-migliaccio
c244e6b81e Add section for DevStack Integration Strategies to the DevRef
Plugins may already have DevStack support, that may need to be revised
according to the decomposition. If a plugin/driver does not have one,
it is necessary to add it to ease the development effort. This section
explains what DevStack integration options are available, in relation
to the dev/test cycle and 3rd party CI systems.

Links were not rendered correctly. So this patch takes care of that too.

Partially implements blueprint: core-vendor-decomposition

Change-Id: Ib12e38d775af1e5a840bd009c95dac4c982b9753
2015-02-05 11:02:10 -08:00
armando-migliaccio
e16b38b6ac Add notes on how to deal with stable branches
This patch provides further details related to importing stable branches,
as well as how to deal with backports.

Partially-implements: blueprint core-vendor-decomposition

Change-Id: I4ccde019ee9d86a93a956e42b866ff9b2dc5aedb
2015-01-23 09:36:29 -08:00
Jenkins
39c2efef3a Merge "DHCP agent restructuring" 2015-01-22 05:59:29 +00:00
Russell Bryant
8364c03d10 Create SecurityGroupServerRpcApi and add some docs
Create SecurityGroupServerRpcApi, which is intended to replace
SecurityGroupServerRpcApiMixin over time.  The new class is the same
code, but used as a standalone class.  This is needed to be able to
eventually move this API into a messaging namespace.

In passing, add docstrings that show where to find the corresponding
other side of this interface in the code base.

Part of blueprint rpc-docs-and-namespaces.

Change-Id: If959b2f8bf21b4963bf6876a3eedc0a4b06c6400
2015-01-21 09:49:28 -05:00
armando-migliaccio
b35c004204 DHCP agent restructuring
Wrap dhcp agent into its own module and break out configurations and
entry point for better seperation. This lead to some test cleanup
that revealed that options were registered unnecessarily.

When/if the dhcp agent goes through a restructuring along the same
lines of the L3 agent's, this would be the step to start from.

Related-blueprint: restructure-l3-agent
Related-blueprint: core-vendor-decomposition

Change-Id: I87d9f1079ed4e71c731984ec00e2f785024fd5f8
2015-01-17 01:03:09 -08:00
armando-migliaccio
9391526a58 Add developer documentation for plugins/drivers contributions
This is the initial step to provide documentation and
how-to for developers interested in contributing plugins and
drivers according to the core-vendor-decomp proposal.

Partially-implements: blueprint core-vendor-decomposition

Change-Id: Ib8b6cc5fd72eb1b8b4b4b2bdbda132062c81cbc1
2015-01-05 16:36:48 -08:00
Henry Gessau
3e0745827f Move DB TestModelsMigrations from unit to functional
The tests to check that DB migrations and models are in sync depends
on the mysql and postgresql backends being available with a specific
DB user and database created. This violates the principles for unit
tests and therefore these tests should be moved to functional tests.

For these tests to work in the functional job in the gate, the
backends must be installed and the DB user and database created.
We do this via the functional gate hook.

Closes-bug: #1372981

Change-Id: I7b89feef3f19ca07dbfb05acfaa30529a5bf683d
2014-12-18 22:41:05 -05:00
Russell Bryant
9a276e05a2 Update rpc_api docs with example version update
Update the rpc api devref docs to include an example of what a change
that includes a minor version increment looks like.  I hope this will
help clarify for people what all is included in an API change that
requires a version bump.

Part of blueprint rpc-docs-and-namespaces.

Change-Id: I9c53d3518b200412701b19958d7cbf1ed03d643e
2014-12-09 17:29:16 +00:00
Jeremy Stanley
25ef9258a8 Workflow documentation is now in infra-manual
Replace URLs for workflow documentation to appropriate parts of the
OpenStack Project Infrastructure Manual.

Change-Id: I77aa4152a903a0f1f47de20bb1a006d29f5a1bf2
2014-12-05 03:30:37 +00:00
Russell Bryant
c52840e516 Add some basic rpc api docs
The devref docs had a placeholder file for rpc API docs.  Now that
both a client side and server side interface have been converted from
the rpc compat layer to oslo.messaging APIs, add some docs that give
an overview of what the client and server sides look like.

Also include a section that describes the code layout of where you can
find client and server api implementations in the neutron code base.
It starts by discussing the DHCP agent related APIs.

Part of blueprint drop-rpc-compat.

Change-Id: Ib391958252077365a81bcb881ab27a078f71fdec
2014-11-19 17:18:34 +00:00
Ann Kamyshnikova
5247f5cdf1 Implement ModelsMigrationsSync test from oslo.db
Add tests to verify that database migrations produce
the same schema as the database models.

Also for MySQL, check that all tables are configured to use InnoDB
as the storage engine.
These tests make use of the ModelsMigrationsSync test class from
oslo.db and the load_tests protocol from Python unittest.

Closes-bug: #1346444

Change-Id: Ic0e7eb37c30cc5e94cbdbddf07a6dc1ebf377c17
2014-09-30 11:55:06 +04:00
Andreas Jaeger
6a65321527 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 can cause docs jobs to fail if the project errors out on
warnings.

Change-Id: I71e941e2a639641a662a163c682eb86d51de42fb
Related-Bug: #1368910
2014-09-13 09:29:37 +02:00
Sean M. Collins
8a556c674f Add a link to a blog post by RedHat that discusses GRE tunnels in OVS
Change-Id: I6f3f458eadac12bcb907a2ee6b5d795b8e9593e2
2014-07-07 23:48:19 -07:00
Jenkins
1867207470 Merge "Start using oslosphinx theme for docs" 2014-04-15 11:16:29 +00:00
Sergey Lukjanov
aa4375890c Start using oslosphinx theme for docs
Change-Id: Ica731ff679c618a0ec82b8de816654e758ee5244
2014-03-26 15:51:48 +04:00
Sean M. Collins
c160a03c4e Advanced Services documentation
Adds the beginnings of documentation for the Firewall as a Service,
Loadbalancer as a Service, and VPN as a Service.

Part of blueprint developer-documentation

Change-Id: I5e46df2dc4f87f961490ee75791a7e825ea94e1e
2014-03-18 11:44:02 -04:00
Sean M. Collins
08cf38e86c API layer documentation
* Discuss the WSGI layer of Neutron
* Describe the startup code that creates the WSGI application
* Briefly discuss the URL routing and resource creation

Change-Id: Id82a2a5679d7e29c0a19d1a20942a9249946b011
2014-03-13 00:43:07 -04:00
Jenkins
4753628681 Merge "Developer documentation" 2014-03-08 10:40:41 +00:00
Sean M. Collins
72398f1f69 Developer documentation
* Turns TESTING into a rst file, that we include in the developer
  documentation, for instructions on how to run the unit tests.
* Link to a Vagrant project that sets up Neutron inside a VM.
* Adds a section for how to debug with Nose
* Add new section for Neutron Internals
* Neutron L2 Agent documentation - currently only OVS
* Make the Security Group API extension an example of how an API
  extension is implemented

Implements bp developer-documentation

Change-Id: I9b452abc9da3b1a41ae65cff727967de0eab12fe
2014-02-26 11:03:46 -05:00
Ailing Zhang
b6b4d825cb change Openstack to OpenStack in neutron
Change-Id: I769e00efb8d61679a544ed5ded1c93dd3bc252db
2014-02-24 10:34:25 -08:00
Joe Harrison
4abf27a443 Fixes broken documentation hyperlinks
Several hyperlinks were incorrectly specified in one page of the docs.
These syntax typos have been fixed.

Change-Id: I1a4fe91ac05f51b71e01c001b76712752664ae74
Closes-Bug: #1268611
2014-02-21 12:45:03 -05:00
Jay Pipes
de38cdafaa Start of new developer documentation
There is currently no useful developer-focused documentation in-tree
for Neutron. There are a smattering of useful documents on the
OpenStack wiki, however, there isn't a good organization to this
information, nor is there a condensed developer focus to a lot of it.
Some of the wiki pages are more proposals for features or bug fixes,
and there is a need for architecture, design, and code walk-through
documentation for Neutron to help with new (and existing) contribution.

This patch begins the process of adding developer documentation to Neutron.
It updates the main developer reference index.rst to pull in-line with what
Nova is doing, leaving some todo references for future patches. It also
adds a development.environment tutorial that is up-to-date with current
Neutron development, using tox/testr processes for running unit tests and
including a number of references to external wiki pages that have
instructions for using DevStack for OpenStack contribution/testing.

The next series of patches will add automodule documentation to the
developer reference for some of the major modules in Neutron.

Change-Id: I23aaa11d9a174f24242c49767b92540f5e25b48a
Addresses: blueprint quantum-developer-docs
2013-12-26 17:24:38 -05:00
Nachi Ueno
88148584f2 Fix misspells
Change-Id: I8be38727ca55ebbead9032cf69f10a1006fd004b
Closes-bug:1257424
2013-12-03 15:03:47 -08:00
Tom Fifield
e12ed79936 Update references with new Mailing List location
Yesterday, openstack@lists.launchpad.org was migrated with
all users to openstack@list.openstack.org.

This patch updates references to the old mailing list with the
new, to ensure that people encountering them don't accidentally
try and join the old list!

Change-Id: Id52268cc077bcc89e345a1cd28203ce2fce75db7
2013-07-28 11:35:32 -07:00
Mark McClain
ee3fe4e836 Rename Quantum to Neutron
This change renames everything to Neutron while providing backwards
compatible adjustments for Grizzly configuration files.

implements blueprint: remove-use-of-quantum

Change-Id: Ie7d07ba7c89857e13d4ddc8f0e9b68de020a3d19
2013-07-06 15:02:43 -04:00
Lorin Hochstein
28884ffaa4 Sphinx-ify QuantumPluginBaseV2 docstrings
The quantum.quantum_plugin_base_v2 module had some good docstrings,
but there was no corresponding sphinx code that would generate
docs from them. There were also some syntax issues with the
sphinx markup in the docstrings.

This change adds sphinx directives so these docs will be auto-
generated. It also modifies the docstrings in the QuantumPluginBaseV2
methods so they are parsed by the Sphinx documentation generator
without any errors.

If this patch is accepted, a "Plugin API" link to these docs
will appear at

http://docs.openstack.org/developer/quantum/

Fixes bug 1186255

Change-Id: I96eddcc516d109766d7f4c52edd595748696b595
2013-05-31 09:47:49 -04:00
Gary Kotton
e4b44c2856 Replace "OpenStack LLC" with "OpenStack Foundation"
fixes bug 1154702

Change-Id: I78b1d2c9975a1a4f32b0785cce45f1e471783d8c
2013-03-13 15:06:24 -04:00
Alessio Ababilov
8789704221 Synchronize code from oslo
Use commit eaab5fae2502198e9fa57d0d90a7204a2bd83b16:
Merge "sort options to make --help output prettier"
(Wed Feb 13 12:52:14 2013 +0000)

Add processutils to quantum since impl_zmq depends on them.

Drop notifier.list_notifier that is not present in oslo.

Change-Id: I91d9ec05481b8c24da9fbee1ad4706ff56a3b7aa
Fixes: bug #1116290
2013-02-13 17:43:40 +02:00
Monty Taylor
d65bca867c Updated openstack-common setup and version code.
Updating setup and version require code changes in the code base. This is done
here to support Id9c116a1e10e5c240913fae7a127110b806eff0f

Change-Id: I60b6dd6d684982e33de8fbf051a3dcaf98cb9b87
2012-11-08 09:21:34 +08:00
Ray Chen
b6266559a7 PEP8 issues fixed
Fix some pep8 problems in doc/source/conf.py and make the code
more pretty.

Change-Id: Iff1333441b67addb38533ba061aa89f59533fdb2
2012-08-24 19:21:55 +08:00
Jason Kölker
6d14917e76 Automatically determine Quantum version from source
* Fixes LP1007132
* Adds keystone link
* removes __init__.py since doc/source is not a python module

Change-Id: I6a3234fa760ca23889e352735669547ad9afedf8
2012-05-31 16:04:16 -05:00
Gary Kotton
a86c31ba15 Parse linuxbridge plugins using openstack.common.cfg
Implements the blueprint use-common-cfg

In order for the linuxbridge plugin to use the rpc code soon to be merged into
openstack-common, we need to parse our configuration using cfg. Here we
make the most simple, backwards compatible change in that direction.

The same is relevant for the openvswitch implementation

Fixes after comments.

Change-Id: I70fc1898a802cb4198f72741453283d114added2
2012-05-29 09:54:29 -04:00
Gary Kotton
c809179141 blueprint man-support and fix documentation build
bug 995283

Changes after initial comments

Removed spaces

Updates after comments

Remove white spaces

Fix text and remove empty files

Remove config.py

Updated to be similar to the keystone page

Updated afetr comments

Change-Id: If9240114ae31d7120c708cdcf883e8fe4c7d2bb2
2012-05-22 03:10:58 -04:00
Dan Wendlandt
8d86da72e8 API docs: fix typo for network delete
bug 962282

Change-Id: Ic7f633b59d963e8a14a993468048ccbded9aba34
2012-03-22 09:49:54 -07:00
Jenkins
f0f16bffd7 Merge "fixed incorrect duplicate title" 2012-03-13 00:43:49 +00:00
Jenkins
1173d90ced Merge "add git commit date / sha1 to sphinx html docs" 2012-03-13 00:40:44 +00:00
Mark McClain
f0b6de5dce fixed incorrect duplicate title
Fixes bug 951089

Changed the JSON example title to label the port JSON API examples properly.

Change-Id: I0bec330256f1dd3de43bc3202cedada2f9d40c01
2012-03-09 14:50:19 -05:00
Mark McClain
beed3d1122 Fixed incorrect title for example 3.10
Fixes bug 950535

Changed title for Example 3.10 to correctly reflect JSON

Change-Id: I0f7fae73efa80b617da0a895b80a95f60cb12c42
2012-03-09 00:11:02 -05:00
Jesse Andrews
1769ce8581 add git commit date / sha1 to sphinx html docs
Change-Id: Ie286200e3f569d6d5b0debf66baf24229b0b86ab
2012-03-02 16:09:25 -08:00
Brad Hall
559aedc3d9 Merge from launchpad quantum/diablo branch:
merge salv's fix to remove keystone middleware: lp855151
  one more 202->200 from tyler
  merge tylers additional 202 -> 200 changes
  merge additions to OVS readme describing running with multiple hosts
  merge brad's changes to make create API calls return 200, not 202
  merge unit test for showing unset attachment
  merging API docs branch
  Merge: lp:~yinliu2/quantum/bug856564
  Merge: lp:~bgh/quantum/bug850261

Change-Id: I56fe24c59f918737e57b562343c33ec6dcceac60
2011-09-23 20:17:44 -07:00